Path - Get Properties

  • Reference
Service:
Storage Services
API Version:
2023-08-03

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 https://{accountName}.{dnsSuffix}/{filesystem}/{path}
With optional parameters: 
HEAD https://{accountName}.{dnsSuffix}/{filesystem}/{path}?action={action}&upn={upn}&fsAction={fsAction}&timeout={timeout}

URI Parameters

Name In Required Type Description
accountName
 path True

string

The Azure Storage account name.
dnsSuffix
 path True

string

The DNS suffix for the Azure Data Lake Storage endpoint.
filesystem
 path True

string

The filesystem identifier.

Regex pattern: ^[$a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$
path
 path True

string

The file or directory path.
action
 query

PathGetPropertiesAction

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.
fsAction
 query

string

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}'
timeout
 query

integer

int32

An optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails.
upn
 query

boolean

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.

Request Header

Name Required Type Description
x-ms-lease-id

string

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.

Regex pattern: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$
If-Match

string

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-Match

string

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-Since

string

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-Since

string

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.
x-ms-encryption-key

string

Optional. The Base64-encoded AES-256 encryption key.
x-ms-encryption-key-sha256

string

Optional. The Base64-encoded SHA256 hash of the encryption key.
x-ms-encryption-algorithm: AES256

string

Optional. Specifies the algorithm to use for encryption. The value of this header must be AES256.
x-ms-client-request-id

string

A UUID recorded in the analytics logs for troubleshooting and correlation.

Regex pattern: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$
x-ms-date

string

Specifies the Coordinated Universal Time (UTC) for the request. This is required when using shared key authorization.
x-ms-version

string

Specifies the version of the REST protocol used for processing the request. This is required when using shared key authorization.

Responses

Name Type Description
200 OK

Returns all properties for the file or directory.

Headers

  • Accept-Ranges: string
  • Cache-Control: string
  • Content-Disposition: string
  • Content-Encoding: string
  • Content-Language: string
  • Content-Length: integer
  • Content-Range: string
  • Content-Type: string
  • Content-MD5: string
  • Date: string
  • ETag: string
  • Last-Modified: string
  • x-ms-request-id: string
  • x-ms-version: string
  • x-ms-resource-type: string
  • x-ms-properties: string
  • x-ms-owner: string
  • x-ms-group: string
  • x-ms-permissions: string
  • x-ms-acl: string
  • x-ms-lease-duration: string
  • x-ms-lease-state: string
  • x-ms-lease-status: string
  • x-ms-server-encrypted: true/false: boolean
  • x-ms-encryption-key-sha256: string
  • x-ms-encryption-context: string
  • x-ms-encryption-scope: string
  • x-ms-creation-time: string
  • x-ms-expiry-time: string
Other Status Codes

DataLakeStorageError

An error occurred. The possible HTTP status, code, and message strings are listed below:

  • 400 Bad Request, ContentLengthMustBeZero, "The Content-Length request header must be zero."
  • 400 Bad Request, InvalidAuthenticationInfo, "Authentication information is not given in the correct format. Check the value of Authorization header."
  • 400 Bad Request, InvalidFlushPosition, "The uploaded data is not contiguous or the position query parameter value is not equal to the length of the file after appending the uploaded data."
  • 400 Bad Request, InvalidHeaderValue, "The value for one of the HTTP headers is not in the correct format."
  • 400 Bad Request, InvalidHttpVerb, "The HTTP verb specified is invalid - it is not recognized by the server."
  • 400 Bad Request, InvalidInput, "One of the request inputs is not valid."
  • 400 Bad Request, InvalidPropertyName, "A property name cannot be empty."
  • 400 Bad Request, InvalidPropertyName, "The property name contains invalid characters."
  • 400 Bad Request, InvalidQueryParameterValue, "Value for one of the query parameters specified in the request URI is invalid."
  • 400 Bad Request, InvalidResourceName, "The specified resource name contains invalid characters."
  • 400 Bad Request, InvalidSourceUri, "The source URI is invalid."
  • 400 Bad Request, InvalidUri, "The request URI is invalid."
  • 400 Bad Request, MissingRequiredHeader, "An HTTP header that's mandatory for this request is not specified."
  • 400 Bad Request, MissingRequiredQueryParameter, "A query parameter that's mandatory for this request is not specified."
  • 400 Bad Request, MultipleConditionHeadersNotSupported, "Multiple condition headers are not supported."
  • 400 Bad Request, OutOfRangeInput, "One of the request inputs is out of range."
  • 400 Bad Request, OutOfRangeQueryParameterValue, "One of the query parameters specified in the request URI is outside the permissible range."
  • 400 Bad Request, UnsupportedHeader, "One of the headers specified in the request is not supported."
  • 400 Bad Request, UnsupportedQueryParameter, "One of the query parameters specified in the request URI is not supported."
  • 400 Bad Request, UnsupportedRestVersion, "The specified Rest Version is Unsupported."
  • 403 Forbidden, AccountIsDisabled, "The specified account is disabled."
  • 403 Forbidden, AuthorizationFailure, "This request is not authorized to perform this operation."
  • 403 Forbidden, InsufficientAccountPermissions, "The account being accessed does not have sufficient permissions to execute this operation."
  • 404 Not Found, FilesystemNotFound, "The specified filesystem does not exist."
  • 404 Not Found, PathNotFound, "The specified path does not exist."
  • 404 Not Found, RenameDestinationParentPathNotFound, "The parent directory of the destination path does not exist."
  • 404 Not Found, ResourceNotFound, "The specified resource does not exist."
  • 404 Not Found, SourcePathNotFound, "The source path for a rename operation does not exist."
  • 405 Method Not Allowed, UnsupportedHttpVerb, "The resource doesn't support the specified HTTP verb."
  • 409 Conflict, DestinationPathIsBeingDeleted, "The specified destination path is marked to be deleted."
  • 409 Conflict, DirectoryNotEmpty, "The recursive query parameter value must be true to delete a non-empty directory."
  • 409 Conflict, FilesystemAlreadyExists, "The specified filesystem already exists."
  • 409 Conflict, FilesystemBeingDeleted, "The specified filesystem is being deleted."
  • 409 Conflict, InvalidDestinationPath, "The specified path, or an element of the path, exists and its resource type is invalid for this operation."* 409 Conflict, InvalidFlushOperation, "The resource was created or modified by the Blob Service API and cannot be written to by the Data Lake Storage Service API."
  • 409 Conflict, InvalidRenameSourcePath, "The source directory cannot be the same as the destination directory, nor can the destination be a subdirectory of the source directory."
  • 409 Conflict, InvalidSourceOrDestinationResourceType, "The source and destination resource type must be identical."
  • 409 Conflict, LeaseAlreadyPresent, "There is already a lease present."
  • 409 Conflict, LeaseIdMismatchWithLeaseOperation, "The lease ID specified did not match the lease ID for the resource with the specified lease operation."
  • 409 Conflict, LeaseIsAlreadyBroken, "The lease has already been broken and cannot be broken again."
  • 409 Conflict, LeaseIsBreakingAndCannotBeAcquired, "The lease ID matched, but the lease is currently in breaking state and cannot be acquired until it is broken."
  • 409 Conflict, LeaseIsBreakingAndCannotBeChanged, "The lease ID matched, but the lease is currently in breaking state and cannot be changed."
  • 409 Conflict, LeaseIsBrokenAndCannotBeRenewed, "The lease ID matched, but the lease has been broken explicitly and cannot be renewed."
  • 409 Conflict, LeaseNameMismatch, "The lease name specified did not match the existing lease name."
  • 409 Conflict, LeaseNotPresentWithLeaseOperation, "The lease ID is not present with the specified lease operation."
  • 409 Conflict, PathAlreadyExists, "The specified path already exists."
  • 409 Conflict, PathConflict, "The specified path, or an element of the path, exists and its resource type is invalid for this operation."
  • 409 Conflict, SourcePathIsBeingDeleted, "The specified source path is marked to be deleted."
  • 409 Conflict, ResourceTypeMismatch, "The resource type specified in the request does not match the type of the resource."
  • 412 Precondition Failed, ConditionNotMet, "The condition specified using HTTP conditional header(s) is not met."
  • 412 Precondition Failed, LeaseIdMismatch, "The lease ID specified did not match the lease ID for the resource."
  • 412 Precondition Failed, LeaseIdMissing, "There is currently a lease on the resource and no lease ID was specified in the request."
  • 412 Precondition Failed, LeaseNotPresent, "There is currently no lease on the resource."
  • 412 Precondition Failed, LeaseLost, "A lease ID was specified, but the lease for the resource has expired."
  • 412 Precondition Failed, SourceConditionNotMet, "The source condition specified using HTTP conditional header(s) is not met."
  • 413 Request Entity Too Large, RequestBodyTooLarge, "The request body is too large and exceeds the maximum permissible limit."
  • 416 Requested Range Not Satisfiable, InvalidRange, "The range specified is invalid for the current size of the resource."
  • 500 Internal Server Error, InternalError, "The server encountered an internal error. Please retry the request."
  • 500 Internal Server Error, OperationTimedOut, "The operation could not be completed within the permitted time."
  • 503 Service Unavailable, ServerBusy, "Egress is over the account limit."
  • 503 Service Unavailable, ServerBusy, "Ingress is over the account limit."
  • 503 Service Unavailable, ServerBusy, "Operations per second is over the account limit."
  • 503 Service Unavailable, ServerBusy, "The server is currently unable to receive requests. Please retry your request."

Headers

  • x-ms-request-id: string
  • x-ms-version: string

Definitions

Name Description
DataLakeStorageError
Error

The service error response object.
PathGetPropertiesAction

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.

DataLakeStorageError

Name Type Description
error

Error

The service error response object.

Error

The service error response object.

Name Type Description
code

string

The service error code.
message

string

The service error message.

PathGetPropertiesAction

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.

Name Type Description
checkAccess

string

getAccessControl

string

getStatus

string