Set Table ACL

The Set Table ACL operation sets the stored access policies for the table that can be used with shared access signatures. For more information, see Define a stored access policy.

Note

The Set Table ACL operation is available in version 2012-02-12 and later.

Note

An access control list (ACL) is a list of access control entries (ACEs). Each ACE in an ACL identifies a trustee and specifies the access rights allowed, denied, or audited for that trustee. For more information, see Access control lists.

Request

You can construct the Set Table ACL request as follows. We recommend HTTPS. Replace myaccount with the name of your storage account.

Method Request URI HTTP version
PUT https://myaccount.table.core.windows.net/mytable?comp=acl HTTP/1.1

Emulated storage service URI

When you're making a request against the emulated storage service, specify the emulator host name and Azure Table Storage port as 127.0.0.1:10002. Then add the emulated storage account name.

Method Request URI HTTP version
PUT http://127.0.0.1:10002/devstoreaccount1/mytable?comp=acl HTTP/1.1

For more information, see Use the Azurite emulator for local Azure Storage development.

URI parameters

You can specify the following additional parameters on the request URI:

Parameter Description
timeout Optional. Expressed in seconds. For more information, see Set timeouts for Table Storage operations.

Request headers

The following table describes required and optional request headers:

Request header Description
Authorization Required. Specifies the authorization scheme, account name, and signature. For more information, see Authorize requests to Azure Storage.
Date or x-ms-date Required. Specifies the Coordinated Universal Time (UTC) for the request. For more information, see Authorize requests to Azure Storage.
x-ms-version Optional. Specifies the version of the operation to use for this request. For more information, see Versioning for the Azure Storage services.
x-ms-client-request-id Optional. Provides a client-generated, opaque value with a 1-kibibyte (KiB) character limit that's recorded in the Storage Analytics logs when logging is configured. We highly recommend that you use this header to correlate client-side activities with requests that the server receives.

Request body

To specify a stored access policy, provide a unique identifier and access policy in the request body for the Set Table ACL operation.

The SignedIdentifier element includes the unique identifier, as specified in the Id element. SignedIdentifier also includes the details of the access policy, as specified in the AccessPolicy element. The maximum length of the unique identifier is 64 characters.

The Start and Expiry fields must be expressed as UTC times and must adhere to a valid ISO 8061 format. Supported ISO 8061 formats include:

  • YYYY-MM-DD

  • YYYY-MM-DDThh:mmTZD

  • YYYY-MM-DDThh:mm:ssTZD

  • YYYY-MM-DDThh:mm:ss.ffffffTZD

For the date portion of these formats, YYYY is a four-digit year representation, MM is a two-digit month representation, and DD is a two-digit day representation. For the time portion, hh is the hour representation in 24-hour notation, mm is the two-digit minute representation, ss is the two-digit second representation, and ffffff is the six-digit millisecond representation. The time designator T separates the date and time portions of the string. The time zone designator TZD specifies 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>  
  

Sample request

Request Syntax:  
PUT https://myaccount.table.core.windows.net/mytable?comp=acl HTTP/1.1  
  
Request Headers:  
x-ms-version: 2013-08-15  
x-ms-date: Mon, 25 Nov 2013 00:42:49 GMT  
Authorization: SharedKey myaccount:V47F2tYLS29MmHPhiR8FyiCny9zO5De3kVSF0RYQHmo=  
  
Request Body:  
<?xml version="1.0" encoding="utf-8"?>  
<SignedIdentifiers>  
  <SignedIdentifier>   
    <Id>MTIzNDU2Nzg5MDEyMzQ1Njc4OTAxMjM0NTY3ODkwMTI=</Id>  
    <AccessPolicy>  
      <Start>2013-11-26T08:49:37.0000000Z</Start>  
      <Expiry>2013-11-27T08:49:37.0000000Z</Expiry>  
      <Permission>raud</Permission>  
    </AccessPolicy>  
  </SignedIdentifier>  
</SignedIdentifiers>  
  

Response

The response includes an HTTP status code and a set of response headers.

Status code

A successful operation returns status code 204 (No Content).

For information about status codes, see Status and error codes.

Response headers

The response for this operation includes the following headers. The response might also include additional standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.

Response header Description
x-ms-request-id Uniquely identifies the request that was made. You can also use it to troubleshoot the request. For more information, see Troubleshoot API operations.
x-ms-version Indicates the version of Table Storage that's used to execute the request. This header is returned for requests made against version 2009-09-19 and later.
Date A UTC date/time value that indicates the time at which the service sent the response.
x-ms-client-request-id Can be used to troubleshoot requests and corresponding responses. The value of this header is equal to the value of the x-ms-client-request-id header, if it's present in the request and the value is at most 1,024 visible ASCII characters. If the x-ms-client-request-id header is not present in the request, this header won't be present in the response.

Sample response

Response Status:  
HTTP/1.1 204 No Content  
  
Response Headers:  
Transfer-Encoding: chunked  
Date: Mon, 25 Nov 2013 22:42:55 GMT  
x-ms-version: 2013-08-15  
Server: Windows-Azure-Table/1.0 Microsoft-HTTPAPI/2.0  
  

Authorization

Authorization is required when calling any data access operation in Azure Storage. You can authorize the Set Table ACL operation using Microsoft Entra ID or Shared Key.

To authorize the Set Table ACL operation using Microsoft Entra ID, the security principal needs a custom Azure RBAC role that includes the following RBAC action: Microsoft.Storage/storageAccounts/tableServices/tables/setAcl/action.

Important

Microsoft recommends using Microsoft Entra ID with managed identities to authorize requests to Azure Storage. Microsoft Entra ID provides superior security and ease of use compared to Shared Key authorization.

Remarks

When you set permissions for a table, the existing permissions are replaced. To update the table's permissions, call Get Table ACL to fetch all access policies associated with the table. Modify the access policy that you want to change, and then call Set Table ACL with the complete set of data to perform the update.

Establishing stored access policies

A stored access policy can specify the start time, expiration time, and permissions for the shared access signatures that it's associated with. Depending on how you want to control access to your share or file 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 or revoke it at any time.
  • Specify one or more of the access policy parameters within the stored access policy, and specify the other parameters on the URL.
  • 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.

For more information about establishing access policies, see Define a stored access policy.

Together, the shared access signature and the stored access policy must include all fields required to authorize 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). For more information about the fields that compose a shared access signature, see Create a service SAS.

You can set a maximum of five separate access policies for a table at any time. If more than five access policies are passed in the request body, the service returns status code 400 (Bad Request).

Note

When you establish a stored access policy on a table, it might take up to 30 seconds to take effect. During this interval, a shared access signature that's associated with the stored access policy will fail with status code 403 (Forbidden), until the access policy becomes active.

See also

Define a stored access policy
Create and use a shared access signature
Delegate access with a shared access signature
Get Table ACL
Authorize requests to Azure Storage
Status and error codes