Set Blob Metadata
Set Blob Metadata operation sets user-defined metadata for the specified blob as one or more name-value pairs.
Set Blob Metadata request may be constructed as follows. We recommend that you use HTTPS. Replace myaccount with the name of your storage account:
|PUT method request URI||HTTP version|
Emulated Storage Service URI
When you're making a request against the emulated storage service, specify the emulator hostname and Blob Storage port as
127.0.0.1:10000, followed by the emulated storage account name:
|PUT 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:
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. Specifies the version of the operation to use for this request. For more information, see Versioning for the Azure Storage services.|
||Optional. Sets a name-value pair for the blob.
Each call to this operation replaces all existing metadata that's attached to the blob. To remove all metadata from the blob, call this operation with no metadata headers.
Note: As of version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers.
||Optional. Indicates the encryption scope to use to encrypt the request contents. This header is supported in version 2019-02-02 or later.|
||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.|
||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 set blob metadata 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, the following headers may be specified on the request to encrypt a blob 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, then these headers must be included on the request to complete the write operation successfully.
||Required. The Base64-encoded AES-256 encryption key.|
||Required. 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.
||Contains a value that you can use to perform operations conditionally. See Specify conditional headers for Blob Storage operations for more information. If the request version is 2011-08-18 and later, the ETag value is enclosed in quotation marks.|
||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 write operation on the blob (including updates on the blob's metadata or properties) changes the last modified time of the blob.
||Uniquely identifies the request that was made and can be used to troubleshoot the request. For more information, see Troubleshoot API operations.|
||Indicates the Blob Storage version that was used to execute the request. This header is returned for requests made against version 2009-09-19 and later.|
||A UTC date/time value that's generated by the service, which indicates the time when the response was initiated.|
||Version 2015-12-11 and later. The value of this header is set to
||Version 2019-02-02 and later. Returned if the request used a customer-provided key for encryption, so that the client can ensure that the contents of the request are successfully encrypted by using the provided key.|
||Version 2019-02-02 and later. Returned if the request used an encryption scope, so that the client can ensure that the contents of the request are successfully encrypted by using the encryption scope.|
||Can be used to troubleshoot requests and 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
Set Blob 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
Set 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/write
- Least privileged built-in role: Storage Blob Data Contributor
To learn more about assigning roles using Azure RBAC, see Assign an Azure role for access to blob data.
If the blob has an active lease, the client must specify a valid lease ID on the request to write metadata to the blob. If the client doesn't specify a lease ID, or specifies an invalid lease ID, Blob Storage returns status code 412 (Precondition Failed). If the client specifies a lease ID but the blob doesn't have an active lease, Blob Storage also returns status code 412 (Precondition Failed).
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
Set Blob Metadata requests based on the storage account type:
|Operation||Storage account type||Billing category|
|Set Blob Metadata||Premium block blob
Standard general-purpose v2
|Set Blob Metadata||Standard general-purpose v1||Write operations|
To learn about pricing for the specified billing category, see Azure Blob Storage Pricing.