SALES: 1-800-867-1380

Set Share Metadata

The Set Share Metadata operation sets one or more user-defined name-value pairs for the specified share.

The Set Share Metadata request is constructed as follows. HTTPS is recommended.

 

Method Request URI HTTP Version

PUT

https://myaccount.file.core.windows.net/myshare?restype=share&comp=metadata

HTTP/1.1

Replace the path components shown in the request URI with your own, as follows:

 

Path Component Description

myaccount

The name of your storage account.

myshare

The name of your file share.

For details on path naming restrictions, see Naming and Referencing Shares, Directories, Files, and Metadata.

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 Setting Timeouts for File Service Operations.

The following table describes required and optional request headers.

 

Request Header Description

Authorization

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.

x-ms-version

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.

x-ms-meta-name:value

Optional. A name-value pair to contain metadata for the share.

Each call to this operation replaces all existing metadata attached to the share. To remove all metadata from the share, call this operation with no metadata headers.

Metadata names must adhere to the naming rules for C# identifiers.

PUT https://myaccount.file.core.windows.net/myshare?restype=share&comp=metadata HTTP/1.1

Request Headers:
x-ms-version: 2014-02-14
x-ms-date: Mon, 27 Jan 2014 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.

 

Response header Description

Last-Modified

Returns the date and time the share 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 share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share.

ETag

The ETag contains a value which represents the version of the share, in quotes.

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

Indicates the version of the File service used to execute the request.

Date

A UTC date/time value generated by the service that indicates the time at which the response was initiated.

Only the account owner may call this operation.

Calling Set Share Metadata overwrites all existing metadata that is associated with the share. It is not possible to modify an individual name-value pair.

You may also set metadata for a share at the time that it is created, as part of the Create Share operation.

Calling Set Share Metadata updates the ETag and the Last-Modified-Time properties for the share.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft