azure-native-v2.storage.QueueServiceProperties
Explore with Pulumi AI
The properties of a storage account’s Queue service. Azure REST API version: 2022-09-01. Prior API version in Azure Native 1.x: 2021-02-01.
Other available API versions: 2023-01-01, 2023-04-01, 2023-05-01.
Create QueueServiceProperties Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new QueueServiceProperties(name: string, args: QueueServicePropertiesArgs, opts?: CustomResourceOptions);
@overload
def QueueServiceProperties(resource_name: str,
args: QueueServicePropertiesArgs,
opts: Optional[ResourceOptions] = None)
@overload
def QueueServiceProperties(resource_name: str,
opts: Optional[ResourceOptions] = None,
account_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
cors: Optional[CorsRulesArgs] = None,
queue_service_name: Optional[str] = None)
func NewQueueServiceProperties(ctx *Context, name string, args QueueServicePropertiesArgs, opts ...ResourceOption) (*QueueServiceProperties, error)
public QueueServiceProperties(string name, QueueServicePropertiesArgs args, CustomResourceOptions? opts = null)
public QueueServiceProperties(String name, QueueServicePropertiesArgs args)
public QueueServiceProperties(String name, QueueServicePropertiesArgs args, CustomResourceOptions options)
type: azure-native:storage:QueueServiceProperties
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. QueueServicePropertiesArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. QueueServicePropertiesArgs - The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. QueueServicePropertiesArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. QueueServicePropertiesArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. QueueServicePropertiesArgs - The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var queueServicePropertiesResource = new AzureNative.Storage.QueueServiceProperties("queueServicePropertiesResource", new()
{
AccountName = "string",
ResourceGroupName = "string",
Cors =
{
{ "corsRules", new[]
{
{
{ "allowedHeaders", new[]
{
"string",
} },
{ "allowedMethods", new[]
{
"string",
} },
{ "allowedOrigins", new[]
{
"string",
} },
{ "exposedHeaders", new[]
{
"string",
} },
{ "maxAgeInSeconds", 0 },
},
} },
},
QueueServiceName = "string",
});
example, err := storage.NewQueueServiceProperties(ctx, "queueServicePropertiesResource", &storage.QueueServicePropertiesArgs{
AccountName: "string",
ResourceGroupName: "string",
Cors: map[string]interface{}{
"corsRules": []map[string]interface{}{
map[string]interface{}{
"allowedHeaders": []string{
"string",
},
"allowedMethods": []string{
"string",
},
"allowedOrigins": []string{
"string",
},
"exposedHeaders": []string{
"string",
},
"maxAgeInSeconds": 0,
},
},
},
QueueServiceName: "string",
})
var queueServicePropertiesResource = new QueueServiceProperties("queueServicePropertiesResource", QueueServicePropertiesArgs.builder()
.accountName("string")
.resourceGroupName("string")
.cors(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.queueServiceName("string")
.build());
queue_service_properties_resource = azure_native.storage.QueueServiceProperties("queueServicePropertiesResource",
account_name=string,
resource_group_name=string,
cors={
corsRules: [{
allowedHeaders: [string],
allowedMethods: [string],
allowedOrigins: [string],
exposedHeaders: [string],
maxAgeInSeconds: 0,
}],
},
queue_service_name=string)
const queueServicePropertiesResource = new azure_native.storage.QueueServiceProperties("queueServicePropertiesResource", {
accountName: "string",
resourceGroupName: "string",
cors: {
corsRules: [{
allowedHeaders: ["string"],
allowedMethods: ["string"],
allowedOrigins: ["string"],
exposedHeaders: ["string"],
maxAgeInSeconds: 0,
}],
},
queueServiceName: "string",
});
type: azure-native:storage:QueueServiceProperties
properties:
accountName: string
cors:
corsRules:
- allowedHeaders:
- string
allowedMethods:
- string
allowedOrigins:
- string
exposedHeaders:
- string
maxAgeInSeconds: 0
queueServiceName: string
resourceGroupName: string
QueueServiceProperties Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The QueueServiceProperties resource accepts the following input properties:
- Account
Name This property is required. Changes to this property will trigger replacement.
- The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group within the user's subscription. The name is case insensitive.
- Cors
Pulumi.
Azure Native. Storage. Inputs. Cors Rules - Specifies CORS rules for the Queue service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Queue service.
- Queue
Service Name Changes to this property will trigger replacement.
- The name of the Queue Service within the specified storage account. Queue Service Name must be 'default'
- Account
Name This property is required. Changes to this property will trigger replacement.
- The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group within the user's subscription. The name is case insensitive.
- Cors
Cors
Rules Args - Specifies CORS rules for the Queue service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Queue service.
- Queue
Service Name Changes to this property will trigger replacement.
- The name of the Queue Service within the specified storage account. Queue Service Name must be 'default'
- account
Name This property is required. Changes to this property will trigger replacement.
- The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group within the user's subscription. The name is case insensitive.
- cors
Cors
Rules - Specifies CORS rules for the Queue service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Queue service.
- queue
Service Name Changes to this property will trigger replacement.
- The name of the Queue Service within the specified storage account. Queue Service Name must be 'default'
- account
Name This property is required. Changes to this property will trigger replacement.
- The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group within the user's subscription. The name is case insensitive.
- cors
Cors
Rules - Specifies CORS rules for the Queue service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Queue service.
- queue
Service Name Changes to this property will trigger replacement.
- The name of the Queue Service within the specified storage account. Queue Service Name must be 'default'
- account_
name This property is required. Changes to this property will trigger replacement.
- The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- The name of the resource group within the user's subscription. The name is case insensitive.
- cors
Cors
Rules Args - Specifies CORS rules for the Queue service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Queue service.
- queue_
service_ name Changes to this property will trigger replacement.
- The name of the Queue Service within the specified storage account. Queue Service Name must be 'default'
- account
Name This property is required. Changes to this property will trigger replacement.
- The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group within the user's subscription. The name is case insensitive.
- cors Property Map
- Specifies CORS rules for the Queue service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Queue service.
- queue
Service Name Changes to this property will trigger replacement.
- The name of the Queue Service within the specified storage account. Queue Service Name must be 'default'
Outputs
All input properties are implicitly available as output properties. Additionally, the QueueServiceProperties resource produces the following output properties:
Supporting Types
AllowedMethods, AllowedMethodsArgs
- DELETE
- DELETE
- GET
- GET
- HEAD
- HEAD
- MERGE
- MERGE
- POST
- POST
- OPTIONS
- OPTIONS
- PUT
- PUT
- PATCH
- PATCH
- Allowed
Methods DELETE - DELETE
- Allowed
Methods GET - GET
- Allowed
Methods HEAD - HEAD
- Allowed
Methods MERGE - MERGE
- Allowed
Methods POST - POST
- Allowed
Methods OPTIONS - OPTIONS
- Allowed
Methods PUT - PUT
- Allowed
Methods PATCH - PATCH
- DELETE
- DELETE
- GET
- GET
- HEAD
- HEAD
- MERGE
- MERGE
- POST
- POST
- OPTIONS
- OPTIONS
- PUT
- PUT
- PATCH
- PATCH
- DELETE
- DELETE
- GET
- GET
- HEAD
- HEAD
- MERGE
- MERGE
- POST
- POST
- OPTIONS
- OPTIONS
- PUT
- PUT
- PATCH
- PATCH
- DELETE
- DELETE
- GET
- GET
- HEAD
- HEAD
- MERGE
- MERGE
- POST
- POST
- OPTIONS
- OPTIONS
- PUT
- PUT
- PATCH
- PATCH
- "DELETE"
- DELETE
- "GET"
- GET
- "HEAD"
- HEAD
- "MERGE"
- MERGE
- "POST"
- POST
- "OPTIONS"
- OPTIONS
- "PUT"
- PUT
- "PATCH"
- PATCH
CorsRule, CorsRuleArgs
- Allowed
Headers This property is required. List<string> - Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request.
- Allowed
Methods This property is required. List<Union<string, Pulumi.Azure Native. Storage. Allowed Methods>> - Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin.
- Allowed
Origins This property is required. List<string> - Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains
- Exposed
Headers This property is required. List<string> - Required if CorsRule element is present. A list of response headers to expose to CORS clients.
- Max
Age In Seconds This property is required. int - Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response.
- Allowed
Headers This property is required. []string - Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request.
- Allowed
Methods This property is required. []string - Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin.
- Allowed
Origins This property is required. []string - Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains
- Exposed
Headers This property is required. []string - Required if CorsRule element is present. A list of response headers to expose to CORS clients.
- Max
Age In Seconds This property is required. int - Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response.
- allowed
Headers This property is required. List<String> - Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request.
- allowed
Methods This property is required. List<Either<String,AllowedMethods>> - Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin.
- allowed
Origins This property is required. List<String> - Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains
- exposed
Headers This property is required. List<String> - Required if CorsRule element is present. A list of response headers to expose to CORS clients.
- max
Age In Seconds This property is required. Integer - Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response.
- allowed
Headers This property is required. string[] - Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request.
- allowed
Methods This property is required. (string | AllowedMethods)[] - Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin.
- allowed
Origins This property is required. string[] - Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains
- exposed
Headers This property is required. string[] - Required if CorsRule element is present. A list of response headers to expose to CORS clients.
- max
Age In Seconds This property is required. number - Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response.
- allowed_
headers This property is required. Sequence[str] - Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request.
- allowed_
methods This property is required. Sequence[Union[str, AllowedMethods]] - Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin.
- allowed_
origins This property is required. Sequence[str] - Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains
- exposed_
headers This property is required. Sequence[str] - Required if CorsRule element is present. A list of response headers to expose to CORS clients.
- max_
age_ in_ seconds This property is required. int - Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response.
- allowed
Headers This property is required. List<String> - Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request.
- allowed
Methods This property is required. List<String | "DELETE" | "GET" | "HEAD" | "MERGE" | "POST" | "OPTIONS" | "PUT" | "PATCH"> - Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin.
- allowed
Origins This property is required. List<String> - Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains
- exposed
Headers This property is required. List<String> - Required if CorsRule element is present. A list of response headers to expose to CORS clients.
- max
Age In Seconds This property is required. Number - Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response.
CorsRuleResponse, CorsRuleResponseArgs
- Allowed
Headers This property is required. List<string> - Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request.
- Allowed
Methods This property is required. List<string> - Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin.
- Allowed
Origins This property is required. List<string> - Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains
- Exposed
Headers This property is required. List<string> - Required if CorsRule element is present. A list of response headers to expose to CORS clients.
- Max
Age In Seconds This property is required. int - Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response.
- Allowed
Headers This property is required. []string - Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request.
- Allowed
Methods This property is required. []string - Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin.
- Allowed
Origins This property is required. []string - Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains
- Exposed
Headers This property is required. []string - Required if CorsRule element is present. A list of response headers to expose to CORS clients.
- Max
Age In Seconds This property is required. int - Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response.
- allowed
Headers This property is required. List<String> - Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request.
- allowed
Methods This property is required. List<String> - Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin.
- allowed
Origins This property is required. List<String> - Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains
- exposed
Headers This property is required. List<String> - Required if CorsRule element is present. A list of response headers to expose to CORS clients.
- max
Age In Seconds This property is required. Integer - Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response.
- allowed
Headers This property is required. string[] - Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request.
- allowed
Methods This property is required. string[] - Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin.
- allowed
Origins This property is required. string[] - Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains
- exposed
Headers This property is required. string[] - Required if CorsRule element is present. A list of response headers to expose to CORS clients.
- max
Age In Seconds This property is required. number - Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response.
- allowed_
headers This property is required. Sequence[str] - Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request.
- allowed_
methods This property is required. Sequence[str] - Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin.
- allowed_
origins This property is required. Sequence[str] - Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains
- exposed_
headers This property is required. Sequence[str] - Required if CorsRule element is present. A list of response headers to expose to CORS clients.
- max_
age_ in_ seconds This property is required. int - Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response.
- allowed
Headers This property is required. List<String> - Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request.
- allowed
Methods This property is required. List<String> - Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin.
- allowed
Origins This property is required. List<String> - Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains
- exposed
Headers This property is required. List<String> - Required if CorsRule element is present. A list of response headers to expose to CORS clients.
- max
Age In Seconds This property is required. Number - Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response.
CorsRules, CorsRulesArgs
- Cors
Rules List<Pulumi.Azure Native. Storage. Inputs. Cors Rule> - The List of CORS rules. You can include up to five CorsRule elements in the request.
- Cors
Rules []CorsRule - The List of CORS rules. You can include up to five CorsRule elements in the request.
- cors
Rules List<CorsRule> - The List of CORS rules. You can include up to five CorsRule elements in the request.
- cors
Rules CorsRule[] - The List of CORS rules. You can include up to five CorsRule elements in the request.
- cors_
rules Sequence[CorsRule] - The List of CORS rules. You can include up to five CorsRule elements in the request.
- cors
Rules List<Property Map> - The List of CORS rules. You can include up to five CorsRule elements in the request.
CorsRulesResponse, CorsRulesResponseArgs
- Cors
Rules List<Pulumi.Azure Native. Storage. Inputs. Cors Rule Response> - The List of CORS rules. You can include up to five CorsRule elements in the request.
- Cors
Rules []CorsRule Response - The List of CORS rules. You can include up to five CorsRule elements in the request.
- cors
Rules List<CorsRule Response> - The List of CORS rules. You can include up to five CorsRule elements in the request.
- cors
Rules CorsRule Response[] - The List of CORS rules. You can include up to five CorsRule elements in the request.
- cors_
rules Sequence[CorsRule Response] - The List of CORS rules. You can include up to five CorsRule elements in the request.
- cors
Rules List<Property Map> - The List of CORS rules. You can include up to five CorsRule elements in the request.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:storage:QueueServiceProperties default /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices/{queueServiceName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- azure-native-v2 pulumi/pulumi-azure-native
- License
- Apache-2.0