Get Container Metadata

The Get Container Metadata operation returns all user-defined metadata for the container.


The Get Container Metadata request may be constructed as follows. We recommend that you use HTTPS. Replace myaccount with the name of your storage account:

Method Request URI HTTP version

Emulated storage service request

When you're making a request against the emulated storage service, specify the emulator hostname and Azure Blob Storage port as, followed by the emulated storage account name:

Method Request URI HTTP version

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

URI parameters

The following additional parameters may be specified on the request URI:

Parameter Description
timeout Optional. The timeout parameter is expressed in seconds. For more information, see Set time-outs for Blob 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-lease-id: <ID> Optional, version 2012-02-12 and later. If it's specified, Get Container Metadata succeeds only if the container’s lease is active and matches this ID. If there's no active lease or the ID doesn't match, error code 412 (Precondition Failed) is returned.
x-ms-version Required for all authorized requests, optional for anonymous requests. 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 logs when logging is configured. We highly recommend that you use this header to correlate client-side activities with requests that the server receives. For more information, see Monitor Azure Blob Storage.

Request body



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

Status code

A successful operation returns status code 200 (OK).

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

Response headers

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.

Syntax Description
x-ms-meta-name:value Returns a string that contains a name-value pair associated with the container as metadata.
ETag The entity tag for the container. If the request version is 2011-08-18 or later, the ETag value is enclosed in quotation marks.
Last-Modified Returns the date and time when the container was last modified. The date format follows RFC 1123. For more information, see Representation of Date-Time Values in headers.

Any operation that modifies the container or its properties or metadata updates the last modified time. Operations on blobs don't affect the last modified time of the container.
x-ms-request-id This header uniquely identifies the request that was made and can be used for troubleshooting the request. For more information, see Troubleshooting API Operations.
x-ms-version The service version that was used to execute the request. This header is returned for requests made against version 2009-09-19 and later.

The header is also returned for anonymous requests without a specified version if the container was marked for public access by using service version 2009-09-19.
Date A UTC date/time value that's generated by the service, which indicates the time when the response was initiated.
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 contains no more than 1,024 visible ASCII characters. If the x-ms-client-request-id header isn't present in the request, this header isn't present in the response.

Response body


Sample response

Response Status:  
HTTP/1.1 200 OK  
Response headers:  
Transfer-Encoding: chunked  
x-ms-meta-AppName: StorageSample  
Date: Sun, 25 Sep 2011 23:43:08 GMT  
ETag: "0x8CAFB82EFF70C46"  
Last-Modified: Sun, 25 Sep 2011 19:42:18 GMT  
x-ms-version: 2011-08-18  
Server: Windows-Azure-Blob/1.0 Microsoft-HTTPAPI/2.0


Authorization is required when calling any data access operation in Azure Storage. You can authorize the Get Container Metadata operation as described below.

Azure Storage supports using Azure Active Directory (Azure AD) to authorize requests to blob data. With Azure AD, you can use Azure role-based access control (Azure RBAC) to grant permissions to a security principal. The security principal may be a user, group, application service principal, or Azure managed identity. The security principal is authenticated by Azure AD to return an OAuth 2.0 token. The token can then be used to authorize a request against the Blob service.

To learn more about authorization using Azure AD, see Authorize access to blobs using Azure Active Directory.


Listed below are the RBAC action necessary for an Azure AD user, group, or service principal to call the Get Container Metadata operation, and the least privileged built-in Azure RBAC role that includes this action:

To learn more about assigning roles using Azure RBAC, see Assign an Azure role for access to blob data.


This operation returns only user-defined metadata on the container. To return system properties also, call Get Container Properties.

See also

Operations on containers