Microsoft.BlobStorage (stable:2025-01-05)

2025/03/19 • 69 updated methods

Service_SetProperties (updated)
Description :  Sets properties for a storage account's Blob service endpoint, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules
Reference :  Link ¶

⚶ Changes

{
  "#id": "Service_SetProperties",
  "$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:  /?restype=service&comp=properties
{
StorageServiceProperties:
{
Description: The StorageService properties. ,
Required: True ,
}
{
Logging:
{
Description: Azure Analytics Logging settings. ,
Required: False ,
}
{
Version:
{
Description: The version of Storage Analytics to configure. ,
Required: True ,
}
string ,
Delete:
{
Description: Indicates whether all delete requests should be logged. ,
Required: True ,
}
boolean ,
Read:
{
Description: Indicates whether all read requests should be logged. ,
Required: True ,
}
boolean ,
Write:
{
Description: Indicates whether all write requests should be logged. ,
Required: True ,
}
boolean ,
RetentionPolicy:
{
Description: the retention policy which determines how long the associated data should persist ,
Required: True ,
}
{
Enabled:
{
Description: Indicates whether a retention policy is enabled for the storage service ,
Required: True ,
}
boolean ,
Days:
{
Description: Indicates the number of days that metrics or logging or soft-deleted data should be retained. All data older than this value will be deleted ,
Required: False ,
}
integer ,
AllowPermanentDelete:
{
Description: Indicates whether permanent delete is allowed on this storage account. ,
Required: False ,
}
boolean ,
}
,
}
,
HourMetrics:
{
Description: a summary of request statistics grouped by API in hour or minute aggregates for blobs ,
Required: False ,
}
{
Version:
{
Description: The version of Storage Analytics to configure. ,
Required: False ,
}
string ,
Enabled:
{
Description: Indicates whether metrics are enabled for the Blob service. ,
Required: True ,
}
boolean ,
IncludeAPIs:
{
Description: Indicates whether metrics should generate summary statistics for called API operations. ,
Required: False ,
}
boolean ,
RetentionPolicy:
{
Description: the retention policy which determines how long the associated data should persist ,
Required: False ,
}
{
Enabled:
{
Description: Indicates whether a retention policy is enabled for the storage service ,
Required: True ,
}
boolean ,
Days:
{
Description: Indicates the number of days that metrics or logging or soft-deleted data should be retained. All data older than this value will be deleted ,
Required: False ,
}
integer ,
AllowPermanentDelete:
{
Description: Indicates whether permanent delete is allowed on this storage account. ,
Required: False ,
}
boolean ,
}
,
}
,
MinuteMetrics:
{
Description: a summary of request statistics grouped by API in hour or minute aggregates for blobs ,
Required: False ,
}
{
Version:
{
Description: The version of Storage Analytics to configure. ,
Required: False ,
}
string ,
Enabled:
{
Description: Indicates whether metrics are enabled for the Blob service. ,
Required: True ,
}
boolean ,
IncludeAPIs:
{
Description: Indicates whether metrics should generate summary statistics for called API operations. ,
Required: False ,
}
boolean ,
RetentionPolicy:
{
Description: the retention policy which determines how long the associated data should persist ,
Required: False ,
}
{
Enabled:
{
Description: Indicates whether a retention policy is enabled for the storage service ,
Required: True ,
}
boolean ,
Days:
{
Description: Indicates the number of days that metrics or logging or soft-deleted data should be retained. All data older than this value will be deleted ,
Required: False ,
}
integer ,
AllowPermanentDelete:
{
Description: Indicates whether permanent delete is allowed on this storage account. ,
Required: False ,
}
boolean ,
}
,
}
,
Cors:
{
Description: The set of CORS rules. ,
Required: False ,
}
[
{
AllowedOrigins:
{
Description: The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive match with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS. ,
Required: True ,
}
string ,
AllowedMethods:
{
Description: The methods (HTTP request verbs) that the origin domain may use for a CORS request. (comma separated) ,
Required: True ,
}
string ,
AllowedHeaders:
{
Description: the request headers that the origin domain may specify on the CORS request. ,
Required: True ,
}
string ,
ExposedHeaders:
{
Description: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer ,
Required: True ,
}
string ,
MaxAgeInSeconds:
{
Description: The maximum amount time that a browser should cache the preflight OPTIONS request. ,
Required: True ,
}
integer ,
}
,
]
,
DefaultServiceVersion:
{
Description: The default version to use for requests to the Blob service if an incoming request's version is not specified. Possible values include version 2008-10-27 and all more recent versions ,
Required: False ,
}
string ,
DeleteRetentionPolicy:
{
Description: the retention policy which determines how long the associated data should persist ,
Required: False ,
}
{
Enabled:
{
Description: Indicates whether a retention policy is enabled for the storage service ,
Required: True ,
}
boolean ,
Days:
{
Description: Indicates the number of days that metrics or logging or soft-deleted data should be retained. All data older than this value will be deleted ,
Required: False ,
}
integer ,
AllowPermanentDelete:
{
Description: Indicates whether permanent delete is allowed on this storage account. ,
Required: False ,
}
boolean ,
}
,
StaticWebsite:
{
Description: The properties that enable an account to host a static website ,
Required: False ,
}
{
Enabled:
{
Description: Indicates whether this account is hosting a static website ,
Required: True ,
}
boolean ,
IndexDocument:
{
Description: The default name of the index page under each directory ,
Required: False ,
}
string ,
ErrorDocument404Path:
{
Description: The absolute path of the custom 404 page ,
Required: False ,
}
string ,
DefaultIndexDocumentPath:
{
Description: Absolute path of the default index page ,
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 (202)

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

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Service_GetProperties (updated)
Description :  gets the properties of a storage account's Blob service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Service_GetProperties",
  "$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:  /?restype=service&comp=properties
{
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:
{
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 ,
}
,
$schema:
{
Description: Storage Service Properties. ,
}
{
Logging:
{
Description: Azure Analytics Logging settings. ,
Required: False ,
}
{
Version:
{
Description: The version of Storage Analytics to configure. ,
Required: True ,
}
string ,
Delete:
{
Description: Indicates whether all delete requests should be logged. ,
Required: True ,
}
boolean ,
Read:
{
Description: Indicates whether all read requests should be logged. ,
Required: True ,
}
boolean ,
Write:
{
Description: Indicates whether all write requests should be logged. ,
Required: True ,
}
boolean ,
RetentionPolicy:
{
Description: the retention policy which determines how long the associated data should persist ,
Required: True ,
}
{
Enabled:
{
Description: Indicates whether a retention policy is enabled for the storage service ,
Required: True ,
}
boolean ,
Days:
{
Description: Indicates the number of days that metrics or logging or soft-deleted data should be retained. All data older than this value will be deleted ,
Required: False ,
}
integer ,
AllowPermanentDelete:
{
Description: Indicates whether permanent delete is allowed on this storage account. ,
Required: False ,
}
boolean ,
}
,
}
,
HourMetrics:
{
Description: a summary of request statistics grouped by API in hour or minute aggregates for blobs ,
Required: False ,
}
{
Version:
{
Description: The version of Storage Analytics to configure. ,
Required: False ,
}
string ,
Enabled:
{
Description: Indicates whether metrics are enabled for the Blob service. ,
Required: True ,
}
boolean ,
IncludeAPIs:
{
Description: Indicates whether metrics should generate summary statistics for called API operations. ,
Required: False ,
}
boolean ,
RetentionPolicy:
{
Description: the retention policy which determines how long the associated data should persist ,
Required: False ,
}
{
Enabled:
{
Description: Indicates whether a retention policy is enabled for the storage service ,
Required: True ,
}
boolean ,
Days:
{
Description: Indicates the number of days that metrics or logging or soft-deleted data should be retained. All data older than this value will be deleted ,
Required: False ,
}
integer ,
AllowPermanentDelete:
{
Description: Indicates whether permanent delete is allowed on this storage account. ,
Required: False ,
}
boolean ,
}
,
}
,
MinuteMetrics:
{
Description: a summary of request statistics grouped by API in hour or minute aggregates for blobs ,
Required: False ,
}
{
Version:
{
Description: The version of Storage Analytics to configure. ,
Required: False ,
}
string ,
Enabled:
{
Description: Indicates whether metrics are enabled for the Blob service. ,
Required: True ,
}
boolean ,
IncludeAPIs:
{
Description: Indicates whether metrics should generate summary statistics for called API operations. ,
Required: False ,
}
boolean ,
RetentionPolicy:
{
Description: the retention policy which determines how long the associated data should persist ,
Required: False ,
}
{
Enabled:
{
Description: Indicates whether a retention policy is enabled for the storage service ,
Required: True ,
}
boolean ,
Days:
{
Description: Indicates the number of days that metrics or logging or soft-deleted data should be retained. All data older than this value will be deleted ,
Required: False ,
}
integer ,
AllowPermanentDelete:
{
Description: Indicates whether permanent delete is allowed on this storage account. ,
Required: False ,
}
boolean ,
}
,
}
,
Cors:
{
Description: The set of CORS rules. ,
Required: False ,
}
[
{
AllowedOrigins:
{
Description: The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive match with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS. ,
Required: True ,
}
string ,
AllowedMethods:
{
Description: The methods (HTTP request verbs) that the origin domain may use for a CORS request. (comma separated) ,
Required: True ,
}
string ,
AllowedHeaders:
{
Description: the request headers that the origin domain may specify on the CORS request. ,
Required: True ,
}
string ,
ExposedHeaders:
{
Description: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer ,
Required: True ,
}
string ,
MaxAgeInSeconds:
{
Description: The maximum amount time that a browser should cache the preflight OPTIONS request. ,
Required: True ,
}
integer ,
}
,
]
,
DefaultServiceVersion:
{
Description: The default version to use for requests to the Blob service if an incoming request's version is not specified. Possible values include version 2008-10-27 and all more recent versions ,
Required: False ,
}
string ,
DeleteRetentionPolicy:
{
Description: the retention policy which determines how long the associated data should persist ,
Required: False ,
}
{
Enabled:
{
Description: Indicates whether a retention policy is enabled for the storage service ,
Required: True ,
}
boolean ,
Days:
{
Description: Indicates the number of days that metrics or logging or soft-deleted data should be retained. All data older than this value will be deleted ,
Required: False ,
}
integer ,
AllowPermanentDelete:
{
Description: Indicates whether permanent delete is allowed on this storage account. ,
Required: False ,
}
boolean ,
}
,
StaticWebsite:
{
Description: The properties that enable an account to host a static website ,
Required: False ,
}
{
Enabled:
{
Description: Indicates whether this account is hosting a static website ,
Required: True ,
}
boolean ,
IndexDocument:
{
Description: The default name of the index page under each directory ,
Required: False ,
}
string ,
ErrorDocument404Path:
{
Description: The absolute path of the custom 404 page ,
Required: False ,
}
string ,
DefaultIndexDocumentPath:
{
Description: Absolute path of the default index page ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Service_GetStatistics (updated)
Description :  Retrieves statistics related to replication for the Blob service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Service_GetStatistics",
  "$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:  /?restype=service&comp=stats
{
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:
{
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: Stats for the storage service. ,
}
{
GeoReplication:
{
Description: Geo-Replication information for the Secondary Storage Service ,
Required: False ,
}
{
Status:
{
Description: The status of the secondary location ,
Enum:
{
live: No description available. ,
bootstrap: No description available. ,
unavailable: No description available. ,
}
,
Required: True ,
}
enum ,
LastSyncTime:
{
Description: A GMT date/time value, to the second. All primary writes preceding this value are guaranteed to be available for read operations at the secondary. Primary writes after this point in time may or may not be available for reads. ,
Format: date-time-rfc1123 ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Service_ListContainersSegment (updated)
Description :  The List Containers Segment operation returns a list of the containers under the specified account
Reference :  Link ¶

⚶ Changes

{
  "#id": "Service_ListContainersSegment",
  "$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:  /?comp=list
{
prefix:
{
Description: Filters the results to return only containers whose name begins with the specified prefix. ,
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: Specifies the maximum number of containers to return. If the request does not specify maxresults, or specifies a value greater than 5000, the server will return up to 5000 items. Note that if the listing operation crosses a partition boundary, then the service will return a continuation token for retrieving the remainder of the results. For this reason, it is possible that the service will return fewer results than specified by maxresults, or than the default of 5000. ,
Required: False ,
}
integer ,
include:
{
Description: Include this parameter to specify that the container's metadata be returned as part of the response body. ,
Required: False ,
}
array ,
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:
{
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 ,
}
,
$schema:
{
Description: An enumeration of containers ,
}
{
ServiceEndpoint:
{
Required: True ,
}
string ,
Prefix:
{
Required: False ,
}
string ,
Marker:
{
Required: False ,
}
string ,
MaxResults:
{
Required: False ,
}
integer ,
ContainerItems:
{
Required: True ,
}
[
{
Name:
{
Required: True ,
}
string ,
Deleted:
{
Required: False ,
}
boolean ,
Version:
{
Required: False ,
}
string ,
Properties:
{
Description: Properties of a container ,
Required: True ,
}
{
Last-Modified:
{
Format: date-time-rfc1123 ,
Required: True ,
}
string ,
Etag:
{
Required: True ,
}
string ,
LeaseStatus:
{
Enum:
{
locked: No description available. ,
unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
LeaseState:
{
Enum:
{
available: No description available. ,
leased: No description available. ,
expired: No description available. ,
breaking: No description available. ,
broken: No description available. ,
}
,
Required: False ,
}
enum ,
LeaseDuration:
{
Enum:
{
infinite: No description available. ,
fixed: No description available. ,
}
,
Required: False ,
}
enum ,
PublicAccess:
{
Enum:
{
container: No description available. ,
blob: No description available. ,
}
,
Required: False ,
}
enum ,
HasImmutabilityPolicy:
{
Required: False ,
}
boolean ,
HasLegalHold:
{
Required: False ,
}
boolean ,
DefaultEncryptionScope:
{
Required: False ,
}
string ,
DenyEncryptionScopeOverride:
{
Required: False ,
}
boolean ,
DeletedTime:
{
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
RemainingRetentionDays:
{
Required: False ,
}
integer ,
ImmutableStorageWithVersioningEnabled:
{
Description: Indicates if version level worm is enabled on this container. ,
Required: False ,
}
boolean ,
}
,
Metadata:
{
Required: False ,
}
object ,
}
,
]
,
NextMarker:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Service_GetUserDelegationKey (updated)
Description :  Retrieves a user delegation key for the Blob service. This is only a valid operation when using bearer token authentication.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Service_GetUserDelegationKey",
  "$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

POST:  /?restype=service&comp=userdelegationkey
{
KeyInfo:
{
Description: Key information ,
Required: True ,
}
{
Start:
{
Description: The date-time the key is active in ISO 8601 UTC time ,
Required: True ,
}
string ,
Expiry:
{
Description: The date-time the key expires in ISO 8601 UTC time ,
Required: True ,
}
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:
{
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: A user delegation key ,
}
{
SignedOid:
{
Description: The Azure Active Directory object ID in GUID format. ,
Required: True ,
}
string ,
SignedTid:
{
Description: The Azure Active Directory tenant ID in GUID format ,
Required: True ,
}
string ,
SignedStart:
{
Description: The date-time the key is active ,
Format: date-time ,
Required: True ,
}
string ,
SignedExpiry:
{
Description: The date-time the key expires ,
Format: date-time ,
Required: True ,
}
string ,
SignedService:
{
Description: Abbreviation of the Azure Storage service that accepts the key ,
Required: True ,
}
string ,
SignedVersion:
{
Description: The service version that created the key ,
Required: True ,
}
string ,
Value:
{
Description: The key as a base64 string ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Service_GetAccountInfo (updated)
Description :  Returns the sku name and account kind
Reference :  Link ¶

⚶ Changes

{
  "#id": "Service_GetAccountInfo",
  "$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:  /?restype=account&comp=properties
{
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)

{
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 ,
x-ms-sku-name:
{
Description: Identifies the sku name of the account ,
}
string ,
x-ms-account-kind:
{
Description: Identifies the account kind ,
}
string ,
x-ms-is-hns-enabled:
{
Description: Version 2019-07-07 and newer. Indicates if the account has a hierarchical namespace enabled. ,
}
boolean ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Service_SubmitBatch (updated)
Description :  The Batch operation allows multiple API calls to be embedded into a single HTTP request.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Service_SubmitBatch",
  "$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

POST:  /?comp=batch
{
body:
{
Description: Initial data ,
Required: True ,
}
object ,
Content-Length:
{
Description: The length of the request. ,
Format: int64 ,
Required: True ,
}
integer ,
Content-Type:
{
Description: Required. The value of this header must be multipart/mixed with a batch boundary. Example header value: multipart/mixed; boundary=batch_ ,
Required: True ,
}
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 batch requests, this is multipart/mixed; boundary=batchresponse_GUID ,
}
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 ,
}
,
$schema:
{
Format: file ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Service_FilterBlobs (updated)
Description :  The Filter Blobs operation enables callers to list blobs across all containers whose tags match a given search expression. Filter blobs searches across all containers within a storage account but can be scoped within the expression to a single container.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Service_FilterBlobs",
  "$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:  /?comp=blobs
{
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 ,
where:
{
Description: Filters the results to return only to return only blobs whose tags match the specified expression. ,
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: Specifies the maximum number of containers to return. If the request does not specify maxresults, or specifies a value greater than 5000, the server will return up to 5000 items. Note that if the listing operation crosses a partition boundary, then the service will return a continuation token for retrieving the remainder of the results. For this reason, it is possible that the service will return fewer results than specified by maxresults, or than the default of 5000. ,
Required: False ,
}
integer ,
include:
{
Description: Include this parameter to specify one or more datasets to include in the response. ,
Required: False ,
}
array ,
}

⚐ Response (200)

{
$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: 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: The result of a Filter Blobs API call ,
}
{
ServiceEndpoint:
{
Required: True ,
}
string ,
Where:
{
Required: True ,
}
string ,
Blobs:
{
Required: True ,
}
[
{
Name:
{
Required: True ,
}
string ,
ContainerName:
{
Required: True ,
}
string ,
Tags:
{
Description: Blob tags ,
Required: False ,
}
{
BlobTagSet:
{
Required: True ,
}
[
{
Key:
{
Required: True ,
}
string ,
Value:
{
Required: True ,
}
string ,
}
,
]
,
}
,
VersionId:
{
Required: False ,
}
string ,
IsCurrentVersion:
{
Required: False ,
}
boolean ,
}
,
]
,
NextMarker:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Container_Create (updated)
Description :  creates a new container under the specified account. If the container with the same name already exists, the operation fails
Reference :  Link ¶

⚶ Changes

{
  "#id": "Container_Create",
  "$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:  /{containerName}?restype=container
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. ,
Required: False ,
}
integer ,
x-ms-meta:
{
Description: Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. ,
Required: False ,
}
string ,
x-ms-blob-public-access:
{
Description: Specifies whether data in the container may be accessed publicly and the level of access ,
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 ,
x-ms-default-encryption-scope:
{
Description: Optional. Version 2019-07-07 and later. Specifies the default encryption scope to set on the container and use for all future writes. ,
Required: False ,
}
string ,
x-ms-deny-encryption-scope-override:
{
Description: Optional. Version 2019-07-07 and newer. If true, prevents any request from specifying a different encryption scope than the scope set on the container. ,
Required: False ,
}
boolean ,
}

⚐ Response (201)

{
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:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Container_GetProperties (updated)
Description :  returns all user-defined metadata and system properties for the specified container. The data returned does not include the container's list of blobs
Reference :  Link ¶

⚶ Changes

{
  "#id": "Container_GetProperties",
  "$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:  /{containerName}?restype=container
{
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-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-meta: string ,
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-lease-duration:
{
Description: When a blob is leased, specifies whether the lease is of infinite or fixed duration. ,
}
string ,
x-ms-lease-state:
{
Description: Lease state of the blob. ,
}
string ,
x-ms-lease-status:
{
Description: The current lease status 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 ,
x-ms-blob-public-access:
{
Description: Indicated whether data in the container may be accessed publicly and the level of access ,
}
string ,
x-ms-has-immutability-policy:
{
Description: Indicates whether the container has an immutability policy set on it. ,
}
boolean ,
x-ms-has-legal-hold:
{
Description: Indicates whether the container has a legal hold. ,
}
boolean ,
x-ms-default-encryption-scope:
{
Description: The default encryption scope for the container. ,
}
string ,
x-ms-deny-encryption-scope-override:
{
Description: Indicates whether the container's default encryption scope can be overriden. ,
}
boolean ,
x-ms-immutable-storage-with-versioning-enabled:
{
Description: Indicates whether version level worm is enabled on a container. ,
}
boolean ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Container_Delete (updated)
Description :  operation marks the specified container for deletion. The container and any blobs contained within it are later deleted during garbage collection
Reference :  Link ¶

⚶ Changes

{
  "#id": "Container_Delete",
  "$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

DELETE:  /{containerName}?restype=container
{
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 ,
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-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 (202)

{
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:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Container_SetMetadata (updated)
Description :  operation sets one or more user-defined name-value pairs for the specified container.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Container_SetMetadata",
  "$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:  /{containerName}?restype=container&comp=metadata
{
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-meta:
{
Description: Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. ,
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 ,
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)

{
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:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Container_GetAccessPolicy (updated)
Description :  gets the permissions for the specified container. The permissions indicate whether container data may be accessed publicly.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Container_GetAccessPolicy",
  "$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:  /{containerName}?restype=container&comp=acl
{
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-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:
{
x-ms-blob-public-access:
{
Description: Indicated whether data in the container may be accessed publicly and the level of access ,
}
string ,
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 ,
}
,
$schema:
{
Description: a collection of signed identifiers ,
}
{
Id:
{
Description: a unique id ,
Required: True ,
}
string ,
AccessPolicy:
{
Description: An Access policy ,
Required: True ,
}
{
Start:
{
Description: the date-time the policy is active ,
Format: date-time ,
Required: False ,
}
string ,
Expiry:
{
Description: the date-time the policy expires ,
Format: date-time ,
Required: False ,
}
string ,
Permission:
{
Description: the permissions for the acl policy ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Container_SetAccessPolicy (updated)
Description :  sets the permissions for the specified container. The permissions indicate whether blobs in a container may be accessed publicly.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Container_SetAccessPolicy",
  "$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:  /{containerName}?restype=container&comp=acl
{
containerAcl:
{
Description: the acls for the container ,
Required: False ,
}
{
Id:
{
Description: a unique id ,
Required: True ,
}
string ,
AccessPolicy:
{
Description: An Access policy ,
Required: True ,
}
{
Start:
{
Description: the date-time the policy is active ,
Format: date-time ,
Required: False ,
}
string ,
Expiry:
{
Description: the date-time the policy expires ,
Format: date-time ,
Required: False ,
}
string ,
Permission:
{
Description: the permissions for the acl policy ,
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-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-blob-public-access:
{
Description: Specifies whether data in the container may be accessed publicly and the level of access ,
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-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)

{
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:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Container_Restore (updated)
Description :  Restores a previously-deleted container.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Container_Restore",
  "$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:  /{containerName}?restype=container&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-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-deleted-container-name:
{
Description: Optional. Version 2019-12-12 and later. Specifies the name of the deleted container to restore. ,
Required: False ,
}
string ,
x-ms-deleted-container-version:
{
Description: Optional. Version 2019-12-12 and later. Specifies the version of the deleted container to restore. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
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:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Container_Rename (updated)
Description :  Renames an existing container.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Container_Rename",
  "$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:  /{containerName}?restype=container&comp=rename
{
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-source-container-name:
{
Description: Required. Specifies the name of the container to rename. ,
Required: True ,
}
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 ,
}

⚐ 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-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:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Container_SubmitBatch (updated)
Description :  The Batch operation allows multiple API calls to be embedded into a single HTTP request.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Container_SubmitBatch",
  "$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

POST:  /{containerName}?restype=container&comp=batch
{
body:
{
Description: Initial data ,
Required: True ,
}
object ,
Content-Length:
{
Description: The length of the request. ,
Format: int64 ,
Required: True ,
}
integer ,
Content-Type:
{
Description: Required. The value of this header must be multipart/mixed with a batch boundary. Example header value: multipart/mixed; boundary=batch_ ,
Required: True ,
}
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 (202)

{
$headers:
{
content-type:
{
Description: The media type of the body of the response. For batch requests, this is multipart/mixed; boundary=batchresponse_GUID ,
}
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 ,
}
,
$schema:
{
Format: file ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Container_FilterBlobs (updated)
Description :  The Filter Blobs operation enables callers to list blobs in a container whose tags match a given search expression. Filter blobs searches within the given container.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Container_FilterBlobs",
  "$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:  /{containerName}?restype=container&comp=blobs
{
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 ,
where:
{
Description: Filters the results to return only to return only blobs whose tags match the specified expression. ,
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: Specifies the maximum number of containers to return. If the request does not specify maxresults, or specifies a value greater than 5000, the server will return up to 5000 items. Note that if the listing operation crosses a partition boundary, then the service will return a continuation token for retrieving the remainder of the results. For this reason, it is possible that the service will return fewer results than specified by maxresults, or than the default of 5000. ,
Required: False ,
}
integer ,
include:
{
Description: Include this parameter to specify one or more datasets to include in the response. ,
Required: False ,
}
array ,
}

⚐ Response (200)

{
$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: 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: The result of a Filter Blobs API call ,
}
{
ServiceEndpoint:
{
Required: True ,
}
string ,
Where:
{
Required: True ,
}
string ,
Blobs:
{
Required: True ,
}
[
{
Name:
{
Required: True ,
}
string ,
ContainerName:
{
Required: True ,
}
string ,
Tags:
{
Description: Blob tags ,
Required: False ,
}
{
BlobTagSet:
{
Required: True ,
}
[
{
Key:
{
Required: True ,
}
string ,
Value:
{
Required: True ,
}
string ,
}
,
]
,
}
,
VersionId:
{
Required: False ,
}
string ,
IsCurrentVersion:
{
Required: False ,
}
boolean ,
}
,
]
,
NextMarker:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Container_AcquireLease (updated)
Description :  [Update] establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite
Reference :  Link ¶

⚶ Changes

{
  "#id": "Container_AcquireLease",
  "$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:  /{containerName}?comp=lease&restype=container&acquire
{
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-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. ,
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 ,
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-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 (201)

{
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-lease-id:
{
Description: Uniquely identifies a container's lease ,
}
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:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Container_ReleaseLease (updated)
Description :  [Update] establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite
Reference :  Link ¶

⚶ Changes

{
  "#id": "Container_ReleaseLease",
  "$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:  /{containerName}?comp=lease&restype=container&release
{
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: Specifies the current lease ID on the resource. ,
Required: True ,
}
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-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)

{
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:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Container_RenewLease (updated)
Description :  [Update] establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite
Reference :  Link ¶

⚶ Changes

{
  "#id": "Container_RenewLease",
  "$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:  /{containerName}?comp=lease&restype=container&renew
{
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: Specifies the current lease ID on the resource. ,
Required: True ,
}
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-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)

{
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-lease-id:
{
Description: Uniquely identifies a container's lease ,
}
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:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Container_BreakLease (updated)
Description :  [Update] establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite
Reference :  Link ¶

⚶ Changes

{
  "#id": "Container_BreakLease",
  "$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:  /{containerName}?comp=lease&restype=container&break
{
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-break-period:
{
Description: For a break operation, proposed duration the lease should continue before it is broken, in seconds, between 0 and 60. This break period is only used if it is shorter than the time remaining on the lease. If longer, the time remaining on the lease is used. A new lease will not be available before the break period has expired, but the lease may be held for longer than the break period. If this header does not appear with a break operation, a fixed-duration lease breaks after the remaining lease period elapses, and an infinite lease breaks immediately. ,
Required: False ,
}
integer ,
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-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 (202)

{
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-lease-time:
{
Description: Approximate time remaining in the lease period, in seconds. ,
}
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: 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:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Container_ChangeLease (updated)
Description :  [Update] establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite
Reference :  Link ¶

⚶ Changes

{
  "#id": "Container_ChangeLease",
  "$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:  /{containerName}?comp=lease&restype=container&change
{
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: Specifies the current lease ID on the resource. ,
Required: True ,
}
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: True ,
}
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-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)

{
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-lease-id:
{
Description: Uniquely identifies a container's lease ,
}
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:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Container_ListBlobFlatSegment (updated)
Description :  [Update] The List Blobs operation returns a list of the blobs under the specified container
Reference :  Link ¶

⚶ Changes

{
  "#id": "Container_ListBlobFlatSegment",
  "$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:  /{containerName}?restype=container&comp=list&flat
{
prefix:
{
Description: Filters the results to return only containers whose name begins with the specified prefix. ,
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: Specifies the maximum number of containers to return. If the request does not specify maxresults, or specifies a value greater than 5000, the server will return up to 5000 items. Note that if the listing operation crosses a partition boundary, then the service will return a continuation token for retrieving the remainder of the results. For this reason, it is possible that the service will return fewer results than specified by maxresults, or than the default of 5000. ,
Required: False ,
}
integer ,
include:
{
Description: Include this parameter to specify one or more datasets to include in the response. ,
Required: False ,
}
array ,
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 ,
Segment:
{
Required: True ,
}
{
BlobItems:
{
Required: True ,
}
[
{
Name:
{
Required: True ,
}
{
Encoded:
{
Description: Indicates if the blob name is encoded. ,
Required: False ,
}
boolean ,
content:
{
Description: The name of the blob. ,
Required: False ,
}
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 ,
BlobType:
{
Enum:
{
BlockBlob: No description available. ,
PageBlob: No description available. ,
AppendBlob: No description available. ,
}
,
Required: False ,
}
enum ,
LeaseStatus:
{
Enum:
{
locked: No description available. ,
unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
LeaseState:
{
Enum:
{
available: No description available. ,
leased: No description available. ,
expired: No description available. ,
breaking: No description available. ,
broken: No description available. ,
}
,
Required: False ,
}
enum ,
LeaseDuration:
{
Enum:
{
infinite: No description available. ,
fixed: No description available. ,
}
,
Required: False ,
}
enum ,
CopyId:
{
Required: False ,
}
string ,
CopyStatus:
{
Enum:
{
pending: No description available. ,
success: No description available. ,
aborted: No description available. ,
failed: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
AccessTier:
{
Enum:
{
P4: No description available. ,
P6: No description available. ,
P10: No description available. ,
P15: No description available. ,
P20: No description available. ,
P30: No description available. ,
P40: No description available. ,
P50: No description available. ,
P60: No description available. ,
P70: No description available. ,
P80: No description available. ,
Hot: No description available. ,
Cool: No description available. ,
Archive: No description available. ,
Premium: No description available. ,
Cold: No description available. ,
}
,
Required: False ,
}
enum ,
AccessTierInferred:
{
Required: False ,
}
boolean ,
ArchiveStatus:
{
Enum:
{
rehydrate-pending-to-hot: No description available. ,
rehydrate-pending-to-cool: No description available. ,
rehydrate-pending-to-cold: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
RehydratePriority:
{
Description: If an object is in rehydrate pending state then this header is returned with priority of rehydrate. Valid values are High and Standard. ,
Enum:
{
High: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
LastAccessTime:
{
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
ImmutabilityPolicyUntilDate:
{
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
ImmutabilityPolicyMode:
{
Enum:
{
Mutable: No description available. ,
Unlocked: No description available. ,
Locked: No description available. ,
}
,
Required: False ,
}
enum ,
LegalHold:
{
Required: False ,
}
boolean ,
}
,
Metadata:
{
Required: False ,
}
{
Encrypted:
{
Required: False ,
}
string ,
}
,
BlobTags:
{
Description: Blob tags ,
Required: False ,
}
{
BlobTagSet:
{
Required: True ,
}
[
{
Key:
{
Required: True ,
}
string ,
Value:
{
Required: True ,
}
string ,
}
,
]
,
}
,
ObjectReplicationMetadata:
{
Required: False ,
}
object ,
HasVersionsOnly:
{
Required: False ,
}
boolean ,
}
,
]
,
}
,
NextMarker:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Container_ListBlobHierarchySegment (updated)
Description :  [Update] The List Blobs operation returns a list of the blobs under the specified container
Reference :  Link ¶

⚶ Changes

{
  "#id": "Container_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:  /{containerName}?restype=container&comp=list&hierarchy
{
prefix:
{
Description: Filters the results to return only containers whose name begins with 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: True ,
}
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: Specifies the maximum number of containers to return. If the request does not specify maxresults, or specifies a value greater than 5000, the server will return up to 5000 items. Note that if the listing operation crosses a partition boundary, then the service will return a continuation token for retrieving the remainder of the results. For this reason, it is possible that the service will return fewer results than specified by maxresults, or than the default of 5000. ,
Required: False ,
}
integer ,
include:
{
Description: Include this parameter to specify one or more datasets to include in the response. ,
Required: False ,
}
array ,
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 ,
}
{
Encoded:
{
Description: Indicates if the blob name is encoded. ,
Required: False ,
}
boolean ,
content:
{
Description: The name of the blob. ,
Required: False ,
}
string ,
}
,
}
,
]
,
BlobItems:
{
Required: True ,
}
[
{
Name:
{
Required: True ,
}
{
Encoded:
{
Description: Indicates if the blob name is encoded. ,
Required: False ,
}
boolean ,
content:
{
Description: The name of the blob. ,
Required: False ,
}
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 ,
BlobType:
{
Enum:
{
BlockBlob: No description available. ,
PageBlob: No description available. ,
AppendBlob: No description available. ,
}
,
Required: False ,
}
enum ,
LeaseStatus:
{
Enum:
{
locked: No description available. ,
unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
LeaseState:
{
Enum:
{
available: No description available. ,
leased: No description available. ,
expired: No description available. ,
breaking: No description available. ,
broken: No description available. ,
}
,
Required: False ,
}
enum ,
LeaseDuration:
{
Enum:
{
infinite: No description available. ,
fixed: No description available. ,
}
,
Required: False ,
}
enum ,
CopyId:
{
Required: False ,
}
string ,
CopyStatus:
{
Enum:
{
pending: No description available. ,
success: No description available. ,
aborted: No description available. ,
failed: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
AccessTier:
{
Enum:
{
P4: No description available. ,
P6: No description available. ,
P10: No description available. ,
P15: No description available. ,
P20: No description available. ,
P30: No description available. ,
P40: No description available. ,
P50: No description available. ,
P60: No description available. ,
P70: No description available. ,
P80: No description available. ,
Hot: No description available. ,
Cool: No description available. ,
Archive: No description available. ,
Premium: No description available. ,
Cold: No description available. ,
}
,
Required: False ,
}
enum ,
AccessTierInferred:
{
Required: False ,
}
boolean ,
ArchiveStatus:
{
Enum:
{
rehydrate-pending-to-hot: No description available. ,
rehydrate-pending-to-cool: No description available. ,
rehydrate-pending-to-cold: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
RehydratePriority:
{
Description: If an object is in rehydrate pending state then this header is returned with priority of rehydrate. Valid values are High and Standard. ,
Enum:
{
High: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
LastAccessTime:
{
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
ImmutabilityPolicyUntilDate:
{
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
ImmutabilityPolicyMode:
{
Enum:
{
Mutable: No description available. ,
Unlocked: No description available. ,
Locked: No description available. ,
}
,
Required: False ,
}
enum ,
LegalHold:
{
Required: False ,
}
boolean ,
}
,
Metadata:
{
Required: False ,
}
{
Encrypted:
{
Required: False ,
}
string ,
}
,
BlobTags:
{
Description: Blob tags ,
Required: False ,
}
{
BlobTagSet:
{
Required: True ,
}
[
{
Key:
{
Required: True ,
}
string ,
Value:
{
Required: True ,
}
string ,
}
,
]
,
}
,
ObjectReplicationMetadata:
{
Required: False ,
}
object ,
HasVersionsOnly:
{
Required: False ,
}
boolean ,
}
,
]
,
}
,
NextMarker:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Container_GetAccountInfo (updated)
Description :  Returns the sku name and account kind
Reference :  Link ¶

⚶ Changes

{
  "#id": "Container_GetAccountInfo",
  "$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:  /{containerName}?restype=account&comp=properties
{
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)

{
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 ,
x-ms-sku-name:
{
Description: Identifies the sku name of the account ,
}
string ,
x-ms-account-kind:
{
Description: Identifies the account kind ,
}
string ,
x-ms-is-hns-enabled:
{
Description: Version 2019-07-07 and newer. Indicates if the account has a hierarchical namespace enabled. ,
}
boolean ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
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",
  "$parameters": [
    {
      "#name": "snapshot",
      "Description": {
        "new": "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.",
        "old": "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."
      }
    },
    {
      "#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:  /{containerName}/{blob}
{
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. ,
Required: False ,
}
integer ,
x-ms-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: When set to true and specified together with the Range, 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. 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 ,
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 ,
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 ,
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-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:
{
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-creation-time:
{
Description: Returns the date and time the blob was created. ,
}
string ,
x-ms-meta: 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-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 ,
content-length:
{
Description: The number of bytes present in the response body. ,
}
integer ,
content-type:
{
Description: The media type of the body of the response. For Download Blob this is 'application/octet-stream' ,
}
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 ,
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 ,
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-encoding:
{
Description: This header returns the value that was specified for the Content-Encoding request header ,
}
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-language:
{
Description: This header returns the value that was specified for the Content-Language request header. ,
}
string ,
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 blob's type. ,
}
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-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-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-lease-duration:
{
Description: When a blob is leased, specifies whether the lease is of infinite or fixed duration. ,
}
string ,
x-ms-lease-state:
{
Description: Lease state of the blob. ,
}
string ,
x-ms-lease-status:
{
Description: The current lease status 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 ,
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 ,
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 ,
accept-ranges:
{
Description: Indicates that the service supports requests for partial blob content. ,
}
string ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
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-server-encrypted:
{
Description: The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the blob is unencrypted, or if only parts of the blob/application metadata are encrypted). ,
}
boolean ,
x-ms-encryption-key-sha256:
{
Description: The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key. ,
}
string ,
x-ms-encryption-scope:
{
Description: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. ,
}
string ,
x-ms-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-tag-count:
{
Description: The number of tags associated with the blob ,
}
integer ,
x-ms-blob-sealed:
{
Description: If this blob has been sealed ,
}
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-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-immutability-policy-mode:
{
Description: Indicates immutability policy mode. ,
}
string ,
x-ms-legal-hold:
{
Description: Indicates if a legal hold is present on the blob. ,
}
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 ,
}
,
$schema:
{
Format: file ,
}
object ,
}

⚐ Response (206)

{
$headers:
{
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-creation-time:
{
Description: Returns the date and time the blob was created. ,
}
string ,
x-ms-meta: 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-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 ,
content-length:
{
Description: The number of bytes present in the response body. ,
}
integer ,
content-type:
{
Description: The media type of the body of the response. For Download Blob this is 'application/octet-stream' ,
}
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 ,
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 ,
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-encoding:
{
Description: This header returns the value that was specified for the Content-Encoding request header ,
}
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-language:
{
Description: This header returns the value that was specified for the Content-Language request header. ,
}
string ,
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 blob's type. ,
}
string ,
x-ms-content-crc64:
{
Description: If the request is to read a specified range and the x-ms-range-get-content-crc64 is set to true, then the request returns a crc64 for the range, as long as the range size is less than or equal to 4 MB. If both x-ms-range-get-content-crc64 & x-ms-range-get-content-md5 is specified in the same request, it will fail with 400(Bad 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-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-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-lease-duration:
{
Description: When a blob is leased, specifies whether the lease is of infinite or fixed duration. ,
}
string ,
x-ms-lease-state:
{
Description: Lease state of the blob. ,
}
string ,
x-ms-lease-status:
{
Description: The current lease status 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 ,
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 ,
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 ,
accept-ranges:
{
Description: Indicates that the service supports requests for partial blob content. ,
}
string ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
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-server-encrypted:
{
Description: The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the blob is unencrypted, or if only parts of the blob/application metadata are encrypted). ,
}
boolean ,
x-ms-encryption-key-sha256:
{
Description: The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key. ,
}
string ,
x-ms-encryption-scope:
{
Description: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. ,
}
string ,
x-ms-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-tag-count:
{
Description: The number of tags associated with the blob ,
}
integer ,
x-ms-blob-sealed:
{
Description: If this blob has been sealed ,
}
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-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-immutability-policy-mode:
{
Description: Indicates immutability policy mode. ,
}
string ,
x-ms-legal-hold:
{
Description: Indicates if a legal hold is present on the blob. ,
}
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 ,
}
,
$schema:
{
Format: file ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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",
  "$parameters": [
    {
      "#name": "snapshot",
      "Description": {
        "new": "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.",
        "old": "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."
      }
    },
    {
      "#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."
      }
    }
  ],
  "$responses": {
    "200": [
      {
        "#name": "x-ms-access-tier",
        "Description": {
          "new": "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.",
          "old": "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://docs.microsoft.com/en-us/azure/virtual-machines/windows/premium-storage#features. For blob storage LRS accounts, valid values are Hot/Cool/Archive."
        }
      }
    ]
  }
}

⚼ Request

HEAD:  /{containerName}/{blob}
{
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. ,
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. 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 ,
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 ,
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 ,
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-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)

{
last-modified:
{
Description: Returns the date and time the blob 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-creation-time:
{
Description: Returns the date and time the blob was created. ,
}
string ,
x-ms-meta: 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-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-blob-type:
{
Description: The blob's type. ,
}
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-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-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-incremental-copy:
{
Description: Included if the blob is incremental copy blob. ,
}
boolean ,
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-lease-duration:
{
Description: When a blob is leased, specifies whether the lease is of infinite or fixed duration. ,
}
string ,
x-ms-lease-state:
{
Description: Lease state of the blob. ,
}
string ,
x-ms-lease-status:
{
Description: The current lease status of the blob. ,
}
string ,
content-length:
{
Description: The number of bytes present in the response body. ,
}
integer ,
content-type:
{
Description: The content type specified for the blob. The default content type is 'application/octet-stream' ,
}
string ,
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 ,
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-encoding:
{
Description: This header returns the value that was specified for the Content-Encoding request header ,
}
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-language:
{
Description: This header returns the value that was specified for the Content-Language request header. ,
}
string ,
cache-control:
{
Description: This header is returned if it was previously specified for the blob. ,
}
string ,
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-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 ,
accept-ranges:
{
Description: Indicates that the service supports requests for partial blob content. ,
}
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-server-encrypted:
{
Description: The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the blob is unencrypted, or if only parts of the blob/application metadata are encrypted). ,
}
boolean ,
x-ms-encryption-key-sha256:
{
Description: The SHA-256 hash of the encryption key used to encrypt the metadata. This header is only returned when the metadata was encrypted with a customer-provided key. ,
}
string ,
x-ms-encryption-scope:
{
Description: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. ,
}
string ,
x-ms-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-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-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-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 ,
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-tag-count:
{
Description: The number of tags associated with the blob ,
}
integer ,
x-ms-expiry-time:
{
Description: The time this blob will expire. ,
}
string ,
x-ms-blob-sealed:
{
Description: If this blob has been sealed ,
}
boolean ,
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-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-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-immutability-policy-mode:
{
Description: Indicates immutability policy mode. ,
}
string ,
x-ms-legal-hold:
{
Description: Indicates if a legal hold is present on the blob. ,
}
boolean ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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",
  "$parameters": [
    {
      "#name": "snapshot",
      "Description": {
        "new": "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.",
        "old": "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."
      }
    },
    {
      "#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

DELETE:  /{containerName}/{blob}
{
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. ,
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: 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 ,
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 ,
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-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 ,
deletetype:
{
Description: Optional. Only possible value is 'permanent', which specifies to permanently delete a blob if blob soft delete is enabled. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
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:
{
Message:
{
Required: False ,
}
string ,
}
,
}
PageBlob_Create (updated)
Description :  The Create operation creates a new page blob.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PageBlob_Create",
  "$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:  /{containerName}/{blob}?PageBlob
{
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: The length of the request. ,
Format: int64 ,
Required: True ,
}
integer ,
x-ms-access-tier:
{
Description: Optional. Indicates the tier to be set on the page blob. ,
Required: False ,
}
string ,
x-ms-blob-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-blob-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-blob-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-blob-content-md5:
{
Description: Optional. An MD5 hash of the blob content. Note that this hash is not validated, as the hashes for the individual blocks were validated when each was uploaded. ,
Format: byte ,
Required: False ,
}
string ,
x-ms-blob-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-meta:
{
Description: Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. ,
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-blob-content-disposition:
{
Description: Optional. Sets the blob's Content-Disposition header. ,
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-encryption-scope:
{
Description: Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. ,
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 ,
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 ,
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-blob-content-length:
{
Description: This header specifies the maximum size for the page blob, up to 1 TB. The page blob size must be aligned to a 512-byte boundary. ,
Format: int64 ,
Required: True ,
}
integer ,
x-ms-blob-sequence-number:
{
Description: Set for page blobs only. The sequence number is a user-controlled value that you can use to track requests. The value of the sequence number must be between 0 and 2^63 - 1. ,
Format: int64 ,
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-tags:
{
Description: Optional. Used to set blob tags in various blob operations. ,
Required: False ,
}
string ,
x-ms-immutability-policy-until-date:
{
Description: Specifies the date time when the blobs immutability policy is set to expire. ,
Format: date-time-rfc1123 ,
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 ,
}

⚐ Response (201)

{
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 ,
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-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 ,
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 ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
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-encryption-scope:
{
Description: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
AppendBlob_Create (updated)
Description :  The Create Append Blob operation creates a new append blob.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AppendBlob_Create",
  "$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:  /{containerName}/{blob}?AppendBlob
{
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: The length of the request. ,
Format: int64 ,
Required: True ,
}
integer ,
x-ms-blob-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-blob-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-blob-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-blob-content-md5:
{
Description: Optional. An MD5 hash of the blob content. Note that this hash is not validated, as the hashes for the individual blocks were validated when each was uploaded. ,
Format: byte ,
Required: False ,
}
string ,
x-ms-blob-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-meta:
{
Description: Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. ,
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-blob-content-disposition:
{
Description: Optional. Sets the blob's Content-Disposition header. ,
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-encryption-scope:
{
Description: Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. ,
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 ,
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 ,
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-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-tags:
{
Description: Optional. Used to set blob tags in various blob operations. ,
Required: False ,
}
string ,
x-ms-immutability-policy-until-date:
{
Description: Specifies the date time when the blobs immutability policy is set to expire. ,
Format: date-time-rfc1123 ,
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 ,
}

⚐ Response (201)

{
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 ,
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-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 ,
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 ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
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-encryption-scope:
{
Description: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
BlockBlob_Upload (updated)
Description :  The Upload Block Blob operation updates the content of an existing block blob. Updating an existing block blob overwrites any existing metadata on the blob. Partial updates are not supported with Put Blob; the content of the existing blob is overwritten with the content of the new blob. To perform a partial update of the content of a block blob, use the Put Block List operation.
Reference :  Link ¶

⚶ Changes

{
  "#id": "BlockBlob_Upload",
  "$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:  /{containerName}/{blob}?BlockBlob
{
body:
{
Description: Initial data ,
Required: True ,
}
object ,
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. ,
Required: False ,
}
integer ,
Content-MD5:
{
Description: Specify the transactional md5 for the body, to be validated by the service. ,
Format: byte ,
Required: False ,
}
string ,
Content-Length:
{
Description: The length of the request. ,
Format: int64 ,
Required: True ,
}
integer ,
x-ms-blob-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-blob-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-blob-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-blob-content-md5:
{
Description: Optional. An MD5 hash of the blob content. Note that this hash is not validated, as the hashes for the individual blocks were validated when each was uploaded. ,
Format: byte ,
Required: False ,
}
string ,
x-ms-blob-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-meta:
{
Description: Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. ,
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-blob-content-disposition:
{
Description: Optional. Sets the blob's Content-Disposition header. ,
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-encryption-scope:
{
Description: Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. ,
Required: False ,
}
string ,
x-ms-access-tier:
{
Description: Optional. Indicates the tier to be set on the blob. ,
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 ,
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 ,
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-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-tags:
{
Description: Optional. Used to set blob tags in various blob operations. ,
Required: False ,
}
string ,
x-ms-immutability-policy-until-date:
{
Description: Specifies the date time when the blobs immutability policy is set to expire. ,
Format: date-time-rfc1123 ,
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-content-crc64:
{
Description: Specify the transactional crc64 for the body, to be validated by the service. ,
Format: byte ,
Required: False ,
}
string ,
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 (201)

{
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 ,
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-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 ,
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 ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
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-encryption-scope:
{
Description: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. ,
}
string ,
x-ms-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:
{
Message:
{
Required: False ,
}
string ,
}
,
}
BlockBlob_PutBlobFromUrl (updated)
Description :  The Put Blob from URL operation creates a new Block Blob where the contents of the blob are read from a given URL. This API is supported beginning with the 2020-04-08 version. Partial updates are not supported with Put Blob from URL; the content of an existing blob is overwritten with the content of the new blob. To perform partial updates to a block blob’s contents using a source URL, use the Put Block from URL API in conjunction with Put Block List.
Reference :  Link ¶

⚶ Changes

{
  "#id": "BlockBlob_PutBlobFromUrl",
  "$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:  /{containerName}/{blob}?BlockBlob&fromUrl
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. ,
Required: False ,
}
integer ,
Content-MD5:
{
Description: Specify the transactional md5 for the body, to be validated by the service. ,
Format: byte ,
Required: False ,
}
string ,
Content-Length:
{
Description: The length of the request. ,
Format: int64 ,
Required: True ,
}
integer ,
x-ms-blob-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-blob-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-blob-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-blob-content-md5:
{
Description: Optional. An MD5 hash of the blob content. Note that this hash is not validated, as the hashes for the individual blocks were validated when each was uploaded. ,
Format: byte ,
Required: False ,
}
string ,
x-ms-blob-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-meta:
{
Description: Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. ,
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-blob-content-disposition:
{
Description: Optional. Sets the blob's Content-Disposition header. ,
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-encryption-scope:
{
Description: Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. ,
Required: False ,
}
string ,
x-ms-access-tier:
{
Description: Optional. Indicates the tier to be set on the blob. ,
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 ,
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 ,
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-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-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-tags:
{
Description: Specify a SQL where clause on blob tags to operate only on blobs with a matching value. ,
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 ,
x-ms-source-content-md5:
{
Description: Specify the md5 calculated for the range of bytes that must be read from the copy source. ,
Format: byte ,
Required: False ,
}
string ,
x-ms-tags:
{
Description: Optional. Used to set blob tags in various blob operations. ,
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-copy-source-blob-properties:
{
Description: Optional, default is true. Indicates if properties from the source blob should be copied. ,
Required: False ,
}
boolean ,
x-ms-copy-source-authorization:
{
Description: Only Bearer type is supported. Credentials should be a valid OAuth access token to copy source. ,
Required: False ,
}
string ,
x-ms-copy-source-tag-option:
{
Description: Optional, default 'replace'. Indicates if source tags should be copied or replaced with the tags specified by x-ms-tags. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
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 ,
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-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 ,
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 ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
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-encryption-scope:
{
Description: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Blob_Undelete (updated)
Description :  Undelete a blob that was previously soft deleted
Reference :  Link ¶

⚶ Changes

{
  "#id": "Blob_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:  /{containerName}/{blob}?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-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-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:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Blob_SetExpiry (updated)
Description :  Sets the time a blob will expire and be deleted.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Blob_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:  /{containerName}/{blob}?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:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Blob_SetHTTPHeaders (updated)
Description :  The Set HTTP Headers operation sets system properties on the blob
Reference :  Link ¶

⚶ Changes

{
  "#id": "Blob_SetHTTPHeaders",
  "$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:  /{containerName}/{blob}?comp=properties&SetHTTPHeaders
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. ,
Required: False ,
}
integer ,
x-ms-blob-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-blob-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-blob-content-md5:
{
Description: Optional. An MD5 hash of the blob content. Note that this hash is not validated, as the hashes for the individual blocks were validated when each was uploaded. ,
Format: byte ,
Required: False ,
}
string ,
x-ms-blob-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-blob-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-lease-id:
{
Description: If specified, the operation only succeeds if the resource's lease is active and matches this ID. ,
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 ,
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 ,
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-blob-content-disposition:
{
Description: Optional. Sets the blob's Content-Disposition header. ,
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)

{
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-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-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:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Blob_SetImmutabilityPolicy (updated)
Description :  The Set Immutability Policy operation sets the immutability policy on the blob
Reference :  Link ¶

⚶ Changes

{
  "#id": "Blob_SetImmutabilityPolicy",
  "$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."
      }
    },
    {
      "#name": "snapshot",
      "Description": {
        "new": "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.",
        "old": "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."
      }
    }
  ]
}

⚼ Request

PUT:  /{containerName}/{blob}?comp=immutabilityPolicies
{
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 ,
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-immutability-policy-until-date:
{
Description: Specifies the date time when the blobs immutability policy is set to expire. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
x-ms-immutability-policy-mode:
{
Description: Specifies the immutability policy mode to set on the blob. ,
Required: False ,
}
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 ,
}

⚐ 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-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 ,
x-ms-immutability-policy-until-date:
{
Description: Indicates the time the immutability policy will expire. ,
}
string ,
x-ms-immutability-policy-mode:
{
Description: Indicates immutability policy mode. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Blob_DeleteImmutabilityPolicy (updated)
Description :  The Delete Immutability Policy operation deletes the immutability policy on the blob
Reference :  Link ¶

⚶ Changes

{
  "#id": "Blob_DeleteImmutabilityPolicy",
  "$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."
      }
    },
    {
      "#name": "snapshot",
      "Description": {
        "new": "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.",
        "old": "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."
      }
    }
  ]
}

⚼ Request

DELETE:  /{containerName}/{blob}?comp=immutabilityPolicies
{
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 ,
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 ,
}

⚐ 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-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:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Blob_SetLegalHold (updated)
Description :  The Set Legal Hold operation sets a legal hold on the blob.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Blob_SetLegalHold",
  "$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."
      }
    },
    {
      "#name": "snapshot",
      "Description": {
        "new": "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.",
        "old": "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."
      }
    }
  ]
}

⚼ Request

PUT:  /{containerName}/{blob}?comp=legalhold
{
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-legal-hold:
{
Description: Specified if a legal hold should be set on the blob. ,
Required: True ,
}
boolean ,
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 ,
}

⚐ 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-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 ,
x-ms-legal-hold:
{
Description: Indicates if the blob has a legal hold. ,
}
boolean ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Blob_SetMetadata (updated)
Description :  The Set Blob Metadata operation sets user-defined metadata for the specified blob as one or more name-value pairs
Reference :  Link ¶

⚶ Changes

{
  "#id": "Blob_SetMetadata",
  "$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:  /{containerName}/{blob}?comp=metadata
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. ,
Required: False ,
}
integer ,
x-ms-meta:
{
Description: Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. ,
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-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-encryption-scope:
{
Description: Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. ,
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 ,
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 ,
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-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)

{
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 ,
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 ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
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 metadata. This header is only returned when the metadata was encrypted with a customer-provided key. ,
}
string ,
x-ms-encryption-scope:
{
Description: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Blob_AcquireLease (updated)
Description :  [Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations
Reference :  Link ¶

⚶ Changes

{
  "#id": "Blob_AcquireLease",
  "$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:  /{containerName}/{blob}?comp=lease&acquire
{
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-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. ,
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 ,
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 ,
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 ,
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-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 (201)

{
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 blob 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-lease-id:
{
Description: Uniquely identifies a blobs' lease ,
}
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:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Blob_ReleaseLease (updated)
Description :  [Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations
Reference :  Link ¶

⚶ Changes

{
  "#id": "Blob_ReleaseLease",
  "$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:  /{containerName}/{blob}?comp=lease&release
{
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: Specifies the current lease ID on the resource. ,
Required: True ,
}
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 ,
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 ,
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-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)

{
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 blob 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:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Blob_RenewLease (updated)
Description :  [Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations
Reference :  Link ¶

⚶ Changes

{
  "#id": "Blob_RenewLease",
  "$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:  /{containerName}/{blob}?comp=lease&renew
{
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: Specifies the current lease ID on the resource. ,
Required: True ,
}
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 ,
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 ,
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-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)

{
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 blob 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-lease-id:
{
Description: Uniquely identifies a blobs' lease ,
}
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:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Blob_ChangeLease (updated)
Description :  [Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations
Reference :  Link ¶

⚶ Changes

{
  "#id": "Blob_ChangeLease",
  "$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:  /{containerName}/{blob}?comp=lease&change
{
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: Specifies the current lease ID on the resource. ,
Required: True ,
}
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: True ,
}
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 ,
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 ,
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-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)

{
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 blob 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-lease-id:
{
Description: Uniquely identifies a blobs' lease ,
}
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:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Blob_BreakLease (updated)
Description :  [Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations
Reference :  Link ¶

⚶ Changes

{
  "#id": "Blob_BreakLease",
  "$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:  /{containerName}/{blob}?comp=lease&break
{
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-break-period:
{
Description: For a break operation, proposed duration the lease should continue before it is broken, in seconds, between 0 and 60. This break period is only used if it is shorter than the time remaining on the lease. If longer, the time remaining on the lease is used. A new lease will not be available before the break period has expired, but the lease may be held for longer than the break period. If this header does not appear with a break operation, a fixed-duration lease breaks after the remaining lease period elapses, and an infinite lease breaks immediately. ,
Required: False ,
}
integer ,
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 ,
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 ,
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-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 (202)

{
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 blob 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-lease-time:
{
Description: Approximate time remaining in the lease period, in seconds. ,
}
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: 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:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Blob_CreateSnapshot (updated)
Description :  The Create Snapshot operation creates a read-only snapshot of a blob
Reference :  Link ¶

⚶ Changes

{
  "#id": "Blob_CreateSnapshot",
  "$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:  /{containerName}/{blob}?comp=snapshot
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. ,
Required: False ,
}
integer ,
x-ms-meta:
{
Description: Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. ,
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-encryption-scope:
{
Description: Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. ,
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 ,
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 ,
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-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-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 (201)

{
x-ms-snapshot:
{
Description: Uniquely identifies the snapshot and indicates the snapshot version. It may be used in subsequent requests to access the snapshot ,
}
string ,
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 ,
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 ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
string ,
x-ms-request-server-encrypted:
{
Description: True if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. For a snapshot request, this header is set to true when metadata was provided in the request and encrypted with a customer-provided key. ,
}
boolean ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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",
  "$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:  /{containerName}/{blob}?comp=copy
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. ,
Required: False ,
}
integer ,
x-ms-meta:
{
Description: Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. ,
Required: False ,
}
string ,
x-ms-access-tier:
{
Description: Optional. Indicates the tier to be set on the blob. ,
Required: False ,
}
string ,
x-ms-rehydrate-priority:
{
Description: Optional: Indicates the priority with which to rehydrate an archived blob. ,
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-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-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: 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 ,
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 ,
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-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-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-rfc1123 ,
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 ,
}

⚐ Response (202)

{
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 ,
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 ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
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 ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Blob_CopyFromURL (updated)
Description :  The Copy From URL operation copies a blob or an internet resource to a new blob. It will not return a response until the copy is complete.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Blob_CopyFromURL",
  "$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:  /{containerName}/{blob}?comp=copy&sync
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. ,
Required: False ,
}
integer ,
x-ms-meta:
{
Description: Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. ,
Required: False ,
}
string ,
x-ms-access-tier:
{
Description: Optional. Indicates the tier to be set on the blob. ,
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-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 ,
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 ,
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 ,
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-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-source-content-md5:
{
Description: Specify the md5 calculated for the range of bytes that must be read from the copy source. ,
Format: byte ,
Required: False ,
}
string ,
x-ms-tags:
{
Description: Optional. Used to set blob tags in various blob operations. ,
Required: False ,
}
string ,
x-ms-immutability-policy-until-date:
{
Description: Specifies the date time when the blobs immutability policy is set to expire. ,
Format: date-time-rfc1123 ,
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-copy-source-authorization:
{
Description: Only Bearer type is supported. Credentials should be a valid OAuth access token to copy source. ,
Required: False ,
}
string ,
x-ms-encryption-scope:
{
Description: Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. ,
Required: False ,
}
string ,
x-ms-copy-source-tag-option:
{
Description: Optional, default 'replace'. Indicates if source tags should be copied or replaced with the tags specified by x-ms-tags. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
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 ,
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 ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
string ,
x-ms-copy-id:
{
Description: String identifier for this copy operation. ,
}
string ,
x-ms-copy-status:
{
Description: State of the copy operation identified by x-ms-copy-id. ,
}
string ,
content-md5:
{
Description: This response header is returned so that the client can check for the integrity of the copied content. This header is only returned if the source content MD5 was specified. ,
}
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-encryption-scope:
{
Description: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Blob_AbortCopyFromURL (updated)
Description :  The Abort Copy From URL operation aborts a pending Copy From URL operation, and leaves a destination blob with zero length and full metadata.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Blob_AbortCopyFromURL",
  "$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:  /{containerName}/{blob}?comp=copy©id
{
copyid:
{
Description: The copy identifier provided in the x-ms-copy-id header of the original Copy Blob operation. ,
Required: True ,
}
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-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-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 (204)

{
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:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Blob_SetTier (updated)
Description :  The Set Tier operation sets the tier on a blob. The operation is allowed on a page blob in a premium storage account and on a block blob in a blob storage account (locally redundant storage only). A premium page blob's tier determines the allowed size, IOPS, and bandwidth of the blob. A block blob's tier determines Hot/Cool/Archive storage type. This operation does not update the blob's ETag.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Blob_SetTier",
  "$parameters": [
    {
      "#name": "snapshot",
      "Description": {
        "new": "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.",
        "old": "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."
      }
    },
    {
      "#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:  /{containerName}/{blob}?comp=tier
{
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. ,
Required: False ,
}
integer ,
x-ms-access-tier:
{
Description: Indicates the tier to be set on the blob. ,
Required: True ,
}
string ,
x-ms-rehydrate-priority:
{
Description: Optional: Indicates the priority with which to rehydrate an archived blob. ,
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 ,
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-if-tags:
{
Description: Specify a SQL where clause on blob tags to operate only on blobs with a matching value. ,
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-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 newer. ,
}
string ,
}

⚐ Response (202)

{
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 newer. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Blob_GetAccountInfo (updated)
Description :  Returns the sku name and account kind
Reference :  Link ¶

⚶ Changes

{
  "#id": "Blob_GetAccountInfo",
  "$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:  /{containerName}/{blob}?restype=account&comp=properties&blob
{
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)

{
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 ,
x-ms-sku-name:
{
Description: Identifies the sku name of the account ,
}
string ,
x-ms-account-kind:
{
Description: Identifies the account kind ,
}
string ,
x-ms-is-hns-enabled:
{
Description: Version 2019-07-07 and newer. Indicates if the account has a hierarchical namespace enabled. ,
}
boolean ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
BlockBlob_StageBlock (updated)
Description :  The Stage Block operation creates a new block to be committed as part of a blob
Reference :  Link ¶

⚶ Changes

{
  "#id": "BlockBlob_StageBlock",
  "$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:  /{containerName}/{blob}?comp=block
{
blockid:
{
Description: A valid Base64 string value that identifies the block. Prior to encoding, the string must be less than or equal to 64 bytes in size. For a given blob, the length of the value specified for the blockid parameter must be the same size for each block. ,
Required: True ,
}
string ,
Content-Length:
{
Description: The length of the request. ,
Format: int64 ,
Required: True ,
}
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 ,
body:
{
Description: Initial data ,
Required: True ,
}
object ,
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-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-encryption-scope:
{
Description: Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. ,
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 ,
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 (201)

{
content-md5:
{
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-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 ,
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 block. This header is only returned when the block was encrypted with a customer-provided key. ,
}
string ,
x-ms-encryption-scope:
{
Description: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. ,
}
string ,
x-ms-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:
{
Message:
{
Required: False ,
}
string ,
}
,
}
BlockBlob_StageBlockFromURL (updated)
Description :  The Stage Block operation creates a new block to be committed as part of a blob where the contents are read from a URL.
Reference :  Link ¶

⚶ Changes

{
  "#id": "BlockBlob_StageBlockFromURL",
  "$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:  /{containerName}/{blob}?comp=block&fromURL
{
blockid:
{
Description: A valid Base64 string value that identifies the block. Prior to encoding, the string must be less than or equal to 64 bytes in size. For a given blob, the length of the value specified for the blockid parameter must be the same size for each block. ,
Required: True ,
}
string ,
Content-Length:
{
Description: The length of the request. ,
Format: int64 ,
Required: True ,
}
integer ,
x-ms-copy-source:
{
Description: Specify a URL to the copy source. ,
Required: True ,
}
string ,
x-ms-source-range:
{
Description: Bytes of source data in the specified range. ,
Required: False ,
}
string ,
x-ms-source-content-md5:
{
Description: Specify the md5 calculated for the range of bytes that must be read from the copy source. ,
Format: byte ,
Required: False ,
}
string ,
x-ms-source-content-crc64:
{
Description: Specify the crc64 calculated for the range of bytes that must be read from the copy source. ,
Format: byte ,
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-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-encryption-scope:
{
Description: Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. ,
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-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-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-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-copy-source-authorization:
{
Description: Only Bearer type is supported. Credentials should be a valid OAuth access token to copy source. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
content-md5:
{
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-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-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 ,
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 block. This header is only returned when the block was encrypted with a customer-provided key. ,
}
string ,
x-ms-encryption-scope:
{
Description: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
BlockBlob_CommitBlockList (updated)
Description :  The Commit Block List operation writes a blob by specifying the list of block IDs that make up the blob. In order to be written as part of a blob, a block must have been successfully written to the server in a prior Put Block operation. You can call Put Block List to update a blob by uploading only those blocks that have changed, then committing the new and existing blocks together. You can do this by specifying whether to commit a block from the committed block list or from the uncommitted block list, or to commit the most recently uploaded version of the block, whichever list it may belong to.
Reference :  Link ¶

⚶ Changes

{
  "#id": "BlockBlob_CommitBlockList",
  "$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:  /{containerName}/{blob}?comp=blocklist
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. ,
Required: False ,
}
integer ,
x-ms-blob-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-blob-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-blob-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-blob-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-blob-content-md5:
{
Description: Optional. An MD5 hash of the blob content. Note that this hash is not validated, as the hashes for the individual blocks were validated when each was uploaded. ,
Format: byte ,
Required: False ,
}
string ,
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-meta:
{
Description: Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. ,
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-blob-content-disposition:
{
Description: Optional. Sets the blob's Content-Disposition header. ,
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-encryption-scope:
{
Description: Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. ,
Required: False ,
}
string ,
x-ms-access-tier:
{
Description: Optional. Indicates the tier to be set on the blob. ,
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 ,
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 ,
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 ,
blocks:
{
Description: Blob Blocks. ,
Required: True ,
}
{
Committed:
{
Required: False ,
}
[
string ,
]
,
Uncommitted:
{
Required: False ,
}
[
string ,
]
,
Latest:
{
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 ,
x-ms-tags:
{
Description: Optional. Used to set blob tags in various blob operations. ,
Required: False ,
}
string ,
x-ms-immutability-policy-until-date:
{
Description: Specifies the date time when the blobs immutability policy is set to expire. ,
Format: date-time-rfc1123 ,
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 ,
}

⚐ Response (201)

{
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 ,
content-md5:
{
Description: This header is returned so that the client can check for message content integrity. This header refers to the content of the request, meaning, in this case, the list of blocks, and not the content of the blob itself. ,
}
string ,
x-ms-content-crc64:
{
Description: This header is returned so that the client can check for message content integrity. This header refers to the content of the request, meaning, in this case, the list of blocks, and not the content of the blob itself. ,
}
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 ,
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 ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
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-encryption-scope:
{
Description: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
BlockBlob_GetBlockList (updated)
Description :  The Get Block List operation retrieves the list of blocks that have been uploaded as part of a block blob
Reference :  Link ¶

⚶ Changes

{
  "#id": "BlockBlob_GetBlockList",
  "$parameters": [
    {
      "#name": "snapshot",
      "Description": {
        "new": "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.",
        "old": "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."
      }
    },
    {
      "#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:  /{containerName}/{blob}?comp=blocklist
{
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 ,
blocklisttype:
{
Description: Specifies whether to return the list of committed blocks, the list of uncommitted blocks, or both lists together. ,
Required: True ,
}
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-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-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-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:
{
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 ,
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 ,
content-type:
{
Description: The media type of the body of the response. For Get Block List this is 'application/xml' ,
}
string ,
x-ms-blob-content-length:
{
Description: The size of the blob 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: 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:
{
CommittedBlocks:
{
Required: False ,
}
[
{
Name:
{
Description: The base64 encoded block ID. ,
Required: True ,
}
string ,
Size:
{
Description: The block size in bytes. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
]
,
UncommittedBlocks:
{
Required: False ,
}
[
{
Name:
{
Description: The base64 encoded block ID. ,
Required: True ,
}
string ,
Size:
{
Description: The block size in bytes. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
PageBlob_UploadPages (updated)
Description :  The Upload Pages operation writes a range of pages to a page blob
Reference :  Link ¶

⚶ Changes

{
  "#id": "PageBlob_UploadPages",
  "$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:  /{containerName}/{blob}?comp=page&update
{
body:
{
Description: Initial data ,
Required: True ,
}
object ,
Content-Length:
{
Description: The length of the request. ,
Format: int64 ,
Required: True ,
}
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 ,
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. ,
Required: False ,
}
integer ,
x-ms-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-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-encryption-scope:
{
Description: Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. ,
Required: False ,
}
string ,
x-ms-if-sequence-number-le:
{
Description: Specify this header value to operate only on a blob if it has a sequence number less than or equal to the specified. ,
Format: int64 ,
Required: False ,
}
integer ,
x-ms-if-sequence-number-lt:
{
Description: Specify this header value to operate only on a blob if it has a sequence number less than the specified. ,
Format: int64 ,
Required: False ,
}
integer ,
x-ms-if-sequence-number-eq:
{
Description: Specify this header value to operate only on a blob if it has the specified sequence number. ,
Format: int64 ,
Required: False ,
}
integer ,
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 ,
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 ,
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-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-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 (201)

{
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 ,
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-blob-sequence-number:
{
Description: The current sequence number for the page blob. ,
}
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: 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 ,
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 pages. This header is only returned when the pages were encrypted with a customer-provided key. ,
}
string ,
x-ms-encryption-scope:
{
Description: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. ,
}
string ,
x-ms-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:
{
Message:
{
Required: False ,
}
string ,
}
,
}
PageBlob_ClearPages (updated)
Description :  The Clear Pages operation clears a set of pages from a page blob
Reference :  Link ¶

⚶ Changes

{
  "#id": "PageBlob_ClearPages",
  "$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:  /{containerName}/{blob}?comp=page&clear
{
Content-Length:
{
Description: The length of the request. ,
Format: int64 ,
Required: True ,
}
integer ,
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. ,
Required: False ,
}
integer ,
x-ms-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-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-encryption-scope:
{
Description: Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. ,
Required: False ,
}
string ,
x-ms-if-sequence-number-le:
{
Description: Specify this header value to operate only on a blob if it has a sequence number less than or equal to the specified. ,
Format: int64 ,
Required: False ,
}
integer ,
x-ms-if-sequence-number-lt:
{
Description: Specify this header value to operate only on a blob if it has a sequence number less than the specified. ,
Format: int64 ,
Required: False ,
}
integer ,
x-ms-if-sequence-number-eq:
{
Description: Specify this header value to operate only on a blob if it has the specified sequence number. ,
Format: int64 ,
Required: False ,
}
integer ,
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 ,
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 ,
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-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 (201)

{
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 ,
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-blob-sequence-number:
{
Description: The current sequence number for the page blob. ,
}
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: 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:
{
Message:
{
Required: False ,
}
string ,
}
,
}
PageBlob_UploadPagesFromURL (updated)
Description :  The Upload Pages operation writes a range of pages to a page blob where the contents are read from a URL
Reference :  Link ¶

⚶ Changes

{
  "#id": "PageBlob_UploadPagesFromURL",
  "$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:  /{containerName}/{blob}?comp=page&update&fromUrl
{
x-ms-copy-source:
{
Description: Specify a URL to the copy source. ,
Required: True ,
}
string ,
x-ms-source-range:
{
Description: Bytes of source data in the specified range. The length of this range should match the ContentLength header and x-ms-range/Range destination range header. ,
Required: True ,
}
string ,
x-ms-source-content-md5:
{
Description: Specify the md5 calculated for the range of bytes that must be read from the copy source. ,
Format: byte ,
Required: False ,
}
string ,
x-ms-source-content-crc64:
{
Description: Specify the crc64 calculated for the range of bytes that must be read from the copy source. ,
Format: byte ,
Required: False ,
}
string ,
Content-Length:
{
Description: The length of the request. ,
Format: int64 ,
Required: True ,
}
integer ,
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. ,
Required: False ,
}
integer ,
x-ms-range:
{
Description: The range of bytes to which the source range would be written. The range should be 512 aligned and range-end is required. ,
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 ,
x-ms-encryption-scope:
{
Description: Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. ,
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-if-sequence-number-le:
{
Description: Specify this header value to operate only on a blob if it has a sequence number less than or equal to the specified. ,
Format: int64 ,
Required: False ,
}
integer ,
x-ms-if-sequence-number-lt:
{
Description: Specify this header value to operate only on a blob if it has a sequence number less than the specified. ,
Format: int64 ,
Required: False ,
}
integer ,
x-ms-if-sequence-number-eq:
{
Description: Specify this header value to operate only on a blob if it has the specified sequence number. ,
Format: int64 ,
Required: False ,
}
integer ,
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 ,
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 ,
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-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-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-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-copy-source-authorization:
{
Description: Only Bearer type is supported. Credentials should be a valid OAuth access token to copy source. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
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 ,
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-blob-sequence-number:
{
Description: The current sequence number for the page blob. ,
}
integer ,
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 ,
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-encryption-scope:
{
Description: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
PageBlob_GetPageRanges (updated)
Description :  The Get Page Ranges operation returns the list of valid page ranges for a page blob or snapshot of a page blob
Reference :  Link ¶

⚶ Changes

{
  "#id": "PageBlob_GetPageRanges",
  "$parameters": [
    {
      "#name": "snapshot",
      "Description": {
        "new": "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.",
        "old": "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."
      }
    },
    {
      "#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:  /{containerName}/{blob}?comp=pagelist
{
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 ,
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. ,
Required: False ,
}
integer ,
x-ms-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 ,
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 ,
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 ,
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-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 ,
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: Specifies the maximum number of containers to return. If the request does not specify maxresults, or specifies a value greater than 5000, the server will return up to 5000 items. Note that if the listing operation crosses a partition boundary, then the service will return a continuation token for retrieving the remainder of the results. For this reason, it is possible that the service will return fewer results than specified by maxresults, or than the default of 5000. ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
$headers:
{
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 ,
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 ,
x-ms-blob-content-length:
{
Description: The size of the blob 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: 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: the list of pages ,
}
{
PageRange:
{
Required: False ,
}
[
{
Start:
{
Format: int64 ,
Required: True ,
}
integer ,
End:
{
Format: int64 ,
Required: True ,
}
integer ,
}
,
]
,
ClearRange:
{
Required: False ,
}
[
{
Start:
{
Format: int64 ,
Required: True ,
}
integer ,
End:
{
Format: int64 ,
Required: True ,
}
integer ,
}
,
]
,
NextMarker:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
PageBlob_GetPageRangesDiff (updated)
Description :  The Get Page Ranges Diff operation returns the list of valid page ranges for a page blob that were changed between target blob and previous snapshot.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PageBlob_GetPageRangesDiff",
  "$parameters": [
    {
      "#name": "snapshot",
      "Description": {
        "new": "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.",
        "old": "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."
      }
    },
    {
      "#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:  /{containerName}/{blob}?comp=pagelist&diff
{
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 ,
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. ,
Required: False ,
}
integer ,
prevsnapshot:
{
Description: Optional in version 2015-07-08 and newer. The prevsnapshot parameter is a DateTime value that specifies that the response will contain only pages that were changed between target blob and previous snapshot. Changed pages include both updated and cleared pages. The target blob may be a snapshot, as long as the snapshot specified by prevsnapshot is the older of the two. Note that incremental snapshots are currently supported only for blobs created on or after January 1, 2016. ,
Required: False ,
}
string ,
x-ms-previous-snapshot-url:
{
Description: Optional. This header is only supported in service versions 2019-04-19 and after and specifies the URL of a previous snapshot of the target blob. The response will only contain pages that were changed between the target blob and its previous snapshot. ,
Required: False ,
}
string ,
x-ms-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 ,
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 ,
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 ,
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-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 ,
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: Specifies the maximum number of containers to return. If the request does not specify maxresults, or specifies a value greater than 5000, the server will return up to 5000 items. Note that if the listing operation crosses a partition boundary, then the service will return a continuation token for retrieving the remainder of the results. For this reason, it is possible that the service will return fewer results than specified by maxresults, or than the default of 5000. ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
$headers:
{
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 ,
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 ,
x-ms-blob-content-length:
{
Description: The size of the blob 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: 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: the list of pages ,
}
{
PageRange:
{
Required: False ,
}
[
{
Start:
{
Format: int64 ,
Required: True ,
}
integer ,
End:
{
Format: int64 ,
Required: True ,
}
integer ,
}
,
]
,
ClearRange:
{
Required: False ,
}
[
{
Start:
{
Format: int64 ,
Required: True ,
}
integer ,
End:
{
Format: int64 ,
Required: True ,
}
integer ,
}
,
]
,
NextMarker:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
PageBlob_Resize (updated)
Description :  Resize the Blob
Reference :  Link ¶

⚶ Changes

{
  "#id": "PageBlob_Resize",
  "$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:  /{containerName}/{blob}?comp=properties&Resize
{
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-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-encryption-scope:
{
Description: Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. ,
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 ,
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 ,
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-blob-content-length:
{
Description: This header specifies the maximum size for the page blob, up to 1 TB. The page blob size must be aligned to a 512-byte boundary. ,
Format: int64 ,
Required: True ,
}
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)

{
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-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-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:
{
Message:
{
Required: False ,
}
string ,
}
,
}
PageBlob_UpdateSequenceNumber (updated)
Description :  Update the sequence number of the blob
Reference :  Link ¶

⚶ Changes

{
  "#id": "PageBlob_UpdateSequenceNumber",
  "$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:  /{containerName}/{blob}?comp=properties&UpdateSequenceNumber
{
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 ,
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 ,
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 ,
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-sequence-number-action:
{
Description: Required if the x-ms-blob-sequence-number header is set for the request. This property applies to page blobs only. This property indicates how the service should modify the blob's sequence number ,
Required: True ,
}
string ,
x-ms-blob-sequence-number:
{
Description: Set for page blobs only. The sequence number is a user-controlled value that you can use to track requests. The value of the sequence number must be between 0 and 2^63 - 1. ,
Format: int64 ,
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)

{
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-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-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:
{
Message:
{
Required: False ,
}
string ,
}
,
}
PageBlob_CopyIncremental (updated)
Description :  The Copy Incremental operation copies a snapshot of the source page blob to a destination page blob. The snapshot is copied such that only the differential changes between the previously copied snapshot are transferred to the destination. The copied snapshots are complete copies of the original snapshot and can be read or copied from as usual. This API is supported since REST version 2016-05-31.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PageBlob_CopyIncremental",
  "$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:  /{containerName}/{blob}?comp=incrementalcopy
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. ,
Required: False ,
}
integer ,
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 ,
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 ,
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-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 (202)

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

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
AppendBlob_AppendBlock (updated)
Description :  The Append Block operation commits a new block of data to the end of an existing append blob. The Append Block operation is permitted only if the blob was created with x-ms-blob-type set to AppendBlob. Append Block is supported only on version 2015-02-21 version or later.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AppendBlob_AppendBlock",
  "$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:  /{containerName}/{blob}?comp=appendblock
{
body:
{
Description: Initial data ,
Required: True ,
}
object ,
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: The length of the request. ,
Format: int64 ,
Required: True ,
}
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-blob-condition-maxsize:
{
Description: Optional conditional header. The max length in bytes permitted for the append blob. If the Append Block operation would cause the blob to exceed that limit or if the blob size is already greater than the value specified in this header, the request will fail with MaxBlobSizeConditionNotMet error (HTTP status code 412 - Precondition Failed). ,
Format: int64 ,
Required: False ,
}
integer ,
x-ms-blob-condition-appendpos:
{
Description: Optional conditional header, used only for the Append Block operation. A number indicating the byte offset to compare. Append Block will succeed only if the append position is equal to this number. If it is not, the request will fail with the AppendPositionConditionNotMet error (HTTP status code 412 - Precondition Failed). ,
Format: int64 ,
Required: False ,
}
integer ,
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-encryption-scope:
{
Description: Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. ,
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 ,
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 ,
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-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-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 (201)

{
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 ,
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-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 ,
x-ms-blob-append-offset:
{
Description: This response header is returned only for append operations. It returns the offset at which the block was committed, in bytes. ,
}
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-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 block. This header is only returned when the block was encrypted with a customer-provided key. ,
}
string ,
x-ms-encryption-scope:
{
Description: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. ,
}
string ,
x-ms-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:
{
Message:
{
Required: False ,
}
string ,
}
,
}
AppendBlob_AppendBlockFromUrl (updated)
Description :  The Append Block operation commits a new block of data to the end of an existing append blob where the contents are read from a source url. The Append Block operation is permitted only if the blob was created with x-ms-blob-type set to AppendBlob. Append Block is supported only on version 2015-02-21 version or later.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AppendBlob_AppendBlockFromUrl",
  "$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:  /{containerName}/{blob}?comp=appendblock&fromUrl
{
x-ms-copy-source:
{
Description: Specify a URL to the copy source. ,
Required: True ,
}
string ,
x-ms-source-range:
{
Description: Bytes of source data in the specified range. ,
Required: False ,
}
string ,
x-ms-source-content-md5:
{
Description: Specify the md5 calculated for the range of bytes that must be read from the copy source. ,
Format: byte ,
Required: False ,
}
string ,
x-ms-source-content-crc64:
{
Description: Specify the crc64 calculated for the range of bytes that must be read from the copy source. ,
Format: byte ,
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 ,
Content-Length:
{
Description: The length of the request. ,
Format: int64 ,
Required: True ,
}
integer ,
Content-MD5:
{
Description: Specify the transactional md5 for the body, to be validated by the service. ,
Format: byte ,
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-encryption-scope:
{
Description: Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. ,
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-blob-condition-maxsize:
{
Description: Optional conditional header. The max length in bytes permitted for the append blob. If the Append Block operation would cause the blob to exceed that limit or if the blob size is already greater than the value specified in this header, the request will fail with MaxBlobSizeConditionNotMet error (HTTP status code 412 - Precondition Failed). ,
Format: int64 ,
Required: False ,
}
integer ,
x-ms-blob-condition-appendpos:
{
Description: Optional conditional header, used only for the Append Block operation. A number indicating the byte offset to compare. Append Block will succeed only if the append position is equal to this number. If it is not, the request will fail with the AppendPositionConditionNotMet error (HTTP status code 412 - Precondition Failed). ,
Format: int64 ,
Required: False ,
}
integer ,
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 ,
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 ,
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-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-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-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-copy-source-authorization:
{
Description: Only Bearer type is supported. Credentials should be a valid OAuth access token to copy source. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
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 ,
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-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 ,
x-ms-blob-append-offset:
{
Description: This response header is returned only for append operations. It returns the offset at which the block was committed, in bytes. ,
}
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-encryption-key-sha256:
{
Description: The SHA-256 hash of the encryption key used to encrypt the block. This header is only returned when the block was encrypted with a customer-provided key. ,
}
string ,
x-ms-encryption-scope:
{
Description: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. ,
}
string ,
x-ms-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 ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
AppendBlob_Seal (updated)
Description :  The Seal operation seals the Append Blob to make it read-only. Seal is supported only on version 2019-12-12 version or later.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AppendBlob_Seal",
  "$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:  /{containerName}/{blob}?comp=seal
{
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-lease-id:
{
Description: If specified, the operation only succeeds if the resource's lease is active and matches this ID. ,
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 ,
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 ,
x-ms-blob-condition-appendpos:
{
Description: Optional conditional header, used only for the Append Block operation. A number indicating the byte offset to compare. Append Block will succeed only if the append position is equal to this number. If it is not, the request will fail with the AppendPositionConditionNotMet error (HTTP status code 412 - Precondition Failed). ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ 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 ,
x-ms-blob-sealed:
{
Description: If this blob has been sealed ,
}
boolean ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Blob_Query (updated)
Description :  The Query operation enables users to select/project on blob data by providing simple query expressions.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Blob_Query",
  "$parameters": [
    {
      "#name": "snapshot",
      "Description": {
        "new": "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.",
        "old": "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."
      }
    },
    {
      "#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

POST:  /{containerName}/{blob}?comp=query
{
queryRequest:
{
Description: the query request ,
Required: False ,
}
{
QueryType:
{
Description: Required. The type of the provided query expression. ,
Enum:
{
SQL: No description available. ,
}
,
Required: True ,
}
enum ,
Expression:
{
Description: The query expression in SQL. The maximum size of the query expression is 256KiB. ,
Required: True ,
}
string ,
InputSerialization:
{
Required: False ,
}
{
Format:
{
Required: True ,
}
{
Type:
{
Description: The quick query format type. ,
Enum:
{
delimited: No description available. ,
json: No description available. ,
arrow: No description available. ,
parquet: No description available. ,
}
,
Required: True ,
}
enum ,
DelimitedTextConfiguration:
{
Description: Groups the settings used for interpreting the blob data if the blob is delimited text formatted. ,
Required: False ,
}
{
ColumnSeparator:
{
Description: The string used to separate columns. ,
Required: False ,
}
string ,
FieldQuote:
{
Description: The string used to quote a specific field. ,
Required: False ,
}
string ,
RecordSeparator:
{
Description: The string used to separate records. ,
Required: False ,
}
string ,
EscapeChar:
{
Description: The string used as an escape character. ,
Required: False ,
}
string ,
HeadersPresent:
{
Description: Represents whether the data has headers. ,
Required: False ,
}
boolean ,
}
,
JsonTextConfiguration:
{
Description: json text configuration ,
Required: False ,
}
{
RecordSeparator:
{
Description: The string used to separate records. ,
Required: False ,
}
string ,
}
,
ArrowConfiguration:
{
Description: Groups the settings used for formatting the response if the response should be Arrow formatted. ,
Required: False ,
}
{
Schema:
{
Required: True ,
}
[
{
Type:
{
Required: True ,
}
string ,
Name:
{
Required: False ,
}
string ,
Precision:
{
Required: False ,
}
integer ,
Scale:
{
Required: False ,
}
integer ,
}
,
]
,
}
,
ParquetTextConfiguration:
{
Description: parquet configuration ,
Required: False ,
}
object ,
}
,
}
,
OutputSerialization:
{
Required: False ,
}
{
Format:
{
Required: True ,
}
{
Type:
{
Description: The quick query format type. ,
Enum:
{
delimited: No description available. ,
json: No description available. ,
arrow: No description available. ,
parquet: No description available. ,
}
,
Required: True ,
}
enum ,
DelimitedTextConfiguration:
{
Description: Groups the settings used for interpreting the blob data if the blob is delimited text formatted. ,
Required: False ,
}
{
ColumnSeparator:
{
Description: The string used to separate columns. ,
Required: False ,
}
string ,
FieldQuote:
{
Description: The string used to quote a specific field. ,
Required: False ,
}
string ,
RecordSeparator:
{
Description: The string used to separate records. ,
Required: False ,
}
string ,
EscapeChar:
{
Description: The string used as an escape character. ,
Required: False ,
}
string ,
HeadersPresent:
{
Description: Represents whether the data has headers. ,
Required: False ,
}
boolean ,
}
,
JsonTextConfiguration:
{
Description: json text configuration ,
Required: False ,
}
{
RecordSeparator:
{
Description: The string used to separate records. ,
Required: False ,
}
string ,
}
,
ArrowConfiguration:
{
Description: Groups the settings used for formatting the response if the response should be Arrow formatted. ,
Required: False ,
}
{
Schema:
{
Required: True ,
}
[
{
Type:
{
Required: True ,
}
string ,
Name:
{
Required: False ,
}
string ,
Precision:
{
Required: False ,
}
integer ,
Scale:
{
Required: False ,
}
integer ,
}
,
]
,
}
,
ParquetTextConfiguration:
{
Description: parquet configuration ,
Required: False ,
}
object ,
}
,
}
,
}
,
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 ,
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-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 ,
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 ,
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 ,
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-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:
{
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-meta: string ,
content-length:
{
Description: The number of bytes present in the response body. ,
}
integer ,
content-type:
{
Description: The media type of the body of the response. For Download Blob this is 'application/octet-stream' ,
}
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 ,
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 ,
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-encoding:
{
Description: This header returns the value that was specified for the Content-Encoding request header ,
}
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-language:
{
Description: This header returns the value that was specified for the Content-Language request header. ,
}
string ,
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 blob's type. ,
}
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-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-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-lease-duration:
{
Description: When a blob is leased, specifies whether the lease is of infinite or fixed duration. ,
}
string ,
x-ms-lease-state:
{
Description: Lease state of the blob. ,
}
string ,
x-ms-lease-status:
{
Description: The current lease status 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 ,
accept-ranges:
{
Description: Indicates that the service supports requests for partial blob content. ,
}
string ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
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-server-encrypted:
{
Description: The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the blob is unencrypted, or if only parts of the blob/application metadata are encrypted). ,
}
boolean ,
x-ms-encryption-key-sha256:
{
Description: The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key. ,
}
string ,
x-ms-encryption-scope:
{
Description: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. ,
}
string ,
x-ms-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 ,
}
,
$schema:
{
Format: file ,
}
object ,
}

⚐ Response (206)

{
$headers:
{
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-meta: string ,
content-length:
{
Description: The number of bytes present in the response body. ,
}
integer ,
content-type:
{
Description: The media type of the body of the response. For Download Blob this is 'application/octet-stream' ,
}
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 ,
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 ,
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-encoding:
{
Description: This header returns the value that was specified for the Content-Encoding request header ,
}
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-language:
{
Description: This header returns the value that was specified for the Content-Language request header. ,
}
string ,
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 blob's type. ,
}
string ,
x-ms-content-crc64:
{
Description: If the request is to read a specified range and the x-ms-range-get-content-crc64 is set to true, then the request returns a crc64 for the range, as long as the range size is less than or equal to 4 MB. If both x-ms-range-get-content-crc64 and x-ms-range-get-content-md5 is specified in the same request, it will fail with 400(Bad 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-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-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-lease-duration:
{
Description: When a blob is leased, specifies whether the lease is of infinite or fixed duration. ,
}
string ,
x-ms-lease-state:
{
Description: Lease state of the blob. ,
}
string ,
x-ms-lease-status:
{
Description: The current lease status 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 ,
accept-ranges:
{
Description: Indicates that the service supports requests for partial blob content. ,
}
string ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
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-server-encrypted:
{
Description: The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the blob is unencrypted, or if only parts of the blob/application metadata are encrypted). ,
}
boolean ,
x-ms-encryption-key-sha256:
{
Description: The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key. ,
}
string ,
x-ms-encryption-scope:
{
Description: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. ,
}
string ,
x-ms-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 ,
}
,
$schema:
{
Format: file ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Blob_GetTags (updated)
Description :  The Get Tags operation enables users to get the tags associated with a blob.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Blob_GetTags",
  "$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."
      }
    },
    {
      "#name": "snapshot",
      "Description": {
        "new": "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.",
        "old": "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."
      }
    }
  ]
}

⚼ Request

GET:  /{containerName}/{blob}?comp=tags
{
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 ,
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 ,
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-lease-id:
{
Description: If specified, the operation only succeeds if the resource's lease is active and matches this ID. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$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: 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: Blob tags ,
}
{
BlobTagSet:
{
Required: True ,
}
[
{
Key:
{
Required: True ,
}
string ,
Value:
{
Required: True ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Blob_SetTags (updated)
Description :  The Set Tags operation enables users to set tags on a blob.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Blob_SetTags",
  "$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:  /{containerName}/{blob}?comp=tags
{
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. ,
Required: False ,
}
integer ,
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 ,
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-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-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-lease-id:
{
Description: If specified, the operation only succeeds if the resource's lease is active and matches this ID. ,
Required: False ,
}
string ,
Tags:
{
Description: Blob tags ,
Required: False ,
}
{
BlobTagSet:
{
Required: True ,
}
[
{
Key:
{
Required: True ,
}
string ,
Value:
{
Required: True ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (204)

{
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:
{
Message:
{
Required: False ,
}
string ,
}
,
}