Get Blob Tags
Get Blob Tags operation returns all user-defined tags for the specified blob, version, or snapshot.
You can construct the
Get Blob Tags request as follows. We recommend that you use HTTPS. Replace myaccount with the name of your storage account:
|GET method request URI||HTTP Version|
The following additional parameters may be specified on the request URI.
||Optional. The snapshot parameter is an opaque
||Optional for 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.|
||Required if the blob has an active lease.
To perform this operation on a blob with an active lease, specify the valid lease ID for this header. If a valid lease ID isn't specified on the request, the operation fails with status code 403 (Forbidden).
||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 supports the
x-ms-if-tags conditional header to get blob tags only if a specified condition is met. For more information, see Specify conditional headers for Blob Storage operations.
The response includes an HTTP status code, response headers, and a response body.
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.
||The size of the returned XML document, in bytes|
||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 used to execute the request.|
||A 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
Here is the format of the response body:
<?xml version="1.0" encoding="utf-8"?> <Tags> <TagSet> <Tag> <Key>tag-name-1</Key> <Value>tag-value-1</Value> </Tag> <Tag> <Key>tag-name-2</Key> <Value>tag-value-2</Value> </Tag> </TagSet> </Tags>
The response body is a well-formed UTF-8 XML document that represents all the tags that are stored on the blob.
Authorization is required when calling any data access operation in Azure Storage. You can authorize the
Get Blob Tags 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 Tags operation, and the least privileged built-in Azure RBAC role that includes this action:
- Azure RBAC action: Microsoft.Storage/storageAccounts/blobServices/containers/blobs/tags/read
- Least privileged built-in role: Storage Blob Data Owner
To learn more about assigning roles using Azure RBAC, see Assign an Azure role for access to blob data.
Get Blob Tags operation is supported in REST API version 2019-12-12 and later.
The ordering of tags is not guaranteed in the response.
The storage service maintains strong consistency between a blob and its tags, but the secondary index is eventually consistent. Tags might be visible in a response to
Get Blob Tags before they're visible to
Find Blobs by Tags operations.
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 Tags requests based on the storage account type:
|Operation||Storage account type||Billing category|
|Get Blob Tags||Premium block blob
Standard general-purpose v2
|Get Blob Tags||Standard general-purpose v1||Read operations|
To learn about pricing for the specified billing category, see Azure Blob Storage Pricing.