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

2025/03/19 • 16 updated methods

Service_ListFileSystems (updated)
Description :  List filesystems and their properties in given account.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Service_ListFileSystems",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations."
      }
    }
  ]
}

⚼ Request

GET:  /
{
resource:
{
Description: The value must be "account" for all account operations. ,
Required: True ,
}
string ,
prefix:
{
Description: Filters results to filesystems within the specified prefix. ,
Required: False ,
}
string ,
continuation:
{
Description: Optional. When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory. ,
Required: False ,
}
string ,
maxResults:
{
Description: An optional value that specifies the maximum number of items to return. If omitted or greater than 5,000, the response will include up to 5,000 items. ,
Format: int32 ,
Required: False ,
}
integer ,
x-ms-client-request-id:
{
Description: Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. ,
Required: False ,
}
string ,
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
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-continuation:
{
Description: If the number of filesystems to be listed exceeds the maxResults limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the filesystems. ,
}
string ,
content-type:
{
Description: The content type of list filesystem response. The default content type is application/json. ,
}
string ,
}
,
$schema:
{
filesystems:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
lastModified:
{
Required: False ,
}
string ,
eTag:
{
Required: False ,
}
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 ,
}
,
}
,
}
FileSystem_SetProperties (updated)
Description :  Set properties for the FileSystem. 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": "FileSystem_SetProperties",
  "Description": {
    "new": "Set properties for the FileSystem.  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).",
    "old": "Set properties for the FileSystem.  This operation supports conditional HTTP requests.  For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations)."
  }
}

⚼ Request

PATCH:  /{filesystem}
{
x-ms-properties:
{
Description: Optional. User-defined properties to be stored with the filesystem, 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. If the filesystem exists, any properties not included in the list will be removed. All properties are removed if the header is omitted. To merge new and existing properties, first get all existing properties and the current E-Tag, then make a conditional request with the E-Tag and include values for all properties. ,
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)

{
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 filesystem. Changes to filesystem properties affect the entity tag, but operations on files and directories do not. ,
}
string ,
last-modified:
{
Description: The data and time the filesystem was last modified. Changes to filesystem properties update the last modified time, but operations on files and directories do not. ,
}
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 ,
}

⚐ 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 ,
}
,
}
,
}
FileSystem_Delete (updated)
Description :  Marks the FileSystem for deletion. When a FileSystem is deleted, a FileSystem with the same identifier cannot be created for at least 30 seconds. While the filesystem is being deleted, attempts to create a filesystem with the same identifier will fail with status code 409 (Conflict), with the service returning additional error information indicating that the filesystem is being deleted. All other operations, including operations on any files or directories within the filesystem, will fail with status code 404 (Not Found) while the filesystem is being deleted. 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": "FileSystem_Delete",
  "Description": {
    "new": "Marks the FileSystem for deletion.  When a FileSystem is deleted, a FileSystem with the same identifier cannot be created for at least 30 seconds. While the filesystem is being deleted, attempts to create a filesystem with the same identifier will fail with status code 409 (Conflict), with the service returning additional error information indicating that the filesystem is being deleted. All other operations, including operations on any files or directories within the filesystem, will fail with status code 404 (Not Found) while the filesystem is being deleted. 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).",
    "old": "Marks the FileSystem for deletion.  When a FileSystem is deleted, a FileSystem with the same identifier cannot be created for at least 30 seconds. While the filesystem is being deleted, attempts to create a filesystem with the same identifier will fail with status code 409 (Conflict), with the service returning additional error information indicating that the filesystem is being deleted. All other operations, including operations on any files or directories within the filesystem, will fail with status code 404 (Not Found) while the filesystem is being deleted. This operation supports conditional HTTP requests.  For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations)."
  }
}

⚼ Request

DELETE:  /{filesystem}
{
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 (202)

{
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 ,
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
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 ,
}
,
}
,
}
FileSystem_ListBlobHierarchySegment (updated)
Description :  The List Blobs operation returns a list of the blobs under the specified container
Reference :  Link ¶

⚶ Changes

{
  "#id": "FileSystem_ListBlobHierarchySegment",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations."
      }
    }
  ]
}

⚼ Request

GET:  /{filesystem}?restype=container&comp=list&hierarchy
{
prefix:
{
Description: Filters results to filesystems within the specified prefix. ,
Required: False ,
}
string ,
delimiter:
{
Description: When the request includes this parameter, the operation returns a BlobPrefix element in the response body that acts as a placeholder for all blobs whose names begin with the same substring up to the appearance of the delimiter character. The delimiter may be a single character or a string. ,
Required: False ,
}
string ,
marker:
{
Description: A string value that identifies the portion of the list of containers to be returned with the next listing operation. The operation returns the NextMarker value within the response body if the listing operation did not return all containers remaining to be listed with the current page. The NextMarker value can be used as the value for the marker parameter in a subsequent call to request the next page of list items. The marker value is opaque to the client. ,
Required: False ,
}
string ,
maxResults:
{
Description: An optional value that specifies the maximum number of items to return. If omitted or greater than 5,000, the response will include up to 5,000 items. ,
Format: int32 ,
Required: False ,
}
integer ,
include:
{
Description: Include this parameter to specify one or more datasets to include in the response. ,
Required: False ,
}
array ,
showonly:
{
Description: Include this parameter to specify one or more datasets to include in the response. ,
Required: False ,
}
string ,
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
content-type:
{
Description: The media type of the body of the response. For List Blobs this is 'application/xml' ,
}
string ,
x-ms-client-request-id:
{
Description: If a client request id header is sent in the request, this header will be present in the response with the same value. ,
}
string ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. ,
}
string ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
string ,
}
,
$schema:
{
Description: An enumeration of blobs ,
}
{
ServiceEndpoint:
{
Required: True ,
}
string ,
ContainerName:
{
Required: True ,
}
string ,
Prefix:
{
Required: False ,
}
string ,
Marker:
{
Required: False ,
}
string ,
MaxResults:
{
Required: False ,
}
integer ,
Delimiter:
{
Required: False ,
}
string ,
Segment:
{
Required: True ,
}
{
BlobPrefixes:
{
Required: False ,
}
[
{
Name:
{
Required: True ,
}
string ,
}
,
]
,
BlobItems:
{
Required: True ,
}
[
{
Name:
{
Required: True ,
}
string ,
Deleted:
{
Required: True ,
}
boolean ,
Snapshot:
{
Required: True ,
}
string ,
VersionId:
{
Required: False ,
}
string ,
IsCurrentVersion:
{
Required: False ,
}
boolean ,
Properties:
{
Description: Properties of a blob ,
Required: True ,
}
{
Creation-Time:
{
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
Last-Modified:
{
Format: date-time-rfc1123 ,
Required: True ,
}
string ,
Etag:
{
Required: True ,
}
string ,
Content-Length:
{
Description: Size in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
Content-Type:
{
Required: False ,
}
string ,
Content-Encoding:
{
Required: False ,
}
string ,
Content-Language:
{
Required: False ,
}
string ,
Content-MD5:
{
Format: byte ,
Required: False ,
}
string ,
Content-Disposition:
{
Required: False ,
}
string ,
Cache-Control:
{
Required: False ,
}
string ,
x-ms-blob-sequence-number:
{
Format: int64 ,
Required: False ,
}
integer ,
CopyId:
{
Required: False ,
}
string ,
CopySource:
{
Required: False ,
}
string ,
CopyProgress:
{
Required: False ,
}
string ,
CopyCompletionTime:
{
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
CopyStatusDescription:
{
Required: False ,
}
string ,
ServerEncrypted:
{
Required: False ,
}
boolean ,
IncrementalCopy:
{
Required: False ,
}
boolean ,
DestinationSnapshot:
{
Required: False ,
}
string ,
DeletedTime:
{
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
RemainingRetentionDays:
{
Required: False ,
}
integer ,
AccessTierInferred:
{
Required: False ,
}
boolean ,
CustomerProvidedKeySha256:
{
Required: False ,
}
string ,
EncryptionScope:
{
Description: The name of the encryption scope under which the blob is encrypted. ,
Required: False ,
}
string ,
AccessTierChangeTime:
{
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
TagCount:
{
Required: False ,
}
integer ,
Expiry-Time:
{
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
Sealed:
{
Required: False ,
}
boolean ,
LastAccessTime:
{
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
DeleteTime:
{
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
DeletionId:
{
Required: False ,
}
string ,
}
,
]
,
}
,
NextMarker:
{
Required: False ,
}
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 ,
}
,
}
,
}
Path_Create (updated)
Description :  Create or rename a file or directory. By default, the destination is overwritten and if the destination already exists and has a lease the lease is broken. 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). To fail if the destination already exists, use a conditional request with If-None-Match: "*".
Reference :  Link ¶

⚶ Changes

{
  "#id": "Path_Create",
  "Description": {
    "new": "Create or rename a file or directory.    By default, the destination is overwritten and if the destination already exists and has a lease the lease is broken.  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).  To fail if the destination already exists, use a conditional request with If-None-Match: \"*\".",
    "old": "Create or rename a file or directory.    By default, the destination is overwritten and if the destination already exists and has a lease the lease is broken.  This operation supports conditional HTTP requests.  For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).  To fail if the destination already exists, use a conditional request with If-None-Match: \"*\"."
  }
}

⚼ Request

PUT:  /{filesystem}/{path}
{
resource:
{
Description: Required only for Create File and Create Directory. The value must be "file" or "directory". ,
Required: False ,
}
string ,
continuation:
{
Description: Optional. When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory. ,
Required: False ,
}
string ,
mode:
{
Description: Optional. Valid only when namespace is enabled. This parameter determines the behavior of the rename operation. The value must be "legacy" or "posix", and the default value will be "posix". ,
Required: False ,
}
string ,
x-ms-cache-control:
{
Description: Optional. Sets the blob's cache control. If specified, this property is stored with the blob and returned with a read request. ,
Required: False ,
}
string ,
x-ms-content-encoding:
{
Description: Optional. Sets the blob's content encoding. If specified, this property is stored with the blob and returned with a read request. ,
Required: False ,
}
string ,
x-ms-content-language:
{
Description: Optional. Set the blob's content language. If specified, this property is stored with the blob and returned with a read request. ,
Required: False ,
}
string ,
x-ms-content-disposition:
{
Description: Optional. Sets the blob's Content-Disposition header. ,
Required: False ,
}
string ,
x-ms-content-type:
{
Description: Optional. Sets the blob's content type. If specified, this property is stored with the blob and returned with a read request. ,
Required: False ,
}
string ,
x-ms-rename-source:
{
Description: An optional file or directory to be renamed. The value must have the following format: "/{filesystem}/{path}". If "x-ms-properties" is specified, the properties will overwrite the existing properties; otherwise, the existing properties will be preserved. This value must be a URL percent-encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set. ,
Required: False ,
}
string ,
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 ,
x-ms-source-lease-id:
{
Description: A lease ID for the source path. If specified, the source path must have an active lease and the lease ID must match. ,
Required: False ,
}
string ,
x-ms-properties:
{
Description: Optional. User-defined properties to be stored with the filesystem, 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. If the filesystem exists, any properties not included in the list will be removed. All properties are removed if the header is omitted. To merge new and existing properties, first get all existing properties and the current E-Tag, then make a conditional request with the E-Tag and include values for all properties. ,
Required: False ,
}
string ,
x-ms-permissions:
{
Description: Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported. ,
Required: False ,
}
string ,
x-ms-umask:
{
Description: Optional and only valid if Hierarchical Namespace is enabled for the account. When creating a file or directory and the parent folder does not have a default ACL, the umask restricts the permissions of the file or directory to be created. The resulting permission is given by p bitwise and not u, where p is the permission and u is the umask. For example, if p is 0777 and u is 0057, then the resulting permission is 0720. The default permission is 0777 for a directory and 0666 for a file. The default umask is 0027. The umask must be specified in 4-digit octal notation (e.g. 0766). ,
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 ,
x-ms-source-if-match:
{
Description: Specify an ETag value to operate only on blobs with a matching value. ,
Required: False ,
}
string ,
x-ms-source-if-none-match:
{
Description: Specify an ETag value to operate only on blobs without a matching value. ,
Required: False ,
}
string ,
x-ms-source-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 ,
x-ms-source-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 ,
x-ms-encryption-key:
{
Description: Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. ,
Required: False ,
}
string ,
x-ms-encryption-key-sha256:
{
Description: The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. ,
Required: False ,
}
string ,
x-ms-encryption-algorithm:
{
Description: The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. ,
Required: False ,
}
string ,
x-ms-owner:
{
Description: Optional. The owner of the blob or directory. ,
Required: False ,
}
string ,
x-ms-group:
{
Description: Optional. The owning group of the blob or directory. ,
Required: False ,
}
string ,
x-ms-acl:
{
Description: Sets POSIX access control rights on files and directories. The value is a comma-separated list of access control entries. Each access control entry (ACE) consists of a scope, a type, a user or group identifier, and permissions in the format "[scope:][type]:[id]:[permissions]". ,
Required: False ,
}
string ,
x-ms-proposed-lease-id:
{
Description: Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats. ,
Required: False ,
}
string ,
x-ms-lease-duration:
{
Description: The lease duration is required to acquire a lease, and specifies the duration of the lease in seconds. The lease duration must be between 15 and 60 seconds or -1 for infinite lease. ,
Format: int64 ,
Required: False ,
}
integer ,
x-ms-expiry-option:
{
Description: Required. Indicates mode of the expiry time ,
Required: False ,
}
string ,
x-ms-expiry-time:
{
Description: The time to set the blob to expiry ,
Required: False ,
}
string ,
x-ms-encryption-context:
{
Description: Specifies the encryption context to set on the file. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
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-continuation:
{
Description: When renaming a directory, the number of paths that are renamed with each invocation is limited. If the number of paths to be renamed exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the rename operation to continue renaming the directory. ,
}
string ,
content-length:
{
Description: The size of the resource in bytes. ,
}
integer ,
x-ms-request-server-encrypted:
{
Description: 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. ,
}
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 ,
}

⚐ 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 ,
}
,
}
,
}
Path_Update (updated)
Description :  Uploads data to be appended to a file, flushes (writes) previously uploaded data to a file, sets properties for a file or directory, or sets access control for a file or directory. Data can only be appended to a file. Concurrent writes to the same file using multiple clients are not supported. 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_Update",
  "Description": {
    "new": "Uploads data to be appended to a file, flushes (writes) previously uploaded data to a file, sets properties for a file or directory, or sets access control for a file or directory. Data can only be appended to a file. Concurrent writes to the same file using multiple clients are not supported. 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).",
    "old": "Uploads data to be appended to a file, flushes (writes) previously uploaded data to a file, sets properties for a file or directory, or sets access control for a file or directory. Data can only be appended to a file. Concurrent writes to the same file using multiple clients are not supported. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations)."
  }
}

⚼ Request

PATCH:  /{filesystem}/{path}
{
action:
{
Description: The action must be "append" to upload data to be appended to a file, "flush" to flush previously uploaded data to a file, "setProperties" to set the properties of a file or directory, "setAccessControl" to set the owner, group, permissions, or access control list for a file or directory, or "setAccessControlRecursive" to set the access control list for a directory recursively. Note that Hierarchical Namespace must be enabled for the account in order to use access control. Also note that the Access Control List (ACL) includes permissions for the owner, owning group, and others, so the x-ms-permissions and x-ms-acl request headers are mutually exclusive. ,
Required: True ,
}
string ,
maxRecords:
{
Description: Optional. Valid for "SetAccessControlRecursive" operation. It specifies the maximum number of files or directories on which the acl change will be applied. If omitted or greater than 2,000, the request will process up to 2,000 items ,
Format: int32 ,
Required: False ,
}
integer ,
continuation:
{
Description: Optional. The number of paths processed with each invocation is limited. If the number of paths to be processed exceeds this limit, a continuation token is returned in the response header x-ms-continuation. When a continuation token is returned in the response, it must be percent-encoded and specified in a subsequent invocation of setAccessControlRecursive operation. ,
Required: False ,
}
string ,
mode:
{
Description: Mode "set" sets POSIX access control rights on files and directories, "modify" modifies one or more POSIX access control rights that pre-exist on files and directories, "remove" removes one or more POSIX access control rights that were present earlier on files and directories ,
Required: True ,
}
string ,
forceFlag:
{
Description: Optional. Valid for "SetAccessControlRecursive" operation. If set to false, the operation will terminate quickly on encountering user errors (4XX). If true, the operation will ignore user errors and proceed with the operation on other sub-entities of the directory. Continuation token will only be returned when forceFlag is true in case of user errors. If not set the default value is false for this. ,
Required: False ,
}
boolean ,
position:
{
Description: This parameter allows the caller to upload data in parallel and control the order in which it is appended to the file. It is required when uploading data to be appended to the file and when flushing previously uploaded data to the file. The value must be the position where the data is to be appended. Uploaded data is not immediately flushed, or written, to the file. To flush, the previously uploaded data must be contiguous, the position parameter must be specified and equal to the length of the file after all data has been written, and there must not be a request entity body included with the request. ,
Format: int64 ,
Required: False ,
}
integer ,
retainUncommittedData:
{
Description: Valid only for flush operations. If "true", uncommitted data is retained after the flush operation completes; otherwise, the uncommitted data is deleted after the flush operation. The default is false. Data at offsets less than the specified position are written to the file when flush succeeds, but this optional parameter allows data after the flush position to be retained for a future flush operation. ,
Required: False ,
}
boolean ,
close:
{
Description: Azure Storage Events allow applications to receive notifications when files change. When Azure Storage Events are enabled, a file changed event is raised. This event has a property indicating whether this is the final change to distinguish the difference between an intermediate flush to a file stream and the final close of a file stream. The close query parameter is valid only when the action is "flush" and change notifications are enabled. If the value of close is "true" and the flush operation completes successfully, the service raises a file change notification with a property indicating that this is the final update (the file stream has been closed). If "false" a change notification is raised indicating the file has changed. The default is false. This query parameter is set to true by the Hadoop ABFS driver to indicate that the file stream has been closed." ,
Required: False ,
}
boolean ,
Content-Length:
{
Description: Required for "Append Data" and "Flush Data". Must be 0 for "Flush Data". Must be the length of the request content in bytes for "Append Data". ,
Format: int64 ,
Required: False ,
}
integer ,
x-ms-content-md5:
{
Description: Specify the transactional md5 for the body, to be validated by the service. ,
Format: byte ,
Required: False ,
}
string ,
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 ,
x-ms-cache-control:
{
Description: Optional. Sets the blob's cache control. If specified, this property is stored with the blob and returned with a read request. ,
Required: False ,
}
string ,
x-ms-content-type:
{
Description: Optional. Sets the blob's content type. If specified, this property is stored with the blob and returned with a read request. ,
Required: False ,
}
string ,
x-ms-content-disposition:
{
Description: Optional. Sets the blob's Content-Disposition header. ,
Required: False ,
}
string ,
x-ms-content-encoding:
{
Description: Optional. Sets the blob's content encoding. If specified, this property is stored with the blob and returned with a read request. ,
Required: False ,
}
string ,
x-ms-content-language:
{
Description: Optional. Set the blob's content language. If specified, this property is stored with the blob and returned with a read request. ,
Required: False ,
}
string ,
x-ms-properties:
{
Description: Optional. User-defined properties to be stored with the filesystem, 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. If the filesystem exists, any properties not included in the list will be removed. All properties are removed if the header is omitted. To merge new and existing properties, first get all existing properties and the current E-Tag, then make a conditional request with the E-Tag and include values for all properties. ,
Required: False ,
}
string ,
x-ms-owner:
{
Description: Optional. The owner of the blob or directory. ,
Required: False ,
}
string ,
x-ms-group:
{
Description: Optional. The owning group of the blob or directory. ,
Required: False ,
}
string ,
x-ms-permissions:
{
Description: Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported. ,
Required: False ,
}
string ,
x-ms-acl:
{
Description: Sets POSIX access control rights on files and directories. The value is a comma-separated list of access control entries. Each access control entry (ACE) consists of a scope, a type, a user or group identifier, and permissions in the format "[scope:][type]:[id]:[permissions]". ,
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 ,
body:
{
Description: Initial data ,
Required: True ,
}
object ,
x-ms-structured-body:
{
Description: Required if the request body is a structured message. Specifies the message schema version and properties. ,
Required: False ,
}
string ,
x-ms-structured-content-length:
{
Description: Required if the request body is a structured message. Specifies the length of the blob/file content inside the message body. Will always be smaller than Content-Length. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
$headers:
{
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 ,
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: An MD5 hash of the request content. This header is only returned for "Flush" operation. This header is returned so that the client can check for message content integrity. This header refers to the content of the request, not actual file content. ,
}
string ,
x-ms-properties:
{
Description: 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-continuation:
{
Description: When performing setAccessControlRecursive on a directory, the number of paths that are processed with each invocation is limited. If the number of paths to be processed exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the setAccessControlRecursive operation to continue the setAccessControlRecursive operation on the directory. ,
}
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 ,
}
,
$schema:
{
directoriesSuccessful:
{
Format: int32 ,
Required: False ,
}
integer ,
filesSuccessful:
{
Format: int32 ,
Required: False ,
}
integer ,
failureCount:
{
Format: int32 ,
Required: False ,
}
integer ,
failedEntries:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
errorMessage:
{
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
content-md5:
{
Description: An MD5 hash of the request content. This header is only returned for "Append" operation. This header is returned so that the client can check for message content integrity. The value of this header is computed by the service; it is not necessarily the same value specified in the request headers. ,
}
string ,
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
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-structured-body:
{
Description: Indicates the structured message body was accepted and mirrors back the message schema version and properties. ,
}
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 ,
}
,
}
,
}
Path_Lease (updated)
Description :  Create and manage a lease to restrict write and delete access to the 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_Lease",
  "Description": {
    "new": "Create and manage a lease to restrict write and delete access to the 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).",
    "old": "Create and manage a lease to restrict write and delete access to the path. This operation supports conditional HTTP requests.  For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations)."
  }
}

⚼ Request

POST:  /{filesystem}/{path}
{
x-ms-lease-action:
{
Description: There are five lease actions: "acquire", "break", "change", "renew", and "release". Use "acquire" and specify the "x-ms-proposed-lease-id" and "x-ms-lease-duration" to acquire a new lease. Use "break" to break an existing lease. When a lease is broken, the lease break period is allowed to elapse, during which time no lease operation except break and release can be performed on the file. When a lease is successfully broken, the response indicates the interval in seconds until a new lease can be acquired. Use "change" and specify the current lease ID in "x-ms-lease-id" and the new lease ID in "x-ms-proposed-lease-id" to change the lease ID of an active lease. Use "renew" and specify the "x-ms-lease-id" to renew an existing lease. Use "release" and specify the "x-ms-lease-id" to release a lease. ,
Required: True ,
}
string ,
x-ms-lease-duration:
{
Description: The lease duration is required to acquire a lease, and specifies the duration of the lease in seconds. The lease duration must be between 15 and 60 seconds or -1 for infinite lease. ,
Format: int32 ,
Required: False ,
}
integer ,
x-ms-lease-break-period:
{
Description: The lease break period duration is optional to break a lease, and specifies the break period of the lease in seconds. The lease break duration must be between 0 and 60 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
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 ,
x-ms-proposed-lease-id:
{
Description: Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats. ,
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)

{
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. ,
}
string ,
last-modified:
{
Description: The data and time the file was last modified. Write operations on the file 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-lease-id:
{
Description: A successful "renew" action returns the lease ID. ,
}
string ,
}

⚐ Response (201)

{
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-lease-id:
{
Description: A successful "acquire" action returns the lease ID. ,
}
string ,
}

⚐ Response (202)

{
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-lease-time:
{
Description: The time remaining in the lease period in seconds. ,
}
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 ,
}
,
}
,
}
Path_Read (updated)
Description :  Read the contents of a file. For read operations, range requests are supported. 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_Read",
  "Description": {
    "new": "Read the contents of a file.  For read operations, range requests are supported. 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).",
    "old": "Read the contents of a file.  For read operations, range requests are supported. This operation supports conditional HTTP requests.  For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations)."
  }
}

⚼ Request

GET:  /{filesystem}/{path}
{
Range:
{
Description: The HTTP Range request header specifies one or more byte ranges of the resource to be retrieved. ,
Required: False ,
}
string ,
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 ,
x-ms-range-get-content-md5:
{
Description: Optional. When this header is set to "true" and specified together with the Range header, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4MB in size. If this header is specified without the Range header, the service returns status code 400 (Bad Request). If this header is set to true when the range exceeds 4 MB in size, the service returns status code 400 (Bad Request). ,
Required: False ,
}
boolean ,
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 ,
x-ms-encryption-key:
{
Description: Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. ,
Required: False ,
}
string ,
x-ms-encryption-key-sha256:
{
Description: The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. ,
Required: False ,
}
string ,
x-ms-encryption-algorithm:
{
Description: The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
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. If the file has an MD5 hash and this read operation is to read the complete file, this response header is returned 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-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-request-server-encrypted:
{
Description: 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. ,
}
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 ,
}
,
$schema:
{
Format: file ,
}
object ,
}

⚐ Response (206)

{
$headers:
{
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 read range. If the request is to read a specified range and the "x-ms-range-get-content-md5" is set to true, then the request returns an MD5 hash for the range, as long as the range size is less than or equal to 4 MB. ,
}
string ,
x-ms-content-md5:
{
Description: The MD5 hash of complete file stored in storage. If the file has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the complete file's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range. ,
}
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-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-request-server-encrypted:
{
Description: 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. ,
}
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 ,
}
,
$schema:
{
Format: file ,
}
object ,
}

⚐ 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 ,
}
,
}
,
}
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",
  "Description": {
    "new": "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).",
    "old": "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://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations)."
  }
}

⚼ 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 ,
}

⚐ 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 ,
}
,
}
,
}
Path_Delete (updated)
Description :  Delete the file or directory. 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_Delete",
  "Description": {
    "new": "Delete the file or directory. 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).",
    "old": "Delete the file or directory. This operation supports conditional HTTP requests.  For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations)."
  }
}

⚼ Request

DELETE:  /{filesystem}/{path}
{
recursive:
{
Description: Required ,
Required: False ,
}
boolean ,
continuation:
{
Description: Optional. When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory. ,
Required: False ,
}
string ,
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 ,
paginated:
{
Description: If true, paginated behavior will be seen. Pagination is for the recursive ACL checks as a POSIX requirement in the server and Delete in an atomic operation once the ACL checks are completed. If false or missing, normal default behavior will kick in, which may timeout in case of very large directories due to recursive ACL checks. This new parameter is introduced for backward compatibility. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
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-continuation:
{
Description: When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory. ,
}
string ,
x-ms-deletion-id:
{
Description: Returned only for hierarchical namespace space enabled accounts when soft delete is enabled. A unique identifier for the entity that can be used to restore it. See the Undelete REST API for more information. ,
}
string ,
}

⚐ Response (202)

{
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
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-continuation:
{
Description: Applicable only when Hierarchical Namespace is enabled for the account. When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response when the following conditions are met: Delete should be on a directory with query parameters "recursive" and "paginated" set to true, the identity of the user calling the api should be a non-super user using ACL based authorization, number of paths to be deleted exceeds a limit, request version is 2023-08-03 and later. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory. Directory is successfully deleted when the continuation token returned is empty. The actual directory deletion happens only in the last invocation, the previous ones involve ACL checks in the server of the files and directories under the directory to be recursively deleted. ,
}
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 ,
}
,
}
,
}
Path_SetAccessControl (updated)
Description :  Set the owner, group, permissions, or access control list for a path.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Path_SetAccessControl",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations."
      }
    }
  ]
}

⚼ Request

PATCH:  /{filesystem}/{path}?action=setAccessControl
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. ,
Required: False ,
}
integer ,
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 ,
x-ms-owner:
{
Description: Optional. The owner of the blob or directory. ,
Required: False ,
}
string ,
x-ms-group:
{
Description: Optional. The owning group of the blob or directory. ,
Required: False ,
}
string ,
x-ms-permissions:
{
Description: Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported. ,
Required: False ,
}
string ,
x-ms-acl:
{
Description: Sets POSIX access control rights on files and directories. The value is a comma-separated list of access control entries. Each access control entry (ACE) consists of a scope, a type, a user or group identifier, and permissions in the format "[scope:][type]:[id]:[permissions]". ,
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 ,
x-ms-client-request-id:
{
Description: Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. ,
Required: False ,
}
string ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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-client-request-id:
{
Description: If a client request id header is sent in the request, this header will be present in the response with the same value. ,
}
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 ,
}

⚐ Response (default)

{
$headers:
{
x-ms-client-request-id:
{
Description: If a client request id header is sent in the request, this header will be present in the response with the same value. ,
}
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 ,
}
,
$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 ,
}
,
}
,
}
Path_SetAccessControlRecursive (updated)
Description :  Set the access control list for a path and sub-paths.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Path_SetAccessControlRecursive",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations."
      }
    }
  ]
}

⚼ Request

PATCH:  /{filesystem}/{path}?action=setAccessControlRecursive
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. ,
Required: False ,
}
integer ,
continuation:
{
Description: Optional. When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory. ,
Required: False ,
}
string ,
mode:
{
Description: Mode "set" sets POSIX access control rights on files and directories, "modify" modifies one or more POSIX access control rights that pre-exist on files and directories, "remove" removes one or more POSIX access control rights that were present earlier on files and directories ,
Required: True ,
}
string ,
forceFlag:
{
Description: Optional. Valid for "SetAccessControlRecursive" operation. If set to false, the operation will terminate quickly on encountering user errors (4XX). If true, the operation will ignore user errors and proceed with the operation on other sub-entities of the directory. Continuation token will only be returned when forceFlag is true in case of user errors. If not set the default value is false for this. ,
Required: False ,
}
boolean ,
maxRecords:
{
Description: Optional. It specifies the maximum number of files or directories on which the acl change will be applied. If omitted or greater than 2,000, the request will process up to 2,000 items ,
Format: int32 ,
Required: False ,
}
integer ,
x-ms-acl:
{
Description: Sets POSIX access control rights on files and directories. The value is a comma-separated list of access control entries. Each access control entry (ACE) consists of a scope, a type, a user or group identifier, and permissions in the format "[scope:][type]:[id]:[permissions]". ,
Required: False ,
}
string ,
x-ms-client-request-id:
{
Description: Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. ,
Required: False ,
}
string ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
string ,
x-ms-client-request-id:
{
Description: If a client request id header is sent in the request, this header will be present in the response with the same value. ,
}
string ,
x-ms-continuation:
{
Description: When performing setAccessControlRecursive on a directory, the number of paths that are processed with each invocation is limited. If the number of paths to be processed exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the setAccessControlRecursive operation to continue the setAccessControlRecursive operation on the directory. ,
}
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 ,
}
,
$schema:
{
directoriesSuccessful:
{
Format: int32 ,
Required: False ,
}
integer ,
filesSuccessful:
{
Format: int32 ,
Required: False ,
}
integer ,
failureCount:
{
Format: int32 ,
Required: False ,
}
integer ,
failedEntries:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
errorMessage:
{
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-client-request-id:
{
Description: If a client request id header is sent in the request, this header will be present in the response with the same value. ,
}
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 ,
}
,
$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 ,
}
,
}
,
}
Path_FlushData (updated)
Description :  Set the owner, group, permissions, or access control list for a path.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Path_FlushData",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations."
      }
    }
  ]
}

⚼ Request

PATCH:  /{filesystem}/{path}?action=flush
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. ,
Required: False ,
}
integer ,
position:
{
Description: This parameter allows the caller to upload data in parallel and control the order in which it is appended to the file. It is required when uploading data to be appended to the file and when flushing previously uploaded data to the file. The value must be the position where the data is to be appended. Uploaded data is not immediately flushed, or written, to the file. To flush, the previously uploaded data must be contiguous, the position parameter must be specified and equal to the length of the file after all data has been written, and there must not be a request entity body included with the request. ,
Format: int64 ,
Required: False ,
}
integer ,
retainUncommittedData:
{
Description: Valid only for flush operations. If "true", uncommitted data is retained after the flush operation completes; otherwise, the uncommitted data is deleted after the flush operation. The default is false. Data at offsets less than the specified position are written to the file when flush succeeds, but this optional parameter allows data after the flush position to be retained for a future flush operation. ,
Required: False ,
}
boolean ,
close:
{
Description: Azure Storage Events allow applications to receive notifications when files change. When Azure Storage Events are enabled, a file changed event is raised. This event has a property indicating whether this is the final change to distinguish the difference between an intermediate flush to a file stream and the final close of a file stream. The close query parameter is valid only when the action is "flush" and change notifications are enabled. If the value of close is "true" and the flush operation completes successfully, the service raises a file change notification with a property indicating that this is the final update (the file stream has been closed). If "false" a change notification is raised indicating the file has changed. The default is false. This query parameter is set to true by the Hadoop ABFS driver to indicate that the file stream has been closed." ,
Required: False ,
}
boolean ,
Content-Length:
{
Description: Required for "Append Data" and "Flush Data". Must be 0 for "Flush Data". Must be the length of the request content in bytes for "Append Data". ,
Format: int64 ,
Required: False ,
}
integer ,
x-ms-content-md5:
{
Description: Specify the transactional md5 for the body, to be validated by the service. ,
Format: byte ,
Required: False ,
}
string ,
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 ,
x-ms-lease-action:
{
Description: Optional. If "acquire" it will acquire the lease. If "auto-renew" it will renew the lease. If "release" it will release the lease only on flush. If "acquire-release" it will acquire & complete the operation & release the lease once operation is done. ,
Required: False ,
}
string ,
x-ms-lease-duration:
{
Description: The lease duration is required to acquire a lease, and specifies the duration of the lease in seconds. The lease duration must be between 15 and 60 seconds or -1 for infinite lease. ,
Format: int64 ,
Required: False ,
}
integer ,
x-ms-proposed-lease-id:
{
Description: Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats. ,
Required: False ,
}
string ,
x-ms-cache-control:
{
Description: Optional. Sets the blob's cache control. If specified, this property is stored with the blob and returned with a read request. ,
Required: False ,
}
string ,
x-ms-content-type:
{
Description: Optional. Sets the blob's content type. If specified, this property is stored with the blob and returned with a read request. ,
Required: False ,
}
string ,
x-ms-content-disposition:
{
Description: Optional. Sets the blob's Content-Disposition header. ,
Required: False ,
}
string ,
x-ms-content-encoding:
{
Description: Optional. Sets the blob's content encoding. If specified, this property is stored with the blob and returned with a read request. ,
Required: False ,
}
string ,
x-ms-content-language:
{
Description: Optional. Set the blob's content language. If specified, this property is stored with the blob and returned with a read request. ,
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 ,
x-ms-client-request-id:
{
Description: Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. ,
Required: False ,
}
string ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-encryption-key:
{
Description: Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. ,
Required: False ,
}
string ,
x-ms-encryption-key-sha256:
{
Description: The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. ,
Required: False ,
}
string ,
x-ms-encryption-algorithm:
{
Description: The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
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 ,
content-length:
{
Description: The size of the resource in bytes. ,
}
integer ,
x-ms-client-request-id:
{
Description: If a client request id header is sent in the request, this header will be present in the response with the same value. ,
}
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-request-server-encrypted:
{
Description: 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. ,
}
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-lease-renewed:
{
Description: If the lease was auto-renewed with this request ,
}
boolean ,
}

⚐ Response (default)

{
$headers:
{
x-ms-client-request-id:
{
Description: If a client request id header is sent in the request, this header will be present in the response with the same value. ,
}
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 ,
}
,
$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 ,
}
,
}
,
}
Path_AppendData (updated)
Description :  Append data to the file.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Path_AppendData",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations."
      }
    }
  ]
}

⚼ Request

PATCH:  /{filesystem}/{path}?action=append
{
position:
{
Description: This parameter allows the caller to upload data in parallel and control the order in which it is appended to the file. It is required when uploading data to be appended to the file and when flushing previously uploaded data to the file. The value must be the position where the data is to be appended. Uploaded data is not immediately flushed, or written, to the file. To flush, the previously uploaded data must be contiguous, the position parameter must be specified and equal to the length of the file after all data has been written, and there must not be a request entity body included with the request. ,
Format: int64 ,
Required: False ,
}
integer ,
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. ,
Required: False ,
}
integer ,
Content-Length:
{
Description: Required for "Append Data" and "Flush Data". Must be 0 for "Flush Data". Must be the length of the request content in bytes for "Append Data". ,
Format: int64 ,
Required: False ,
}
integer ,
Content-MD5:
{
Description: Specify the transactional md5 for the body, to be validated by the service. ,
Format: byte ,
Required: False ,
}
string ,
x-ms-content-crc64:
{
Description: Specify the transactional crc64 for the body, to be validated by the service. ,
Format: byte ,
Required: False ,
}
string ,
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 ,
x-ms-lease-action:
{
Description: Optional. If "acquire" it will acquire the lease. If "auto-renew" it will renew the lease. If "release" it will release the lease only on flush. If "acquire-release" it will acquire & complete the operation & release the lease once operation is done. ,
Required: False ,
}
string ,
x-ms-lease-duration:
{
Description: The lease duration is required to acquire a lease, and specifies the duration of the lease in seconds. The lease duration must be between 15 and 60 seconds or -1 for infinite lease. ,
Format: int64 ,
Required: False ,
}
integer ,
x-ms-proposed-lease-id:
{
Description: Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats. ,
Required: False ,
}
string ,
body:
{
Description: Initial data ,
Required: True ,
}
object ,
x-ms-client-request-id:
{
Description: Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. ,
Required: False ,
}
string ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-encryption-key:
{
Description: Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. ,
Required: False ,
}
string ,
x-ms-encryption-key-sha256:
{
Description: The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. ,
Required: False ,
}
string ,
x-ms-encryption-algorithm:
{
Description: The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. ,
Required: False ,
}
string ,
flush:
{
Description: If file should be flushed after the append ,
Required: False ,
}
boolean ,
x-ms-structured-body:
{
Description: Required if the request body is a structured message. Specifies the message schema version and properties. ,
Required: False ,
}
string ,
x-ms-structured-content-length:
{
Description: Required if the request body is a structured message. Specifies the length of the blob/file content inside the message body. Will always be smaller than Content-Length. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (202)

{
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
string ,
x-ms-request-id:
{
Description: A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. ,
}
string ,
x-ms-client-request-id:
{
Description: If a client request id header is sent in the request, this header will be present in the response with the same value. ,
}
string ,
x-ms-version:
{
Description: The version of the REST protocol used to process the request. ,
}
string ,
etag:
{
Description: An HTTP entity tag associated with the file or directory. ,
}
string ,
content-md5:
{
Description: If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity. ,
}
string ,
x-ms-content-crc64:
{
Description: This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers. ,
}
string ,
x-ms-request-server-encrypted:
{
Description: 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. ,
}
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-lease-renewed:
{
Description: If the lease was auto-renewed with this request ,
}
boolean ,
x-ms-structured-body:
{
Description: Indicates the structured message body was accepted and mirrors back the message schema version and properties. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-client-request-id:
{
Description: If a client request id header is sent in the request, this header will be present in the response with the same value. ,
}
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 ,
}
,
$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 ,
}
,
}
,
}
Path_SetExpiry (updated)
Description :  Sets the time a blob will expire and be deleted.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Path_SetExpiry",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations."
      }
    }
  ]
}

⚼ Request

PUT:  /{filesystem}/{path}?comp=expiry
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. ,
Required: False ,
}
string ,
x-ms-expiry-option:
{
Description: Required. Indicates mode of the expiry time ,
Required: True ,
}
string ,
x-ms-expiry-time:
{
Description: The time to set the blob to expiry ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. ,
}
string ,
last-modified:
{
Description: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. ,
}
string ,
x-ms-client-request-id:
{
Description: If a client request id header is sent in the request, this header will be present in the response with the same value. ,
}
string ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. ,
}
string ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
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 ,
}
,
}
,
}
Path_Undelete (updated)
Description :  Undelete a path that was previously soft deleted
Reference :  Link ¶

⚶ Changes

{
  "#id": "Path_Undelete",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations."
      }
    }
  ]
}

⚼ Request

PUT:  /{filesystem}/{path}?comp=undelete
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. ,
Required: False ,
}
integer ,
x-ms-undelete-source:
{
Description: Only for hierarchical namespace enabled accounts. Optional. The path of the soft deleted blob to undelete. ,
Required: False ,
}
string ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
x-ms-client-request-id:
{
Description: If a client request id header is sent in the request, this header will be present in the response with the same value. ,
}
string ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting 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-version:
{
Description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. ,
}
string ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
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 ,
}
,
}
,
}