queue_services
Creates, updates, deletes, gets or lists a queue_services resource.
Overview
| Name | queue_services |
| Type | Resource |
| Id | azure.storage.queue_services |
Fields
The following fields are returned by SELECT queries:
- list
OK -- returned the properties of a storage account’s Queue service.
| Name | Datatype | Description |
|---|---|---|
id | string (arm-id) | Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
name | string | The name of the resource |
properties | | The properties of a storage account’s Queue service. (x-ms-client-name: QueueServiceProperties) |
systemData | object | Azure Resource Manager metadata containing createdBy and modifiedBy information. |
type | string | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | resourceGroupName, accountName, subscriptionId | List all queue services for the storage account | |
set_service_properties | exec | resourceGroupName, accountName, subscriptionId, queueServiceName | Sets the properties of a storage account’s Queue service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
accountName | 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 | string | The name of the Queue Service within the specified storage account. Queue Service Name must be 'default' |
resourceGroupName | string | The name of the resource group within the user's subscription. The name is case insensitive. |
subscriptionId | string (uuid) | The ID of the target subscription. The value must be an UUID. |
SELECT examples
- list
List all queue services for the storage account
SELECT
id,
name,
properties,
systemData,
type
FROM azure.storage.queue_services
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;
Lifecycle Methods
- set_service_properties
Sets the properties of a storage account’s Queue service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.
EXEC azure.storage.queue_services.set_service_properties
@resourceGroupName='{{ resourceGroupName }}' --required,
@accountName='{{ accountName }}' --required,
@subscriptionId='{{ subscriptionId }}' --required,
@queueServiceName='{{ queueServiceName }}' --required
@@json=
'{
"properties": "{{ properties }}"
}'
;