Get Blob Metadata
Get Blob Metadata operation returns all user-defined metadata for the specified blob or snapshot.
You can construct the
Get Blob Metadata request as follows. We recommend that you use HTTPS. Replace myaccount with the name of your storage account.
|GET or HEAD 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
127.0.0.1:10000, followed by the emulated storage account name:
|GET or HEAD method request URI||HTTP version|
For more information, see Use the Azurite emulator for local Azure Storage development.
You can specify the following additional parameters on the request URI:
||Optional. The snapshot parameter is an opaque
||Optional. Version 2019-12-12 and later. The
The required and optional request headers are described in the following table:
||Required. Specifies the authorization scheme, account name, and signature. For more information, see Authorize requests to Azure Storage.|
||Required. Specifies the Coordinated Universal Time (UTC) for the request. For more information, see Authorize requests to Azure Storage.|
||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.|
||Optional. If this header is specified, the
- The blob's lease is currently active.
- The lease ID that's specified in the request matches the lease ID of the blob.
If either of these conditions is not met, the request fails, and the
||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.|
This operation also supports the use of conditional headers to get the blob's metadata operation only if a specified condition is met. For more information, see Specify conditional headers for Blob Storage operations.
Request headers (customer-provided encryption keys)
As of version 2019-02-02, you can specify the following headers on the request to read a blob that's encrypted with a customer-provided key. Encryption with a customer-provided key (and the corresponding set of headers) is optional. If a blob has previously been encrypted with a customer-provided key, these headers must be included on the request so that the read operation can be completed successfully.
||Required. The Base64-encoded AES-256 encryption key.|
||Optional. The Base64-encoded SHA256 hash of the encryption key.|
||Required. Specifies the algorithm to use for encryption. The value of this header must be
The response includes an HTTP status code and a set of response headers.
A successful operation returns status code 200 (OK).
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.
||Returns a metadata value for the container.|
||The date/time that the blob was last modified. The date format follows RFC 1123. For more information, see Represent date/time values in headers.
Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last modified time of the blob.
||The ETag for the blob. If the request version is 2011-08-18 or later, the ETag value is enclosed in quotation marks.|
||This header uniquely identifies the request that was made, and you can use it to troubleshoot the request. For more information, see Troubleshoot API operations.|
||Indicates the Blob Storage version that's being used to execute the request. This header is returned for requests that are made against version 2009-09-19 and later.
This header is also returned for anonymous requests without a specified version if the container was marked for public access by using Blob Storage version 2009-09-19.
||The UTC date/time value that's generated by the service, which indicates the time when the response was initiated.|
||Can be used to troubleshoot requests and their corresponding responses. The value of this header is equal to the value of the
Authorization is required when calling any data access operation in Azure Storage. You can authorize the
Get Blob Metadata operation as described below.
Azure Storage supports using Microsoft Entra ID to authorize requests to blob data. With Microsoft Entra ID, 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 Microsoft Entra ID 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 Microsoft Entra ID, see Authorize access to blobs using Microsoft Entra ID.
Listed below are the RBAC action necessary for a Microsoft Entra user, group, or service principal to call the
Get Blob Metadata operation, and the least privileged built-in Azure RBAC role that includes this action:
- Azure RBAC action: Microsoft.Storage/storageAccounts/blobServices/containers/blobs/read
- Least privileged built-in role: Storage Blob Data Reader
To learn more about assigning roles using Azure RBAC, see Assign an Azure role for access to blob data.
None. See billing information for details on how this operation affects costs.
Pricing requests can originate from clients that use Blob Storage APIs, either directly through the Blob Storage REST API, or from an Azure Storage client library. These requests accrue charges per transaction. The type of transaction affects how the account is charged. For example, read transactions accrue to a different billing category than write transactions. The following table shows the billing category for
Get Blob Metadata requests based on the storage account type:
|Operation||Storage account type||Billing category|
|Get Blob Metadata||Premium block blob
Standard general-purpose v2
|Get Blob Metadata||Standard general-purpose v1||Read operations|
To learn about pricing for the specified billing category, see Azure Blob Storage Pricing.