Set Queue ACL
Set Queue ACL operation sets stored access policies for the queue that may be used with Shared Access Signatures. For more information, see Establishing a Stored Access Policy.
Set Queue ACL operation is available in version 2012-02-12 and newer.
Set Queue ACL request may be constructed as follows. HTTPS is recommended. Replace myaccount with the name of your storage account:
|Method||Request URI||HTTP Version|
Emulated Storage Service URI
When making a request against the emulated storage service, specify the emulator hostname and Queue service port as
127.0.0.1:10001, followed by the emulated storage account name:
|Method||Request URI||HTTP Version|
For more information, see Differences Between the Storage Emulator and Azure Storage Services.
The following additional parameters may be specified on the request URI.
The following table describes required and optional request headers.
||Required. Specifies the authentication scheme, account name, and signature. For more information, see Authentication for the Azure Storage Services.|
||Required. Specifies the Coordinated Universal Time (UTC) for the request. For more information, see Authentication for the Azure Storage Services.|
||Optional. Specifies the version of the operation to use for this request. For more information, see Versioning for the Azure Storage Services.|
||Optional. Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. Using this header is highly recommended for correlating client-side activities with requests received by the server. For more information, see About Storage Analytics Logging and Azure Logging: Using Logs to Track Storage Requests.|
To specify a stored access policy, provide a unique identifier and access policy in the request body for the
Set Queue ACL operation.
SignedIdentifier element includes the unique identifier, as specified in the
Id element, and the details of the access policy, as specified in the
AccessPolicy element. The maximum length of the unique identifier is 64 characters.
Expiry fields must be expressed as UTC times and must adhere to a valid ISO 8061 format. Supported ISO 8061 formats include the following:
For the date portion of these formats,
YYYYis a four-digit year representation,
MMis a two-digit month representation, and
DDis a two-digit day representation. For the time portion,
hhis the hour representation in 24-hour notation,
mmis the two-digit minute representation,
ssis the two-digit second representation, and
ffffffis the six-digit millisecond representation. A time designator
Tseparates the date and time portions of the string, while a time zone designator
TZDspecifies a time zone.
<?xml version="1.0" encoding="utf-8"?> <SignedIdentifiers> <SignedIdentifier> <Id>unique-64-character-value</Id> <AccessPolicy> <Start>start-time</Start> <Expiry>expiry-time</Expiry> <Permission>abbreviated-permission-list</Permission> </AccessPolicy> </SignedIdentifier> </SignedIdentifiers>
Request Syntax: PUT https://myaccount.queue.core.windows.net/myqueue?comp=acl HTTP/1.1 Request Headers: x-ms-version: 2012-02-12 x-ms-date: Sun, 25 Sep 2011 00:42:49 GMT Authorization: SharedKey myaccount:V47F2tYLS29MmHPhiR8FyiCny9zO5De3kVSF0RYQHmo= Request Body: <?xml version="1.0" encoding="utf-8"?> <SignedIdentifiers> <SignedIdentifier> <Id>MTIzNDU2Nzg5MDEyMzQ1Njc4OTAxMjM0NTY3ODkwMTI=</Id> <AccessPolicy> <Start>2009-09-28T08:49:37.0000000Z</Start> <Expiry>2009-09-29T08:49:37.0000000Z</Expiry> <Permission>raup</Permission> </AccessPolicy> </SignedIdentifier> </SignedIdentifiers>
The response includes an HTTP status code and a set of response headers.
A successful operation returns status code 204 (No Content).
For information about status codes, see Status and Error Codes.
The response for this operation includes the following headers. The response may also include additional standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.
||This header uniquely identifies the request that was made and can be used for troubleshooting the request. For more information, see Troubleshooting API Operations|
||Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and later.|
||A UTC date/time value generated by the service that indicates the time at which the response was initiated.|
Response Status: HTTP/1.1 204 No Content Response Headers: Transfer-Encoding: chunked Date: Sun, 25 Sep 2011 22:42:55 GMT x-ms-version: 2012-02-12 Server: Windows-Azure-Queue/1.0 Microsoft-HTTPAPI/2.0
Only the account owner may call this operation.
Only the account owner may access resources in a particular queue unless the owner has issued a Shared Access Signature for a resource within the queue.
When you set permissions for a queue, the existing permissions are replaced. To update the queue’s permissions, call Get Queue ACL to fetch all access policies associated with the queue, modify the access policy that you wish to change, and then call
Set Queue ACL with the complete set of data to perform the update.
Establishing Stored Access Policies
A stored access policy can specify the start time, expiry time, and permissions for the Shared Access Signatures with which it's associated. Depending on how you want to control access to your queue resource, you can specify all of these parameters within the stored access policy, and omit them from the URL for the Shared Access Signature. Doing so permits you to modify the associated signature's behavior at any time, as well as to revoke it. Or you can specify one or more of the access policy parameters within the stored access policy, and the others on the URL. Finally, you can specify all of the parameters on the URL. In this case, you can use the stored access policy to revoke the signature, but not to modify its behavior. See Establishing a Stored Access Policy for more information about establishing access policies.
Together the Shared Access Signature and the stored access policy must include all fields required to authenticate the signature. If any required fields are missing, the request will fail. Likewise, if a field is specified both in the Shared Access Signature URL and in the stored access policy, the request will fail with status code 400 (Bad Request).
Note that at most five separate access policies can be set for a given queue at any time. If more than five access policies are passed in the request body, then the service returns status code 400 (Bad Request).
When you establish a stored access policy on a queue, it may take up to 30 seconds to take effect. During this interval, a shared access signature that is associated with the stored access policy will fail with status code 403 (Forbidden), until the access policy becomes active.