SALES: 1-800-867-1380

Get File Properties

The Get File Properties operation returns all user-defined metadata, standard HTTP properties, and system properties for the file. It does not return the content of the file.

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

 

Method Request URI HTTP Version

HEAD

https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile

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 parent 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 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.

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

x-ms-meta-name:value

A set of name-value pairs associated with this file as user-defined metadata.

x-ms-type: <File>

Returns the type File. Reserved for future use.

Content-Length

The size of the file in bytes. This header returns the value of the x-ms-content-length header that is stored with the file.

Content-Type

The content type specified for the file. If no content type was specified, the default content type is application/octet-stream.

ETag

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

Content-MD5

If the Content-MD5 header has been set for the file, the Content-MD5 response header is returned so that the client can check for message content integrity.

Content-Encoding

If the Content-Encoding request header has previously been set for the file, the Content-Encoding value is returned in this header.

Content-Language

If the Content-Language request header has previously been set for the file, the Content-Language value is returned in this header.

Cache-Control

If the Cache-Control request header has previously been set for the file, the Cache-Control value is returned in this header.

Content-Disposition

Returns the value that was specified for the x-ms-content-disposition header and specifies how to process the response.

The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, Content-Disposition indicates that the user-agent should not display the response, but instead show a Save As dialog.

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.

Response Status:
HTTP/1.1 200 OK

Response Headers:
x-ms-type: File
x-ms-meta-m1: v1
x-ms-meta-m2: v2
Content-Length: 11
Content-Type: text/plain; charset=UTF-8
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

Only the account owner may call this operation.

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