Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. storage
  5. getQueueServiceProperties
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.storage.getQueueServiceProperties

Explore with Pulumi AI

These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

Gets the properties of a storage account’s Queue service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules. API Version: 2021-02-01.

Using getQueueServiceProperties

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getQueueServiceProperties(args: GetQueueServicePropertiesArgs, opts?: InvokeOptions): Promise<GetQueueServicePropertiesResult>
function getQueueServicePropertiesOutput(args: GetQueueServicePropertiesOutputArgs, opts?: InvokeOptions): Output<GetQueueServicePropertiesResult>
Copy
def get_queue_service_properties(account_name: Optional[str] = None,
                                 queue_service_name: Optional[str] = None,
                                 resource_group_name: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetQueueServicePropertiesResult
def get_queue_service_properties_output(account_name: Optional[pulumi.Input[str]] = None,
                                 queue_service_name: Optional[pulumi.Input[str]] = None,
                                 resource_group_name: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetQueueServicePropertiesResult]
Copy
func LookupQueueServiceProperties(ctx *Context, args *LookupQueueServicePropertiesArgs, opts ...InvokeOption) (*LookupQueueServicePropertiesResult, error)
func LookupQueueServicePropertiesOutput(ctx *Context, args *LookupQueueServicePropertiesOutputArgs, opts ...InvokeOption) LookupQueueServicePropertiesResultOutput
Copy

> Note: This function is named LookupQueueServiceProperties in the Go SDK.

public static class GetQueueServiceProperties 
{
    public static Task<GetQueueServicePropertiesResult> InvokeAsync(GetQueueServicePropertiesArgs args, InvokeOptions? opts = null)
    public static Output<GetQueueServicePropertiesResult> Invoke(GetQueueServicePropertiesInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetQueueServicePropertiesResult> getQueueServiceProperties(GetQueueServicePropertiesArgs args, InvokeOptions options)
public static Output<GetQueueServicePropertiesResult> getQueueServiceProperties(GetQueueServicePropertiesArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:storage:getQueueServiceProperties
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AccountName
This property is required.
Changes to this property will trigger replacement.
string
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.
QueueServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Queue Service within the specified storage account. Queue Service Name must be 'default'
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group within the user's subscription. The name is case insensitive.
AccountName
This property is required.
Changes to this property will trigger replacement.
string
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.
QueueServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Queue Service within the specified storage account. Queue Service Name must be 'default'
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group within the user's subscription. The name is case insensitive.
accountName
This property is required.
Changes to this property will trigger replacement.
String
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.
queueServiceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Queue Service within the specified storage account. Queue Service Name must be 'default'
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group within the user's subscription. The name is case insensitive.
accountName
This property is required.
Changes to this property will trigger replacement.
string
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.
queueServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Queue Service within the specified storage account. Queue Service Name must be 'default'
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group within the user's subscription. The name is case insensitive.
account_name
This property is required.
Changes to this property will trigger replacement.
str
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.
queue_service_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Queue Service within the specified storage account. Queue Service Name must be 'default'
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group within the user's subscription. The name is case insensitive.
accountName
This property is required.
Changes to this property will trigger replacement.
String
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.
queueServiceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Queue Service within the specified storage account. Queue Service Name must be 'default'
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group within the user's subscription. The name is case insensitive.

getQueueServiceProperties Result

The following output properties are available:

Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Cors Pulumi.AzureNative.Storage.Outputs.CorsRulesResponse
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.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Cors CorsRulesResponse
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.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
cors CorsRulesResponse
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.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string
The name of the resource
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
cors CorsRulesResponse
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.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str
The name of the resource
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
cors CorsRulesResponse
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.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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.

Supporting Types

CorsRuleResponse

AllowedHeaders 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.
AllowedMethods 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.
AllowedOrigins 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
ExposedHeaders This property is required. List<string>
Required if CorsRule element is present. A list of response headers to expose to CORS clients.
MaxAgeInSeconds This property is required. int
Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response.
AllowedHeaders This property is required. []string
Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request.
AllowedMethods 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.
AllowedOrigins 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
ExposedHeaders This property is required. []string
Required if CorsRule element is present. A list of response headers to expose to CORS clients.
MaxAgeInSeconds This property is required. int
Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response.
allowedHeaders 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.
allowedMethods 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.
allowedOrigins 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
exposedHeaders This property is required. List<String>
Required if CorsRule element is present. A list of response headers to expose to CORS clients.
maxAgeInSeconds This property is required. Integer
Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response.
allowedHeaders This property is required. string[]
Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request.
allowedMethods 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.
allowedOrigins 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
exposedHeaders This property is required. string[]
Required if CorsRule element is present. A list of response headers to expose to CORS clients.
maxAgeInSeconds 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.
allowedHeaders 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.
allowedMethods 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.
allowedOrigins 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
exposedHeaders This property is required. List<String>
Required if CorsRule element is present. A list of response headers to expose to CORS clients.
maxAgeInSeconds This property is required. Number
Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response.

CorsRulesResponse

CorsRules List<Pulumi.AzureNative.Storage.Inputs.CorsRuleResponse>
The List of CORS rules. You can include up to five CorsRule elements in the request.
CorsRules []CorsRuleResponse
The List of CORS rules. You can include up to five CorsRule elements in the request.
corsRules List<CorsRuleResponse>
The List of CORS rules. You can include up to five CorsRule elements in the request.
corsRules CorsRuleResponse[]
The List of CORS rules. You can include up to five CorsRule elements in the request.
cors_rules Sequence[CorsRuleResponse]
The List of CORS rules. You can include up to five CorsRule elements in the request.
corsRules List<Property Map>
The List of CORS rules. You can include up to five CorsRule elements in the request.

Package Details

Repository
azure-native-v1 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native