Set Container Metadata
Updated: June 29, 2016
The Set Container Metadata operation sets one or more user-defined name-value pairs for the specified container.
The Set Container Metadata request may be constructed as follows. HTTPS is recommended. Replace myaccount with the name of your storage account:
When making a request against the emulated storage service, specify the emulator hostname and Blob service port as 127.0.0.1:10000, followed by the emulated storage account name:
For more information, see Using the Azure Storage Emulator for Development and Testing.
The following additional parameters may be specified on the request URI.
Optional. The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.
The following table describes required and optional request headers.
Required. Specifies the authentication scheme, account name, and signature. For more information, see Authentication for the Azure Storage Services.
Date or x-ms-date
Required. Specifies the Coordinated Universal Time (UTC) for the request. For more information, see Authentication for the Azure Storage Services.
Required for all authenticated requests. Specifies the version of the operation to use for this request. For more information, see Versioning for the Azure Storage Services.
Optional, version 2012-02-12 and newer. If specified, Set Container Metadata only succeeds if the container's lease is active and matches this ID. If there is no active lease or the ID does not match, 412 (Precondition Failed) is returned.
Optional. A name-value pair to associate with the container as metadata.
Each call to this operation replaces all existing metadata attached to the container. To remove all metadata from the container, call this operation with no metadata headers.
Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers.
Optional. Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. Using this header is highly recommended for correlating client-side activities with requests received by the server. For more information, see About Storage Analytics Logging and Azure Logging: Using Logs to Track Storage Requests.
This operation also supports the use of conditional headers to set container metadata only if a specified condition is met. For more information, see Specifying Conditional Headers for Blob Service Operations.
Request Syntax: PUT https://myaccount.blob.core.windows.net/mycontainer?restype=container&comp=metadata HTTP/1.1 Request Headers: x-ms-version: 2011-08-18 x-ms-date: Sun, 25 Sep 2011 22:50:32 GMT x-ms-meta-Category: Images Authorization: SharedKey myaccount:Z5043vY9MesKNh0PNtksNc9nbXSSqGHueE00JdjidOQ=
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.
The ETag for the container. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.
Returns the date and time 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, including setting the container's permissions. Operations on blobs do not affect the last-modified time of the container.
This header uniquely identifies the request that was made and can be used for troubleshooting the request. For more information, see Troubleshooting API Operations.
Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.
A UTC date/time value generated by the service that indicates the time at which the response was initiated.
Returned if the request includes an Origin header and CORS is enabled with a matching rule. This header returns the value of the origin request header in case of a match.
Returned if the request includes an Origin header and CORS is enabled with a matching rule. Returns the list of response headers that are to be exposed to the client or issuer of the request.
Returned if the request includes an Origin header and CORS is enabled with a matching rule that does not allow all origins. This header will be set to true.
Only the owner may call this operation.
Calling the Set Container Metadata operation overwrites all existing metadata that is associated with the container. It's not possible to modify an individual name-value pair.
You may also set metadata for a container at the time it is created.
Calling Set Container Metadata updates the ETag and Last-Modified-Time properties for the container. If the request was made using version 2011-08-18, the updated ETag will be in quotes.