Microsoft.BlobStorage (stable:2026-02-06)

2025/10/09 • 4 updated methods

Blob_Download (updated)
Description :  The Download operation reads or downloads a blob from the system, including its metadata and properties. You can also call Download to read a snapshot.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Blob_Download",
  "$responses": {
    "default": {
      "$properties": {
        "@added_9b69d060d0f44b39ad921ffa42914288": {
          "#name": "Code",
          "Description": "The error code.",
          "Required": false,
          "Type": "string"
        },
        "@added_3d3423d5d6894ad692f1c41758efb75a": {
          "#name": "Message",
          "Description": "The error message.",
          "Required": false,
          "Type": "string"
        },
        "@added_65e0f900701d49878eac6d817f0c5eb9": {
          "#name": "CopySourceStatusCode",
          "Description": "Copy source status code",
          "Format": "int32",
          "Required": false,
          "Type": "integer"
        },
        "@added_0adefd85d45d427da3605ce990a23a7e": {
          "#name": "CopySourceErrorCode",
          "Description": "Copy source error code",
          "Required": false,
          "Type": "string"
        },
        "@added_f52569dfba104ac29cf73a6040ce710a": {
          "#name": "CopySourceErrorMessage",
          "Description": "Copy source error message",
          "Required": false,
          "Type": "string"
        },
        "@removed_233ad68896d74f74b21f3406dd47b752": {
          "#name": "code",
          "Description": "The error code.",
          "Required": false,
          "Type": "string"
        },
        "@removed_a40b425e91d54b068136db1553763fbc": {
          "#name": "message",
          "Description": "The error message.",
          "Required": false,
          "Type": "string"
        },
        "@removed_00d748cbde214475964ca7dc82a88375": {
          "#name": "copySourceStatusCode",
          "Description": "Copy source status code",
          "Format": "int32",
          "Required": false,
          "Type": "integer"
        },
        "@removed_5b1ab291a6a4444f8a4380aa86f11ccb": {
          "#name": "copySourceErrorCode",
          "Description": "Copy source error code",
          "Required": false,
          "Type": "string"
        },
        "@removed_051e4eb5b168491a987911eebc03b2f0": {
          "#name": "copySourceErrorMessage",
          "Description": "Copy source error message",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

GET:  /{containerName}/{blobName}
{
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
containerName:
{
Description: The name of the container. ,
Required: True ,
}
string ,
blobName:
{
Description: The name of the blob. ,
Required: True ,
}
string ,
snapshot:
{
Description: The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. For more information on working with blob snapshots, see Creating a Snapshot of a Blob. ,
Required: False ,
}
string ,
versionid:
{
Description: The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to operate on. It's for service version 2019-10-10 and newer. ,
Required: False ,
}
string ,
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. ,
Format: int32 ,
Required: False ,
}
integer ,
Range:
{
Description: Return only the bytes of the blob in the specified range. ,
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: When set to true and specified together with the Range, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4 MB in size. ,
Required: False ,
}
boolean ,
x-ms-range-get-content-crc64:
{
Description: Optional. When this header is set to true and specified together with the Range header, the service returns the CRC64 hash for the range, as long as the range is less than or equal to 4 MB in size. ,
Required: False ,
}
boolean ,
x-ms-structured-body:
{
Description: Specifies the response content should be returned as a structured message and specifies the message schema version and properties. ,
Required: False ,
}
string ,
x-ms-encryption-key:
{
Description: Optional. Version 2019-07-07 and later. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, the request will be encrypted with the root account key. ,
Required: False ,
}
string ,
x-ms-encryption-key-sha256:
{
Description: Optional. Version 2019-07-07 and later. Specifies the SHA256 hash of the encryption key used to encrypt the data provided in the request. This header is only used for encryption with a customer-provided key. If the request is authenticated with a client token, this header should be specified using the SHA256 hash of the encryption key. ,
Required: False ,
}
string ,
x-ms-encryption-algorithm:
{
Description: Optional. Version 2019-07-07 and later. Specifies the algorithm to use for encryption. If not specified, the default is AES256. ,
Required: False ,
}
string ,
x-ms-if-tags:
{
Description: Specify a SQL where clause on blob tags to operate only on blobs with a matching value. ,
Required: False ,
}
string ,
If-Match:
{
Description: The request should only proceed if an entity matches this string. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: The request should only proceed if no entity matches this string. ,
Required: False ,
}
string ,
If-Unmodified-Since:
{
Description: The request should only proceed if the entity was not modified after this time. ,
Format: date-time ,
Required: False ,
}
string ,
If-Modified-Since:
{
Description: The request should only proceed if the entity was modified after this time. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
accept-ranges:
{
Description: Indicates that the service supports requests for partial blob content. ,
}
string ,
cache-control:
{
Description: This header is returned if it was previously specified for the blob. ,
}
string ,
content-disposition:
{
Description: This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified. ,
}
string ,
content-encoding:
{
Description: This header returns the value that was specified for the Content-Encoding request header ,
}
string ,
content-language:
{
Description: This header returns the value that was specified for the Content-Language request header. ,
}
string ,
content-length:
{
Description: The number of bytes present in the response body. ,
}
integer ,
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 ,
content-range:
{
Description: Indicates the range of bytes returned in the event that the client requested a subset of the blob by setting the 'Range' request header. ,
}
string ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
string ,
etag:
{
Description: The ETag contains a value that you can use to perform operations conditionally. ,
}
string ,
last-modified:
{
Description: The date/time that the container was last modified. ,
}
string ,
x-ms-blob-committed-block-count:
{
Description: The number of committed blocks present in the blob. This header is returned only for append blobs. ,
}
integer ,
x-ms-blob-content-md5:
{
Description: If the blob 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 whole blob'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 ,
x-ms-blob-sealed:
{
Description: If this blob has been sealed ,
}
boolean ,
x-ms-blob-sequence-number:
{
Description: The current sequence number for a page blob. This header is not returned for block blobs or append blobs. ,
}
integer ,
x-ms-blob-type:
{
Description: The type of the blob. ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
x-ms-copy-completion-time:
{
Description: Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List. ,
}
string ,
x-ms-copy-id:
{
Description: String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy. ,
}
string ,
x-ms-copy-progress:
{
Description: Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob. Can show between 0 and Content-Length bytes copied. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List ,
}
string ,
x-ms-copy-source:
{
Description: URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List. ,
}
string ,
x-ms-copy-status:
{
Description: State of the copy operation identified by x-ms-copy-id. ,
}
string ,
x-ms-copy-status-description:
{
Description: Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List ,
}
string ,
x-ms-creation-time:
{
Description: Returns the date and time the blob was created. ,
}
string ,
x-ms-encryption-key-sha256:
{
Description: The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key. ,
}
string ,
x-ms-encryption-scope:
{
Description: If the blob 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 whole blob'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 ,
x-ms-immutability-policy-mode:
{
Description: Indicates the immutability policy mode of the blob. ,
}
string ,
x-ms-immutability-policy-until-date:
{
Description: UTC date/time value generated by the service that indicates the time at which the blob immutability policy will expire. ,
}
string ,
x-ms-is-current-version:
{
Description: The value of this header indicates whether version of this blob is a current version, see also x-ms-version-id header. ,
}
boolean ,
x-ms-last-access-time:
{
Description: UTC date/time value generated by the service that indicates the time at which the blob was last read or written to ,
}
string ,
x-ms-lease-duration:
{
Description: Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires. A non-infinite lease can be between 15 and 60 seconds. A lease duration cannot be changed using renew or change. ,
}
string ,
x-ms-lease-state:
{
Description: Lease state of the blob. ,
}
string ,
x-ms-lease-status:
{
Description: The lease status of the blob. ,
}
string ,
x-ms-legal-hold:
{
Description: Specifies the legal hold status to set on the blob. ,
}
boolean ,
x-ms-meta:
{
Description: The metadata headers. ,
}
string ,
x-ms-or:
{
Description: Optional. Only valid when Object Replication is enabled for the storage container and on the source blob of the replication. When retrieving this header, it will return the header with the policy id and rule id (e.g. x-ms-or-policyid_ruleid), and the value will be the status of the replication (e.g. complete, failed). ,
}
string ,
x-ms-or-policy-id:
{
Description: Optional. Only valid when Object Replication is enabled for the storage container and on the destination blob of the replication. ,
}
string ,
x-ms-request-id:
{
Description: An opaque, globally-unique, server-generated string identifier for the request. ,
}
string ,
x-ms-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-structured-body:
{
Description: Indicates the response body contains a structured message and specifies the message schema version and properties. ,
}
string ,
x-ms-structured-content-length:
{
Description: The length of the blob/file content inside the message body when the response body is returned as a structured message. Will always be smaller than Content-Length. ,
}
integer ,
x-ms-tag-count:
{
Description: The number of tags associated with the blob ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
}
string ,
x-ms-version-id:
{
Description: A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob. ,
}
string ,
}
,
$schema: file ,
}

⚐ Response (206)

{
$headers:
{
accept-ranges:
{
Description: Indicates that the service supports requests for partial blob content. ,
}
string ,
cache-control:
{
Description: This header is returned if it was previously specified for the blob. ,
}
string ,
content-disposition:
{
Description: This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified. ,
}
string ,
content-encoding:
{
Description: This header returns the value that was specified for the Content-Encoding request header ,
}
string ,
content-language:
{
Description: This header returns the value that was specified for the Content-Language request header. ,
}
string ,
content-length:
{
Description: The number of bytes present in the response body. ,
}
integer ,
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 ,
content-range:
{
Description: Indicates the range of bytes returned in the event that the client requested a subset of the blob by setting the 'Range' request header. ,
}
string ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
string ,
etag:
{
Description: The ETag contains a value that you can use to perform operations conditionally. ,
}
string ,
last-modified:
{
Description: The date/time that the container was last modified. ,
}
string ,
x-ms-blob-committed-block-count:
{
Description: The number of committed blocks present in the blob. This header is returned only for append blobs. ,
}
integer ,
x-ms-blob-content-md5:
{
Description: If the blob 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 whole blob'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 ,
x-ms-blob-sealed:
{
Description: If this blob has been sealed ,
}
boolean ,
x-ms-blob-sequence-number:
{
Description: The current sequence number for a page blob. This header is not returned for block blobs or append blobs. ,
}
integer ,
x-ms-blob-type:
{
Description: The type of the blob. ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
x-ms-content-crc64:
{
Description: This response header is returned so that the client can check for the integrity of the copied content. ,
}
string ,
x-ms-copy-completion-time:
{
Description: Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List. ,
}
string ,
x-ms-copy-id:
{
Description: String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy. ,
}
string ,
x-ms-copy-progress:
{
Description: Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob. Can show between 0 and Content-Length bytes copied. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List ,
}
string ,
x-ms-copy-source:
{
Description: URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List. ,
}
string ,
x-ms-copy-status:
{
Description: State of the copy operation identified by x-ms-copy-id. ,
}
string ,
x-ms-copy-status-description:
{
Description: Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List ,
}
string ,
x-ms-creation-time:
{
Description: Returns the date and time the blob was created. ,
}
string ,
x-ms-encryption-key-sha256:
{
Description: The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key. ,
}
string ,
x-ms-encryption-scope:
{
Description: If the blob 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 whole blob'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 ,
x-ms-immutability-policy-mode:
{
Description: Indicates the immutability policy mode of the blob. ,
}
string ,
x-ms-immutability-policy-until-date:
{
Description: UTC date/time value generated by the service that indicates the time at which the blob immutability policy will expire. ,
}
string ,
x-ms-is-current-version:
{
Description: The value of this header indicates whether version of this blob is a current version, see also x-ms-version-id header. ,
}
boolean ,
x-ms-last-access-time:
{
Description: UTC date/time value generated by the service that indicates the time at which the blob was last read or written to ,
}
string ,
x-ms-lease-duration:
{
Description: Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires. A non-infinite lease can be between 15 and 60 seconds. A lease duration cannot be changed using renew or change. ,
}
string ,
x-ms-lease-state:
{
Description: Lease state of the blob. ,
}
string ,
x-ms-lease-status:
{
Description: The lease status of the blob. ,
}
string ,
x-ms-legal-hold:
{
Description: Specifies the legal hold status to set on the blob. ,
}
boolean ,
x-ms-meta:
{
Description: The metadata headers. ,
}
string ,
x-ms-or:
{
Description: Optional. Only valid when Object Replication is enabled for the storage container and on the source blob of the replication. When retrieving this header, it will return the header with the policy id and rule id (e.g. x-ms-or-policyid_ruleid), and the value will be the status of the replication (e.g. complete, failed). ,
}
string ,
x-ms-or-policy-id:
{
Description: Optional. Only valid when Object Replication is enabled for the storage container and on the destination blob of the replication. ,
}
string ,
x-ms-request-id:
{
Description: An opaque, globally-unique, server-generated string identifier for the request. ,
}
string ,
x-ms-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-structured-body:
{
Description: Indicates the response body contains a structured message and specifies the message schema version and properties. ,
}
string ,
x-ms-structured-content-length:
{
Description: The length of the blob/file content inside the message body when the response body is returned as a structured message. Will always be smaller than Content-Length. ,
}
integer ,
x-ms-tag-count:
{
Description: The number of tags associated with the blob ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
}
string ,
x-ms-version-id:
{
Description: A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob. ,
}
string ,
}
,
$schema: file ,
}

⚐ Response (default)

{
$headers:
{
x-ms-copy-source-error-code:
{
Description: The error code for the copy source. ,
}
string ,
x-ms-copy-source-status-code:
{
Description: The status code for the copy source. ,
}
integer ,
x-ms-error-code:
{
Description: The error code. ,
}
string ,
}
,
$schema:
{
Description: The error response. ,
}
{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
CopySourceStatusCode:
{
Description: Copy source status code ,
Format: int32 ,
Required: False ,
}
integer ,
CopySourceErrorCode:
{
Description: Copy source error code ,
Required: False ,
}
string ,
CopySourceErrorMessage:
{
Description: Copy source error message ,
Required: False ,
}
string ,
}
,
}
Blob_StartCopyFromUrl (updated)
Description :  The Start Copy From URL operation copies a blob or an internet resource to a new blob.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Blob_StartCopyFromUrl",
  "$responses": {
    "default": {
      "$properties": {
        "@added_c00bb35683da45d9946305d005ee5872": {
          "#name": "Code",
          "Description": "The error code.",
          "Required": false,
          "Type": "string"
        },
        "@added_28ad7d6982b144cc96a0ae69ca0ccddc": {
          "#name": "Message",
          "Description": "The error message.",
          "Required": false,
          "Type": "string"
        },
        "@added_1db976e15d5a45e3af27e9348888852d": {
          "#name": "CopySourceStatusCode",
          "Description": "Copy source status code",
          "Format": "int32",
          "Required": false,
          "Type": "integer"
        },
        "@added_f4eb8fe66e5d4284aa725cd6eb55bcb5": {
          "#name": "CopySourceErrorCode",
          "Description": "Copy source error code",
          "Required": false,
          "Type": "string"
        },
        "@added_3cf5372aa3cf48dcb5c57c6fcc4871df": {
          "#name": "CopySourceErrorMessage",
          "Description": "Copy source error message",
          "Required": false,
          "Type": "string"
        },
        "@removed_db69d174a28c4e18bdbdb97b95b79376": {
          "#name": "code",
          "Description": "The error code.",
          "Required": false,
          "Type": "string"
        },
        "@removed_cde28f61fa3542748f599fe9740dc538": {
          "#name": "message",
          "Description": "The error message.",
          "Required": false,
          "Type": "string"
        },
        "@removed_c5957a42dda4436b810000f0632db68e": {
          "#name": "copySourceStatusCode",
          "Description": "Copy source status code",
          "Format": "int32",
          "Required": false,
          "Type": "integer"
        },
        "@removed_89a181ebce0041c4a2cf732c0adefbe6": {
          "#name": "copySourceErrorCode",
          "Description": "Copy source error code",
          "Required": false,
          "Type": "string"
        },
        "@removed_7125f834c921458d9e3ac89ec83f5b02": {
          "#name": "copySourceErrorMessage",
          "Description": "Copy source error message",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

PUT:  /{containerName}/{blobName}
{
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
containerName:
{
Description: The name of the container. ,
Required: True ,
}
string ,
blobName:
{
Description: The name of the blob. ,
Required: True ,
}
string ,
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. ,
Format: int32 ,
Required: False ,
}
integer ,
x-ms-meta:
{
Description: The metadata headers. ,
Required: False ,
}
string ,
x-ms-access-tier:
{
Description: The tier to be set on the blob. ,
Required: False ,
}
string ,
x-ms-rehydrate-priority:
{
Description: If an object is in rehydrate pending state then this header is returned with priority of rehydrate. Valid values are High and Standard. ,
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-rfc7231 ,
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-rfc7231 ,
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 this header value to operate only on a blob if it has been modified since the specified date/time. ,
Required: False ,
}
string ,
x-ms-source-if-tags:
{
Description: Specify a SQL where clause on blob tags to operate only on blobs with a matching value. ,
Required: False ,
}
string ,
If-Modified-Since:
{
Description: A date-time value. A request is made under the condition that the resource has been modified since the specified date-time. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
If-Unmodified-Since:
{
Description: A date-time value. A request is made under the condition that the resource has not been modified since the specified date-time. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
If-None-Match:
{
Description: A condition that must be met in order for the request to be processed. ,
Required: False ,
}
string ,
If-Match:
{
Description: A condition that must be met in order for the request to be processed. ,
Required: False ,
}
string ,
x-ms-if-tags:
{
Description: Specify a SQL where clause on blob tags to operate only on blobs with a matching value. ,
Required: False ,
}
string ,
x-ms-copy-source:
{
Description: Specifies the name of the source page blob snapshot. This value is a URL of up to 2 KB in length that specifies a page blob snapshot. The value should be URL-encoded as it would appear in a request URI. The source blob must either be public or must be authenticated via a shared access signature. ,
Required: True ,
}
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-tags:
{
Description: Optional. Used to set blob tags in various blob operations. ,
Required: False ,
}
string ,
x-ms-seal-blob:
{
Description: Overrides the sealed state of the destination blob. Service version 2019-12-12 and newer. ,
Required: False ,
}
boolean ,
x-ms-immutability-policy-until-date:
{
Description: Specifies the date time when the blobs immutability policy is set to expire. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
x-ms-immutability-policy-mode:
{
Description: Specifies the immutability policy mode to set on the blob. ,
Required: False ,
}
string ,
x-ms-legal-hold:
{
Description: Specified if a legal hold should be set on the blob. ,
Required: False ,
}
boolean ,
x-ms-requires-sync:
{
Description: This header indicates that this is a synchronous Copy Blob From URL instead of a Asynchronous Copy Blob. ,
Required: True ,
}
boolean ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
string ,
etag:
{
Description: The ETag contains a value that you can use to perform operations conditionally. ,
}
string ,
last-modified:
{
Description: The date/time that the container was last modified. ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
x-ms-copy-id:
{
Description: String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy. ,
}
string ,
x-ms-copy-status:
{
Description: State of the copy operation identified by x-ms-copy-id. ,
}
string ,
x-ms-request-id:
{
Description: An opaque, globally-unique, server-generated string identifier for the request. ,
}
string ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
}
string ,
x-ms-version-id:
{
Description: A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-copy-source-error-code:
{
Description: The error code for the copy source. ,
}
string ,
x-ms-copy-source-status-code:
{
Description: The status code for the copy source. ,
}
integer ,
x-ms-error-code:
{
Description: The error code. ,
}
string ,
}
,
$schema:
{
Description: The error response. ,
}
{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
CopySourceStatusCode:
{
Description: Copy source status code ,
Format: int32 ,
Required: False ,
}
integer ,
CopySourceErrorCode:
{
Description: Copy source error code ,
Required: False ,
}
string ,
CopySourceErrorMessage:
{
Description: Copy source error message ,
Required: False ,
}
string ,
}
,
}
Blob_Delete (updated)
Description :  If the storage account's soft delete feature is disabled then, when a blob is deleted, it is permanently removed from the storage account. If the storage account's soft delete feature is enabled, then, when a blob is deleted, it is marked for deletion and becomes inaccessible immediately. However, the blob service retains the blob or snapshot for the number of days specified by the DeleteRetentionPolicy section of [Storage service properties] (Set-Blob-Service-Properties.md). After the specified number of days has passed, the blob's data is permanently removed from the storage account. Note that you continue to be charged for the soft-deleted blob's storage until it is permanently removed. Use the List Blobs API and specify the \"include=deleted\" query parameter to discover which blobs and snapshots have been soft deleted. You can then use the Undelete Blob API to restore a soft-deleted blob. All other operations on a soft-deleted blob or snapshot causes the service to return an HTTP status code of 404 (ResourceNotFound).
Reference :  Link ¶

⚶ Changes

{
  "#id": "Blob_Delete",
  "$responses": {
    "default": {
      "$properties": {
        "@added_b5b183745db2439487507303f0c7fa15": {
          "#name": "Code",
          "Description": "The error code.",
          "Required": false,
          "Type": "string"
        },
        "@added_631a7e7e597c4939a132ea19c3709ff3": {
          "#name": "Message",
          "Description": "The error message.",
          "Required": false,
          "Type": "string"
        },
        "@added_06534e099c58436a86ce02dc5dee43a9": {
          "#name": "CopySourceStatusCode",
          "Description": "Copy source status code",
          "Format": "int32",
          "Required": false,
          "Type": "integer"
        },
        "@added_f13a5e13394c40e1b8c71972002ed064": {
          "#name": "CopySourceErrorCode",
          "Description": "Copy source error code",
          "Required": false,
          "Type": "string"
        },
        "@added_9d8aa96cae50442c9c4f1403815abd45": {
          "#name": "CopySourceErrorMessage",
          "Description": "Copy source error message",
          "Required": false,
          "Type": "string"
        },
        "@removed_d0e28e2548a44350a9c6bb042deb1cb3": {
          "#name": "code",
          "Description": "The error code.",
          "Required": false,
          "Type": "string"
        },
        "@removed_5d04c3aef65f41bcbbc391530f5418f1": {
          "#name": "message",
          "Description": "The error message.",
          "Required": false,
          "Type": "string"
        },
        "@removed_87cbb03b57f8492486a3711e75bbeccf": {
          "#name": "copySourceStatusCode",
          "Description": "Copy source status code",
          "Format": "int32",
          "Required": false,
          "Type": "integer"
        },
        "@removed_38c7b24bf10e4e77b4094aea7f177602": {
          "#name": "copySourceErrorCode",
          "Description": "Copy source error code",
          "Required": false,
          "Type": "string"
        },
        "@removed_d345a235b9a542e6b9184c397034d4a4": {
          "#name": "copySourceErrorMessage",
          "Description": "Copy source error message",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

DELETE:  /{containerName}/{blobName}
{
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
containerName:
{
Description: The name of the container. ,
Required: True ,
}
string ,
blobName:
{
Description: The name of the blob. ,
Required: True ,
}
string ,
snapshot:
{
Description: The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. For more information on working with blob snapshots, see Creating a Snapshot of a Blob. ,
Required: False ,
}
string ,
versionid:
{
Description: The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to operate on. It's for service version 2019-10-10 and newer. ,
Required: False ,
}
string ,
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. ,
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-delete-snapshots:
{
Description: Required if the blob has associated snapshots. Specify one of the following two options: include: Delete the base blob and all of its snapshots. only: Delete only the blob's snapshots and not the blob itself ,
Required: False ,
}
string ,
If-Modified-Since:
{
Description: A date-time value. A request is made under the condition that the resource has been modified since the specified date-time. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
If-Unmodified-Since:
{
Description: A date-time value. A request is made under the condition that the resource has not been modified since the specified date-time. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
If-None-Match:
{
Description: A condition that must be met in order for the request to be processed. ,
Required: False ,
}
string ,
If-Match:
{
Description: A condition that must be met in order for the request to be processed. ,
Required: False ,
}
string ,
x-ms-if-tags:
{
Description: Specify a SQL where clause on blob tags to operate only on blobs with a matching value. ,
Required: False ,
}
string ,
deletetype:
{
Description: Optional. Only possible value is 'permanent', which specifies to permanently delete a blob if blob soft delete is enabled. ,
Required: False ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
date:
{
Description: 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: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
x-ms-request-id:
{
Description: An opaque, globally-unique, server-generated string identifier for the request. ,
}
string ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-copy-source-error-code:
{
Description: The error code for the copy source. ,
}
string ,
x-ms-copy-source-status-code:
{
Description: The status code for the copy source. ,
}
integer ,
x-ms-error-code:
{
Description: The error code. ,
}
string ,
}
,
$schema:
{
Description: The error response. ,
}
{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
CopySourceStatusCode:
{
Description: Copy source status code ,
Format: int32 ,
Required: False ,
}
integer ,
CopySourceErrorCode:
{
Description: Copy source error code ,
Required: False ,
}
string ,
CopySourceErrorMessage:
{
Description: Copy source error message ,
Required: False ,
}
string ,
}
,
}
Blob_GetProperties (updated)
Description :  The Get Properties operation returns all user-defined metadata, standard HTTP properties, and system properties for the blob. It does not return the content of the blob.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Blob_GetProperties",
  "$responses": {
    "default": {
      "$properties": {
        "@added_1b4f79d887a948299a8d5f55934b39e5": {
          "#name": "Code",
          "Description": "The error code.",
          "Required": false,
          "Type": "string"
        },
        "@added_cb2a7f730cd0435bb05fd635cb8f5ef7": {
          "#name": "Message",
          "Description": "The error message.",
          "Required": false,
          "Type": "string"
        },
        "@added_82b0e70531b14b9f93b3ebaf1ddc79da": {
          "#name": "CopySourceStatusCode",
          "Description": "Copy source status code",
          "Format": "int32",
          "Required": false,
          "Type": "integer"
        },
        "@added_8966f9166d4249e0b09413b261522f60": {
          "#name": "CopySourceErrorCode",
          "Description": "Copy source error code",
          "Required": false,
          "Type": "string"
        },
        "@added_d54c475c812f4f5e823737b80bb3bba0": {
          "#name": "CopySourceErrorMessage",
          "Description": "Copy source error message",
          "Required": false,
          "Type": "string"
        },
        "@removed_6e3f2f1e01524fc5915a9fe5c2c55098": {
          "#name": "code",
          "Description": "The error code.",
          "Required": false,
          "Type": "string"
        },
        "@removed_c8b74f1947f54888ad5309f54609cf9d": {
          "#name": "message",
          "Description": "The error message.",
          "Required": false,
          "Type": "string"
        },
        "@removed_d61eea1959d44a08b2cd475edda0626c": {
          "#name": "copySourceStatusCode",
          "Description": "Copy source status code",
          "Format": "int32",
          "Required": false,
          "Type": "integer"
        },
        "@removed_3b74aa8c25894cda8b23efaedac859ea": {
          "#name": "copySourceErrorCode",
          "Description": "Copy source error code",
          "Required": false,
          "Type": "string"
        },
        "@removed_fe211dee87904cf59031db06b25163eb": {
          "#name": "copySourceErrorMessage",
          "Description": "Copy source error message",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

HEAD:  /{containerName}/{blobName}
{
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
containerName:
{
Description: The name of the container. ,
Required: True ,
}
string ,
blobName:
{
Description: The name of the blob. ,
Required: True ,
}
string ,
snapshot:
{
Description: The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. For more information on working with blob snapshots, see Creating a Snapshot of a Blob. ,
Required: False ,
}
string ,
versionid:
{
Description: The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to operate on. It's for service version 2019-10-10 and newer. ,
Required: False ,
}
string ,
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. ,
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-encryption-key:
{
Description: Optional. Version 2019-07-07 and later. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, the request will be encrypted with the root account key. ,
Required: False ,
}
string ,
x-ms-encryption-key-sha256:
{
Description: Optional. Version 2019-07-07 and later. Specifies the SHA256 hash of the encryption key used to encrypt the data provided in the request. This header is only used for encryption with a customer-provided key. If the request is authenticated with a client token, this header should be specified using the SHA256 hash of the encryption key. ,
Required: False ,
}
string ,
x-ms-encryption-algorithm:
{
Description: Optional. Version 2019-07-07 and later. Specifies the algorithm to use for encryption. If not specified, the default is AES256. ,
Required: False ,
}
string ,
If-Modified-Since:
{
Description: A date-time value. A request is made under the condition that the resource has been modified since the specified date-time. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
If-Unmodified-Since:
{
Description: A date-time value. A request is made under the condition that the resource has not been modified since the specified date-time. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
If-None-Match:
{
Description: A condition that must be met in order for the request to be processed. ,
Required: False ,
}
string ,
If-Match:
{
Description: A condition that must be met in order for the request to be processed. ,
Required: False ,
}
string ,
x-ms-if-tags:
{
Description: Specify a SQL where clause on blob tags to operate only on blobs with a matching value. ,
Required: False ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
accept-ranges:
{
Description: Indicates that the service supports requests for partial blob content. ,
}
string ,
cache-control:
{
Description: This header is returned if it was previously specified for the blob. ,
}
string ,
content-disposition:
{
Description: This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified. ,
}
string ,
content-encoding:
{
Description: This header returns the value that was specified for the Content-Encoding request header ,
}
string ,
content-language:
{
Description: This header returns the value that was specified for the Content-Language request header. ,
}
string ,
content-length:
{
Description: The number of bytes present in the response body. ,
}
integer ,
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 ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
string ,
etag:
{
Description: The ETag contains a value that you can use to perform operations conditionally. ,
}
string ,
last-modified:
{
Description: The date/time that the container was last modified. ,
}
string ,
x-ms-access-tier:
{
Description: The tier of page blob on a premium storage account or tier of block blob on blob storage LRS accounts. For a list of allowed premium page blob tiers, see https://learn.microsoft.com/azure/virtual-machines/disks-types#premium-ssd. For blob storage LRS accounts, valid values are Hot/Cool/Archive. ,
}
string ,
x-ms-access-tier-change-time:
{
Description: The time the tier was changed on the object. This is only returned if the tier on the block blob was ever set. ,
}
string ,
x-ms-access-tier-inferred:
{
Description: For page blobs on a premium storage account only. If the access tier is not explicitly set on the blob, the tier is inferred based on its content length and this header will be returned with true value. ,
}
boolean ,
x-ms-archive-status:
{
Description: For blob storage LRS accounts, valid values are rehydrate-pending-to-hot/rehydrate-pending-to-cool. If the blob is being rehydrated and is not complete then this header is returned indicating that rehydrate is pending and also tells the destination tier. ,
}
string ,
x-ms-blob-committed-block-count:
{
Description: The number of committed blocks present in the blob. This header is returned only for append blobs. ,
}
integer ,
x-ms-blob-sealed:
{
Description: If this blob has been sealed ,
}
boolean ,
x-ms-blob-sequence-number:
{
Description: The current sequence number for a page blob. This header is not returned for block blobs or append blobs. ,
}
integer ,
x-ms-blob-type:
{
Description: The type of the blob. ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
x-ms-copy-completion-time:
{
Description: Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List. ,
}
string ,
x-ms-copy-destination-snapshot:
{
Description: Included if the blob is incremental copy blob or incremental copy snapshot, if x-ms-copy-status is success. Snapshot time of the last successful incremental copy snapshot for this blob. ,
}
string ,
x-ms-copy-id:
{
Description: String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy. ,
}
string ,
x-ms-copy-progress:
{
Description: Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob. Can show between 0 and Content-Length bytes copied. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List ,
}
string ,
x-ms-copy-source:
{
Description: URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List. ,
}
string ,
x-ms-copy-status:
{
Description: State of the copy operation identified by x-ms-copy-id. ,
}
string ,
x-ms-copy-status-description:
{
Description: Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List ,
}
string ,
x-ms-creation-time:
{
Description: Returns the date and time the blob was created. ,
}
string ,
x-ms-encryption-key-sha256:
{
Description: The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key. ,
}
string ,
x-ms-encryption-scope:
{
Description: If the blob 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 whole blob'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 ,
x-ms-expiry-time:
{
Description: The time this blob will expire. ,
}
string ,
x-ms-immutability-policy-mode:
{
Description: Indicates the immutability policy mode of the blob. ,
}
string ,
x-ms-immutability-policy-until-date:
{
Description: UTC date/time value generated by the service that indicates the time at which the blob immutability policy will expire. ,
}
string ,
x-ms-incremental-copy:
{
Description: Included if the blob is incremental copy blob. ,
}
boolean ,
x-ms-is-current-version:
{
Description: The value of this header indicates whether version of this blob is a current version, see also x-ms-version-id header. ,
}
boolean ,
x-ms-last-access-time:
{
Description: UTC date/time value generated by the service that indicates the time at which the blob was last read or written to ,
}
string ,
x-ms-lease-duration:
{
Description: Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires. A non-infinite lease can be between 15 and 60 seconds. A lease duration cannot be changed using renew or change. ,
}
string ,
x-ms-lease-state:
{
Description: Lease state of the blob. ,
}
string ,
x-ms-lease-status:
{
Description: The lease status of the blob. ,
}
string ,
x-ms-legal-hold:
{
Description: Specifies the legal hold status to set on the blob. ,
}
boolean ,
x-ms-meta:
{
Description: The metadata headers. ,
}
string ,
x-ms-or:
{
Description: Optional. Only valid when Object Replication is enabled for the storage container and on the source blob of the replication. When retrieving this header, it will return the header with the policy id and rule id (e.g. x-ms-or-policyid_ruleid), and the value will be the status of the replication (e.g. complete, failed). ,
}
string ,
x-ms-or-policy-id:
{
Description: Optional. Only valid when Object Replication is enabled for the storage container and on the destination blob of the replication. ,
}
string ,
x-ms-rehydrate-priority:
{
Description: If an object is in rehydrate pending state then this header is returned with priority of rehydrate. Valid values are High and Standard. ,
}
string ,
x-ms-request-id:
{
Description: An opaque, globally-unique, server-generated string identifier for the request. ,
}
string ,
x-ms-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-tag-count:
{
Description: The number of tags associated with the blob ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
}
string ,
x-ms-version-id:
{
Description: A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-copy-source-error-code:
{
Description: The error code for the copy source. ,
}
string ,
x-ms-copy-source-status-code:
{
Description: The status code for the copy source. ,
}
integer ,
x-ms-error-code:
{
Description: The error code. ,
}
string ,
}
,
$schema:
{
Description: The error response. ,
}
{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
CopySourceStatusCode:
{
Description: Copy source status code ,
Format: int32 ,
Required: False ,
}
integer ,
CopySourceErrorCode:
{
Description: Copy source error code ,
Required: False ,
}
string ,
CopySourceErrorMessage:
{
Description: Copy source error message ,
Required: False ,
}
string ,
}
,
}