v1

latestSwagger 2.02026-07-13125103.0 KB

File and Directory Operations

Get Properties | Get Status | Get Access Control List | Check Access

Get Properties returns all system and user defined properties for a path. Get Status returns all system defined properties for a path. Get Access Control List returns the access control list for a path. This operation supports conditional HTTP requests. For more information, see Specifying Conditional Headers for Blob Service Operations.

head/{filesystem}/{path}

Query parameters

action'getAccessControl' | 'getStatus' | 'checkAccess'

Optional. If the value is "getStatus" only the system defined properties for the path are returned. If the value is "getAccessControl" the access control list is returned in the response headers (Hierarchical Namespace must be enabled for the account), otherwise the properties are returned.

upnboolean

Optional. Valid only when Hierarchical Namespace is enabled for the account. If "true", the user identity values returned in the x-ms-owner, x-ms-group, and x-ms-acl response headers will be transformed from Azure Active Directory Object IDs to User Principal Names. If "false", the values will be returned as Azure Active Directory Object IDs. The default value is false. Note that group and application Object IDs are not translated because they do not have unique friendly names.

fsActionstring

Required only for check access action. Valid only when Hierarchical Namespace is enabled for the account. File system operation read/write/execute in string form, matching regex pattern '[rwx-]{3}'

Headers

x-ms-lease-idstring

Optional. If this header is specified, the operation will be performed only if both of the following conditions are met: i) the path's lease is currently active and ii) the lease ID specified in the request matches that of the path.

If-Matchstring

Optional. An ETag value. Specify this header to perform the operation only if the resource's ETag matches the value specified. The ETag must be specified in quotes.

If-None-Matchstring

Optional. An ETag value or the special wildcard ("*") value. Specify this header to perform the operation only if the resource's ETag does not match the value specified. The ETag must be specified in quotes.

If-Modified-Sincestring

Optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.

If-Unmodified-Sincestring

Optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.

Response

Returns all properties for the file or directory.