service

Creates, updates, deletes, gets or lists a service resource.

Overview

Name	service
Type	Resource
Id	azure.storage_queue.service

Fields

The following fields are returned by SELECT queries:

get_user_delegation_key

Name	Datatype	Description
signedDelegatedUserTid	string	The delegated user tenant ID in Entra ID. Return if DelegatedUserTid is specified.
signedExpiry	string	The date-time the key expires. Required.
signedOid	string	The Entra ID object ID in GUID format. Required.
signedService	string	The service that created the key. Required.
signedStart	string	The date-time the key is active. Required.
signedTid	string	The Entra ID tenant ID in GUID format. Required.
signedVersion	string	The service version used when creating the key. Required.
value	string	The key as a base64 string. Required.

get_properties

Name	Datatype	Description
cors	array	The CORS properties.
hourMetrics	object	The hour metrics properties.
logging	object	The logging properties.
minuteMetrics	object	The minute metrics properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_user_delegation_key	select	account	timeout	Retrieves a user delegation key for the Queue service. This is only a valid operation when using bearer token authentication.
get_properties	select	account	timeout	Retrieves properties of a storage account's Queue service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.
set_properties	exec	account	timeout	Sets properties for a storage account's Queue service endpoint, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.
get_statistics	exec	account	timeout	Retrieves statistics related to replication for the Queue service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account.
get_queues	exec	account	prefix, marker, maxresults, timeout, include	Returns a list of queues.

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
account	string	Storage account name. (default: )
include	array	Specify to include additional, optional information. Default value is None.
marker	string	Identifies the portion of the list of queues to be returned with the next listing operation. The operation returns the marker value if the listing operation did not return all queues remaining. The marker value can be used as the value for the marker parameter in a subsequent call to request the next page of list items. The marker value is opaque to the client. Default value is None.
maxresults	integer	Specifies the maximum number of queues to return. If the request does not specify maxresults, or specifies a value greater than 5000, the server will return up to 5000 items. Default value is None.
prefix	string	Filters the results to return only queues whose name begins with the specified prefix. Default value is None.
timeout	integer	The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations.. Default value is None.

SELECT examples

get_user_delegation_key

Retrieves a user delegation key for the Queue service. This is only a valid operation when using bearer token authentication.

SELECT
signedDelegatedUserTid,
signedExpiry,
signedOid,
signedService,
signedStart,
signedTid,
signedVersion,
value
FROM azure.storage_queue.service
WHERE account = '{{ account }}' -- required
AND timeout = '{{ timeout }}'
;

get_properties

Retrieves properties of a storage account's Queue service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.

SELECT
cors,
hourMetrics,
logging,
minuteMetrics
FROM azure.storage_queue.service
WHERE account = '{{ account }}' -- required
AND timeout = '{{ timeout }}'
;

Lifecycle Methods

set_properties

Sets properties for a storage account's Queue service endpoint, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.

EXEC azure.storage_queue.service.set_properties 
@account='{{ account }}' --required, 
@timeout='{{ timeout }}' 
@@json=
'{
"logging": "{{ logging }}", 
"hourMetrics": "{{ hourMetrics }}", 
"minuteMetrics": "{{ minuteMetrics }}", 
"cors": "{{ cors }}"
}'
;

get_statistics

Retrieves statistics related to replication for the Queue service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account.

EXEC azure.storage_queue.service.get_statistics 
@account='{{ account }}' --required, 
@timeout='{{ timeout }}'
;

get_queues

Returns a list of queues.

EXEC azure.storage_queue.service.get_queues 
@account='{{ account }}' --required, 
@prefix='{{ prefix }}', 
@marker='{{ marker }}', 
@maxresults='{{ maxresults }}', 
@timeout='{{ timeout }}', 
@include='{{ include }}'
;