Get Share Properties

11/11/2016 2 min to read Contributors
  • Tamra Myers
  • sankethka

The Get Share Properties request returns all user-defined metadata and system properties for the specified share. The data returned does not include the share's list of files.

Request

The Get Share Properties request may be constructed as follows. HTTPS is recommended.

Method Request URI HTTP Version
GET/HEAD https://myaccount.file.core.windows.net/myshare?restype=share 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.

URI Parameters

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

Parameter Description
timeout Optional. The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.

Request Headers

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.

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 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 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.
x-ms-meta-name:value A set of name-value pairs that contain the user-defined metadata of the share.
ETag The ETag contains a value that you can use to perform operations conditionally, 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.
x-ms-share-quota Returns the current share quota in GB for version 2015-02-21 and above.

Response Body

None.

Sample Response

Response Status:  
HTTP/1.1 200 OK  

Response Headers:  
Transfer-Encoding: chunked  
x-ms-meta-name: some_metadata  
Date: <date>  
ETag: "0x8CB171DBEAD6A6B"  
Last-Modified: <date>  
x-ms-version: 2015-02-21  
x-ms-share-quota: 55  
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0

Authorization

Only the account owner may call this operation.

Remarks

None.

See Also

Operations on Shares (File Service)