Set File Metadata
Set File Metadata operation updates user-defined metadata for the specified file.
Set File Metadata request is constructed as follows. HTTPS is recommended.
|Method||Request URI||HTTP Version|
Replace the path components shown in the request URI with your own, as follows:
|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 can be specified in the request URI.
||Optional. The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.|
||Required. Specifies the authentication scheme, account name, and signature. For more information, see Authentication for the Azure Storage Services.|
||Required. Specifies the Coordinated Universal Time (UTC) for the request. For more information, see Authentication for the Azure Storage Services.|
||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.|
||Optional. Sets a name-value pair for the file.
Each call to this operation replaces all existing metadata attached to the file. To remove all metadata from the file, call this operation with no metadata headers.
Metadata names must adhere to the naming rules for C# identifiers.
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.
||The ETag contains a value which represents the version of the file, in quotes.|
||This header uniquely identifies the request that was made and can be used for troubleshooting the request. For more information, see Troubleshooting API Operations.|
||Indicates the version of the File service used to execute the request.|
||A UTC date/time value generated by the service that indicates the time at which the response was initiated.|
||Version 2017-04-17 or newer. The value of this header is set to
Only the account owner may call this operation.
Set File Metadata 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)