SALES: 1-800-867-1380
Get File Metadata
Collapse the table of content
Expand the table of content

Get File Metadata

 

Updated: June 29, 2016

The Get File Metadata operation returns all user-defined metadata for the specified file.

The Get File Metadata request is constructed as follows. HTTPS is recommended.

Method

Request URI

HTTP Version

GET

https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?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.

mydirectorypath

Optional. The path to the directory.

myfile

The name of the file.

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

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.

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.

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

A successful operation returns status code 202 (Accepted).

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 file 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 file or its properties updates the last modified time.

x-ms-meta-name:value

A set of name-value pairs that contain metadata for the file.

x-ms-type: <File>

Returns File and is reserved for future use.

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.

ETag

The ETag contains a value that you can use to perform operations conditionally, in quotes.

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.

Response Status:
HTTP/1.1 200 OK

Response Headers:
x-ms-type: File
x-ms-meta-m1: v1
x-ms-meta-m2: v2
Date: <date>
ETag: "0x8CB171DBEAD6A6B"
Last-Modified: <date>
x-ms-version: 2015-02-21
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0

Only the account owner may call this operation.

Show:
© 2016 Microsoft