Get Share Metadata

The Get Share Metadata operation returns all user-defined metadata for the Azure file share or share snapshot.

Although this API is fully supported, it's a legacy management API. For this reason, we recommend that you use File Shares - Get, which is provided by the storage resource provider (Microsoft.Storage), instead.

To learn more about programmatically interacting with FileShare resources by using the storage resource provider, see Operations on Azure file shares.

Protocol availability

Enabled file share protocol Available
SMB Yes
NFS Yes

Request

The Get Share Metadata request is constructed as follows. We recommend that you use HTTPS.

Method Request URI HTTP version
GET/HEAD https://myaccount.file.core.windows.net/myshare?restype=share&comp=metadata HTTP/1.1
GET/HEAD https://myaccount.file.core.windows.net/myshare?restype=share&comp=metadata&sharesnapshot=<DateTime> HTTP/1.1

Replace the path components that are 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 information about path naming restrictions, see Name and reference shares, directories, files, and metadata.

URI parameters

The following additional parameters can be specified in the request URI:

Parameter Description
sharesnapshot Optional. Version 2017-04-17 and later. The sharesnapshot parameter is an opaque date/time value that, when present, specifies the share snapshot to query to retrieve the metadata
timeout Optional. The timeout parameter is expressed in seconds. For more information, see Set time-outs for Azure Files operations.

Request headers

Request header Description
Authorization Required. Specifies the authorization scheme, account name, and signature. For more information, see Authorize requests to Azure Storage.
Date or x-ms-date Required. Specifies the Coordinated Universal Time (UTC) for the request. For more information, see Authorize requests to Azure Storage.
x-ms-version 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.
x-ms-client-request-id 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 Files.
x-ms-lease-id:<ID> Optional. Version 2020-02-10 and later. If the header is specified, the operation is performed only if the file share's lease is currently active and the lease ID that's specified in the request matches the lease ID of the file share. If there's no match, the operation fails with status code 412 (Precondition Failed).

Request body

None.

Response

The response includes an HTTP status code and a set of response headers.

Status code

A successful operation returns status code 200 (OK).

For more information about status codes, see Status and error codes.

Response headers

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 when the share was last modified. The date format follows RFC 1123. For more information, see Represent date/time values in headers. Any operation that modifies the share or its properties updates the last modified time. Operations on files don't affect the last modified time of the share.
x-ms-meta-name:value A set of name-value pairs that contain user-defined metadata for the share.
ETag Contains a value that you can use to perform operations conditionally. The value is enclosed in quotation marks.
x-ms-request-id Uniquely identifies the request that was made and can be used to troubleshoot the request. For more information, see Troubleshoot API operations.
x-ms-version Indicates the Azure Files version that was used to execute the request.
Date or x-ms-date A UTC date/time value that's generated by the service, which indicates the time when the response was initiated.
x-ms-client-request-id Can be used to troubleshoot requests and their corresponding responses. The value of this header is equal to the value of the x-ms-client-request-id header if it's present in the request and the value contains no more than 1,024 visible ASCII characters. If the x-ms-client-request-id header isn't present in the request, it won't be present in the response.

Response body

None.

Sample response

Response Status:  
HTTP/1.1 200 OK  
  
Response Headers:  
Transfer-Encoding: chunked  
x-ms-meta-name: somemetadata  
Date: Mon, 27 Jan 2014 22:49:18 GMT  
ETag: "0x8CB171DBEAD6A6B"  
Last-Modified: Mon, 27 Jan 2014 22:48:29 GMT  
x-ms-version: 2014-02-14  
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0  

Authorization

Only the account owner may call this operation.

Remarks

This operation returns only user-defined metadata on the share. To return system properties as well, call Get Share Properties.

See also

Operations on FileShare resources (Azure Files)