Set File Properties

The Set File Properties operation sets system properties on the file.

Request

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

Method Request URI HTTP Version
PUT https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?comp=properties 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.

URI Parameters

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.

Request Headers

The following table describes required and optional 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-cache-control Optional. Modifies the cache control string for the file.

If this property is not specified on the request, then the property will be cleared for the file. Subsequent calls to Get File Properties will not return this property, unless it is explicitly set on the file again.
x-ms-content-type Optional. Sets the file's content type.

If this property is not specified on the request, then the property will be cleared for the file. Subsequent calls to Get File Properties will not return this property, unless it is explicitly set on the file again.
x-ms-content-md5 Optional. Sets the file's MD5 hash.

If this property is not specified on the request, then the property will be cleared for the file. Subsequent calls to Get File Properties will not return this property, unless it is explicitly set on the file again.
x-ms-content-encoding Optional. Sets the file's content encoding.

If this property is not specified on the request, then the property will be cleared for the file. Subsequent calls to Get File Properties will not return this property, unless it is explicitly set on the file again.
x-ms-content-language Optional. Sets the file's content language.

If this property is not specified on the request, then the property will be cleared for the file. Subsequent calls to Get File Properties will not return this property, unless it is explicitly set on the file again.
x-ms-content-disposition Optional. Sets the file’s Content-Disposition header.

If this property is not specified on the request, then the property will be cleared for the file. Subsequent calls to Get File Properties will not return this property, unless it is explicitly set on the file again.
x-ms-content-length: bytes Optional. Resizes a file to the specified size. If the specified byte value is less than the current size of the file, then all ranges above the specified byte value are cleared.
x-ms-file-permission Required if x-ms-file-permission-key is not specified. Version 2019-02-02 and newer. This permission is the security descriptor for the file specified in the Security Descriptor Definition Language (SDDL). This header can be used if the permissions size is over 8 KiB, otherwise the x-ms-file-permission-key may be used. If specified, it must have an owner, group, and discretionary access control list (DACL). A value of inherit may be passed to inherit from the parent directory.

Note that only one of x-ms-file-permission or x-ms-file-permission-key can be specified.
x-ms-file-permission-key Required if x-ms-file-permission is not specified. Version 2019-02-02 and newer. The key of the permission to be set for the file. This can be created using the Create-Permission API.

Note that only one of x-ms-file-permission or x-ms-file-permission-key can be specified.
x-ms-file-attributes Required. Version 2019-02-02 and newer. The file system attributes to be set on the file. See the list of available attributes. A value of preserve may be passed to keep an existing value unchanged.
x-ms-file-creation-time Required. Version 2019-02-02 and newer. The Coordinated Universal Time (UTC) creation time property for a file. A value of now may be used to indicate the time of the request. A value of preserve may be passed to keep an existing value unchanged.
x-ms-file-last-write-time Required. Version 2019-02-02 and newer. The Coordinated Universal Time (UTC) last write property for a file. A value of now may be used to indicate the time of the request. A value of preserve may be passed to keep an existing value unchanged.

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
ETag The ETag contains a value which represents the version of the file, in quotes.
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-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-request-server-encrypted: true/false Version 2017-04-17 or newer. The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise.
x-ms-file-permission-key The key of the permission of the file.
x-ms-file-attributes The file system attributes on the file. See the list of available attributes.
x-ms-file-creation-time The UTC date/time value that represents the creation time property for the file.
x-ms-file-last-write-time The UTC date/time value that represents the last write time property for the file.
x-ms-file-change-time The UTC date/time that value that represents the change time property for the file.

Response Body

None.

Authorization

Only the account owner may call this operation.

File system attributes

Attribute Win32 file attribute Definition
ReadOnly FILE_ATTRIBUTE_READONLY A file that is read-only. Applications can read the file, but cannot write to it or delete it.
Hidden FILE_ATTRIBUTE_HIDDEN The file is hidden. It is not included in an ordinary directory listing.
System FILE_ATTRIBUTE_SYSTEM A file that the operating system uses a part of, or uses exclusively.
None FILE_ATTRIBUTE_NORMAL A file that does not have other attributes set. This attribute is valid only when used alone.
Archive FILE_ATTRIBUTE_ARCHIVE A file that is an archive file. Applications typically use this attribute to mark files for backup or removal.
Temporary FILE_ATTRIBUTE_TEMPORARY A file that is being used for temporary storage.
Offline FILE_ATTRIBUTE_OFFLINE The data of a file is not available immediately. This file system attribute is presented primarily to provide compatibility with Windows - Azure Files does not support with offline storage options.
NotContentIndexed FILE_ATTRIBUTE_NOT_CONTENT_INDEXED The file is not to be indexed by the content indexing service.
NoScrubData FILE_ATTRIBUTE_NO_SCRUB_DATA The user data stream not to be read by the background data integrity scanner. This file system attribute is presented primarily to provide compatibility with Windows.

Remarks

The semantics for updating a file's properties are as follows:

  • A file's size is modified only if the request specifies a value for the x-ms-content-length header.

  • If a request sets only x-ms-content-length, and no other properties, then none of the file’s other properties are modified.

  • If any one or more of the following properties is set in the request, then all of these properties are set together. If a value is not provided for a given property when at least one of the properties listed below is set, then that property will be cleared for the file.

    • x-ms-cache-control

    • x-ms-content-type

    • x-ms-content-md5

    • x-ms-content-encoding

    • x-ms-content-language

Note

The file properties listed above are discrete from the file system properties available to SMB clients. SMB clients cannot read, write, or modify these property values.

Set File properties is not supported on a share snapshot, which is a read-only copy of a share. An attempt to perform this operation on a share snapshot will fail with 400 (InvalidQueryParameterValue)

See Also

Operations on Files