Azure.Storage.Files.DataLake (stable:2025-05-05)

2025/04/03 • 1 updated methods

Path_GetProperties (updated)
Description :  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](https://learn.microsoft.com/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).
Reference :  Link ¶

⚶ Changes

{
  "#id": "Path_GetProperties",
  "$responses": {
    "200": [
      {
        "@added_5d94655f0221408ba7615aaaf4e17701": {
          "#name": "x-ms-server-encrypted",
          "Description": "The value of this header is set to true if the directory metadata is completely encrypted using the specified algorithm. Otherwise, the value is set to false.",
          "Type": "boolean"
        }
      },
      {
        "@added_8992ca38c3dd442a9a726e7a5f6fe54b": {
          "#name": "x-ms-encryption-key-sha256",
          "Description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key.",
          "Type": "string"
        }
      },
      {
        "@added_967e9308a3cd4887825ba6c3e912f571": {
          "#name": "x-ms-encryption-context",
          "Description": "The encryption context used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key.",
          "Type": "string"
        }
      },
      {
        "@added_d17e2e90ce244a9184955f78261de368": {
          "#name": "x-ms-encryption-scope",
          "Description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata.  Note that the absence of this header implies use of the default account encryption scope.",
          "Type": "string"
        }
      },
      {
        "@added_1de88cf109854849859e1a21f6f619a4": {
          "#name": "x-ms-creation-time",
          "Description": "Returns the date and time the blob was created.",
          "Type": "string"
        }
      },
      {
        "@added_9b694f7969fe40fda14dbe6a5559fe94": {
          "#name": "x-ms-expiry-time",
          "Description": "The time this blob will expire.",
          "Type": "string"
        }
      }
    ]
  }
}

⚼ Request

HEAD:  /{filesystem}/{path}
{
action:
{
Description: 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. ,
Required: False ,
}
string ,
upn:
{
Description: 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. ,
Required: False ,
}
boolean ,
x-ms-lease-id:
{
Description: If specified, the operation only succeeds if the resource's lease is active and matches this ID. ,
Required: False ,
}
string ,
If-Match:
{
Description: Specify an ETag value to operate only on blobs with a matching value. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: Specify an ETag value to operate only on blobs without a matching value. ,
Required: False ,
}
string ,
If-Modified-Since:
{
Description: Specify this header value to operate only on a blob if it has been modified since the specified date/time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
If-Unmodified-Since:
{
Description: Specify this header value to operate only on a blob if it has not been modified since the specified date/time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
accept-ranges:
{
Description: Indicates that the service supports requests for partial file content. ,
}
string ,
cache-control:
{
Description: If the Cache-Control request header has previously been set for the resource, that value is returned in this header. ,
}
string ,
content-disposition:
{
Description: If the Content-Disposition request header has previously been set for the resource, that value is returned in this header. ,
}
string ,
content-encoding:
{
Description: If the Content-Encoding request header has previously been set for the resource, that value is returned in this header. ,
}
string ,
content-language:
{
Description: If the Content-Language request header has previously been set for the resource, that value is returned in this header. ,
}
string ,
content-length:
{
Description: The size of the resource in bytes. ,
}
integer ,
content-range:
{
Description: Indicates the range of bytes returned in the event that the client requested a subset of the file by setting the Range request header. ,
}
string ,
content-type:
{
Description: The content type specified for the resource. If no content type was specified, the default content type is application/octet-stream. ,
}
string ,
content-md5:
{
Description: The MD5 hash of complete file stored in storage. This header is returned only for "GetProperties" operation. If the Content-MD5 header has been set for the file, this response header is returned for GetProperties call so that the client can check for message content integrity. ,
}
string ,
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
string ,
etag:
{
Description: An HTTP entity tag associated with the file or directory. ,
}
string ,
last-modified:
{
Description: The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time. ,
}
string ,
x-ms-request-id:
{
Description: A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. ,
}
string ,
x-ms-version:
{
Description: The version of the REST protocol used to process the request. ,
}
string ,
x-ms-resource-type:
{
Description: The type of the resource. The value may be "file" or "directory". If not set, the value is "file". ,
}
string ,
x-ms-properties:
{
Description: The user-defined properties associated with the file or directory, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set. ,
}
string ,
x-ms-owner:
{
Description: The owner of the file or directory. Included in the response if Hierarchical Namespace is enabled for the account. ,
}
string ,
x-ms-group:
{
Description: The owning group of the file or directory. Included in the response if Hierarchical Namespace is enabled for the account. ,
}
string ,
x-ms-permissions:
{
Description: The POSIX access permissions for the file owner, the file owning group, and others. Included in the response if Hierarchical Namespace is enabled for the account. ,
}
string ,
x-ms-acl:
{
Description: The POSIX access control list for the file or directory. Included in the response only if the action is "getAccessControl" and Hierarchical Namespace is enabled for the account. ,
}
string ,
x-ms-lease-duration:
{
Description: When a resource is leased, specifies whether the lease is of infinite or fixed duration. ,
}
string ,
x-ms-lease-state:
{
Description: Lease state of the resource. ,
}
string ,
x-ms-lease-status:
{
Description: The lease status of the resource. ,
}
string ,
x-ms-server-encrypted:
{
Description: The value of this header is set to true if the directory metadata is completely encrypted using the specified algorithm. Otherwise, the value is set to false. ,
}
boolean ,
x-ms-encryption-key-sha256:
{
Description: The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key. ,
}
string ,
x-ms-encryption-context:
{
Description: The encryption context used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key. ,
}
string ,
x-ms-encryption-scope:
{
Description: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. ,
}
string ,
x-ms-creation-time:
{
Description: Returns the date and time the blob was created. ,
}
string ,
x-ms-expiry-time:
{
Description: The time this blob will expire. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
Description: The service error response object. ,
Required: False ,
}
{
Code:
{
Description: The service error code. ,
Required: False ,
}
string ,
Message:
{
Description: The service error message. ,
Required: False ,
}
string ,
}
,
}
,
}