{
"swagger": "2.0",
"info": {
"title": "Azure Storage Blob service",
"version": "2025-11-05",
"x-typespec-generated": [
{
"emitter": "@azure-tools/typespec-autorest"
}
]
},
"schemes": [
"https"
],
"x-ms-parameterized-host": {
"hostTemplate": "{url}",
"useSchemePrefix": false,
"parameters": [
{
"name": "url",
"in": "path",
"description": "The host name of the blob storage account, e.g. accountName.blob.core.windows.net",
"required": true,
"type": "string",
"format": "uri",
"x-ms-skip-url-encoding": true
}
]
},
"produces": [
"application/xml"
],
"consumes": [
"application/xml"
],
"security": [
{
"OAuth2Auth": [
"https://storage.azure.com/.default"
]
}
],
"securityDefinitions": {
"OAuth2Auth": {
"type": "oauth2",
"flow": "implicit",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"scopes": {
"https://storage.azure.com/.default": ""
}
}
},
"tags": [],
"paths": {
"/": {
"get": {
"operationId": "Blob_Download",
"description": "Downloads the specified blob.",
"produces": [
"application/octet-stream",
"application/xml"
],
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "snapshot",
"in": "query",
"description": "Specifies the snapshot of the blob.",
"required": false,
"type": "string"
},
{
"name": "versionid",
"in": "query",
"description": "Specifies the version ID of the blob.",
"required": false,
"type": "string",
"x-ms-client-name": "versionId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "Range",
"in": "header",
"description": "Specifies the range of the blob to operate on.",
"required": false,
"type": "string",
"x-ms-client-name": "range"
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.",
"required": false,
"type": "string",
"x-ms-client-name": "leaseId"
},
{
"name": "x-ms-range-get-content-md5",
"in": "header",
"description": "When set to true and specified together with the `Range` header, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4 MiB in size.",
"required": false,
"type": "boolean",
"x-ms-client-name": "rangeGetContentMd5"
},
{
"name": "x-ms-range-get-content-crc64",
"in": "header",
"description": "When set to true and the request includes a Range header, the service returns the CRC64 hash for the range, as long as the range is less than or equal to 4 MiB in size.",
"required": false,
"type": "boolean",
"x-ms-client-name": "rangeGetContentCrc64"
},
{
"name": "x-ms-structured-body",
"in": "header",
"description": "Specifies the response content should be returned as a structured message and specifies the message schema version and properties.",
"required": false,
"type": "string",
"x-ms-client-name": "structuredBodyType"
},
{
"name": "x-ms-encryption-key",
"in": "header",
"description": "Specifies the encryption key to use to encrypt the data provided in the request.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionKey"
},
{
"name": "x-ms-encryption-key-sha256",
"in": "header",
"description": "The SHA-256 hash of the provided encryption key. Must be provided if the encryption key is provided.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionKeySha256"
},
{
"name": "x-ms-encryption-algorithm",
"in": "header",
"description": "The algorithm used to produce the encryption key hash. Must be provided if the encryption key is provided.",
"required": false,
"type": "string",
"enum": [
"AES256"
],
"x-ms-enum": {
"name": "EncryptionAlgorithmType",
"modelAsString": false,
"values": [
{
"name": "AES256",
"value": "AES256",
"description": "The AES256 encryption algorithm."
}
]
},
"x-ms-client-name": "encryptionAlgorithm"
},
{
"name": "x-ms-if-tags",
"in": "header",
"description": "Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.",
"required": false,
"type": "string",
"x-ms-client-name": "ifTags"
},
{
"name": "If-Modified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifModifiedSince"
},
{
"name": "If-Unmodified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifUnmodifiedSince"
},
{
"name": "If-None-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a non-matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifNoneMatch"
},
{
"name": "If-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifMatch"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"type": "file"
},
"headers": {
"Accept-Ranges": {
"type": "string",
"description": "Indicates that the service supports requests for partial blob content."
},
"Cache-Control": {
"type": "string",
"description": "The Cache-Control of the blob."
},
"Content-Disposition": {
"type": "string",
"description": "The Content-Disposition of the blob."
},
"Content-Encoding": {
"type": "string",
"description": "The Content-Encoding of the blob."
},
"Content-Language": {
"type": "string",
"description": "The Content-Language of the blob."
},
"Content-Length": {
"type": "integer",
"format": "int64",
"description": "The number of bytes present in the response body."
},
"Content-MD5": {
"type": "string",
"format": "byte",
"description": "The blob content MD5 hash. Only returned if the full blob is read."
},
"Content-Range": {
"type": "string",
"description": "Indicates the range of bytes returned in this response."
},
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-blob-committed-block-count": {
"type": "integer",
"format": "int32",
"description": "The number of committed blocks present in the blob."
},
"x-ms-blob-content-md5": {
"type": "string",
"format": "byte",
"description": "MD5 hash of the full blob content only returned for ranged reads. This is the hash of the complete blob, not just the requested range."
},
"x-ms-blob-sealed": {
"type": "boolean",
"description": "Whether the blob is sealed."
},
"x-ms-blob-sequence-number": {
"type": "integer",
"format": "int64",
"description": "The current sequence number for a page blob."
},
"x-ms-blob-type": {
"type": "string",
"description": "The type of the blob.",
"enum": [
"BlockBlob",
"PageBlob",
"AppendBlob"
],
"x-ms-enum": {
"name": "BlobType",
"modelAsString": false,
"values": [
{
"name": "BlockBlob",
"value": "BlockBlob",
"description": "The blob is a block blob."
},
{
"name": "PageBlob",
"value": "PageBlob",
"description": "The blob is a page blob."
},
{
"name": "AppendBlob",
"value": "AppendBlob",
"description": "The blob is an append blob."
}
]
}
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-copy-completion-time": {
"type": "string",
"format": "date-time-rfc7231",
"description": "If this blob was the destination of a copy, specifies the completion time of the last attempted copy operation."
},
"x-ms-copy-id": {
"type": "string",
"description": "Identifier for this copy operation."
},
"x-ms-copy-progress": {
"type": "string",
"description": "If this blob was the destination of a copy, specifies the number of bytes copied and the total bytes in the source."
},
"x-ms-copy-source": {
"type": "string",
"description": "If this blob was the destination of a copy, specifies the source URL."
},
"x-ms-copy-status": {
"type": "string",
"description": "Status of the copy operation.",
"enum": [
"pending",
"success",
"failed",
"aborted"
],
"x-ms-enum": {
"name": "CopyStatus",
"modelAsString": false,
"values": [
{
"name": "Pending",
"value": "pending",
"description": "The copy operation is pending."
},
{
"name": "Success",
"value": "success",
"description": "The copy operation succeeded."
},
{
"name": "Failed",
"value": "failed",
"description": "The copy operation failed."
},
{
"name": "Aborted",
"value": "aborted",
"description": "The copy operation was aborted."
}
]
}
},
"x-ms-copy-status-description": {
"type": "string",
"description": "If this blob was the destination of a copy, specifies the cause of the copy operation failure."
},
"x-ms-creation-time": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time the blob was created."
},
"x-ms-encryption-key-sha256": {
"type": "string",
"description": "The SHA-256 hash of the provided encryption key."
},
"x-ms-encryption-scope": {
"type": "string",
"description": "Specifies the encryption scope used to encrypt the data."
},
"x-ms-immutability-policy-mode": {
"type": "string",
"description": "Indicates the immutability policy mode of the blob.",
"enum": [
"mutable",
"locked",
"unlocked"
],
"x-ms-enum": {
"name": "ImmutabilityPolicyMode",
"modelAsString": false,
"values": [
{
"name": "Mutable",
"value": "mutable",
"description": "Response only. The immutability policy is mutable."
},
{
"name": "Locked",
"value": "locked",
"description": "The immutability policy is locked."
},
{
"name": "Unlocked",
"value": "unlocked",
"description": "The immutability policy is unlocked."
}
]
}
},
"x-ms-immutability-policy-until-date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that indicates the time at which the blob immutability policy will expire."
},
"x-ms-is-current-version": {
"type": "boolean",
"description": "Indicates whether this is the current version of the blob."
},
"x-ms-last-access-time": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time value that indicates the time at which the blob was last read or written."
},
"x-ms-lease-duration": {
"type": "string",
"description": "Specifies the duration of the lease.",
"enum": [
"infinite",
"fixed"
],
"x-ms-enum": {
"name": "LeaseDuration",
"modelAsString": false,
"values": [
{
"name": "Infinite",
"value": "infinite",
"description": "The lease is of infinite duration."
},
{
"name": "Fixed",
"value": "fixed",
"description": "The lease is of fixed duration."
}
]
}
},
"x-ms-lease-state": {
"type": "string",
"description": "The lease state of the blob.",
"enum": [
"available",
"leased",
"expired",
"breaking",
"broken"
],
"x-ms-enum": {
"name": "LeaseState",
"modelAsString": false,
"values": [
{
"name": "Available",
"value": "available",
"description": "The lease is available."
},
{
"name": "Leased",
"value": "leased",
"description": "The lease is currently leased."
},
{
"name": "Expired",
"value": "expired",
"description": "The lease is expired."
},
{
"name": "Breaking",
"value": "breaking",
"description": "The lease is breaking."
},
{
"name": "Broken",
"value": "broken",
"description": "The lease is broken."
}
]
}
},
"x-ms-lease-status": {
"type": "string",
"description": "The lease status of the blob.",
"enum": [
"unlocked",
"locked"
],
"x-ms-enum": {
"name": "LeaseStatus",
"modelAsString": false,
"values": [
{
"name": "Unlocked",
"value": "unlocked",
"description": "The lease is unlocked."
},
{
"name": "Locked",
"value": "locked",
"description": "The lease is locked."
}
]
}
},
"x-ms-legal-hold": {
"type": "boolean",
"description": "Indicates whether the blob has a legal hold."
},
"x-ms-meta": {
"type": "string",
"description": "The metadata headers."
},
"x-ms-or": {
"type": "string",
"description": "The object replication status headers."
},
"x-ms-or-policy-id": {
"type": "string",
"description": "The object replication policy ID."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-server-encrypted": {
"type": "boolean",
"description": "Indicates whether the contents of the request are successfully encrypted."
},
"x-ms-structured-body": {
"type": "string",
"description": "Indicates if the response body contains a structured message and specifies the message schema version and properties."
},
"x-ms-structured-content-length": {
"type": "integer",
"format": "int64",
"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."
},
"x-ms-tag-count": {
"type": "integer",
"format": "int64",
"description": "The number of tags associated with the blob."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
},
"x-ms-version-id": {
"type": "string",
"description": "The version ID of the blob."
}
}
},
"206": {
"description": "Successful",
"schema": {
"type": "file"
},
"headers": {
"Accept-Ranges": {
"type": "string",
"description": "Indicates that the service supports requests for partial blob content."
},
"Cache-Control": {
"type": "string",
"description": "The Cache-Control of the blob."
},
"Content-Disposition": {
"type": "string",
"description": "The Content-Disposition of the blob."
},
"Content-Encoding": {
"type": "string",
"description": "The Content-Encoding of the blob."
},
"Content-Language": {
"type": "string",
"description": "The Content-Language of the blob."
},
"Content-Length": {
"type": "integer",
"format": "int64",
"description": "The number of bytes present in the response body."
},
"Content-MD5": {
"type": "string",
"format": "byte",
"description": "The blob content MD5 hash. Only returned if the full blob is read."
},
"Content-Range": {
"type": "string",
"description": "Indicates the range of bytes returned in this response."
},
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-blob-committed-block-count": {
"type": "integer",
"format": "int32",
"description": "The number of committed blocks present in the blob."
},
"x-ms-blob-content-md5": {
"type": "string",
"format": "byte",
"description": "MD5 hash of the full blob content only returned for ranged reads. This is the hash of the complete blob, not just the requested range."
},
"x-ms-blob-sealed": {
"type": "boolean",
"description": "Whether the blob is sealed."
},
"x-ms-blob-sequence-number": {
"type": "integer",
"format": "int64",
"description": "The current sequence number for a page blob."
},
"x-ms-blob-type": {
"type": "string",
"description": "The type of the blob.",
"enum": [
"BlockBlob",
"PageBlob",
"AppendBlob"
],
"x-ms-enum": {
"name": "BlobType",
"modelAsString": false,
"values": [
{
"name": "BlockBlob",
"value": "BlockBlob",
"description": "The blob is a block blob."
},
{
"name": "PageBlob",
"value": "PageBlob",
"description": "The blob is a page blob."
},
{
"name": "AppendBlob",
"value": "AppendBlob",
"description": "The blob is an append blob."
}
]
}
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-content-crc64": {
"type": "string",
"format": "byte",
"description": "The CRC64 hash of the content."
},
"x-ms-copy-completion-time": {
"type": "string",
"format": "date-time-rfc7231",
"description": "If this blob was the destination of a copy, specifies the completion time of the last attempted copy operation."
},
"x-ms-copy-id": {
"type": "string",
"description": "Identifier for this copy operation."
},
"x-ms-copy-progress": {
"type": "string",
"description": "If this blob was the destination of a copy, specifies the number of bytes copied and the total bytes in the source."
},
"x-ms-copy-source": {
"type": "string",
"description": "If this blob was the destination of a copy, specifies the source URL."
},
"x-ms-copy-status": {
"type": "string",
"description": "Status of the copy operation.",
"enum": [
"pending",
"success",
"failed",
"aborted"
],
"x-ms-enum": {
"name": "CopyStatus",
"modelAsString": false,
"values": [
{
"name": "Pending",
"value": "pending",
"description": "The copy operation is pending."
},
{
"name": "Success",
"value": "success",
"description": "The copy operation succeeded."
},
{
"name": "Failed",
"value": "failed",
"description": "The copy operation failed."
},
{
"name": "Aborted",
"value": "aborted",
"description": "The copy operation was aborted."
}
]
}
},
"x-ms-copy-status-description": {
"type": "string",
"description": "If this blob was the destination of a copy, specifies the cause of the copy operation failure."
},
"x-ms-creation-time": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time the blob was created."
},
"x-ms-encryption-key-sha256": {
"type": "string",
"description": "The SHA-256 hash of the provided encryption key."
},
"x-ms-encryption-scope": {
"type": "string",
"description": "Specifies the encryption scope used to encrypt the data."
},
"x-ms-immutability-policy-mode": {
"type": "string",
"description": "Indicates the immutability policy mode of the blob.",
"enum": [
"mutable",
"locked",
"unlocked"
],
"x-ms-enum": {
"name": "ImmutabilityPolicyMode",
"modelAsString": false,
"values": [
{
"name": "Mutable",
"value": "mutable",
"description": "Response only. The immutability policy is mutable."
},
{
"name": "Locked",
"value": "locked",
"description": "The immutability policy is locked."
},
{
"name": "Unlocked",
"value": "unlocked",
"description": "The immutability policy is unlocked."
}
]
}
},
"x-ms-immutability-policy-until-date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that indicates the time at which the blob immutability policy will expire."
},
"x-ms-is-current-version": {
"type": "boolean",
"description": "Indicates whether this is the current version of the blob."
},
"x-ms-last-access-time": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time value that indicates the time at which the blob was last read or written."
},
"x-ms-lease-duration": {
"type": "string",
"description": "Specifies the duration of the lease.",
"enum": [
"infinite",
"fixed"
],
"x-ms-enum": {
"name": "LeaseDuration",
"modelAsString": false,
"values": [
{
"name": "Infinite",
"value": "infinite",
"description": "The lease is of infinite duration."
},
{
"name": "Fixed",
"value": "fixed",
"description": "The lease is of fixed duration."
}
]
}
},
"x-ms-lease-state": {
"type": "string",
"description": "The lease state of the blob.",
"enum": [
"available",
"leased",
"expired",
"breaking",
"broken"
],
"x-ms-enum": {
"name": "LeaseState",
"modelAsString": false,
"values": [
{
"name": "Available",
"value": "available",
"description": "The lease is available."
},
{
"name": "Leased",
"value": "leased",
"description": "The lease is currently leased."
},
{
"name": "Expired",
"value": "expired",
"description": "The lease is expired."
},
{
"name": "Breaking",
"value": "breaking",
"description": "The lease is breaking."
},
{
"name": "Broken",
"value": "broken",
"description": "The lease is broken."
}
]
}
},
"x-ms-lease-status": {
"type": "string",
"description": "The lease status of the blob.",
"enum": [
"unlocked",
"locked"
],
"x-ms-enum": {
"name": "LeaseStatus",
"modelAsString": false,
"values": [
{
"name": "Unlocked",
"value": "unlocked",
"description": "The lease is unlocked."
},
{
"name": "Locked",
"value": "locked",
"description": "The lease is locked."
}
]
}
},
"x-ms-legal-hold": {
"type": "boolean",
"description": "Indicates whether the blob has a legal hold."
},
"x-ms-meta": {
"type": "string",
"description": "The metadata headers."
},
"x-ms-or": {
"type": "string",
"description": "The object replication status headers."
},
"x-ms-or-policy-id": {
"type": "string",
"description": "The object replication policy ID."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-server-encrypted": {
"type": "boolean",
"description": "Indicates whether the contents of the request are successfully encrypted."
},
"x-ms-structured-body": {
"type": "string",
"description": "Indicates if the response body contains a structured message and specifies the message schema version and properties."
},
"x-ms-structured-content-length": {
"type": "integer",
"format": "int64",
"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."
},
"x-ms-tag-count": {
"type": "integer",
"format": "int64",
"description": "The number of tags associated with the blob."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
},
"x-ms-version-id": {
"type": "string",
"description": "The version ID of the blob."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
},
"put": {
"operationId": "Blob_StartCopyFromUrl",
"description": "Starts an asynchronous copy from a source URL to a destination blob.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "x-ms-meta",
"in": "header",
"description": "The metadata headers.",
"required": false,
"type": "string",
"x-ms-client-name": "metadata"
},
{
"name": "x-ms-access-tier",
"in": "header",
"description": "The tier to be set on the blob.",
"required": false,
"type": "string",
"enum": [
"P4",
"P6",
"P10",
"P15",
"P20",
"P30",
"P40",
"P50",
"P60",
"P70",
"P80",
"Hot",
"Cool",
"Archive",
"Premium",
"Cold"
],
"x-ms-enum": {
"name": "AccessTier",
"modelAsString": true,
"values": [
{
"name": "P4",
"value": "P4",
"description": "The P4 access tier."
},
{
"name": "P6",
"value": "P6",
"description": "The P6 access tier."
},
{
"name": "P10",
"value": "P10",
"description": "The P10 access tier."
},
{
"name": "P15",
"value": "P15",
"description": "The P15 access tier."
},
{
"name": "P20",
"value": "P20",
"description": "The P20 access tier."
},
{
"name": "P30",
"value": "P30",
"description": "The P30 access tier."
},
{
"name": "P40",
"value": "P40",
"description": "The P40 access tier."
},
{
"name": "P50",
"value": "P50",
"description": "The P50 access tier."
},
{
"name": "P60",
"value": "P60",
"description": "The P60 access tier."
},
{
"name": "P70",
"value": "P70",
"description": "The P70 access tier."
},
{
"name": "P80",
"value": "P80",
"description": "The P80 access tier."
},
{
"name": "Hot",
"value": "Hot",
"description": "The Hot access tier."
},
{
"name": "Cool",
"value": "Cool",
"description": "The Cool access tier."
},
{
"name": "Archive",
"value": "Archive",
"description": "The Archive access tier."
},
{
"name": "Premium",
"value": "Premium",
"description": "The Premium access tier."
},
{
"name": "Cold",
"value": "Cold",
"description": "The Cold access tier."
}
]
},
"x-ms-client-name": "tier"
},
{
"name": "x-ms-rehydrate-priority",
"in": "header",
"description": "The priority of the rehydration operation.",
"required": false,
"type": "string",
"enum": [
"High",
"Standard"
],
"x-ms-enum": {
"name": "RehydratePriority",
"modelAsString": true,
"values": [
{
"name": "High",
"value": "High",
"description": "The rehydrate priority is high."
},
{
"name": "Standard",
"value": "Standard",
"description": "The rehydrate priority is standard."
}
]
},
"x-ms-client-name": "rehydratePriority"
},
{
"name": "x-ms-source-if-modified-since",
"in": "header",
"description": "Specify this value to operate only on a source blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "sourceIfModifiedSince"
},
{
"name": "x-ms-source-if-unmodified-since",
"in": "header",
"description": "Specify this header value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "sourceIfUnmodifiedSince"
},
{
"name": "x-ms-source-if-match",
"in": "header",
"description": "Specify this value to operate only on a source blob with a matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "sourceIfMatch"
},
{
"name": "x-ms-source-if-none-match",
"in": "header",
"description": "Specify this value to operate only on a source blob with a non-matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "sourceIfNoneMatch"
},
{
"name": "x-ms-source-if-tags",
"in": "header",
"description": "Specifies a SQL-like where clause on blob tags to operate only on a source blob with matching tags.",
"required": false,
"type": "string",
"x-ms-client-name": "sourceIfTags"
},
{
"name": "If-Modified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifModifiedSince"
},
{
"name": "If-Unmodified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifUnmodifiedSince"
},
{
"name": "If-None-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a non-matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifNoneMatch"
},
{
"name": "If-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifMatch"
},
{
"name": "x-ms-if-tags",
"in": "header",
"description": "Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.",
"required": false,
"type": "string",
"x-ms-client-name": "ifTags"
},
{
"name": "x-ms-copy-source",
"in": "header",
"description": "Specifies the name of the source URL for the copy operation. The value should be URL-encoded as it would appear in a request URI.",
"required": true,
"type": "string",
"x-ms-client-name": "copySource"
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.",
"required": false,
"type": "string",
"x-ms-client-name": "leaseId"
},
{
"name": "x-ms-tags",
"in": "header",
"description": "The blob tags.",
"required": false,
"type": "string",
"x-ms-client-name": "BlobTagsString"
},
{
"name": "x-ms-seal-blob",
"in": "header",
"description": "Overrides the sealed state of the destination blob.",
"required": false,
"type": "boolean",
"x-ms-client-name": "sealBlob"
},
{
"name": "x-ms-immutability-policy-until-date",
"in": "header",
"description": "The date-time that indicates the time at which the blob immutability policy will expire.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "immutabilityPolicyExpiry"
},
{
"name": "x-ms-immutability-policy-mode",
"in": "header",
"description": "Indicates the immutability policy mode of the blob.",
"required": false,
"type": "string",
"enum": [
"mutable",
"locked",
"unlocked"
],
"x-ms-enum": {
"name": "ImmutabilityPolicyMode",
"modelAsString": false,
"values": [
{
"name": "Mutable",
"value": "mutable",
"description": "Response only. The immutability policy is mutable."
},
{
"name": "Locked",
"value": "locked",
"description": "The immutability policy is locked."
},
{
"name": "Unlocked",
"value": "unlocked",
"description": "The immutability policy is unlocked."
}
]
},
"x-ms-client-name": "immutabilityPolicyMode"
},
{
"name": "x-ms-legal-hold",
"in": "header",
"description": "Indicates whether the blob has a legal hold.",
"required": false,
"type": "boolean",
"x-ms-client-name": "legalHold"
}
],
"responses": {
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-copy-id": {
"type": "string",
"description": "Identifier for this copy operation."
},
"x-ms-copy-status": {
"type": "string",
"description": "Status of the copy operation.",
"enum": [
"pending",
"success",
"failed",
"aborted"
],
"x-ms-enum": {
"name": "CopyStatus",
"modelAsString": false,
"values": [
{
"name": "Pending",
"value": "pending",
"description": "The copy operation is pending."
},
{
"name": "Success",
"value": "success",
"description": "The copy operation succeeded."
},
{
"name": "Failed",
"value": "failed",
"description": "The copy operation failed."
},
{
"name": "Aborted",
"value": "aborted",
"description": "The copy operation was aborted."
}
]
}
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
},
"x-ms-version-id": {
"type": "string",
"description": "The version ID of the blob."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
},
"delete": {
"operationId": "Blob_Delete",
"description": "Deletes the specified blob. If blob soft delete is enabled, the blob is marked for deletion and can be recovered until the retention period expires.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "snapshot",
"in": "query",
"description": "Specifies the snapshot of the blob.",
"required": false,
"type": "string"
},
{
"name": "versionid",
"in": "query",
"description": "Specifies the version ID of the blob.",
"required": false,
"type": "string",
"x-ms-client-name": "versionId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.",
"required": false,
"type": "string",
"x-ms-client-name": "leaseId"
},
{
"name": "x-ms-delete-snapshots",
"in": "header",
"description": "Required if the blob has associated snapshots. Specifies the delete behavior.",
"required": false,
"type": "string",
"enum": [
"only",
"include"
],
"x-ms-enum": {
"name": "DeleteSnapshotsOptionType",
"modelAsString": false,
"values": [
{
"name": "Only",
"value": "only",
"description": "Only delete the snapshots."
},
{
"name": "Include",
"value": "include",
"description": "Delete the blob and snapshots."
}
]
},
"x-ms-client-name": "deleteSnapshots"
},
{
"name": "If-Modified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifModifiedSince"
},
{
"name": "If-Unmodified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifUnmodifiedSince"
},
{
"name": "If-None-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a non-matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifNoneMatch"
},
{
"name": "If-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifMatch"
},
{
"name": "x-ms-if-tags",
"in": "header",
"description": "Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.",
"required": false,
"type": "string",
"x-ms-client-name": "ifTags"
},
{
"name": "deletetype",
"in": "query",
"description": "The delete type.",
"required": false,
"type": "string",
"enum": [
"Permanent"
],
"x-ms-enum": {
"name": "BlobDeleteType",
"modelAsString": false,
"values": [
{
"name": "Permanent",
"value": "Permanent",
"description": "Permanently delete the blob."
}
]
},
"x-ms-client-name": "blobDeleteType"
}
],
"responses": {
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
},
"head": {
"operationId": "Blob_GetProperties",
"description": "Returns all user-defined metadata, standard HTTP properties, and system properties for the specified blob. It does not return the content of the blob.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "snapshot",
"in": "query",
"description": "Specifies the snapshot of the blob.",
"required": false,
"type": "string"
},
{
"name": "versionid",
"in": "query",
"description": "Specifies the version ID of the blob.",
"required": false,
"type": "string",
"x-ms-client-name": "versionId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.",
"required": false,
"type": "string",
"x-ms-client-name": "leaseId"
},
{
"name": "x-ms-encryption-key",
"in": "header",
"description": "Specifies the encryption key to use to encrypt the data provided in the request.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionKey"
},
{
"name": "x-ms-encryption-key-sha256",
"in": "header",
"description": "The SHA-256 hash of the provided encryption key. Must be provided if the encryption key is provided.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionKeySha256"
},
{
"name": "x-ms-encryption-algorithm",
"in": "header",
"description": "The algorithm used to produce the encryption key hash. Must be provided if the encryption key is provided.",
"required": false,
"type": "string",
"enum": [
"AES256"
],
"x-ms-enum": {
"name": "EncryptionAlgorithmType",
"modelAsString": false,
"values": [
{
"name": "AES256",
"value": "AES256",
"description": "The AES256 encryption algorithm."
}
]
},
"x-ms-client-name": "encryptionAlgorithm"
},
{
"name": "If-Modified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifModifiedSince"
},
{
"name": "If-Unmodified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifUnmodifiedSince"
},
{
"name": "If-None-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a non-matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifNoneMatch"
},
{
"name": "If-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifMatch"
},
{
"name": "x-ms-if-tags",
"in": "header",
"description": "Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.",
"required": false,
"type": "string",
"x-ms-client-name": "ifTags"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"headers": {
"Accept-Ranges": {
"type": "string",
"description": "Indicates that the service supports requests for partial blob content."
},
"Cache-Control": {
"type": "string",
"description": "The Cache-Control of the blob."
},
"Content-Disposition": {
"type": "string",
"description": "The Content-Disposition of the blob."
},
"Content-Encoding": {
"type": "string",
"description": "The Content-Encoding of the blob."
},
"Content-Language": {
"type": "string",
"description": "The Content-Language of the blob."
},
"Content-Length": {
"type": "integer",
"format": "int64",
"description": "The number of bytes present in the response body."
},
"Content-MD5": {
"type": "string",
"format": "byte",
"description": "The blob content MD5 hash. Only returned if the full blob is read."
},
"Content-Type": {
"type": "string",
"description": "Content-type."
},
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-access-tier": {
"type": "string",
"description": "The access tier of the blob."
},
"x-ms-access-tier-change-time": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The time the tier was changed on the blob. This is only returned if the tier on the blob was ever set."
},
"x-ms-access-tier-inferred": {
"type": "boolean",
"description": "Included if the access tier is inferred."
},
"x-ms-archive-status": {
"type": "string",
"description": "Included if the blob rehydrate operation is pending. Indicates the destination tier.",
"enum": [
"rehydrate-pending-to-hot",
"rehydrate-pending-to-cool",
"rehydrate-pending-to-cold"
],
"x-ms-enum": {
"name": "ArchiveStatus",
"modelAsString": true,
"values": [
{
"name": "RehydratePendingToHot",
"value": "rehydrate-pending-to-hot",
"description": "The archive status is rehydrating pending to Hot."
},
{
"name": "RehydratePendingToCool",
"value": "rehydrate-pending-to-cool",
"description": "The archive status is rehydrating pending to Cool."
},
{
"name": "RehydratePendingToCold",
"value": "rehydrate-pending-to-cold",
"description": "The archive status is rehydrating pending to Cold."
}
]
}
},
"x-ms-blob-committed-block-count": {
"type": "integer",
"format": "int32",
"description": "The number of committed blocks present in the blob."
},
"x-ms-blob-sealed": {
"type": "boolean",
"description": "Whether the blob is sealed."
},
"x-ms-blob-sequence-number": {
"type": "integer",
"format": "int64",
"description": "The current sequence number for a page blob."
},
"x-ms-blob-type": {
"type": "string",
"description": "The type of the blob.",
"enum": [
"BlockBlob",
"PageBlob",
"AppendBlob"
],
"x-ms-enum": {
"name": "BlobType",
"modelAsString": false,
"values": [
{
"name": "BlockBlob",
"value": "BlockBlob",
"description": "The blob is a block blob."
},
{
"name": "PageBlob",
"value": "PageBlob",
"description": "The blob is a page blob."
},
{
"name": "AppendBlob",
"value": "AppendBlob",
"description": "The blob is an append blob."
}
]
}
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-copy-completion-time": {
"type": "string",
"format": "date-time-rfc7231",
"description": "If this blob was the destination of a copy, specifies the completion time of the last attempted copy operation."
},
"x-ms-copy-destination-snapshot": {
"type": "string",
"description": "Included if the blob is incremental copy blob or incremental copy snapshot, if x-ms-copy-status is success."
},
"x-ms-copy-id": {
"type": "string",
"description": "Identifier for this copy operation."
},
"x-ms-copy-progress": {
"type": "string",
"description": "If this blob was the destination of a copy, specifies the number of bytes copied and the total bytes in the source."
},
"x-ms-copy-source": {
"type": "string",
"description": "If this blob was the destination of a copy, specifies the source URL."
},
"x-ms-copy-status": {
"type": "string",
"description": "Status of the copy operation.",
"enum": [
"pending",
"success",
"failed",
"aborted"
],
"x-ms-enum": {
"name": "CopyStatus",
"modelAsString": false,
"values": [
{
"name": "Pending",
"value": "pending",
"description": "The copy operation is pending."
},
{
"name": "Success",
"value": "success",
"description": "The copy operation succeeded."
},
{
"name": "Failed",
"value": "failed",
"description": "The copy operation failed."
},
{
"name": "Aborted",
"value": "aborted",
"description": "The copy operation was aborted."
}
]
}
},
"x-ms-copy-status-description": {
"type": "string",
"description": "If this blob was the destination of a copy, specifies the cause of the copy operation failure."
},
"x-ms-creation-time": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time the blob was created."
},
"x-ms-encryption-key-sha256": {
"type": "string",
"description": "The SHA-256 hash of the provided encryption key."
},
"x-ms-encryption-scope": {
"type": "string",
"description": "Specifies the encryption scope used to encrypt the data."
},
"x-ms-expiry-time": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time this blob will expire."
},
"x-ms-immutability-policy-mode": {
"type": "string",
"description": "Indicates the immutability policy mode of the blob.",
"enum": [
"mutable",
"locked",
"unlocked"
],
"x-ms-enum": {
"name": "ImmutabilityPolicyMode",
"modelAsString": false,
"values": [
{
"name": "Mutable",
"value": "mutable",
"description": "Response only. The immutability policy is mutable."
},
{
"name": "Locked",
"value": "locked",
"description": "The immutability policy is locked."
},
{
"name": "Unlocked",
"value": "unlocked",
"description": "The immutability policy is unlocked."
}
]
}
},
"x-ms-immutability-policy-until-date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that indicates the time at which the blob immutability policy will expire."
},
"x-ms-incremental-copy": {
"type": "boolean",
"description": "Included if the blob is incremental copy blob."
},
"x-ms-is-current-version": {
"type": "boolean",
"description": "Indicates whether this is the current version of the blob."
},
"x-ms-last-access-time": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time value that indicates the time at which the blob was last read or written."
},
"x-ms-lease-duration": {
"type": "string",
"description": "Specifies the duration of the lease.",
"enum": [
"infinite",
"fixed"
],
"x-ms-enum": {
"name": "LeaseDuration",
"modelAsString": false,
"values": [
{
"name": "Infinite",
"value": "infinite",
"description": "The lease is of infinite duration."
},
{
"name": "Fixed",
"value": "fixed",
"description": "The lease is of fixed duration."
}
]
}
},
"x-ms-lease-state": {
"type": "string",
"description": "The lease state of the blob.",
"enum": [
"available",
"leased",
"expired",
"breaking",
"broken"
],
"x-ms-enum": {
"name": "LeaseState",
"modelAsString": false,
"values": [
{
"name": "Available",
"value": "available",
"description": "The lease is available."
},
{
"name": "Leased",
"value": "leased",
"description": "The lease is currently leased."
},
{
"name": "Expired",
"value": "expired",
"description": "The lease is expired."
},
{
"name": "Breaking",
"value": "breaking",
"description": "The lease is breaking."
},
{
"name": "Broken",
"value": "broken",
"description": "The lease is broken."
}
]
}
},
"x-ms-lease-status": {
"type": "string",
"description": "The lease status of the blob.",
"enum": [
"unlocked",
"locked"
],
"x-ms-enum": {
"name": "LeaseStatus",
"modelAsString": false,
"values": [
{
"name": "Unlocked",
"value": "unlocked",
"description": "The lease is unlocked."
},
{
"name": "Locked",
"value": "locked",
"description": "The lease is locked."
}
]
}
},
"x-ms-legal-hold": {
"type": "boolean",
"description": "Indicates whether the blob has a legal hold."
},
"x-ms-meta": {
"type": "string",
"description": "The metadata headers."
},
"x-ms-or": {
"type": "string",
"description": "The object replication status headers."
},
"x-ms-or-policy-id": {
"type": "string",
"description": "The object replication policy ID."
},
"x-ms-rehydrate-priority": {
"type": "string",
"description": "The priority of the rehydration operation.",
"enum": [
"High",
"Standard"
],
"x-ms-enum": {
"name": "RehydratePriority",
"modelAsString": true,
"values": [
{
"name": "High",
"value": "High",
"description": "The rehydrate priority is high."
},
{
"name": "Standard",
"value": "Standard",
"description": "The rehydrate priority is standard."
}
]
}
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-server-encrypted": {
"type": "boolean",
"description": "Indicates whether the contents of the request are successfully encrypted."
},
"x-ms-tag-count": {
"type": "integer",
"format": "int64",
"description": "The number of tags associated with the blob."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
},
"x-ms-version-id": {
"type": "string",
"description": "The version ID of the blob."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
}
},
"x-ms-paths": {
"?comp=appendblock": {
"put": {
"operationId": "AppendBlob_AppendBlock",
"description": "Uploads a new block of data to the end of an append blob.",
"consumes": [
"application/octet-stream"
],
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "Content-Length",
"in": "header",
"description": "The length of the request.",
"required": true,
"type": "integer",
"format": "int64",
"x-ms-client-name": "contentLength"
},
{
"name": "Content-MD5",
"in": "header",
"description": "Specifies the transactional MD5 hash for the body.",
"required": false,
"type": "string",
"format": "byte",
"x-ms-client-name": "transactionalContentMd5"
},
{
"name": "x-ms-content-crc64",
"in": "header",
"description": "Specifies the transactional CRC64 hash for the body.",
"required": false,
"type": "string",
"format": "byte",
"x-ms-client-name": "transactionalContentCrc64"
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.",
"required": false,
"type": "string",
"x-ms-client-name": "leaseId"
},
{
"name": "x-ms-blob-condition-maxsize",
"in": "header",
"description": "The max length of the blob. If the operation would cause the blob to exceed that limit or if the blob size is already greater than the value specified, the request will fail with MaxBlobSizeConditionNotMet.",
"required": false,
"type": "integer",
"format": "int64",
"x-ms-client-name": "maxSize"
},
{
"name": "x-ms-blob-condition-appendpos",
"in": "header",
"description": "A byte offset where the operation will only succeed if the append position is equal. If not, the request will fail with AppendPositionConditionNotMet.",
"required": false,
"type": "integer",
"format": "int64",
"x-ms-client-name": "appendPosition"
},
{
"name": "x-ms-encryption-key",
"in": "header",
"description": "Specifies the encryption key to use to encrypt the data provided in the request.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionKey"
},
{
"name": "x-ms-encryption-key-sha256",
"in": "header",
"description": "The SHA-256 hash of the provided encryption key. Must be provided if the encryption key is provided.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionKeySha256"
},
{
"name": "x-ms-encryption-algorithm",
"in": "header",
"description": "The algorithm used to produce the encryption key hash. Must be provided if the encryption key is provided.",
"required": false,
"type": "string",
"enum": [
"AES256"
],
"x-ms-enum": {
"name": "EncryptionAlgorithmType",
"modelAsString": false,
"values": [
{
"name": "AES256",
"value": "AES256",
"description": "The AES256 encryption algorithm."
}
]
},
"x-ms-client-name": "encryptionAlgorithm"
},
{
"name": "x-ms-encryption-scope",
"in": "header",
"description": "Specifies the encryption scope used to encrypt the data.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionScope"
},
{
"name": "If-Modified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifModifiedSince"
},
{
"name": "If-Unmodified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifUnmodifiedSince"
},
{
"name": "If-None-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a non-matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifNoneMatch"
},
{
"name": "If-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifMatch"
},
{
"name": "x-ms-if-tags",
"in": "header",
"description": "Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.",
"required": false,
"type": "string",
"x-ms-client-name": "ifTags"
},
{
"name": "x-ms-structured-body",
"in": "header",
"description": "Required if the request body is a structured message. Specifies the message schema version and properties.",
"required": false,
"type": "string",
"x-ms-client-name": "structuredBodyType"
},
{
"name": "x-ms-structured-content-length",
"in": "header",
"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.",
"required": false,
"type": "integer",
"format": "int64",
"x-ms-client-name": "structuredContentLength"
},
{
"name": "body",
"in": "body",
"description": "The body of the request.",
"required": true,
"schema": {
"type": "string",
"format": "binary"
}
}
],
"responses": {
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"headers": {
"Content-MD5": {
"type": "string",
"format": "byte",
"description": "The blob content MD5 hash. Only returned if the full blob is read."
},
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-blob-append-offset": {
"type": "string",
"description": "The offset at which the block was committed, in bytes."
},
"x-ms-blob-committed-block-count": {
"type": "integer",
"format": "int32",
"description": "The number of committed blocks present in the blob."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-content-crc64": {
"type": "string",
"format": "byte",
"description": "The CRC64 hash of the content."
},
"x-ms-encryption-key-sha256": {
"type": "string",
"description": "The SHA-256 hash of the provided encryption key."
},
"x-ms-encryption-scope": {
"type": "string",
"description": "Specifies the encryption scope used to encrypt the data."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-request-server-encrypted": {
"type": "boolean",
"description": "Indicates whether the contents of the request are successfully encrypted."
},
"x-ms-structured-body": {
"type": "string",
"description": "Indicates if the response body contains a structured message and specifies the message schema version and properties."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=appendblock&_overload=appendBlockFromUrl": {
"put": {
"operationId": "AppendBlob_AppendBlockFromUrl",
"description": "Uploads a new block of data from the specified URL to the end of an append blob.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "x-ms-copy-source",
"in": "header",
"description": "Specifies the URL of the source.",
"required": true,
"type": "string",
"x-ms-client-name": "sourceUrl"
},
{
"name": "x-ms-source-range",
"in": "header",
"description": "Specifies the bytes of the source.",
"required": false,
"type": "string",
"x-ms-client-name": "sourceRange"
},
{
"name": "x-ms-source-content-md5",
"in": "header",
"description": "Specifies the MD5 hash calculated for the range of bytes that must be read from the copy source.",
"required": false,
"type": "string",
"format": "byte",
"x-ms-client-name": "sourceContentMd5"
},
{
"name": "x-ms-source-content-crc64",
"in": "header",
"description": "Specifies the CRC64 calculated for the range of bytes that must be read from the source.",
"required": false,
"type": "string",
"format": "byte",
"x-ms-client-name": "sourceContentCrc64"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "Content-Length",
"in": "header",
"description": "The length of the request.",
"required": true,
"type": "integer",
"format": "int64",
"x-ms-client-name": "contentLength"
},
{
"name": "Content-MD5",
"in": "header",
"description": "Specifies the transactional MD5 hash for the body.",
"required": false,
"type": "string",
"format": "byte",
"x-ms-client-name": "transactionalContentMd5"
},
{
"name": "x-ms-encryption-key",
"in": "header",
"description": "Specifies the encryption key to use to encrypt the data provided in the request.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionKey"
},
{
"name": "x-ms-encryption-key-sha256",
"in": "header",
"description": "The SHA-256 hash of the provided encryption key. Must be provided if the encryption key is provided.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionKeySha256"
},
{
"name": "x-ms-encryption-algorithm",
"in": "header",
"description": "The algorithm used to produce the encryption key hash. Must be provided if the encryption key is provided.",
"required": false,
"type": "string",
"enum": [
"AES256"
],
"x-ms-enum": {
"name": "EncryptionAlgorithmType",
"modelAsString": false,
"values": [
{
"name": "AES256",
"value": "AES256",
"description": "The AES256 encryption algorithm."
}
]
},
"x-ms-client-name": "encryptionAlgorithm"
},
{
"name": "x-ms-encryption-scope",
"in": "header",
"description": "Specifies the encryption scope used to encrypt the data.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionScope"
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.",
"required": false,
"type": "string",
"x-ms-client-name": "leaseId"
},
{
"name": "x-ms-blob-condition-maxsize",
"in": "header",
"description": "The max length of the blob. If the operation would cause the blob to exceed that limit or if the blob size is already greater than the value specified, the request will fail with MaxBlobSizeConditionNotMet.",
"required": false,
"type": "integer",
"format": "int64",
"x-ms-client-name": "maxSize"
},
{
"name": "x-ms-blob-condition-appendpos",
"in": "header",
"description": "A byte offset where the operation will only succeed if the append position is equal. If not, the request will fail with AppendPositionConditionNotMet.",
"required": false,
"type": "integer",
"format": "int64",
"x-ms-client-name": "appendPosition"
},
{
"name": "If-Modified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifModifiedSince"
},
{
"name": "If-Unmodified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifUnmodifiedSince"
},
{
"name": "If-None-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a non-matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifNoneMatch"
},
{
"name": "If-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifMatch"
},
{
"name": "x-ms-if-tags",
"in": "header",
"description": "Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.",
"required": false,
"type": "string",
"x-ms-client-name": "ifTags"
},
{
"name": "x-ms-source-if-modified-since",
"in": "header",
"description": "Specify this value to operate only on a source blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "sourceIfModifiedSince"
},
{
"name": "x-ms-source-if-unmodified-since",
"in": "header",
"description": "Specify this header value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "sourceIfUnmodifiedSince"
},
{
"name": "x-ms-source-if-match",
"in": "header",
"description": "Specify this value to operate only on a source blob with a matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "sourceIfMatch"
},
{
"name": "x-ms-source-if-none-match",
"in": "header",
"description": "Specify this value to operate only on a source blob with a non-matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "sourceIfNoneMatch"
},
{
"name": "x-ms-copy-source-authorization",
"in": "header",
"description": "Only the Bearer authorization scheme is supported, and the value must be a valid OAuth access token for the copy source.",
"required": false,
"type": "string",
"x-ms-client-name": "copySourceAuthorization"
},
{
"name": "x-ms-file-request-intent",
"in": "header",
"description": "Specifies the file request token intent.",
"required": false,
"type": "string",
"enum": [
"backup"
],
"x-ms-enum": {
"name": "FileShareTokenIntent",
"modelAsString": true,
"values": [
{
"name": "Backup",
"value": "backup",
"description": "The file share token intent is backup."
}
]
},
"x-ms-client-name": "fileRequestIntent"
}
],
"responses": {
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"headers": {
"Content-MD5": {
"type": "string",
"format": "byte",
"description": "The blob content MD5 hash. Only returned if the full blob is read."
},
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-blob-append-offset": {
"type": "string",
"description": "The offset at which the block was committed, in bytes."
},
"x-ms-blob-committed-block-count": {
"type": "integer",
"format": "int32",
"description": "The number of committed blocks present in the blob."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-content-crc64": {
"type": "string",
"format": "byte",
"description": "The CRC64 hash of the content."
},
"x-ms-encryption-key-sha256": {
"type": "string",
"description": "The SHA-256 hash of the provided encryption key."
},
"x-ms-encryption-scope": {
"type": "string",
"description": "Specifies the encryption scope used to encrypt the data."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-request-server-encrypted": {
"type": "boolean",
"description": "Indicates whether the contents of the request are successfully encrypted."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=batch": {
"post": {
"operationId": "Service_SubmitBatch",
"description": "Allows multiple API calls to be embedded into a single HTTP request.",
"produces": [
"multipart/mixed",
"application/xml"
],
"consumes": [
"multipart/mixed"
],
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "Content-Length",
"in": "header",
"description": "The length of the request.",
"required": true,
"type": "integer",
"format": "int64",
"x-ms-client-name": "contentLength"
},
{
"name": "body",
"in": "formData",
"required": true,
"type": "file"
}
],
"responses": {
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"schema": {
"type": "string"
},
"headers": {
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=blobs": {
"get": {
"operationId": "Service_FindBlobsByTags",
"description": "Lists blobs across all containers whose tags match a given search expression.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "where",
"in": "query",
"description": "Filters the results to return only blobs whose tags match the specified expression.",
"required": true,
"type": "string",
"x-ms-client-name": "filterExpression"
},
{
"name": "marker",
"in": "query",
"description": "An opaque string value that identifies the portion of the result set to return with this operation.",
"required": false,
"type": "string"
},
{
"name": "maxresults",
"in": "query",
"description": "Specifies the maximum number of resources to return. If the request does not specify maxresults, or specifies a value greater than 5000, the server will return up to 5000 items.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 1
},
{
"name": "include",
"in": "query",
"description": "Specify to include additional, optional information.",
"required": false,
"type": "array",
"items": {
"type": "string",
"enum": [
"none",
"versions"
],
"x-ms-enum": {
"name": "FilterBlobsIncludeItem",
"modelAsString": false,
"values": [
{
"name": "None",
"value": "none",
"description": "The filter includes no versions."
},
{
"name": "Versions",
"value": "versions",
"description": "The filter includes versions."
}
]
}
},
"collectionFormat": "csv"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/FilteredBlobResponse"
},
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=block": {
"put": {
"operationId": "BlockBlob_StageBlock",
"description": "Creates a new block of data to be committed as part of a blob.",
"consumes": [
"application/octet-stream"
],
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "blockid",
"in": "query",
"description": "A Base64 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,
"type": "string",
"format": "byte",
"x-ms-client-name": "blockId"
},
{
"name": "Content-Length",
"in": "header",
"description": "The length of the request.",
"required": true,
"type": "integer",
"format": "int64",
"x-ms-client-name": "contentLength"
},
{
"name": "Content-MD5",
"in": "header",
"description": "Specifies the transactional MD5 hash for the body.",
"required": false,
"type": "string",
"format": "byte",
"x-ms-client-name": "transactionalContentMd5"
},
{
"name": "x-ms-content-crc64",
"in": "header",
"description": "Specifies the transactional CRC64 hash for the body.",
"required": false,
"type": "string",
"format": "byte",
"x-ms-client-name": "transactionalContentCrc64"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.",
"required": false,
"type": "string",
"x-ms-client-name": "leaseId"
},
{
"name": "x-ms-encryption-key",
"in": "header",
"description": "Specifies the encryption key to use to encrypt the data provided in the request.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionKey"
},
{
"name": "x-ms-encryption-key-sha256",
"in": "header",
"description": "The SHA-256 hash of the provided encryption key. Must be provided if the encryption key is provided.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionKeySha256"
},
{
"name": "x-ms-encryption-algorithm",
"in": "header",
"description": "The algorithm used to produce the encryption key hash. Must be provided if the encryption key is provided.",
"required": false,
"type": "string",
"enum": [
"AES256"
],
"x-ms-enum": {
"name": "EncryptionAlgorithmType",
"modelAsString": false,
"values": [
{
"name": "AES256",
"value": "AES256",
"description": "The AES256 encryption algorithm."
}
]
},
"x-ms-client-name": "encryptionAlgorithm"
},
{
"name": "x-ms-encryption-scope",
"in": "header",
"description": "Specifies the encryption scope used to encrypt the data.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionScope"
},
{
"name": "x-ms-structured-body",
"in": "header",
"description": "Required if the request body is a structured message. Specifies the message schema version and properties.",
"required": false,
"type": "string",
"x-ms-client-name": "structuredBodyType"
},
{
"name": "x-ms-structured-content-length",
"in": "header",
"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.",
"required": false,
"type": "integer",
"format": "int64",
"x-ms-client-name": "structuredContentLength"
},
{
"name": "body",
"in": "body",
"description": "The body of the request.",
"required": true,
"schema": {
"type": "string",
"format": "binary"
}
}
],
"responses": {
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"headers": {
"Content-MD5": {
"type": "string",
"format": "byte",
"description": "The blob content MD5 hash. Only returned if the full blob is read."
},
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-content-crc64": {
"type": "string",
"format": "byte",
"description": "The CRC64 hash of the content."
},
"x-ms-encryption-key-sha256": {
"type": "string",
"description": "The SHA-256 hash of the provided encryption key."
},
"x-ms-encryption-scope": {
"type": "string",
"description": "Specifies the encryption scope used to encrypt the data."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-request-server-encrypted": {
"type": "boolean",
"description": "Indicates whether the contents of the request are successfully encrypted."
},
"x-ms-structured-body": {
"type": "string",
"description": "Indicates if the response body contains a structured message and specifies the message schema version and properties."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=block&_overload=stageBlockFromUrl": {
"put": {
"operationId": "BlockBlob_StageBlockFromUrl",
"description": "Creates a new block of data from the specified URL to be committed as part of a blob.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "blockid",
"in": "query",
"description": "A Base64 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,
"type": "string",
"format": "byte",
"x-ms-client-name": "blockId"
},
{
"name": "Content-Length",
"in": "header",
"description": "The length of the request.",
"required": true,
"type": "integer",
"format": "int64",
"x-ms-client-name": "contentLength"
},
{
"name": "x-ms-copy-source",
"in": "header",
"description": "Specifies the URL of the source.",
"required": true,
"type": "string",
"x-ms-client-name": "sourceUrl"
},
{
"name": "x-ms-source-range",
"in": "header",
"description": "Specifies the bytes of the source.",
"required": false,
"type": "string",
"x-ms-client-name": "sourceRange"
},
{
"name": "x-ms-source-content-md5",
"in": "header",
"description": "Specifies the MD5 hash calculated for the range of bytes that must be read from the copy source.",
"required": false,
"type": "string",
"format": "byte",
"x-ms-client-name": "sourceContentMd5"
},
{
"name": "x-ms-source-content-crc64",
"in": "header",
"description": "Specifies the CRC64 calculated for the range of bytes that must be read from the source.",
"required": false,
"type": "string",
"format": "byte",
"x-ms-client-name": "sourceContentCrc64"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "x-ms-encryption-key",
"in": "header",
"description": "Specifies the encryption key to use to encrypt the data provided in the request.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionKey"
},
{
"name": "x-ms-encryption-key-sha256",
"in": "header",
"description": "The SHA-256 hash of the provided encryption key. Must be provided if the encryption key is provided.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionKeySha256"
},
{
"name": "x-ms-encryption-algorithm",
"in": "header",
"description": "The algorithm used to produce the encryption key hash. Must be provided if the encryption key is provided.",
"required": false,
"type": "string",
"enum": [
"AES256"
],
"x-ms-enum": {
"name": "EncryptionAlgorithmType",
"modelAsString": false,
"values": [
{
"name": "AES256",
"value": "AES256",
"description": "The AES256 encryption algorithm."
}
]
},
"x-ms-client-name": "encryptionAlgorithm"
},
{
"name": "x-ms-encryption-scope",
"in": "header",
"description": "Specifies the encryption scope used to encrypt the data.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionScope"
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.",
"required": false,
"type": "string",
"x-ms-client-name": "leaseId"
},
{
"name": "x-ms-source-if-modified-since",
"in": "header",
"description": "Specify this value to operate only on a source blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "sourceIfModifiedSince"
},
{
"name": "x-ms-source-if-unmodified-since",
"in": "header",
"description": "Specify this header value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "sourceIfUnmodifiedSince"
},
{
"name": "x-ms-source-if-match",
"in": "header",
"description": "Specify this value to operate only on a source blob with a matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "sourceIfMatch"
},
{
"name": "x-ms-source-if-none-match",
"in": "header",
"description": "Specify this value to operate only on a source blob with a non-matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "sourceIfNoneMatch"
},
{
"name": "x-ms-copy-source-authorization",
"in": "header",
"description": "Only the Bearer authorization scheme is supported, and the value must be a valid OAuth access token for the copy source.",
"required": false,
"type": "string",
"x-ms-client-name": "copySourceAuthorization"
},
{
"name": "x-ms-file-request-intent",
"in": "header",
"description": "Specifies the file request token intent.",
"required": false,
"type": "string",
"enum": [
"backup"
],
"x-ms-enum": {
"name": "FileShareTokenIntent",
"modelAsString": true,
"values": [
{
"name": "Backup",
"value": "backup",
"description": "The file share token intent is backup."
}
]
},
"x-ms-client-name": "fileRequestIntent"
}
],
"responses": {
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"headers": {
"Content-MD5": {
"type": "string",
"format": "byte",
"description": "The blob content MD5 hash. Only returned if the full blob is read."
},
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-content-crc64": {
"type": "string",
"format": "byte",
"description": "The CRC64 hash of the content."
},
"x-ms-encryption-key-sha256": {
"type": "string",
"description": "The SHA-256 hash of the provided encryption key."
},
"x-ms-encryption-scope": {
"type": "string",
"description": "Specifies the encryption scope used to encrypt the data."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-request-server-encrypted": {
"type": "boolean",
"description": "Indicates whether the contents of the request are successfully encrypted."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=blocklist": {
"put": {
"operationId": "BlockBlob_CommitBlockList",
"description": "Writes to the block blob by specifying the list of block IDs that make up the blob.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "x-ms-blob-cache-control",
"in": "header",
"description": "Specifies the blob's Cache-Control. If specified, this property is stored with the blob and returned with a read request.",
"required": false,
"type": "string",
"x-ms-client-name": "blobCacheControl"
},
{
"name": "x-ms-blob-content-type",
"in": "header",
"description": "Specifies the blob's Content-Type. If specified, this property is stored with the blob and returned with a read request.",
"required": false,
"type": "string",
"x-ms-client-name": "blobContentType"
},
{
"name": "x-ms-blob-content-encoding",
"in": "header",
"description": "Specifies the blob's Content-Encoding. If specified, this property is stored with the blob and returned with a read request.",
"required": false,
"type": "string",
"x-ms-client-name": "blobContentEncoding"
},
{
"name": "x-ms-blob-content-language",
"in": "header",
"description": "Specifies the blob's Content-Language. If specified, this property is stored with the blob and returned with a read request.",
"required": false,
"type": "string",
"x-ms-client-name": "blobContentLanguage"
},
{
"name": "x-ms-blob-content-md5",
"in": "header",
"description": "The MD5 hash of the blob content that is stored as a property on the blob. Note: This hash is not validated.",
"required": false,
"type": "string",
"format": "byte",
"x-ms-client-name": "blobContentMd5"
},
{
"name": "Content-MD5",
"in": "header",
"description": "Specifies the transactional MD5 hash for the body.",
"required": false,
"type": "string",
"format": "byte",
"x-ms-client-name": "transactionalContentMd5"
},
{
"name": "x-ms-content-crc64",
"in": "header",
"description": "Specifies the transactional CRC64 hash for the body.",
"required": false,
"type": "string",
"format": "byte",
"x-ms-client-name": "transactionalContentCrc64"
},
{
"name": "x-ms-meta",
"in": "header",
"description": "The metadata headers.",
"required": false,
"type": "string",
"x-ms-client-name": "metadata"
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.",
"required": false,
"type": "string",
"x-ms-client-name": "leaseId"
},
{
"name": "x-ms-blob-content-disposition",
"in": "header",
"description": "Specifies the blob's Content-Disposition. If specified, this property is stored with the blob and returned with a read request.",
"required": false,
"type": "string",
"x-ms-client-name": "blobContentDisposition"
},
{
"name": "x-ms-encryption-key",
"in": "header",
"description": "Specifies the encryption key to use to encrypt the data provided in the request.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionKey"
},
{
"name": "x-ms-encryption-key-sha256",
"in": "header",
"description": "The SHA-256 hash of the provided encryption key. Must be provided if the encryption key is provided.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionKeySha256"
},
{
"name": "x-ms-encryption-algorithm",
"in": "header",
"description": "The algorithm used to produce the encryption key hash. Must be provided if the encryption key is provided.",
"required": false,
"type": "string",
"enum": [
"AES256"
],
"x-ms-enum": {
"name": "EncryptionAlgorithmType",
"modelAsString": false,
"values": [
{
"name": "AES256",
"value": "AES256",
"description": "The AES256 encryption algorithm."
}
]
},
"x-ms-client-name": "encryptionAlgorithm"
},
{
"name": "x-ms-encryption-scope",
"in": "header",
"description": "Specifies the encryption scope used to encrypt the data.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionScope"
},
{
"name": "x-ms-access-tier",
"in": "header",
"description": "The tier to be set on the blob.",
"required": false,
"type": "string",
"enum": [
"P4",
"P6",
"P10",
"P15",
"P20",
"P30",
"P40",
"P50",
"P60",
"P70",
"P80",
"Hot",
"Cool",
"Archive",
"Premium",
"Cold"
],
"x-ms-enum": {
"name": "AccessTier",
"modelAsString": true,
"values": [
{
"name": "P4",
"value": "P4",
"description": "The P4 access tier."
},
{
"name": "P6",
"value": "P6",
"description": "The P6 access tier."
},
{
"name": "P10",
"value": "P10",
"description": "The P10 access tier."
},
{
"name": "P15",
"value": "P15",
"description": "The P15 access tier."
},
{
"name": "P20",
"value": "P20",
"description": "The P20 access tier."
},
{
"name": "P30",
"value": "P30",
"description": "The P30 access tier."
},
{
"name": "P40",
"value": "P40",
"description": "The P40 access tier."
},
{
"name": "P50",
"value": "P50",
"description": "The P50 access tier."
},
{
"name": "P60",
"value": "P60",
"description": "The P60 access tier."
},
{
"name": "P70",
"value": "P70",
"description": "The P70 access tier."
},
{
"name": "P80",
"value": "P80",
"description": "The P80 access tier."
},
{
"name": "Hot",
"value": "Hot",
"description": "The Hot access tier."
},
{
"name": "Cool",
"value": "Cool",
"description": "The Cool access tier."
},
{
"name": "Archive",
"value": "Archive",
"description": "The Archive access tier."
},
{
"name": "Premium",
"value": "Premium",
"description": "The Premium access tier."
},
{
"name": "Cold",
"value": "Cold",
"description": "The Cold access tier."
}
]
},
"x-ms-client-name": "tier"
},
{
"name": "If-Modified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifModifiedSince"
},
{
"name": "If-Unmodified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifUnmodifiedSince"
},
{
"name": "If-None-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a non-matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifNoneMatch"
},
{
"name": "If-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifMatch"
},
{
"name": "x-ms-if-tags",
"in": "header",
"description": "Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.",
"required": false,
"type": "string",
"x-ms-client-name": "ifTags"
},
{
"name": "x-ms-tags",
"in": "header",
"description": "The blob tags.",
"required": false,
"type": "string",
"x-ms-client-name": "BlobTagsString"
},
{
"name": "x-ms-immutability-policy-until-date",
"in": "header",
"description": "The date-time that indicates the time at which the blob immutability policy will expire.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "immutabilityPolicyExpiry"
},
{
"name": "x-ms-immutability-policy-mode",
"in": "header",
"description": "Indicates the immutability policy mode of the blob.",
"required": false,
"type": "string",
"enum": [
"mutable",
"locked",
"unlocked"
],
"x-ms-enum": {
"name": "ImmutabilityPolicyMode",
"modelAsString": false,
"values": [
{
"name": "Mutable",
"value": "mutable",
"description": "Response only. The immutability policy is mutable."
},
{
"name": "Locked",
"value": "locked",
"description": "The immutability policy is locked."
},
{
"name": "Unlocked",
"value": "unlocked",
"description": "The immutability policy is unlocked."
}
]
},
"x-ms-client-name": "immutabilityPolicyMode"
},
{
"name": "x-ms-legal-hold",
"in": "header",
"description": "Indicates whether the blob has a legal hold.",
"required": false,
"type": "boolean",
"x-ms-client-name": "legalHold"
},
{
"name": "blocks",
"in": "body",
"description": "Blob blocks.",
"required": true,
"schema": {
"$ref": "#/definitions/BlockLookupList"
}
}
],
"responses": {
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"headers": {
"Content-MD5": {
"type": "string",
"format": "byte",
"description": "The blob content MD5 hash. Only returned if the full blob is read."
},
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-content-crc64": {
"type": "string",
"format": "byte",
"description": "The CRC64 hash of the content."
},
"x-ms-encryption-key-sha256": {
"type": "string",
"description": "The SHA-256 hash of the provided encryption key."
},
"x-ms-encryption-scope": {
"type": "string",
"description": "Specifies the encryption scope used to encrypt the data."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-request-server-encrypted": {
"type": "boolean",
"description": "Indicates whether the contents of the request are successfully encrypted."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
},
"x-ms-version-id": {
"type": "string",
"description": "The version ID of the blob."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=blocklist&_overload=getBlockList": {
"get": {
"operationId": "BlockBlob_GetBlockList",
"description": "Retrieves the list of blocks that have been uploaded as part of the block blob.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "snapshot",
"in": "query",
"description": "Specifies the snapshot of the blob.",
"required": false,
"type": "string"
},
{
"name": "blocklisttype",
"in": "query",
"description": "Specifies whether to return the list of committed blocks, the list of uncommitted blocks, or both lists together.",
"required": true,
"type": "string",
"enum": [
"committed",
"uncommitted",
"all"
],
"x-ms-enum": {
"name": "BlockListType",
"modelAsString": false,
"values": [
{
"name": "Committed",
"value": "committed",
"description": "Committed blocks."
},
{
"name": "Uncommitted",
"value": "uncommitted",
"description": "Uncommitted blocks."
},
{
"name": "All",
"value": "all",
"description": "Both committed and uncommitted blocks."
}
]
},
"x-ms-client-name": "listType"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.",
"required": false,
"type": "string",
"x-ms-client-name": "leaseId"
},
{
"name": "x-ms-if-tags",
"in": "header",
"description": "Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.",
"required": false,
"type": "string",
"x-ms-client-name": "ifTags"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/BlockList"
},
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-blob-content-length": {
"type": "integer",
"format": "int64",
"description": "The size of the blob in bytes."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=copy": {
"put": {
"operationId": "Blob_AbortCopyFromUrl",
"description": "Aborts a pending asynchronous copy operation and leaves a destination blob with zero length and full metadata.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "copyid",
"in": "query",
"description": "The ID of the copy to be aborted.",
"required": true,
"type": "string",
"x-ms-client-name": "copyId"
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.",
"required": false,
"type": "string",
"x-ms-client-name": "leaseId"
},
{
"name": "x-ms-copy-action",
"in": "header",
"description": "The copy action to be performed.",
"required": true,
"type": "string",
"enum": [
"abort"
],
"x-ms-enum": {
"modelAsString": false
},
"x-ms-client-name": "copyActionAbortConstant"
}
],
"responses": {
"204": {
"description": "There is no content to send for this request, but the headers may be useful. ",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=expiry": {
"put": {
"operationId": "Blob_SetExpiry",
"description": "Set the expiration time of the specified blob.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "x-ms-expiry-option",
"in": "header",
"description": "Indicates the mode of the expiry time.",
"required": true,
"type": "string",
"enum": [
"NeverExpire",
"RelativeToCreation",
"RelativeToNow",
"Absolute"
],
"x-ms-enum": {
"name": "BlobExpiryOptions",
"modelAsString": true,
"values": [
{
"name": "NeverExpire",
"value": "NeverExpire",
"description": "Never expire."
},
{
"name": "RelativeToCreation",
"value": "RelativeToCreation",
"description": "Relative to creation time."
},
{
"name": "RelativeToNow",
"value": "RelativeToNow",
"description": "Relative to now."
},
{
"name": "Absolute",
"value": "Absolute",
"description": "Absolute time."
}
]
},
"x-ms-client-name": "expiryOptions"
},
{
"name": "x-ms-expiry-time",
"in": "header",
"description": "The date-time this blob will expire.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "expiresOn"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=immutabilityPolicies": {
"put": {
"operationId": "Blob_SetImmutabilityPolicy",
"description": "Set the immutability policy on the specified blob.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "If-Unmodified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifUnmodifiedSince"
},
{
"name": "x-ms-immutability-policy-until-date",
"in": "header",
"description": "The date-time that indicates the time at which the blob immutability policy will expire.",
"required": true,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "expiry"
},
{
"name": "x-ms-immutability-policy-mode",
"in": "header",
"description": "Indicates the immutability policy mode of the blob.",
"required": false,
"type": "string",
"enum": [
"mutable",
"locked",
"unlocked"
],
"x-ms-enum": {
"name": "ImmutabilityPolicyMode",
"modelAsString": false,
"values": [
{
"name": "Mutable",
"value": "mutable",
"description": "Response only. The immutability policy is mutable."
},
{
"name": "Locked",
"value": "locked",
"description": "The immutability policy is locked."
},
{
"name": "Unlocked",
"value": "unlocked",
"description": "The immutability policy is unlocked."
}
]
},
"x-ms-client-name": "immutabilityPolicyMode"
},
{
"name": "snapshot",
"in": "query",
"description": "Specifies the snapshot of the blob.",
"required": false,
"type": "string"
},
{
"name": "versionid",
"in": "query",
"description": "Specifies the version ID of the blob.",
"required": false,
"type": "string",
"x-ms-client-name": "versionId"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-immutability-policy-mode": {
"type": "string",
"description": "Indicates the immutability policy mode of the blob.",
"enum": [
"mutable",
"locked",
"unlocked"
],
"x-ms-enum": {
"name": "ImmutabilityPolicyMode",
"modelAsString": false,
"values": [
{
"name": "Mutable",
"value": "mutable",
"description": "Response only. The immutability policy is mutable."
},
{
"name": "Locked",
"value": "locked",
"description": "The immutability policy is locked."
},
{
"name": "Unlocked",
"value": "unlocked",
"description": "The immutability policy is unlocked."
}
]
}
},
"x-ms-immutability-policy-until-date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that indicates the time at which the blob immutability policy will expire."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=immutabilityPolicies&_overload=deleteImmutabilityPolicy": {
"delete": {
"operationId": "Blob_DeleteImmutabilityPolicy",
"description": "Deletes the immutability policy on the specified blob.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "snapshot",
"in": "query",
"description": "Specifies the snapshot of the blob.",
"required": false,
"type": "string"
},
{
"name": "versionid",
"in": "query",
"description": "Specifies the version ID of the blob.",
"required": false,
"type": "string",
"x-ms-client-name": "versionId"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=incrementalcopy": {
"put": {
"operationId": "PageBlob_CopyIncremental",
"description": "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.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "If-Modified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifModifiedSince"
},
{
"name": "If-Unmodified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifUnmodifiedSince"
},
{
"name": "If-None-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a non-matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifNoneMatch"
},
{
"name": "If-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifMatch"
},
{
"name": "x-ms-if-tags",
"in": "header",
"description": "Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.",
"required": false,
"type": "string",
"x-ms-client-name": "ifTags"
},
{
"name": "x-ms-copy-source",
"in": "header",
"description": "Specifies the name of the source URL for the copy operation. The value should be URL-encoded as it would appear in a request URI.",
"required": true,
"type": "string",
"x-ms-client-name": "copySource"
}
],
"responses": {
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-copy-id": {
"type": "string",
"description": "Identifier for this copy operation."
},
"x-ms-copy-status": {
"type": "string",
"description": "Status of the copy operation.",
"enum": [
"pending",
"success",
"failed",
"aborted"
],
"x-ms-enum": {
"name": "CopyStatus",
"modelAsString": false,
"values": [
{
"name": "Pending",
"value": "pending",
"description": "The copy operation is pending."
},
{
"name": "Success",
"value": "success",
"description": "The copy operation succeeded."
},
{
"name": "Failed",
"value": "failed",
"description": "The copy operation failed."
},
{
"name": "Aborted",
"value": "aborted",
"description": "The copy operation was aborted."
}
]
}
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=lease": {
"put": {
"operationId": "Blob_AcquireLease",
"description": "Requests a new lease on the specified blob.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "x-ms-lease-duration",
"in": "header",
"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.",
"required": true,
"type": "integer",
"format": "int32",
"x-ms-client-name": "duration"
},
{
"name": "x-ms-proposed-lease-id",
"in": "header",
"description": "The proposed lease ID for the lease.",
"required": false,
"type": "string",
"x-ms-client-name": "proposedLeaseId"
},
{
"name": "If-Modified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifModifiedSince"
},
{
"name": "If-Unmodified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifUnmodifiedSince"
},
{
"name": "If-None-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a non-matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifNoneMatch"
},
{
"name": "If-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifMatch"
},
{
"name": "x-ms-if-tags",
"in": "header",
"description": "Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.",
"required": false,
"type": "string",
"x-ms-client-name": "ifTags"
},
{
"name": "x-ms-lease-action",
"in": "header",
"description": "Specifies what lease action to take.",
"required": true,
"type": "string",
"enum": [
"acquire"
],
"x-ms-enum": {
"modelAsString": false
},
"x-ms-client-name": "action"
}
],
"responses": {
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-lease-id": {
"type": "string",
"description": "Uniquely identifies a blob's lease."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=lease&_overload=breakLease": {
"put": {
"operationId": "Blob_BreakLease",
"description": "Ends a lease and ensures that another client can't acquire a new lease until the current lease period has expired.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "x-ms-lease-break-period",
"in": "header",
"description": "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.",
"required": false,
"type": "integer",
"format": "int32",
"x-ms-client-name": "breakPeriod"
},
{
"name": "If-Modified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifModifiedSince"
},
{
"name": "If-Unmodified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifUnmodifiedSince"
},
{
"name": "If-None-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a non-matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifNoneMatch"
},
{
"name": "If-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifMatch"
},
{
"name": "x-ms-if-tags",
"in": "header",
"description": "Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.",
"required": false,
"type": "string",
"x-ms-client-name": "ifTags"
},
{
"name": "x-ms-lease-action",
"in": "header",
"description": "Specifies what lease action to take.",
"required": true,
"type": "string",
"enum": [
"break"
],
"x-ms-enum": {
"modelAsString": false
},
"x-ms-client-name": "action"
}
],
"responses": {
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-lease-time": {
"type": "integer",
"format": "int32",
"description": "Approximate time remaining in the lease period, in seconds."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=lease&_overload=changeLease": {
"put": {
"operationId": "Blob_ChangeLease",
"description": "Change the ID of an existing lease.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "A lease ID for the resource. The resource must have an active lease and the lease ID must match.",
"required": true,
"type": "string",
"x-ms-client-name": "leaseId"
},
{
"name": "x-ms-proposed-lease-id",
"in": "header",
"description": "The proposed lease ID for the lease.",
"required": true,
"type": "string",
"x-ms-client-name": "proposedLeaseId"
},
{
"name": "If-Modified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifModifiedSince"
},
{
"name": "If-Unmodified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifUnmodifiedSince"
},
{
"name": "If-None-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a non-matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifNoneMatch"
},
{
"name": "If-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifMatch"
},
{
"name": "x-ms-if-tags",
"in": "header",
"description": "Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.",
"required": false,
"type": "string",
"x-ms-client-name": "ifTags"
},
{
"name": "x-ms-lease-action",
"in": "header",
"description": "Specifies what lease action to take.",
"required": true,
"type": "string",
"enum": [
"change"
],
"x-ms-enum": {
"modelAsString": false
},
"x-ms-client-name": "action"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-lease-id": {
"type": "string",
"description": "Uniquely identifies a blob's lease."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=lease&_overload=releaseLease": {
"put": {
"operationId": "Blob_ReleaseLease",
"description": "Frees the lease if it's no longer needed, so that another client can immediately acquire a lease against the blob.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "A lease ID for the resource. The resource must have an active lease and the lease ID must match.",
"required": true,
"type": "string",
"x-ms-client-name": "leaseId"
},
{
"name": "If-Modified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifModifiedSince"
},
{
"name": "If-Unmodified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifUnmodifiedSince"
},
{
"name": "If-None-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a non-matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifNoneMatch"
},
{
"name": "If-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifMatch"
},
{
"name": "x-ms-if-tags",
"in": "header",
"description": "Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.",
"required": false,
"type": "string",
"x-ms-client-name": "ifTags"
},
{
"name": "x-ms-lease-action",
"in": "header",
"description": "Specifies what lease action to take.",
"required": true,
"type": "string",
"enum": [
"release"
],
"x-ms-enum": {
"modelAsString": false
},
"x-ms-client-name": "action"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=lease&_overload=renewLease": {
"put": {
"operationId": "Blob_RenewLease",
"description": "Renews an existing lease.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "A lease ID for the resource. The resource must have an active lease and the lease ID must match.",
"required": true,
"type": "string",
"x-ms-client-name": "leaseId"
},
{
"name": "If-Modified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifModifiedSince"
},
{
"name": "If-Unmodified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifUnmodifiedSince"
},
{
"name": "If-None-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a non-matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifNoneMatch"
},
{
"name": "If-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifMatch"
},
{
"name": "x-ms-if-tags",
"in": "header",
"description": "Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.",
"required": false,
"type": "string",
"x-ms-client-name": "ifTags"
},
{
"name": "x-ms-lease-action",
"in": "header",
"description": "Specifies what lease action to take.",
"required": true,
"type": "string",
"enum": [
"renew"
],
"x-ms-enum": {
"modelAsString": false
},
"x-ms-client-name": "action"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-lease-id": {
"type": "string",
"description": "Uniquely identifies a blob's lease."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=lease&restype=container": {
"put": {
"operationId": "Container_AcquireLease",
"description": "Requests a new lease on the specified container.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "x-ms-lease-duration",
"in": "header",
"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.",
"required": true,
"type": "integer",
"format": "int32",
"x-ms-client-name": "duration"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "x-ms-proposed-lease-id",
"in": "header",
"description": "The proposed lease ID for the lease.",
"required": false,
"type": "string",
"x-ms-client-name": "proposedLeaseId"
},
{
"name": "If-Modified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifModifiedSince"
},
{
"name": "If-Unmodified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifUnmodifiedSince"
},
{
"name": "x-ms-lease-action",
"in": "header",
"description": "Specifies what lease action to take.",
"required": true,
"type": "string",
"enum": [
"acquire"
],
"x-ms-enum": {
"modelAsString": false
},
"x-ms-client-name": "action"
}
],
"responses": {
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-lease-id": {
"type": "string",
"description": "Uniquely identifies a blob's lease."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=lease&restype=container&_overload=breakLease": {
"put": {
"operationId": "Container_BreakLease",
"description": "Ends a lease and ensures that another client can't acquire a new lease until the current lease period has expired.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "If-Modified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifModifiedSince"
},
{
"name": "If-Unmodified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifUnmodifiedSince"
},
{
"name": "x-ms-lease-break-period",
"in": "header",
"description": "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.",
"required": false,
"type": "integer",
"format": "int32",
"x-ms-client-name": "breakPeriod"
},
{
"name": "x-ms-lease-action",
"in": "header",
"description": "Specifies what lease action to take.",
"required": true,
"type": "string",
"enum": [
"break"
],
"x-ms-enum": {
"modelAsString": false
},
"x-ms-client-name": "action"
}
],
"responses": {
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-lease-time": {
"type": "integer",
"format": "int32",
"description": "Approximate time remaining in the lease period, in seconds."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=lease&restype=container&_overload=changeLease": {
"put": {
"operationId": "Container_ChangeLease",
"description": "Change the ID of an existing lease.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "A lease ID for the resource. The resource must have an active lease and the lease ID must match.",
"required": true,
"type": "string",
"x-ms-client-name": "leaseId"
},
{
"name": "x-ms-proposed-lease-id",
"in": "header",
"description": "The proposed lease ID for the lease.",
"required": true,
"type": "string",
"x-ms-client-name": "proposedLeaseId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "If-Modified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifModifiedSince"
},
{
"name": "If-Unmodified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifUnmodifiedSince"
},
{
"name": "x-ms-lease-action",
"in": "header",
"description": "Specifies what lease action to take.",
"required": true,
"type": "string",
"enum": [
"change"
],
"x-ms-enum": {
"modelAsString": false
},
"x-ms-client-name": "action"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-lease-id": {
"type": "string",
"description": "Uniquely identifies a blob's lease."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=lease&restype=container&_overload=releaseLease": {
"put": {
"operationId": "Container_ReleaseLease",
"description": "Frees the lease if it's no longer needed, so that another client can immediately acquire a lease against the container.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "A lease ID for the resource. The resource must have an active lease and the lease ID must match.",
"required": true,
"type": "string",
"x-ms-client-name": "leaseId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "If-Modified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifModifiedSince"
},
{
"name": "If-Unmodified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifUnmodifiedSince"
},
{
"name": "x-ms-lease-action",
"in": "header",
"description": "Specifies what lease action to take.",
"required": true,
"type": "string",
"enum": [
"release"
],
"x-ms-enum": {
"modelAsString": false
},
"x-ms-client-name": "action"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=lease&restype=container&_overload=renewLease": {
"put": {
"operationId": "Container_RenewLease",
"description": "Renews an existing lease.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "A lease ID for the resource. The resource must have an active lease and the lease ID must match.",
"required": true,
"type": "string",
"x-ms-client-name": "leaseId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "If-Modified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifModifiedSince"
},
{
"name": "If-Unmodified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifUnmodifiedSince"
},
{
"name": "x-ms-lease-action",
"in": "header",
"description": "Specifies what lease action to take.",
"required": true,
"type": "string",
"enum": [
"renew"
],
"x-ms-enum": {
"modelAsString": false
},
"x-ms-client-name": "action"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-lease-id": {
"type": "string",
"description": "Uniquely identifies a blob's lease."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=legalhold": {
"put": {
"operationId": "Blob_SetLegalHold",
"description": "Sets a legal hold on the specified blob.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "x-ms-legal-hold",
"in": "header",
"description": "Indicates whether the blob has a legal hold.",
"required": true,
"type": "boolean",
"x-ms-client-name": "legalHold"
},
{
"name": "snapshot",
"in": "query",
"description": "Specifies the snapshot of the blob.",
"required": false,
"type": "string"
},
{
"name": "versionid",
"in": "query",
"description": "Specifies the version ID of the blob.",
"required": false,
"type": "string",
"x-ms-client-name": "versionId"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-legal-hold": {
"type": "boolean",
"description": "Indicates whether the blob has a legal hold."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=list": {
"get": {
"operationId": "Service_ListContainers",
"description": "Returns a list of the containers in the specified account.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "prefix",
"in": "query",
"description": "Filters the results to return only resources whose name begins with the specified prefix.",
"required": false,
"type": "string"
},
{
"name": "marker",
"in": "query",
"description": "An opaque string value that identifies the portion of the result set to return with this operation.",
"required": false,
"type": "string"
},
{
"name": "maxresults",
"in": "query",
"description": "Specifies the maximum number of resources to return. If the request does not specify maxresults, or specifies a value greater than 5000, the server will return up to 5000 items.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 1
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "include",
"in": "query",
"description": "Specify to include additional, optional information.",
"required": false,
"type": "array",
"items": {
"type": "string",
"enum": [
"metadata",
"deleted",
"system"
],
"x-ms-enum": {
"name": "ListContainersIncludeType",
"modelAsString": false,
"values": [
{
"name": "metadata",
"value": "metadata",
"description": "Include metadata."
},
{
"name": "deleted",
"value": "deleted",
"description": "Include soft-deleted containers."
},
{
"name": "system",
"value": "system",
"description": "Include system containers."
}
]
}
},
"collectionFormat": "csv"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/ListContainersResponse"
},
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=metadata": {
"put": {
"operationId": "Blob_SetMetadata",
"description": "Sets user-defined metadata for the specified blob.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "x-ms-meta",
"in": "header",
"description": "The metadata headers.",
"required": false,
"type": "string",
"x-ms-client-name": "metadata"
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.",
"required": false,
"type": "string",
"x-ms-client-name": "leaseId"
},
{
"name": "x-ms-encryption-key",
"in": "header",
"description": "Specifies the encryption key to use to encrypt the data provided in the request.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionKey"
},
{
"name": "x-ms-encryption-key-sha256",
"in": "header",
"description": "The SHA-256 hash of the provided encryption key. Must be provided if the encryption key is provided.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionKeySha256"
},
{
"name": "x-ms-encryption-algorithm",
"in": "header",
"description": "The algorithm used to produce the encryption key hash. Must be provided if the encryption key is provided.",
"required": false,
"type": "string",
"enum": [
"AES256"
],
"x-ms-enum": {
"name": "EncryptionAlgorithmType",
"modelAsString": false,
"values": [
{
"name": "AES256",
"value": "AES256",
"description": "The AES256 encryption algorithm."
}
]
},
"x-ms-client-name": "encryptionAlgorithm"
},
{
"name": "x-ms-encryption-scope",
"in": "header",
"description": "Specifies the encryption scope used to encrypt the data.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionScope"
},
{
"name": "If-Modified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifModifiedSince"
},
{
"name": "If-Unmodified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifUnmodifiedSince"
},
{
"name": "If-None-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a non-matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifNoneMatch"
},
{
"name": "If-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifMatch"
},
{
"name": "x-ms-if-tags",
"in": "header",
"description": "Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.",
"required": false,
"type": "string",
"x-ms-client-name": "ifTags"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-encryption-key-sha256": {
"type": "string",
"description": "The SHA-256 hash of the provided encryption key."
},
"x-ms-encryption-scope": {
"type": "string",
"description": "Specifies the encryption scope used to encrypt the data."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-request-server-encrypted": {
"type": "boolean",
"description": "Indicates whether the contents of the request are successfully encrypted."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
},
"x-ms-version-id": {
"type": "string",
"description": "The version ID of the blob."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=page": {
"put": {
"operationId": "PageBlob_UploadPages",
"description": "Writes a range of pages to the specified page blob.",
"consumes": [
"application/octet-stream"
],
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "Content-Length",
"in": "header",
"description": "The length of the request.",
"required": true,
"type": "integer",
"format": "int64",
"x-ms-client-name": "contentLength"
},
{
"name": "Content-MD5",
"in": "header",
"description": "Specifies the transactional MD5 hash for the body.",
"required": false,
"type": "string",
"format": "byte",
"x-ms-client-name": "transactionalContentMd5"
},
{
"name": "x-ms-content-crc64",
"in": "header",
"description": "Specifies the transactional CRC64 hash for the body.",
"required": false,
"type": "string",
"format": "byte",
"x-ms-client-name": "transactionalContentCrc64"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "Range",
"in": "header",
"description": "Specifies the range of the blob to operate on.",
"required": true,
"type": "string",
"x-ms-client-name": "range"
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.",
"required": false,
"type": "string",
"x-ms-client-name": "leaseId"
},
{
"name": "x-ms-encryption-key",
"in": "header",
"description": "Specifies the encryption key to use to encrypt the data provided in the request.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionKey"
},
{
"name": "x-ms-encryption-key-sha256",
"in": "header",
"description": "The SHA-256 hash of the provided encryption key. Must be provided if the encryption key is provided.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionKeySha256"
},
{
"name": "x-ms-encryption-algorithm",
"in": "header",
"description": "The algorithm used to produce the encryption key hash. Must be provided if the encryption key is provided.",
"required": false,
"type": "string",
"enum": [
"AES256"
],
"x-ms-enum": {
"name": "EncryptionAlgorithmType",
"modelAsString": false,
"values": [
{
"name": "AES256",
"value": "AES256",
"description": "The AES256 encryption algorithm."
}
]
},
"x-ms-client-name": "encryptionAlgorithm"
},
{
"name": "x-ms-encryption-scope",
"in": "header",
"description": "Specifies the encryption scope used to encrypt the data.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionScope"
},
{
"name": "x-ms-if-sequence-number-le",
"in": "header",
"description": "Specify this value to operate only on a blob if it has a sequence number less than or equal to the specified.",
"required": false,
"type": "integer",
"format": "int64",
"x-ms-client-name": "ifSequenceNumberLessThanOrEqualTo"
},
{
"name": "x-ms-if-sequence-number-lt",
"in": "header",
"description": "Specify this value to operate only on a blob if it has a sequence number less than the specified.",
"required": false,
"type": "integer",
"format": "int64",
"x-ms-client-name": "ifSequenceNumberLessThan"
},
{
"name": "x-ms-if-sequence-number-eq",
"in": "header",
"description": "Specify this value to operate only on a blob if it has the specified sequence number.",
"required": false,
"type": "integer",
"format": "int64",
"x-ms-client-name": "ifSequenceNumberEqualTo"
},
{
"name": "If-Modified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifModifiedSince"
},
{
"name": "If-Unmodified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifUnmodifiedSince"
},
{
"name": "If-None-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a non-matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifNoneMatch"
},
{
"name": "If-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifMatch"
},
{
"name": "x-ms-if-tags",
"in": "header",
"description": "Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.",
"required": false,
"type": "string",
"x-ms-client-name": "ifTags"
},
{
"name": "x-ms-structured-body",
"in": "header",
"description": "Required if the request body is a structured message. Specifies the message schema version and properties.",
"required": false,
"type": "string",
"x-ms-client-name": "structuredBodyType"
},
{
"name": "x-ms-structured-content-length",
"in": "header",
"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.",
"required": false,
"type": "integer",
"format": "int64",
"x-ms-client-name": "structuredContentLength"
},
{
"name": "x-ms-page-write",
"in": "header",
"description": "Specifies the page write operation type.\n- Update: Writes the bytes specified by the request body into the specified range. The Range and Content-Length headers must match.\n- Clear: Clears the specified range and releases the space used in storage. Set Content-Length to zero and Range to the range to clear.",
"required": true,
"type": "string",
"enum": [
"update"
],
"x-ms-enum": {
"modelAsString": false
},
"x-ms-client-name": "pageWrite"
},
{
"name": "body",
"in": "body",
"description": "The body of the request.",
"required": true,
"schema": {
"type": "string",
"format": "binary"
}
}
],
"responses": {
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"headers": {
"Content-MD5": {
"type": "string",
"format": "byte",
"description": "The blob content MD5 hash. Only returned if the full blob is read."
},
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-blob-sequence-number": {
"type": "integer",
"format": "int64",
"description": "The current sequence number for a page blob."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-content-crc64": {
"type": "string",
"format": "byte",
"description": "The CRC64 hash of the content."
},
"x-ms-encryption-key-sha256": {
"type": "string",
"description": "The SHA-256 hash of the provided encryption key."
},
"x-ms-encryption-scope": {
"type": "string",
"description": "Specifies the encryption scope used to encrypt the data."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-request-server-encrypted": {
"type": "boolean",
"description": "Indicates whether the contents of the request are successfully encrypted."
},
"x-ms-structured-body": {
"type": "string",
"description": "Indicates if the response body contains a structured message and specifies the message schema version and properties."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=page&_overload=clearPages": {
"put": {
"operationId": "PageBlob_ClearPages",
"description": "Clears a range of pages from the specified page blob.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "Content-Length",
"in": "header",
"description": "Value must be 0 when x-ms-page-write is clear.",
"required": true,
"type": "number",
"enum": [
0
],
"x-ms-client-name": "contentLength"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "Range",
"in": "header",
"description": "Specifies the range of the blob to operate on.",
"required": true,
"type": "string",
"x-ms-client-name": "range"
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.",
"required": false,
"type": "string",
"x-ms-client-name": "leaseId"
},
{
"name": "x-ms-encryption-key",
"in": "header",
"description": "Specifies the encryption key to use to encrypt the data provided in the request.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionKey"
},
{
"name": "x-ms-encryption-key-sha256",
"in": "header",
"description": "The SHA-256 hash of the provided encryption key. Must be provided if the encryption key is provided.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionKeySha256"
},
{
"name": "x-ms-encryption-algorithm",
"in": "header",
"description": "The algorithm used to produce the encryption key hash. Must be provided if the encryption key is provided.",
"required": false,
"type": "string",
"enum": [
"AES256"
],
"x-ms-enum": {
"name": "EncryptionAlgorithmType",
"modelAsString": false,
"values": [
{
"name": "AES256",
"value": "AES256",
"description": "The AES256 encryption algorithm."
}
]
},
"x-ms-client-name": "encryptionAlgorithm"
},
{
"name": "x-ms-encryption-scope",
"in": "header",
"description": "Specifies the encryption scope used to encrypt the data.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionScope"
},
{
"name": "x-ms-if-sequence-number-le",
"in": "header",
"description": "Specify this value to operate only on a blob if it has a sequence number less than or equal to the specified.",
"required": false,
"type": "integer",
"format": "int64",
"x-ms-client-name": "ifSequenceNumberLessThanOrEqualTo"
},
{
"name": "x-ms-if-sequence-number-lt",
"in": "header",
"description": "Specify this value to operate only on a blob if it has a sequence number less than the specified.",
"required": false,
"type": "integer",
"format": "int64",
"x-ms-client-name": "ifSequenceNumberLessThan"
},
{
"name": "x-ms-if-sequence-number-eq",
"in": "header",
"description": "Specify this value to operate only on a blob if it has the specified sequence number.",
"required": false,
"type": "integer",
"format": "int64",
"x-ms-client-name": "ifSequenceNumberEqualTo"
},
{
"name": "If-Modified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifModifiedSince"
},
{
"name": "If-Unmodified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifUnmodifiedSince"
},
{
"name": "If-None-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a non-matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifNoneMatch"
},
{
"name": "If-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifMatch"
},
{
"name": "x-ms-if-tags",
"in": "header",
"description": "Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.",
"required": false,
"type": "string",
"x-ms-client-name": "ifTags"
},
{
"name": "x-ms-page-write",
"in": "header",
"description": "Specifies the page write operation type.\n- Update: Writes the bytes specified by the request body into the specified range. The Range and Content-Length headers must match.\n- Clear: Clears the specified range and releases the space used in storage. Set Content-Length to zero and Range to the range to clear.",
"required": true,
"type": "string",
"enum": [
"clear"
],
"x-ms-enum": {
"modelAsString": false
},
"x-ms-client-name": "pageWrite"
}
],
"responses": {
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"headers": {
"Content-MD5": {
"type": "string",
"format": "byte",
"description": "The blob content MD5 hash. Only returned if the full blob is read."
},
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-blob-sequence-number": {
"type": "integer",
"format": "int64",
"description": "The current sequence number for a page blob."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-content-crc64": {
"type": "string",
"format": "byte",
"description": "The CRC64 hash of the content."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=page&_overload=uploadPagesFromUrl": {
"put": {
"operationId": "PageBlob_UploadPagesFromUrl",
"description": "Writes a range of pages to the specified page blob where the contents are read from a URL.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "x-ms-copy-source",
"in": "header",
"description": "Specifies the URL of the source.",
"required": true,
"type": "string",
"x-ms-client-name": "sourceUrl"
},
{
"name": "x-ms-source-range",
"in": "header",
"description": "Specifies the bytes of the source.",
"required": true,
"type": "string",
"x-ms-client-name": "sourceRange"
},
{
"name": "x-ms-source-content-md5",
"in": "header",
"description": "Specifies the MD5 hash calculated for the range of bytes that must be read from the copy source.",
"required": false,
"type": "string",
"format": "byte",
"x-ms-client-name": "sourceContentMd5"
},
{
"name": "x-ms-source-content-crc64",
"in": "header",
"description": "Specifies the CRC64 calculated for the range of bytes that must be read from the source.",
"required": false,
"type": "string",
"format": "byte",
"x-ms-client-name": "sourceContentCrc64"
},
{
"name": "Content-Length",
"in": "header",
"description": "The length of the request.",
"required": true,
"type": "integer",
"format": "int64",
"x-ms-client-name": "contentLength"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "Range",
"in": "header",
"description": "Specifies the range of the blob to operate on.",
"required": true,
"type": "string",
"x-ms-client-name": "range"
},
{
"name": "x-ms-encryption-key",
"in": "header",
"description": "Specifies the encryption key to use to encrypt the data provided in the request.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionKey"
},
{
"name": "x-ms-encryption-key-sha256",
"in": "header",
"description": "The SHA-256 hash of the provided encryption key. Must be provided if the encryption key is provided.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionKeySha256"
},
{
"name": "x-ms-encryption-algorithm",
"in": "header",
"description": "The algorithm used to produce the encryption key hash. Must be provided if the encryption key is provided.",
"required": false,
"type": "string",
"enum": [
"AES256"
],
"x-ms-enum": {
"name": "EncryptionAlgorithmType",
"modelAsString": false,
"values": [
{
"name": "AES256",
"value": "AES256",
"description": "The AES256 encryption algorithm."
}
]
},
"x-ms-client-name": "encryptionAlgorithm"
},
{
"name": "x-ms-encryption-scope",
"in": "header",
"description": "Specifies the encryption scope used to encrypt the data.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionScope"
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.",
"required": false,
"type": "string",
"x-ms-client-name": "leaseId"
},
{
"name": "x-ms-if-sequence-number-le",
"in": "header",
"description": "Specify this value to operate only on a blob if it has a sequence number less than or equal to the specified.",
"required": false,
"type": "integer",
"format": "int64",
"x-ms-client-name": "ifSequenceNumberLessThanOrEqualTo"
},
{
"name": "x-ms-if-sequence-number-lt",
"in": "header",
"description": "Specify this value to operate only on a blob if it has a sequence number less than the specified.",
"required": false,
"type": "integer",
"format": "int64",
"x-ms-client-name": "ifSequenceNumberLessThan"
},
{
"name": "x-ms-if-sequence-number-eq",
"in": "header",
"description": "Specify this value to operate only on a blob if it has the specified sequence number.",
"required": false,
"type": "integer",
"format": "int64",
"x-ms-client-name": "ifSequenceNumberEqualTo"
},
{
"name": "If-Modified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifModifiedSince"
},
{
"name": "If-Unmodified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifUnmodifiedSince"
},
{
"name": "If-None-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a non-matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifNoneMatch"
},
{
"name": "If-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifMatch"
},
{
"name": "x-ms-if-tags",
"in": "header",
"description": "Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.",
"required": false,
"type": "string",
"x-ms-client-name": "ifTags"
},
{
"name": "x-ms-source-if-modified-since",
"in": "header",
"description": "Specify this value to operate only on a source blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "sourceIfModifiedSince"
},
{
"name": "x-ms-source-if-unmodified-since",
"in": "header",
"description": "Specify this header value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "sourceIfUnmodifiedSince"
},
{
"name": "x-ms-source-if-match",
"in": "header",
"description": "Specify this value to operate only on a source blob with a matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "sourceIfMatch"
},
{
"name": "x-ms-source-if-none-match",
"in": "header",
"description": "Specify this value to operate only on a source blob with a non-matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "sourceIfNoneMatch"
},
{
"name": "x-ms-copy-source-authorization",
"in": "header",
"description": "Only the Bearer authorization scheme is supported, and the value must be a valid OAuth access token for the copy source.",
"required": false,
"type": "string",
"x-ms-client-name": "copySourceAuthorization"
},
{
"name": "x-ms-file-request-intent",
"in": "header",
"description": "Specifies the file request token intent.",
"required": false,
"type": "string",
"enum": [
"backup"
],
"x-ms-enum": {
"name": "FileShareTokenIntent",
"modelAsString": true,
"values": [
{
"name": "Backup",
"value": "backup",
"description": "The file share token intent is backup."
}
]
},
"x-ms-client-name": "fileRequestIntent"
},
{
"name": "x-ms-page-write",
"in": "header",
"description": "Specifies the page write operation type.\n- Update: Writes the bytes specified by the request body into the specified range. The Range and Content-Length headers must match.\n- Clear: Clears the specified range and releases the space used in storage. Set Content-Length to zero and Range to the range to clear.",
"required": true,
"type": "string",
"enum": [
"update"
],
"x-ms-enum": {
"modelAsString": false
},
"x-ms-client-name": "pageWrite"
}
],
"responses": {
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"headers": {
"Content-MD5": {
"type": "string",
"format": "byte",
"description": "The blob content MD5 hash. Only returned if the full blob is read."
},
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-blob-sequence-number": {
"type": "integer",
"format": "int64",
"description": "The current sequence number for a page blob."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-content-crc64": {
"type": "string",
"format": "byte",
"description": "The CRC64 hash of the content."
},
"x-ms-encryption-key-sha256": {
"type": "string",
"description": "The SHA-256 hash of the provided encryption key."
},
"x-ms-encryption-scope": {
"type": "string",
"description": "Specifies the encryption scope used to encrypt the data."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-request-server-encrypted": {
"type": "boolean",
"description": "Indicates whether the contents of the request are successfully encrypted."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=pagelist": {
"get": {
"operationId": "PageBlob_GetPageRanges",
"description": "Returns the list of valid page ranges for the specified page blob.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "snapshot",
"in": "query",
"description": "Specifies the snapshot of the blob.",
"required": false,
"type": "string"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "Range",
"in": "header",
"description": "Specifies the range of the blob to operate on.",
"required": false,
"type": "string",
"x-ms-client-name": "range"
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.",
"required": false,
"type": "string",
"x-ms-client-name": "leaseId"
},
{
"name": "If-Modified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifModifiedSince"
},
{
"name": "If-Unmodified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifUnmodifiedSince"
},
{
"name": "If-None-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a non-matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifNoneMatch"
},
{
"name": "If-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifMatch"
},
{
"name": "x-ms-if-tags",
"in": "header",
"description": "Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.",
"required": false,
"type": "string",
"x-ms-client-name": "ifTags"
},
{
"name": "marker",
"in": "query",
"description": "An opaque string value that identifies the portion of the result set to return with this operation.",
"required": false,
"type": "string"
},
{
"name": "maxresults",
"in": "query",
"description": "Specifies the maximum number of resources to return. If the request does not specify maxresults, or specifies a value greater than 5000, the server will return up to 5000 items.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 1
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/PageList"
},
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-blob-content-length": {
"type": "integer",
"format": "int64",
"description": "The size of the blob in bytes."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=pagelist&_overload=getPageRangesDiff": {
"get": {
"operationId": "PageBlob_GetPageRangesDiff",
"description": "Returns the list of page ranges in the diff between the specified page blob and the specified previous snapshot.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "snapshot",
"in": "query",
"description": "Specifies the snapshot of the blob.",
"required": false,
"type": "string"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "prevsnapshot",
"in": "query",
"description": "Specifies the previous snapshot to be compared in the diff.",
"required": false,
"type": "string"
},
{
"name": "x-ms-previous-snapshot-url",
"in": "header",
"description": "Specifies the previous snapshot URL to be compared in the diff.",
"required": false,
"type": "string",
"x-ms-client-name": "prevSnapshotUrl"
},
{
"name": "Range",
"in": "header",
"description": "Specifies the range of the blob to operate on.",
"required": false,
"type": "string",
"x-ms-client-name": "range"
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.",
"required": false,
"type": "string",
"x-ms-client-name": "leaseId"
},
{
"name": "If-Modified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifModifiedSince"
},
{
"name": "If-Unmodified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifUnmodifiedSince"
},
{
"name": "If-None-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a non-matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifNoneMatch"
},
{
"name": "If-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifMatch"
},
{
"name": "x-ms-if-tags",
"in": "header",
"description": "Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.",
"required": false,
"type": "string",
"x-ms-client-name": "ifTags"
},
{
"name": "marker",
"in": "query",
"description": "An opaque string value that identifies the portion of the result set to return with this operation.",
"required": false,
"type": "string"
},
{
"name": "maxresults",
"in": "query",
"description": "Specifies the maximum number of resources to return. If the request does not specify maxresults, or specifies a value greater than 5000, the server will return up to 5000 items.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 1
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/PageList"
},
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-blob-content-length": {
"type": "integer",
"format": "int64",
"description": "The size of the blob in bytes."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=properties": {
"put": {
"operationId": "Blob_SetProperties",
"description": "Sets system properties on the specified blob.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "x-ms-blob-cache-control",
"in": "header",
"description": "Specifies the blob's Cache-Control. If specified, this property is stored with the blob and returned with a read request.",
"required": false,
"type": "string",
"x-ms-client-name": "blobCacheControl"
},
{
"name": "x-ms-blob-content-type",
"in": "header",
"description": "Specifies the blob's Content-Type. If specified, this property is stored with the blob and returned with a read request.",
"required": false,
"type": "string",
"x-ms-client-name": "blobContentType"
},
{
"name": "x-ms-blob-content-md5",
"in": "header",
"description": "The MD5 hash of the blob content that is stored as a property on the blob. Note: This hash is not validated.",
"required": false,
"type": "string",
"format": "byte",
"x-ms-client-name": "blobContentMd5"
},
{
"name": "x-ms-blob-content-encoding",
"in": "header",
"description": "Specifies the blob's Content-Encoding. If specified, this property is stored with the blob and returned with a read request.",
"required": false,
"type": "string",
"x-ms-client-name": "blobContentEncoding"
},
{
"name": "x-ms-blob-content-language",
"in": "header",
"description": "Specifies the blob's Content-Language. If specified, this property is stored with the blob and returned with a read request.",
"required": false,
"type": "string",
"x-ms-client-name": "blobContentLanguage"
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.",
"required": false,
"type": "string",
"x-ms-client-name": "leaseId"
},
{
"name": "x-ms-blob-content-disposition",
"in": "header",
"description": "Specifies the blob's Content-Disposition. If specified, this property is stored with the blob and returned with a read request.",
"required": false,
"type": "string",
"x-ms-client-name": "blobContentDisposition"
},
{
"name": "If-Modified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifModifiedSince"
},
{
"name": "If-Unmodified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifUnmodifiedSince"
},
{
"name": "If-None-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a non-matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifNoneMatch"
},
{
"name": "If-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifMatch"
},
{
"name": "x-ms-if-tags",
"in": "header",
"description": "Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.",
"required": false,
"type": "string",
"x-ms-client-name": "ifTags"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-blob-sequence-number": {
"type": "integer",
"format": "int64",
"description": "The current sequence number for a page blob."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=properties&_overload=resize": {
"put": {
"operationId": "PageBlob_Resize",
"description": "Changes the size of the specified page blob.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.",
"required": false,
"type": "string",
"x-ms-client-name": "leaseId"
},
{
"name": "x-ms-encryption-key",
"in": "header",
"description": "Specifies the encryption key to use to encrypt the data provided in the request.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionKey"
},
{
"name": "x-ms-encryption-key-sha256",
"in": "header",
"description": "The SHA-256 hash of the provided encryption key. Must be provided if the encryption key is provided.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionKeySha256"
},
{
"name": "x-ms-encryption-algorithm",
"in": "header",
"description": "The algorithm used to produce the encryption key hash. Must be provided if the encryption key is provided.",
"required": false,
"type": "string",
"enum": [
"AES256"
],
"x-ms-enum": {
"name": "EncryptionAlgorithmType",
"modelAsString": false,
"values": [
{
"name": "AES256",
"value": "AES256",
"description": "The AES256 encryption algorithm."
}
]
},
"x-ms-client-name": "encryptionAlgorithm"
},
{
"name": "x-ms-encryption-scope",
"in": "header",
"description": "Specifies the encryption scope used to encrypt the data.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionScope"
},
{
"name": "If-Modified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifModifiedSince"
},
{
"name": "If-Unmodified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifUnmodifiedSince"
},
{
"name": "If-None-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a non-matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifNoneMatch"
},
{
"name": "If-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifMatch"
},
{
"name": "x-ms-if-tags",
"in": "header",
"description": "Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.",
"required": false,
"type": "string",
"x-ms-client-name": "ifTags"
},
{
"name": "x-ms-blob-content-length",
"in": "header",
"description": "The maximum size for the page blob. Must be aligned to a 512-byte boundary.",
"required": true,
"type": "integer",
"format": "int64",
"x-ms-client-name": "size"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-blob-sequence-number": {
"type": "integer",
"format": "int64",
"description": "The current sequence number for a page blob."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=properties&_overload=setSequenceNumber": {
"put": {
"operationId": "PageBlob_SetSequenceNumber",
"description": "Updates the sequence number of the specified page blob. The operation will fail if the specified sequence number is less than the current sequence number of the blob.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.",
"required": false,
"type": "string",
"x-ms-client-name": "leaseId"
},
{
"name": "If-Modified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifModifiedSince"
},
{
"name": "If-Unmodified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifUnmodifiedSince"
},
{
"name": "If-None-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a non-matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifNoneMatch"
},
{
"name": "If-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifMatch"
},
{
"name": "x-ms-if-tags",
"in": "header",
"description": "Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.",
"required": false,
"type": "string",
"x-ms-client-name": "ifTags"
},
{
"name": "x-ms-sequence-number-action",
"in": "header",
"description": "Required if the blob sequence number is provided. This property indicates how the service should modify the blob's sequence number.",
"required": true,
"type": "string",
"enum": [
"increment",
"max",
"update"
],
"x-ms-enum": {
"name": "SequenceNumberActionType",
"modelAsString": false,
"values": [
{
"name": "Increment",
"value": "increment",
"description": "Increment the sequence number."
},
{
"name": "Max",
"value": "max",
"description": "Set the maximum for the sequence number."
},
{
"name": "Update",
"value": "update",
"description": "Update the sequence number."
}
]
},
"x-ms-client-name": "sequenceNumberAction"
},
{
"name": "x-ms-blob-sequence-number",
"in": "header",
"description": "A value that can be used to track the request. The value of the sequence number must be between 0 and 2^63 - 1.",
"required": false,
"type": "integer",
"format": "int64",
"default": 0,
"x-ms-client-name": "blobSequenceNumber"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-blob-sequence-number": {
"type": "integer",
"format": "int64",
"description": "The current sequence number for a page blob."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=query": {
"post": {
"operationId": "BlockBlob_Query",
"description": "Queries the data of the specified blob with the provided query expressions.",
"produces": [
"application/octet-stream",
"application/xml"
],
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "snapshot",
"in": "query",
"description": "Specifies the snapshot of the blob.",
"required": false,
"type": "string"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.",
"required": false,
"type": "string",
"x-ms-client-name": "leaseId"
},
{
"name": "x-ms-encryption-key",
"in": "header",
"description": "Specifies the encryption key to use to encrypt the data provided in the request.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionKey"
},
{
"name": "x-ms-encryption-key-sha256",
"in": "header",
"description": "The SHA-256 hash of the provided encryption key. Must be provided if the encryption key is provided.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionKeySha256"
},
{
"name": "x-ms-encryption-algorithm",
"in": "header",
"description": "The algorithm used to produce the encryption key hash. Must be provided if the encryption key is provided.",
"required": false,
"type": "string",
"enum": [
"AES256"
],
"x-ms-enum": {
"name": "EncryptionAlgorithmType",
"modelAsString": false,
"values": [
{
"name": "AES256",
"value": "AES256",
"description": "The AES256 encryption algorithm."
}
]
},
"x-ms-client-name": "encryptionAlgorithm"
},
{
"name": "If-Modified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifModifiedSince"
},
{
"name": "If-Unmodified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifUnmodifiedSince"
},
{
"name": "If-None-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a non-matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifNoneMatch"
},
{
"name": "If-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifMatch"
},
{
"name": "x-ms-if-tags",
"in": "header",
"description": "Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.",
"required": false,
"type": "string",
"x-ms-client-name": "ifTags"
},
{
"name": "queryRequest",
"in": "body",
"description": "The query request.",
"required": true,
"schema": {
"$ref": "#/definitions/QueryRequest"
}
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"type": "file"
},
"headers": {
"Accept-Ranges": {
"type": "string",
"description": "Indicates that the service supports requests for partial blob content."
},
"Cache-Control": {
"type": "string",
"description": "The Cache-Control of the blob."
},
"Content-Disposition": {
"type": "string",
"description": "The Content-Disposition of the blob."
},
"Content-Encoding": {
"type": "string",
"description": "The Content-Encoding of the blob."
},
"Content-Language": {
"type": "string",
"description": "The Content-Language of the blob."
},
"Content-Length": {
"type": "integer",
"format": "int64",
"description": "The number of bytes present in the response body."
},
"Content-MD5": {
"type": "string",
"format": "byte",
"description": "The blob content MD5 hash. Only returned if the full blob is read."
},
"Content-Range": {
"type": "string",
"description": "Indicates the range of bytes returned in this response."
},
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-blob-committed-block-count": {
"type": "integer",
"format": "int32",
"description": "The number of committed blocks present in the blob."
},
"x-ms-blob-content-md5": {
"type": "string",
"format": "byte",
"description": "MD5 hash of the full blob content only returned for ranged reads. This is the hash of the complete blob, not just the requested range."
},
"x-ms-blob-sequence-number": {
"type": "integer",
"format": "int64",
"description": "The current sequence number for a page blob."
},
"x-ms-blob-type": {
"type": "string",
"description": "The type of the blob.",
"enum": [
"BlockBlob",
"PageBlob",
"AppendBlob"
],
"x-ms-enum": {
"name": "BlobType",
"modelAsString": false,
"values": [
{
"name": "BlockBlob",
"value": "BlockBlob",
"description": "The blob is a block blob."
},
{
"name": "PageBlob",
"value": "PageBlob",
"description": "The blob is a page blob."
},
{
"name": "AppendBlob",
"value": "AppendBlob",
"description": "The blob is an append blob."
}
]
}
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-content-crc64": {
"type": "string",
"format": "byte",
"description": "The CRC64 hash of the content."
},
"x-ms-copy-completion-time": {
"type": "string",
"format": "date-time-rfc7231",
"description": "If this blob was the destination of a copy, specifies the completion time of the last attempted copy operation."
},
"x-ms-copy-id": {
"type": "string",
"description": "Identifier for this copy operation."
},
"x-ms-copy-progress": {
"type": "string",
"description": "If this blob was the destination of a copy, specifies the number of bytes copied and the total bytes in the source."
},
"x-ms-copy-source": {
"type": "string",
"description": "If this blob was the destination of a copy, specifies the source URL."
},
"x-ms-copy-status": {
"type": "string",
"description": "Status of the copy operation.",
"enum": [
"pending",
"success",
"failed",
"aborted"
],
"x-ms-enum": {
"name": "CopyStatus",
"modelAsString": false,
"values": [
{
"name": "Pending",
"value": "pending",
"description": "The copy operation is pending."
},
{
"name": "Success",
"value": "success",
"description": "The copy operation succeeded."
},
{
"name": "Failed",
"value": "failed",
"description": "The copy operation failed."
},
{
"name": "Aborted",
"value": "aborted",
"description": "The copy operation was aborted."
}
]
}
},
"x-ms-copy-status-description": {
"type": "string",
"description": "If this blob was the destination of a copy, specifies the cause of the copy operation failure."
},
"x-ms-encryption-key-sha256": {
"type": "string",
"description": "The SHA-256 hash of the provided encryption key."
},
"x-ms-encryption-scope": {
"type": "string",
"description": "Specifies the encryption scope used to encrypt the data."
},
"x-ms-lease-duration": {
"type": "string",
"description": "Specifies the duration of the lease.",
"enum": [
"infinite",
"fixed"
],
"x-ms-enum": {
"name": "LeaseDuration",
"modelAsString": false,
"values": [
{
"name": "Infinite",
"value": "infinite",
"description": "The lease is of infinite duration."
},
{
"name": "Fixed",
"value": "fixed",
"description": "The lease is of fixed duration."
}
]
}
},
"x-ms-lease-state": {
"type": "string",
"description": "The lease state of the blob.",
"enum": [
"available",
"leased",
"expired",
"breaking",
"broken"
],
"x-ms-enum": {
"name": "LeaseState",
"modelAsString": false,
"values": [
{
"name": "Available",
"value": "available",
"description": "The lease is available."
},
{
"name": "Leased",
"value": "leased",
"description": "The lease is currently leased."
},
{
"name": "Expired",
"value": "expired",
"description": "The lease is expired."
},
{
"name": "Breaking",
"value": "breaking",
"description": "The lease is breaking."
},
{
"name": "Broken",
"value": "broken",
"description": "The lease is broken."
}
]
}
},
"x-ms-lease-status": {
"type": "string",
"description": "The lease status of the blob.",
"enum": [
"unlocked",
"locked"
],
"x-ms-enum": {
"name": "LeaseStatus",
"modelAsString": false,
"values": [
{
"name": "Unlocked",
"value": "unlocked",
"description": "The lease is unlocked."
},
{
"name": "Locked",
"value": "locked",
"description": "The lease is locked."
}
]
}
},
"x-ms-meta": {
"type": "string",
"description": "The metadata headers."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-server-encrypted": {
"type": "boolean",
"description": "Indicates whether the contents of the request are successfully encrypted."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"206": {
"description": "Successful",
"schema": {
"type": "file"
},
"headers": {
"Accept-Ranges": {
"type": "string",
"description": "Indicates that the service supports requests for partial blob content."
},
"Cache-Control": {
"type": "string",
"description": "The Cache-Control of the blob."
},
"Content-Disposition": {
"type": "string",
"description": "The Content-Disposition of the blob."
},
"Content-Encoding": {
"type": "string",
"description": "The Content-Encoding of the blob."
},
"Content-Language": {
"type": "string",
"description": "The Content-Language of the blob."
},
"Content-Length": {
"type": "integer",
"format": "int64",
"description": "The number of bytes present in the response body."
},
"Content-MD5": {
"type": "string",
"format": "byte",
"description": "The blob content MD5 hash. Only returned if the full blob is read."
},
"Content-Range": {
"type": "string",
"description": "Indicates the range of bytes returned in this response."
},
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-blob-committed-block-count": {
"type": "integer",
"format": "int32",
"description": "The number of committed blocks present in the blob."
},
"x-ms-blob-content-md5": {
"type": "string",
"format": "byte",
"description": "MD5 hash of the full blob content only returned for ranged reads. This is the hash of the complete blob, not just the requested range."
},
"x-ms-blob-sequence-number": {
"type": "integer",
"format": "int64",
"description": "The current sequence number for a page blob."
},
"x-ms-blob-type": {
"type": "string",
"description": "The type of the blob.",
"enum": [
"BlockBlob",
"PageBlob",
"AppendBlob"
],
"x-ms-enum": {
"name": "BlobType",
"modelAsString": false,
"values": [
{
"name": "BlockBlob",
"value": "BlockBlob",
"description": "The blob is a block blob."
},
{
"name": "PageBlob",
"value": "PageBlob",
"description": "The blob is a page blob."
},
{
"name": "AppendBlob",
"value": "AppendBlob",
"description": "The blob is an append blob."
}
]
}
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-content-crc64": {
"type": "string",
"format": "byte",
"description": "The CRC64 hash of the content."
},
"x-ms-copy-completion-time": {
"type": "string",
"format": "date-time-rfc7231",
"description": "If this blob was the destination of a copy, specifies the completion time of the last attempted copy operation."
},
"x-ms-copy-id": {
"type": "string",
"description": "Identifier for this copy operation."
},
"x-ms-copy-progress": {
"type": "string",
"description": "If this blob was the destination of a copy, specifies the number of bytes copied and the total bytes in the source."
},
"x-ms-copy-source": {
"type": "string",
"description": "If this blob was the destination of a copy, specifies the source URL."
},
"x-ms-copy-status": {
"type": "string",
"description": "Status of the copy operation.",
"enum": [
"pending",
"success",
"failed",
"aborted"
],
"x-ms-enum": {
"name": "CopyStatus",
"modelAsString": false,
"values": [
{
"name": "Pending",
"value": "pending",
"description": "The copy operation is pending."
},
{
"name": "Success",
"value": "success",
"description": "The copy operation succeeded."
},
{
"name": "Failed",
"value": "failed",
"description": "The copy operation failed."
},
{
"name": "Aborted",
"value": "aborted",
"description": "The copy operation was aborted."
}
]
}
},
"x-ms-copy-status-description": {
"type": "string",
"description": "If this blob was the destination of a copy, specifies the cause of the copy operation failure."
},
"x-ms-encryption-key-sha256": {
"type": "string",
"description": "The SHA-256 hash of the provided encryption key."
},
"x-ms-encryption-scope": {
"type": "string",
"description": "Specifies the encryption scope used to encrypt the data."
},
"x-ms-lease-duration": {
"type": "string",
"description": "Specifies the duration of the lease.",
"enum": [
"infinite",
"fixed"
],
"x-ms-enum": {
"name": "LeaseDuration",
"modelAsString": false,
"values": [
{
"name": "Infinite",
"value": "infinite",
"description": "The lease is of infinite duration."
},
{
"name": "Fixed",
"value": "fixed",
"description": "The lease is of fixed duration."
}
]
}
},
"x-ms-lease-state": {
"type": "string",
"description": "The lease state of the blob.",
"enum": [
"available",
"leased",
"expired",
"breaking",
"broken"
],
"x-ms-enum": {
"name": "LeaseState",
"modelAsString": false,
"values": [
{
"name": "Available",
"value": "available",
"description": "The lease is available."
},
{
"name": "Leased",
"value": "leased",
"description": "The lease is currently leased."
},
{
"name": "Expired",
"value": "expired",
"description": "The lease is expired."
},
{
"name": "Breaking",
"value": "breaking",
"description": "The lease is breaking."
},
{
"name": "Broken",
"value": "broken",
"description": "The lease is broken."
}
]
}
},
"x-ms-lease-status": {
"type": "string",
"description": "The lease status of the blob.",
"enum": [
"unlocked",
"locked"
],
"x-ms-enum": {
"name": "LeaseStatus",
"modelAsString": false,
"values": [
{
"name": "Unlocked",
"value": "unlocked",
"description": "The lease is unlocked."
},
{
"name": "Locked",
"value": "locked",
"description": "The lease is locked."
}
]
}
},
"x-ms-meta": {
"type": "string",
"description": "The metadata headers."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-server-encrypted": {
"type": "boolean",
"description": "Indicates whether the contents of the request are successfully encrypted."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=seal": {
"put": {
"operationId": "AppendBlob_Seal",
"description": "Seals the append blob to make it read-only.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.",
"required": false,
"type": "string",
"x-ms-client-name": "leaseId"
},
{
"name": "If-Modified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifModifiedSince"
},
{
"name": "If-Unmodified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifUnmodifiedSince"
},
{
"name": "If-None-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a non-matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifNoneMatch"
},
{
"name": "If-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifMatch"
},
{
"name": "x-ms-blob-condition-appendpos",
"in": "header",
"description": "A byte offset where the operation will only succeed if the append position is equal. If not, the request will fail with AppendPositionConditionNotMet.",
"required": false,
"type": "integer",
"format": "int64",
"x-ms-client-name": "appendPosition"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-blob-sealed": {
"type": "boolean",
"description": "Whether the blob is sealed."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=snapshot": {
"put": {
"operationId": "Blob_CreateSnapshot",
"description": "Creates a read-only snapshot of the specified blob.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "x-ms-meta",
"in": "header",
"description": "The metadata headers.",
"required": false,
"type": "string",
"x-ms-client-name": "metadata"
},
{
"name": "x-ms-encryption-key",
"in": "header",
"description": "Specifies the encryption key to use to encrypt the data provided in the request.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionKey"
},
{
"name": "x-ms-encryption-key-sha256",
"in": "header",
"description": "The SHA-256 hash of the provided encryption key. Must be provided if the encryption key is provided.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionKeySha256"
},
{
"name": "x-ms-encryption-algorithm",
"in": "header",
"description": "The algorithm used to produce the encryption key hash. Must be provided if the encryption key is provided.",
"required": false,
"type": "string",
"enum": [
"AES256"
],
"x-ms-enum": {
"name": "EncryptionAlgorithmType",
"modelAsString": false,
"values": [
{
"name": "AES256",
"value": "AES256",
"description": "The AES256 encryption algorithm."
}
]
},
"x-ms-client-name": "encryptionAlgorithm"
},
{
"name": "x-ms-encryption-scope",
"in": "header",
"description": "Specifies the encryption scope used to encrypt the data.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionScope"
},
{
"name": "If-Modified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifModifiedSince"
},
{
"name": "If-Unmodified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifUnmodifiedSince"
},
{
"name": "If-None-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a non-matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifNoneMatch"
},
{
"name": "If-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifMatch"
},
{
"name": "x-ms-if-tags",
"in": "header",
"description": "Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.",
"required": false,
"type": "string",
"x-ms-client-name": "ifTags"
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.",
"required": false,
"type": "string",
"x-ms-client-name": "leaseId"
}
],
"responses": {
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-request-server-encrypted": {
"type": "boolean",
"description": "Indicates whether the contents of the request are successfully encrypted."
},
"x-ms-snapshot": {
"type": "string",
"description": "Uniquely identifies the snapshot and indicates the snapshot version."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
},
"x-ms-version-id": {
"type": "string",
"description": "The version ID of the blob."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=tags": {
"get": {
"operationId": "Blob_GetTags",
"description": "Gets the tags of the specified blob.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "snapshot",
"in": "query",
"description": "Specifies the snapshot of the blob.",
"required": false,
"type": "string"
},
{
"name": "versionid",
"in": "query",
"description": "Specifies the version ID of the blob.",
"required": false,
"type": "string",
"x-ms-client-name": "versionId"
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.",
"required": false,
"type": "string",
"x-ms-client-name": "leaseId"
},
{
"name": "x-ms-if-tags",
"in": "header",
"description": "Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.",
"required": false,
"type": "string",
"x-ms-client-name": "ifTags"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/BlobTags"
},
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=tags&_overload=setTags": {
"put": {
"operationId": "Blob_SetTags",
"description": "Sets the tags of the specified blob.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "versionid",
"in": "query",
"description": "Specifies the version ID of the blob.",
"required": false,
"type": "string",
"x-ms-client-name": "versionId"
},
{
"name": "Content-MD5",
"in": "header",
"description": "Specifies the transactional MD5 hash for the body.",
"required": false,
"type": "string",
"format": "byte",
"x-ms-client-name": "transactionalContentMd5"
},
{
"name": "x-ms-content-crc64",
"in": "header",
"description": "Specifies the transactional CRC64 hash for the body.",
"required": false,
"type": "string",
"format": "byte",
"x-ms-client-name": "transactionalContentCrc64"
},
{
"name": "x-ms-if-tags",
"in": "header",
"description": "Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.",
"required": false,
"type": "string",
"x-ms-client-name": "ifTags"
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.",
"required": false,
"type": "string",
"x-ms-client-name": "leaseId"
},
{
"name": "tags",
"in": "body",
"description": "The blob tags.",
"required": true,
"schema": {
"$ref": "#/definitions/BlobTags"
}
}
],
"responses": {
"204": {
"description": "There is no content to send for this request, but the headers may be useful. ",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=tier": {
"put": {
"operationId": "Blob_SetTier",
"description": "Sets the tier of the specified blob.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "snapshot",
"in": "query",
"description": "Specifies the snapshot of the blob.",
"required": false,
"type": "string"
},
{
"name": "versionid",
"in": "query",
"description": "Specifies the version ID of the blob.",
"required": false,
"type": "string",
"x-ms-client-name": "versionId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "x-ms-access-tier",
"in": "header",
"description": "Indicates the tier to be set on the blob.",
"required": true,
"type": "string",
"enum": [
"P4",
"P6",
"P10",
"P15",
"P20",
"P30",
"P40",
"P50",
"P60",
"P70",
"P80",
"Hot",
"Cool",
"Archive",
"Premium",
"Cold"
],
"x-ms-enum": {
"name": "AccessTier",
"modelAsString": true,
"values": [
{
"name": "P4",
"value": "P4",
"description": "The P4 access tier."
},
{
"name": "P6",
"value": "P6",
"description": "The P6 access tier."
},
{
"name": "P10",
"value": "P10",
"description": "The P10 access tier."
},
{
"name": "P15",
"value": "P15",
"description": "The P15 access tier."
},
{
"name": "P20",
"value": "P20",
"description": "The P20 access tier."
},
{
"name": "P30",
"value": "P30",
"description": "The P30 access tier."
},
{
"name": "P40",
"value": "P40",
"description": "The P40 access tier."
},
{
"name": "P50",
"value": "P50",
"description": "The P50 access tier."
},
{
"name": "P60",
"value": "P60",
"description": "The P60 access tier."
},
{
"name": "P70",
"value": "P70",
"description": "The P70 access tier."
},
{
"name": "P80",
"value": "P80",
"description": "The P80 access tier."
},
{
"name": "Hot",
"value": "Hot",
"description": "The Hot access tier."
},
{
"name": "Cool",
"value": "Cool",
"description": "The Cool access tier."
},
{
"name": "Archive",
"value": "Archive",
"description": "The Archive access tier."
},
{
"name": "Premium",
"value": "Premium",
"description": "The Premium access tier."
},
{
"name": "Cold",
"value": "Cold",
"description": "The Cold access tier."
}
]
},
"x-ms-client-name": "tier"
},
{
"name": "x-ms-rehydrate-priority",
"in": "header",
"description": "The priority of the rehydration operation.",
"required": false,
"type": "string",
"enum": [
"High",
"Standard"
],
"x-ms-enum": {
"name": "RehydratePriority",
"modelAsString": true,
"values": [
{
"name": "High",
"value": "High",
"description": "The rehydrate priority is high."
},
{
"name": "Standard",
"value": "Standard",
"description": "The rehydrate priority is standard."
}
]
},
"x-ms-client-name": "rehydratePriority"
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.",
"required": false,
"type": "string",
"x-ms-client-name": "leaseId"
},
{
"name": "x-ms-if-tags",
"in": "header",
"description": "Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.",
"required": false,
"type": "string",
"x-ms-client-name": "ifTags"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=undelete": {
"put": {
"operationId": "Blob_Undelete",
"description": "Undelete the specified previously soft deleted blob.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?restype=account&comp=properties": {
"get": {
"operationId": "Service_GetAccountInfo",
"description": "Returns information about the storage account.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-account-kind": {
"type": "string",
"description": "The account kind.",
"enum": [
"Storage",
"BlobStorage",
"StorageV2",
"FileStorage",
"BlockBlobStorage"
],
"x-ms-enum": {
"name": "AccountKind",
"modelAsString": false,
"values": [
{
"name": "Storage",
"value": "Storage",
"description": "A general-purpose account."
},
{
"name": "BlobStorage",
"value": "BlobStorage",
"description": "A blob storage account."
},
{
"name": "StorageV2",
"value": "StorageV2",
"description": "A storage V2 account."
},
{
"name": "FileStorage",
"value": "FileStorage",
"description": "A file storage account."
},
{
"name": "BlockBlobStorage",
"value": "BlockBlobStorage",
"description": "A block blob storage account."
}
]
}
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-is-hns-enabled": {
"type": "boolean",
"description": "Indicates if the account has hierarchical namespace enabled."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-sku-name": {
"type": "string",
"description": "The SKU name of the account.",
"enum": [
"Standard_LRS",
"Standard_GRS",
"Standard_RAGRS",
"Standard_ZRS",
"Premium_LRS"
],
"x-ms-enum": {
"name": "SkuName",
"modelAsString": false,
"values": [
{
"name": "StandardLRS",
"value": "Standard_LRS",
"description": "The standard LRS SKU."
},
{
"name": "StandardGRS",
"value": "Standard_GRS",
"description": "The standard GRS SKU."
},
{
"name": "StandardRAGRS",
"value": "Standard_RAGRS",
"description": "The standard RAGRS SKU."
},
{
"name": "StandardZRS",
"value": "Standard_ZRS",
"description": "The standard ZRS SKU."
},
{
"name": "PremiumLRS",
"value": "Premium_LRS",
"description": "The premium LRS SKU."
}
]
}
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?restype=account&comp=properties&_overload=getAccountInfo": {
"get": {
"operationId": "Blob_GetAccountInfo",
"description": "Returns information about the storage account.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-account-kind": {
"type": "string",
"description": "The account kind.",
"enum": [
"Storage",
"BlobStorage",
"StorageV2",
"FileStorage",
"BlockBlobStorage"
],
"x-ms-enum": {
"name": "AccountKind",
"modelAsString": false,
"values": [
{
"name": "Storage",
"value": "Storage",
"description": "A general-purpose account."
},
{
"name": "BlobStorage",
"value": "BlobStorage",
"description": "A blob storage account."
},
{
"name": "StorageV2",
"value": "StorageV2",
"description": "A storage V2 account."
},
{
"name": "FileStorage",
"value": "FileStorage",
"description": "A file storage account."
},
{
"name": "BlockBlobStorage",
"value": "BlockBlobStorage",
"description": "A block blob storage account."
}
]
}
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-is-hns-enabled": {
"type": "boolean",
"description": "Indicates if the account has a hierarchical namespace enabled."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-sku-name": {
"type": "string",
"description": "The SKU name of the account.",
"enum": [
"Standard_LRS",
"Standard_GRS",
"Standard_RAGRS",
"Standard_ZRS",
"Premium_LRS"
],
"x-ms-enum": {
"name": "SkuName",
"modelAsString": false,
"values": [
{
"name": "StandardLRS",
"value": "Standard_LRS",
"description": "The standard LRS SKU."
},
{
"name": "StandardGRS",
"value": "Standard_GRS",
"description": "The standard GRS SKU."
},
{
"name": "StandardRAGRS",
"value": "Standard_RAGRS",
"description": "The standard RAGRS SKU."
},
{
"name": "StandardZRS",
"value": "Standard_ZRS",
"description": "The standard ZRS SKU."
},
{
"name": "PremiumLRS",
"value": "Premium_LRS",
"description": "The premium LRS SKU."
}
]
}
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?restype=container": {
"put": {
"operationId": "Container_Create",
"description": "Creates a new container in the specified account. If the container with the same name already exists, the operation fails.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "x-ms-meta",
"in": "header",
"description": "The metadata headers.",
"required": false,
"type": "string",
"x-ms-client-name": "metadata"
},
{
"name": "x-ms-blob-public-access",
"in": "header",
"description": "The public access setting for the container.",
"required": false,
"type": "string",
"enum": [
"blob",
"container"
],
"x-ms-enum": {
"name": "PublicAccessType",
"modelAsString": true,
"values": [
{
"name": "Blob",
"value": "blob",
"description": "Blob access."
},
{
"name": "Container",
"value": "container",
"description": "Container access."
}
]
},
"x-ms-client-name": "access"
},
{
"name": "x-ms-default-encryption-scope",
"in": "header",
"description": "Specifies the default encryption scope to set on the container and use for all future requests.",
"required": false,
"type": "string",
"x-ms-client-name": "defaultEncryptionScope"
},
{
"name": "x-ms-deny-encryption-scope-override",
"in": "header",
"description": "Whether to prevent encryption scope override.",
"required": false,
"type": "boolean",
"x-ms-client-name": "preventEncryptionScopeOverride"
}
],
"responses": {
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?restype=container&_overload=delete": {
"delete": {
"operationId": "Container_Delete",
"description": "Deletes the specified container.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.",
"required": false,
"type": "string",
"x-ms-client-name": "leaseId"
},
{
"name": "If-Modified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifModifiedSince"
},
{
"name": "If-Unmodified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifUnmodifiedSince"
}
],
"responses": {
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?restype=container&_overload=getProperties": {
"get": {
"operationId": "Container_GetProperties",
"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.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.",
"required": false,
"type": "string",
"x-ms-client-name": "leaseId"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-blob-public-access": {
"type": "string",
"description": "The public access setting for the container.",
"enum": [
"blob",
"container"
],
"x-ms-enum": {
"name": "PublicAccessType",
"modelAsString": true,
"values": [
{
"name": "Blob",
"value": "blob",
"description": "Blob access."
},
{
"name": "Container",
"value": "container",
"description": "Container access."
}
]
}
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-default-encryption-scope": {
"type": "string",
"description": "The default encryption scope for the container."
},
"x-ms-deny-encryption-scope-override": {
"type": "boolean",
"description": "Whether to prevent encryption scope override."
},
"x-ms-has-immutability-policy": {
"type": "boolean",
"description": "Indicates whether the container has an immutability policy set on it."
},
"x-ms-has-legal-hold": {
"type": "boolean",
"description": "Indicates whether the container has a legal hold."
},
"x-ms-immutable-storage-with-versioning-enabled": {
"type": "boolean",
"description": "Indicates whether version level WORM (Write Once, Read Many) is enabled on a container."
},
"x-ms-lease-duration": {
"type": "string",
"description": "Specifies the duration of the lease.",
"enum": [
"infinite",
"fixed"
],
"x-ms-enum": {
"name": "LeaseDuration",
"modelAsString": false,
"values": [
{
"name": "Infinite",
"value": "infinite",
"description": "The lease is of infinite duration."
},
{
"name": "Fixed",
"value": "fixed",
"description": "The lease is of fixed duration."
}
]
}
},
"x-ms-lease-state": {
"type": "string",
"description": "The lease state of the blob.",
"enum": [
"available",
"leased",
"expired",
"breaking",
"broken"
],
"x-ms-enum": {
"name": "LeaseState",
"modelAsString": false,
"values": [
{
"name": "Available",
"value": "available",
"description": "The lease is available."
},
{
"name": "Leased",
"value": "leased",
"description": "The lease is currently leased."
},
{
"name": "Expired",
"value": "expired",
"description": "The lease is expired."
},
{
"name": "Breaking",
"value": "breaking",
"description": "The lease is breaking."
},
{
"name": "Broken",
"value": "broken",
"description": "The lease is broken."
}
]
}
},
"x-ms-lease-status": {
"type": "string",
"description": "The lease status of the blob.",
"enum": [
"unlocked",
"locked"
],
"x-ms-enum": {
"name": "LeaseStatus",
"modelAsString": false,
"values": [
{
"name": "Unlocked",
"value": "unlocked",
"description": "The lease is unlocked."
},
{
"name": "Locked",
"value": "locked",
"description": "The lease is locked."
}
]
}
},
"x-ms-meta": {
"type": "string",
"description": "The metadata headers."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?restype=container&comp=acl": {
"get": {
"operationId": "Container_GetAccessPolicy",
"description": "Gets the permissions for the specified container.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.",
"required": false,
"type": "string",
"x-ms-client-name": "leaseId"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/SignedIdentifiers"
},
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-blob-public-access": {
"type": "string",
"description": "The public access setting for the container.",
"enum": [
"blob",
"container"
],
"x-ms-enum": {
"name": "PublicAccessType",
"modelAsString": true,
"values": [
{
"name": "Blob",
"value": "blob",
"description": "Blob access."
},
{
"name": "Container",
"value": "container",
"description": "Container access."
}
]
}
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?restype=container&comp=acl&_overload=setAccessPolicy": {
"put": {
"operationId": "Container_SetAccessPolicy",
"description": "Sets the permissions for the specified container.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.",
"required": false,
"type": "string",
"x-ms-client-name": "leaseId"
},
{
"name": "x-ms-blob-public-access",
"in": "header",
"description": "The public access setting for the container.",
"required": false,
"type": "string",
"enum": [
"blob",
"container"
],
"x-ms-enum": {
"name": "PublicAccessType",
"modelAsString": true,
"values": [
{
"name": "Blob",
"value": "blob",
"description": "Blob access."
},
{
"name": "Container",
"value": "container",
"description": "Container access."
}
]
},
"x-ms-client-name": "access"
},
{
"name": "If-Modified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifModifiedSince"
},
{
"name": "If-Unmodified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifUnmodifiedSince"
},
{
"name": "containerAcl",
"in": "body",
"description": "The access control list for the container.",
"required": false,
"schema": {
"$ref": "#/definitions/SignedIdentifiers"
}
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?restype=container&comp=batch": {
"post": {
"operationId": "Container_SubmitBatch",
"description": "Allows multiple API calls to be embedded into a single HTTP request.",
"produces": [
"multipart/mixed",
"application/xml"
],
"consumes": [
"multipart/mixed"
],
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "Content-Length",
"in": "header",
"description": "The length of the request.",
"required": true,
"type": "integer",
"format": "int64",
"x-ms-client-name": "contentLength"
},
{
"name": "body",
"in": "formData",
"required": true,
"type": "file"
}
],
"responses": {
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"schema": {
"type": "string"
},
"headers": {
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?restype=container&comp=blobs": {
"get": {
"operationId": "Container_FindBlobsByTags",
"description": "Lists blobs in the specified container whose tags match a given search expression.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "where",
"in": "query",
"description": "Filters the results to return only blobs whose tags match the specified expression.",
"required": true,
"type": "string",
"x-ms-client-name": "filterExpression"
},
{
"name": "marker",
"in": "query",
"description": "An opaque string value that identifies the portion of the result set to return with this operation.",
"required": false,
"type": "string"
},
{
"name": "maxresults",
"in": "query",
"description": "Specifies the maximum number of resources to return. If the request does not specify maxresults, or specifies a value greater than 5000, the server will return up to 5000 items.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 1
},
{
"name": "include",
"in": "query",
"description": "Specify to include additional, optional information.",
"required": false,
"type": "array",
"items": {
"type": "string",
"enum": [
"none",
"versions"
],
"x-ms-enum": {
"name": "FilterBlobsIncludeItem",
"modelAsString": false,
"values": [
{
"name": "None",
"value": "none",
"description": "The filter includes no versions."
},
{
"name": "Versions",
"value": "versions",
"description": "The filter includes versions."
}
]
}
},
"collectionFormat": "csv"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/FilteredBlobResponse"
},
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?restype=container&comp=list": {
"get": {
"operationId": "Container_ListBlobs",
"description": "Returns a list of the blobs in the specified container.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "prefix",
"in": "query",
"description": "Filters the results to return only resources whose name begins with the specified prefix.",
"required": false,
"type": "string"
},
{
"name": "marker",
"in": "query",
"description": "An opaque string value that identifies the portion of the result set to return with this operation.",
"required": false,
"type": "string"
},
{
"name": "maxresults",
"in": "query",
"description": "Specifies the maximum number of resources to return. If the request does not specify maxresults, or specifies a value greater than 5000, the server will return up to 5000 items.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 1
},
{
"name": "include",
"in": "query",
"description": "Specify to include additional, optional information.",
"required": false,
"type": "array",
"items": {
"type": "string",
"enum": [
"copy",
"deleted",
"metadata",
"snapshots",
"uncommittedblobs",
"versions",
"tags",
"immutabilitypolicy",
"legalhold",
"deletedwithversions"
],
"x-ms-enum": {
"name": "ListBlobsIncludeItem",
"modelAsString": false,
"values": [
{
"name": "Copy",
"value": "copy",
"description": "Include copies."
},
{
"name": "Deleted",
"value": "deleted",
"description": "Include deleted blobs."
},
{
"name": "Metadata",
"value": "metadata",
"description": "Include metadata."
},
{
"name": "Snapshots",
"value": "snapshots",
"description": "Include snapshots."
},
{
"name": "UncommittedBlobs",
"value": "uncommittedblobs",
"description": "Include uncommitted blobs."
},
{
"name": "Versions",
"value": "versions",
"description": "Include versions."
},
{
"name": "Tags",
"value": "tags",
"description": "Include tags."
},
{
"name": "ImmutabilityPolicy",
"value": "immutabilitypolicy",
"description": "Include immutability policies."
},
{
"name": "LegalHold",
"value": "legalhold",
"description": "Include legal hold."
},
{
"name": "DeletedWithVersions",
"value": "deletedwithversions",
"description": "Include deleted with versions."
}
]
}
},
"collectionFormat": "csv"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/ListBlobsResponse"
},
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?restype=container&comp=list&_overload=listBlobHierarchySegment": {
"get": {
"operationId": "Container_ListBlobHierarchySegment",
"description": "Returns a list of the blobs in the specified container. A delimiter can be used to traverse a virtual hierarchy of blobs as though it were a file system.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "delimiter",
"in": "query",
"description": "If specified, the operation returns a BlobPrefix element 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,
"type": "string"
},
{
"name": "prefix",
"in": "query",
"description": "Filters the results to return only resources whose name begins with the specified prefix.",
"required": false,
"type": "string"
},
{
"name": "marker",
"in": "query",
"description": "An opaque string value that identifies the portion of the result set to return with this operation.",
"required": false,
"type": "string"
},
{
"name": "maxresults",
"in": "query",
"description": "Specifies the maximum number of resources to return. If the request does not specify maxresults, or specifies a value greater than 5000, the server will return up to 5000 items.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 1
},
{
"name": "include",
"in": "query",
"description": "Specify to include additional, optional information.",
"required": false,
"type": "array",
"items": {
"type": "string",
"enum": [
"copy",
"deleted",
"metadata",
"snapshots",
"uncommittedblobs",
"versions",
"tags",
"immutabilitypolicy",
"legalhold",
"deletedwithversions"
],
"x-ms-enum": {
"name": "ListBlobsIncludeItem",
"modelAsString": false,
"values": [
{
"name": "Copy",
"value": "copy",
"description": "Include copies."
},
{
"name": "Deleted",
"value": "deleted",
"description": "Include deleted blobs."
},
{
"name": "Metadata",
"value": "metadata",
"description": "Include metadata."
},
{
"name": "Snapshots",
"value": "snapshots",
"description": "Include snapshots."
},
{
"name": "UncommittedBlobs",
"value": "uncommittedblobs",
"description": "Include uncommitted blobs."
},
{
"name": "Versions",
"value": "versions",
"description": "Include versions."
},
{
"name": "Tags",
"value": "tags",
"description": "Include tags."
},
{
"name": "ImmutabilityPolicy",
"value": "immutabilitypolicy",
"description": "Include immutability policies."
},
{
"name": "LegalHold",
"value": "legalhold",
"description": "Include legal hold."
},
{
"name": "DeletedWithVersions",
"value": "deletedwithversions",
"description": "Include deleted with versions."
}
]
}
},
"collectionFormat": "csv"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/ListBlobsHierarchicalResponse"
},
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?restype=container&comp=metadata": {
"put": {
"operationId": "Container_SetMetadata",
"description": "Sets user-defined metadata for the specified container.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.",
"required": false,
"type": "string",
"x-ms-client-name": "leaseId"
},
{
"name": "x-ms-meta",
"in": "header",
"description": "The metadata headers.",
"required": false,
"type": "string",
"x-ms-client-name": "metadata"
},
{
"name": "If-Modified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifModifiedSince"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?restype=container&comp=rename": {
"put": {
"operationId": "Container_Rename",
"description": "Renames the specified existing container.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "x-ms-source-container-name",
"in": "header",
"description": "Specifies the name of the container to rename.",
"required": true,
"type": "string",
"x-ms-client-name": "sourceContainerName"
},
{
"name": "x-ms-source-lease-id",
"in": "header",
"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,
"type": "string",
"x-ms-client-name": "sourceLeaseId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?restype=container&comp=undelete": {
"put": {
"operationId": "Container_Restore",
"description": "Restores the specified previously-deleted container.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "x-ms-deleted-container-name",
"in": "header",
"description": "Specifies the name of the deleted container to restore.",
"required": false,
"type": "string",
"x-ms-client-name": "deletedContainerName"
},
{
"name": "x-ms-deleted-container-version",
"in": "header",
"description": "Specifies the version of the deleted container to restore.",
"required": false,
"type": "string",
"x-ms-client-name": "deletedContainerVersion"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
}
],
"responses": {
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?restype=service&comp=properties": {
"put": {
"operationId": "Service_SetProperties",
"description": "Sets properties for a storage account's Blob service endpoint, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "storageServiceProperties",
"in": "body",
"description": "The storage service properties to set.",
"required": true,
"schema": {
"$ref": "#/definitions/BlobServiceProperties"
}
}
],
"responses": {
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?restype=service&comp=properties&_overload=getProperties": {
"get": {
"operationId": "Service_GetProperties",
"description": "Retrieves properties of a storage account's Blob service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/BlobServiceProperties"
},
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?restype=service&comp=stats": {
"get": {
"operationId": "Service_GetStatistics",
"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.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/StorageServiceStats"
},
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?restype=service&comp=userdelegationkey": {
"post": {
"operationId": "Service_GetUserDelegationKey",
"description": "Retrieves a user delegation key for the Blob service. This is only a valid operation when using bearer token authentication.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "keyInfo",
"in": "body",
"description": "Key information provided in the request.",
"required": true,
"schema": {
"$ref": "#/definitions/KeyInfo"
}
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/UserDelegationKey"
},
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"/?_overload=copyFromUrl": {
"put": {
"operationId": "Blob_CopyFromUrl",
"description": "Synchronously copies a blob from a source URL to the destination blob.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "x-ms-meta",
"in": "header",
"description": "The metadata headers.",
"required": false,
"type": "string",
"x-ms-client-name": "metadata"
},
{
"name": "x-ms-access-tier",
"in": "header",
"description": "The tier to be set on the blob.",
"required": false,
"type": "string",
"enum": [
"P4",
"P6",
"P10",
"P15",
"P20",
"P30",
"P40",
"P50",
"P60",
"P70",
"P80",
"Hot",
"Cool",
"Archive",
"Premium",
"Cold"
],
"x-ms-enum": {
"name": "AccessTier",
"modelAsString": true,
"values": [
{
"name": "P4",
"value": "P4",
"description": "The P4 access tier."
},
{
"name": "P6",
"value": "P6",
"description": "The P6 access tier."
},
{
"name": "P10",
"value": "P10",
"description": "The P10 access tier."
},
{
"name": "P15",
"value": "P15",
"description": "The P15 access tier."
},
{
"name": "P20",
"value": "P20",
"description": "The P20 access tier."
},
{
"name": "P30",
"value": "P30",
"description": "The P30 access tier."
},
{
"name": "P40",
"value": "P40",
"description": "The P40 access tier."
},
{
"name": "P50",
"value": "P50",
"description": "The P50 access tier."
},
{
"name": "P60",
"value": "P60",
"description": "The P60 access tier."
},
{
"name": "P70",
"value": "P70",
"description": "The P70 access tier."
},
{
"name": "P80",
"value": "P80",
"description": "The P80 access tier."
},
{
"name": "Hot",
"value": "Hot",
"description": "The Hot access tier."
},
{
"name": "Cool",
"value": "Cool",
"description": "The Cool access tier."
},
{
"name": "Archive",
"value": "Archive",
"description": "The Archive access tier."
},
{
"name": "Premium",
"value": "Premium",
"description": "The Premium access tier."
},
{
"name": "Cold",
"value": "Cold",
"description": "The Cold access tier."
}
]
},
"x-ms-client-name": "tier"
},
{
"name": "x-ms-source-if-modified-since",
"in": "header",
"description": "Specify this value to operate only on a source blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "sourceIfModifiedSince"
},
{
"name": "x-ms-source-if-unmodified-since",
"in": "header",
"description": "Specify this header value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "sourceIfUnmodifiedSince"
},
{
"name": "x-ms-source-if-match",
"in": "header",
"description": "Specify this value to operate only on a source blob with a matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "sourceIfMatch"
},
{
"name": "x-ms-source-if-none-match",
"in": "header",
"description": "Specify this value to operate only on a source blob with a non-matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "sourceIfNoneMatch"
},
{
"name": "If-Modified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifModifiedSince"
},
{
"name": "If-Unmodified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifUnmodifiedSince"
},
{
"name": "If-None-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a non-matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifNoneMatch"
},
{
"name": "If-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifMatch"
},
{
"name": "x-ms-if-tags",
"in": "header",
"description": "Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.",
"required": false,
"type": "string",
"x-ms-client-name": "ifTags"
},
{
"name": "x-ms-copy-source",
"in": "header",
"description": "Specifies the name of the source URL for the copy operation. The value should be URL-encoded as it would appear in a request URI.",
"required": true,
"type": "string",
"x-ms-client-name": "copySource"
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.",
"required": false,
"type": "string",
"x-ms-client-name": "leaseId"
},
{
"name": "x-ms-source-content-md5",
"in": "header",
"description": "Specifies the MD5 hash calculated for the range of bytes that must be read from the copy source.",
"required": false,
"type": "string",
"format": "byte",
"x-ms-client-name": "sourceContentMd5"
},
{
"name": "x-ms-tags",
"in": "header",
"description": "The blob tags.",
"required": false,
"type": "string",
"x-ms-client-name": "BlobTagsString"
},
{
"name": "x-ms-immutability-policy-until-date",
"in": "header",
"description": "The date-time that indicates the time at which the blob immutability policy will expire.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "immutabilityPolicyExpiry"
},
{
"name": "x-ms-immutability-policy-mode",
"in": "header",
"description": "Indicates the immutability policy mode of the blob.",
"required": false,
"type": "string",
"enum": [
"mutable",
"locked",
"unlocked"
],
"x-ms-enum": {
"name": "ImmutabilityPolicyMode",
"modelAsString": false,
"values": [
{
"name": "Mutable",
"value": "mutable",
"description": "Response only. The immutability policy is mutable."
},
{
"name": "Locked",
"value": "locked",
"description": "The immutability policy is locked."
},
{
"name": "Unlocked",
"value": "unlocked",
"description": "The immutability policy is unlocked."
}
]
},
"x-ms-client-name": "immutabilityPolicyMode"
},
{
"name": "x-ms-legal-hold",
"in": "header",
"description": "Indicates whether the blob has a legal hold.",
"required": false,
"type": "boolean",
"x-ms-client-name": "legalHold"
},
{
"name": "x-ms-copy-source-authorization",
"in": "header",
"description": "Only the Bearer authorization scheme is supported, and the value must be a valid OAuth access token for the copy source.",
"required": false,
"type": "string",
"x-ms-client-name": "copySourceAuthorization"
},
{
"name": "x-ms-encryption-scope",
"in": "header",
"description": "Specifies the encryption scope used to encrypt the data.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionScope"
},
{
"name": "x-ms-copy-source-tag-option",
"in": "header",
"description": "Indicates if source tags should be copied or replaced with the tags specified. Default is 'Replace'.",
"required": false,
"type": "string",
"enum": [
"REPLACE",
"COPY"
],
"x-ms-enum": {
"name": "BlobCopySourceTags",
"modelAsString": false,
"values": [
{
"name": "Replace",
"value": "REPLACE",
"description": "The blob tags will be replaced."
},
{
"name": "Copy",
"value": "COPY",
"description": "The blob tags will be copied from the source."
}
]
},
"x-ms-client-name": "copySourceTags"
},
{
"name": "x-ms-file-request-intent",
"in": "header",
"description": "Specifies the file request token intent.",
"required": false,
"type": "string",
"enum": [
"backup"
],
"x-ms-enum": {
"name": "FileShareTokenIntent",
"modelAsString": true,
"values": [
{
"name": "Backup",
"value": "backup",
"description": "The file share token intent is backup."
}
]
},
"x-ms-client-name": "fileRequestIntent"
},
{
"name": "x-ms-requires-sync",
"in": "header",
"description": "Indicates this is a synchronous copy.",
"required": true,
"type": "string",
"enum": [
"true"
],
"x-ms-enum": {
"modelAsString": false
},
"x-ms-client-name": "requiresSync"
}
],
"responses": {
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Content-MD5": {
"type": "string",
"format": "byte",
"description": "The blob content MD5 hash. Only returned if the full blob is read."
},
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-content-crc64": {
"type": "string",
"format": "byte",
"description": "The CRC64 hash of the content."
},
"x-ms-copy-id": {
"type": "string",
"description": "Identifier for this copy operation."
},
"x-ms-copy-status": {
"type": "string",
"description": "State of the copy operation.",
"enum": [
"success"
],
"x-ms-enum": {
"modelAsString": false
}
},
"x-ms-encryption-scope": {
"type": "string",
"description": "Specifies the encryption scope used to encrypt the data."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
},
"x-ms-version-id": {
"type": "string",
"description": "The version ID of the blob."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"/?_overload=create": {
"put": {
"operationId": "AppendBlob_Create",
"description": "Creates a new append blob.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "x-ms-meta",
"in": "header",
"description": "The metadata headers.",
"required": false,
"type": "string",
"x-ms-client-name": "metadata"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "x-ms-blob-content-type",
"in": "header",
"description": "Specifies the blob's Content-Type. If specified, this property is stored with the blob and returned with a read request.",
"required": false,
"type": "string",
"x-ms-client-name": "blobContentType"
},
{
"name": "x-ms-blob-content-encoding",
"in": "header",
"description": "Specifies the blob's Content-Encoding. If specified, this property is stored with the blob and returned with a read request.",
"required": false,
"type": "string",
"x-ms-client-name": "blobContentEncoding"
},
{
"name": "x-ms-blob-content-language",
"in": "header",
"description": "Specifies the blob's Content-Language. If specified, this property is stored with the blob and returned with a read request.",
"required": false,
"type": "string",
"x-ms-client-name": "blobContentLanguage"
},
{
"name": "x-ms-blob-content-md5",
"in": "header",
"description": "The MD5 hash of the blob content that is stored as a property on the blob. Note: This hash is not validated.",
"required": false,
"type": "string",
"format": "byte",
"x-ms-client-name": "blobContentMd5"
},
{
"name": "x-ms-blob-cache-control",
"in": "header",
"description": "Specifies the blob's Cache-Control. If specified, this property is stored with the blob and returned with a read request.",
"required": false,
"type": "string",
"x-ms-client-name": "blobCacheControl"
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.",
"required": false,
"type": "string",
"x-ms-client-name": "leaseId"
},
{
"name": "x-ms-blob-content-disposition",
"in": "header",
"description": "Specifies the blob's Content-Disposition. If specified, this property is stored with the blob and returned with a read request.",
"required": false,
"type": "string",
"x-ms-client-name": "blobContentDisposition"
},
{
"name": "x-ms-encryption-key",
"in": "header",
"description": "Specifies the encryption key to use to encrypt the data provided in the request.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionKey"
},
{
"name": "x-ms-encryption-key-sha256",
"in": "header",
"description": "The SHA-256 hash of the provided encryption key. Must be provided if the encryption key is provided.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionKeySha256"
},
{
"name": "x-ms-encryption-algorithm",
"in": "header",
"description": "The algorithm used to produce the encryption key hash. Must be provided if the encryption key is provided.",
"required": false,
"type": "string",
"enum": [
"AES256"
],
"x-ms-enum": {
"name": "EncryptionAlgorithmType",
"modelAsString": false,
"values": [
{
"name": "AES256",
"value": "AES256",
"description": "The AES256 encryption algorithm."
}
]
},
"x-ms-client-name": "encryptionAlgorithm"
},
{
"name": "x-ms-encryption-scope",
"in": "header",
"description": "Specifies the encryption scope used to encrypt the data.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionScope"
},
{
"name": "If-Modified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifModifiedSince"
},
{
"name": "If-Unmodified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifUnmodifiedSince"
},
{
"name": "If-None-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a non-matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifNoneMatch"
},
{
"name": "If-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifMatch"
},
{
"name": "x-ms-if-tags",
"in": "header",
"description": "Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.",
"required": false,
"type": "string",
"x-ms-client-name": "ifTags"
},
{
"name": "x-ms-tags",
"in": "header",
"description": "The blob tags.",
"required": false,
"type": "string",
"x-ms-client-name": "BlobTagsString"
},
{
"name": "x-ms-immutability-policy-until-date",
"in": "header",
"description": "The date-time that indicates the time at which the blob immutability policy will expire.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "immutabilityPolicyExpiry"
},
{
"name": "x-ms-immutability-policy-mode",
"in": "header",
"description": "Indicates the immutability policy mode of the blob.",
"required": false,
"type": "string",
"enum": [
"mutable",
"locked",
"unlocked"
],
"x-ms-enum": {
"name": "ImmutabilityPolicyMode",
"modelAsString": false,
"values": [
{
"name": "Mutable",
"value": "mutable",
"description": "Response only. The immutability policy is mutable."
},
{
"name": "Locked",
"value": "locked",
"description": "The immutability policy is locked."
},
{
"name": "Unlocked",
"value": "unlocked",
"description": "The immutability policy is unlocked."
}
]
},
"x-ms-client-name": "immutabilityPolicyMode"
},
{
"name": "x-ms-legal-hold",
"in": "header",
"description": "Indicates whether the blob has a legal hold.",
"required": false,
"type": "boolean",
"x-ms-client-name": "legalHold"
},
{
"name": "Content-Length",
"in": "header",
"description": "The initial size of the append blob.",
"required": true,
"type": "number",
"enum": [
0
],
"x-ms-client-name": "contentLength"
},
{
"name": "x-ms-blob-type",
"in": "header",
"description": "The type of the blob.",
"required": true,
"type": "string",
"enum": [
"AppendBlob"
],
"x-ms-enum": {
"modelAsString": false
},
"x-ms-client-name": "blobType"
}
],
"responses": {
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"headers": {
"Content-MD5": {
"type": "string",
"format": "byte",
"description": "The blob content MD5 hash. Only returned if the full blob is read."
},
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-encryption-key-sha256": {
"type": "string",
"description": "The SHA-256 hash of the provided encryption key."
},
"x-ms-encryption-scope": {
"type": "string",
"description": "Specifies the encryption scope used to encrypt the data."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-request-server-encrypted": {
"type": "boolean",
"description": "Indicates whether the contents of the request are successfully encrypted."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
},
"x-ms-version-id": {
"type": "string",
"description": "The version ID of the blob."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"/?_overload=upload": {
"put": {
"operationId": "BlockBlob_Upload",
"description": "Uploads the content to the specified block blob. If the blob already exists, the data and any existing metadata will be overwritten.",
"consumes": [
"application/octet-stream"
],
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "x-ms-meta",
"in": "header",
"description": "The metadata headers.",
"required": false,
"type": "string",
"x-ms-client-name": "metadata"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "Content-MD5",
"in": "header",
"description": "Specifies the transactional MD5 hash for the body.",
"required": false,
"type": "string",
"format": "byte",
"x-ms-client-name": "transactionalContentMd5"
},
{
"name": "Content-Length",
"in": "header",
"description": "The length of the request.",
"required": true,
"type": "integer",
"format": "int64",
"x-ms-client-name": "contentLength"
},
{
"name": "x-ms-blob-content-type",
"in": "header",
"description": "Specifies the blob's Content-Type. If specified, this property is stored with the blob and returned with a read request.",
"required": false,
"type": "string",
"x-ms-client-name": "blobContentType"
},
{
"name": "x-ms-blob-content-encoding",
"in": "header",
"description": "Specifies the blob's Content-Encoding. If specified, this property is stored with the blob and returned with a read request.",
"required": false,
"type": "string",
"x-ms-client-name": "blobContentEncoding"
},
{
"name": "x-ms-blob-content-language",
"in": "header",
"description": "Specifies the blob's Content-Language. If specified, this property is stored with the blob and returned with a read request.",
"required": false,
"type": "string",
"x-ms-client-name": "blobContentLanguage"
},
{
"name": "x-ms-blob-content-md5",
"in": "header",
"description": "The MD5 hash of the blob content that is stored as a property on the blob. Note: This hash is not validated.",
"required": false,
"type": "string",
"format": "byte",
"x-ms-client-name": "blobContentMd5"
},
{
"name": "x-ms-blob-cache-control",
"in": "header",
"description": "Specifies the blob's Cache-Control. If specified, this property is stored with the blob and returned with a read request.",
"required": false,
"type": "string",
"x-ms-client-name": "blobCacheControl"
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.",
"required": false,
"type": "string",
"x-ms-client-name": "leaseId"
},
{
"name": "x-ms-blob-content-disposition",
"in": "header",
"description": "Specifies the blob's Content-Disposition. If specified, this property is stored with the blob and returned with a read request.",
"required": false,
"type": "string",
"x-ms-client-name": "blobContentDisposition"
},
{
"name": "x-ms-encryption-key",
"in": "header",
"description": "Specifies the encryption key to use to encrypt the data provided in the request.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionKey"
},
{
"name": "x-ms-encryption-key-sha256",
"in": "header",
"description": "The SHA-256 hash of the provided encryption key. Must be provided if the encryption key is provided.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionKeySha256"
},
{
"name": "x-ms-encryption-algorithm",
"in": "header",
"description": "The algorithm used to produce the encryption key hash. Must be provided if the encryption key is provided.",
"required": false,
"type": "string",
"enum": [
"AES256"
],
"x-ms-enum": {
"name": "EncryptionAlgorithmType",
"modelAsString": false,
"values": [
{
"name": "AES256",
"value": "AES256",
"description": "The AES256 encryption algorithm."
}
]
},
"x-ms-client-name": "encryptionAlgorithm"
},
{
"name": "x-ms-encryption-scope",
"in": "header",
"description": "Specifies the encryption scope used to encrypt the data.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionScope"
},
{
"name": "x-ms-access-tier",
"in": "header",
"description": "The tier to be set on the blob.",
"required": false,
"type": "string",
"enum": [
"P4",
"P6",
"P10",
"P15",
"P20",
"P30",
"P40",
"P50",
"P60",
"P70",
"P80",
"Hot",
"Cool",
"Archive",
"Premium",
"Cold"
],
"x-ms-enum": {
"name": "AccessTier",
"modelAsString": true,
"values": [
{
"name": "P4",
"value": "P4",
"description": "The P4 access tier."
},
{
"name": "P6",
"value": "P6",
"description": "The P6 access tier."
},
{
"name": "P10",
"value": "P10",
"description": "The P10 access tier."
},
{
"name": "P15",
"value": "P15",
"description": "The P15 access tier."
},
{
"name": "P20",
"value": "P20",
"description": "The P20 access tier."
},
{
"name": "P30",
"value": "P30",
"description": "The P30 access tier."
},
{
"name": "P40",
"value": "P40",
"description": "The P40 access tier."
},
{
"name": "P50",
"value": "P50",
"description": "The P50 access tier."
},
{
"name": "P60",
"value": "P60",
"description": "The P60 access tier."
},
{
"name": "P70",
"value": "P70",
"description": "The P70 access tier."
},
{
"name": "P80",
"value": "P80",
"description": "The P80 access tier."
},
{
"name": "Hot",
"value": "Hot",
"description": "The Hot access tier."
},
{
"name": "Cool",
"value": "Cool",
"description": "The Cool access tier."
},
{
"name": "Archive",
"value": "Archive",
"description": "The Archive access tier."
},
{
"name": "Premium",
"value": "Premium",
"description": "The Premium access tier."
},
{
"name": "Cold",
"value": "Cold",
"description": "The Cold access tier."
}
]
},
"x-ms-client-name": "tier"
},
{
"name": "If-Modified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifModifiedSince"
},
{
"name": "If-Unmodified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifUnmodifiedSince"
},
{
"name": "If-None-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a non-matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifNoneMatch"
},
{
"name": "If-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifMatch"
},
{
"name": "x-ms-if-tags",
"in": "header",
"description": "Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.",
"required": false,
"type": "string",
"x-ms-client-name": "ifTags"
},
{
"name": "x-ms-tags",
"in": "header",
"description": "The blob tags.",
"required": false,
"type": "string",
"x-ms-client-name": "BlobTagsString"
},
{
"name": "x-ms-immutability-policy-until-date",
"in": "header",
"description": "The date-time that indicates the time at which the blob immutability policy will expire.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "immutabilityPolicyExpiry"
},
{
"name": "x-ms-immutability-policy-mode",
"in": "header",
"description": "Indicates the immutability policy mode of the blob.",
"required": false,
"type": "string",
"enum": [
"mutable",
"locked",
"unlocked"
],
"x-ms-enum": {
"name": "ImmutabilityPolicyMode",
"modelAsString": false,
"values": [
{
"name": "Mutable",
"value": "mutable",
"description": "Response only. The immutability policy is mutable."
},
{
"name": "Locked",
"value": "locked",
"description": "The immutability policy is locked."
},
{
"name": "Unlocked",
"value": "unlocked",
"description": "The immutability policy is unlocked."
}
]
},
"x-ms-client-name": "immutabilityPolicyMode"
},
{
"name": "x-ms-legal-hold",
"in": "header",
"description": "Indicates whether the blob has a legal hold.",
"required": false,
"type": "boolean",
"x-ms-client-name": "legalHold"
},
{
"name": "x-ms-content-crc64",
"in": "header",
"description": "Specifies the transactional CRC64 hash for the body.",
"required": false,
"type": "string",
"format": "byte",
"x-ms-client-name": "transactionalContentCrc64"
},
{
"name": "x-ms-structured-body",
"in": "header",
"description": "Required if the request body is a structured message. Specifies the message schema version and properties.",
"required": false,
"type": "string",
"x-ms-client-name": "structuredBodyType"
},
{
"name": "x-ms-structured-content-length",
"in": "header",
"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.",
"required": false,
"type": "integer",
"format": "int64",
"x-ms-client-name": "structuredContentLength"
},
{
"name": "x-ms-blob-type",
"in": "header",
"description": "The type of the blob.",
"required": true,
"type": "string",
"enum": [
"BlockBlob"
],
"x-ms-enum": {
"modelAsString": false
},
"x-ms-client-name": "blobType"
},
{
"name": "body",
"in": "body",
"description": "The body of the request.",
"required": true,
"schema": {
"type": "string",
"format": "binary"
}
}
],
"responses": {
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"headers": {
"Content-MD5": {
"type": "string",
"format": "byte",
"description": "The blob content MD5 hash. Only returned if the full blob is read."
},
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-content-crc64": {
"type": "string",
"format": "byte",
"description": "The CRC64 hash of the content."
},
"x-ms-encryption-key-sha256": {
"type": "string",
"description": "The SHA-256 hash of the provided encryption key."
},
"x-ms-encryption-scope": {
"type": "string",
"description": "Specifies the encryption scope used to encrypt the data."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-request-server-encrypted": {
"type": "boolean",
"description": "Indicates whether the contents of the request are successfully encrypted."
},
"x-ms-structured-body": {
"type": "string",
"description": "Indicates if the response body contains a structured message and specifies the message schema version and properties."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
},
"x-ms-version-id": {
"type": "string",
"description": "The version ID of the blob."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"/?_overload=uploadBlobFromUrl": {
"put": {
"operationId": "BlockBlob_UploadBlobFromUrl",
"description": "Uploads the content from the specified URL to the block blob. If the blob already exists, the data and any existing metadata will be overwritten.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "x-ms-meta",
"in": "header",
"description": "The metadata headers.",
"required": false,
"type": "string",
"x-ms-client-name": "metadata"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "Content-MD5",
"in": "header",
"description": "Specifies the transactional MD5 hash for the body.",
"required": false,
"type": "string",
"format": "byte",
"x-ms-client-name": "transactionalContentMd5"
},
{
"name": "x-ms-blob-content-type",
"in": "header",
"description": "Specifies the blob's Content-Type. If specified, this property is stored with the blob and returned with a read request.",
"required": false,
"type": "string",
"x-ms-client-name": "blobContentType"
},
{
"name": "x-ms-blob-content-encoding",
"in": "header",
"description": "Specifies the blob's Content-Encoding. If specified, this property is stored with the blob and returned with a read request.",
"required": false,
"type": "string",
"x-ms-client-name": "blobContentEncoding"
},
{
"name": "x-ms-blob-content-language",
"in": "header",
"description": "Specifies the blob's Content-Language. If specified, this property is stored with the blob and returned with a read request.",
"required": false,
"type": "string",
"x-ms-client-name": "blobContentLanguage"
},
{
"name": "x-ms-blob-content-md5",
"in": "header",
"description": "The MD5 hash of the blob content that is stored as a property on the blob. Note: This hash is not validated.",
"required": false,
"type": "string",
"format": "byte",
"x-ms-client-name": "blobContentMd5"
},
{
"name": "x-ms-blob-cache-control",
"in": "header",
"description": "Specifies the blob's Cache-Control. If specified, this property is stored with the blob and returned with a read request.",
"required": false,
"type": "string",
"x-ms-client-name": "blobCacheControl"
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.",
"required": false,
"type": "string",
"x-ms-client-name": "leaseId"
},
{
"name": "x-ms-blob-content-disposition",
"in": "header",
"description": "Specifies the blob's Content-Disposition. If specified, this property is stored with the blob and returned with a read request.",
"required": false,
"type": "string",
"x-ms-client-name": "blobContentDisposition"
},
{
"name": "x-ms-encryption-key",
"in": "header",
"description": "Specifies the encryption key to use to encrypt the data provided in the request.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionKey"
},
{
"name": "x-ms-encryption-key-sha256",
"in": "header",
"description": "The SHA-256 hash of the provided encryption key. Must be provided if the encryption key is provided.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionKeySha256"
},
{
"name": "x-ms-encryption-algorithm",
"in": "header",
"description": "The algorithm used to produce the encryption key hash. Must be provided if the encryption key is provided.",
"required": false,
"type": "string",
"enum": [
"AES256"
],
"x-ms-enum": {
"name": "EncryptionAlgorithmType",
"modelAsString": false,
"values": [
{
"name": "AES256",
"value": "AES256",
"description": "The AES256 encryption algorithm."
}
]
},
"x-ms-client-name": "encryptionAlgorithm"
},
{
"name": "x-ms-encryption-scope",
"in": "header",
"description": "Specifies the encryption scope used to encrypt the data.",
"required": false,
"type": "string",
"x-ms-client-name": "encryptionScope"
},
{
"name": "x-ms-access-tier",
"in": "header",
"description": "The tier to be set on the blob.",
"required": false,
"type": "string",
"enum": [
"P4",
"P6",
"P10",
"P15",
"P20",
"P30",
"P40",
"P50",
"P60",
"P70",
"P80",
"Hot",
"Cool",
"Archive",
"Premium",
"Cold"
],
"x-ms-enum": {
"name": "AccessTier",
"modelAsString": true,
"values": [
{
"name": "P4",
"value": "P4",
"description": "The P4 access tier."
},
{
"name": "P6",
"value": "P6",
"description": "The P6 access tier."
},
{
"name": "P10",
"value": "P10",
"description": "The P10 access tier."
},
{
"name": "P15",
"value": "P15",
"description": "The P15 access tier."
},
{
"name": "P20",
"value": "P20",
"description": "The P20 access tier."
},
{
"name": "P30",
"value": "P30",
"description": "The P30 access tier."
},
{
"name": "P40",
"value": "P40",
"description": "The P40 access tier."
},
{
"name": "P50",
"value": "P50",
"description": "The P50 access tier."
},
{
"name": "P60",
"value": "P60",
"description": "The P60 access tier."
},
{
"name": "P70",
"value": "P70",
"description": "The P70 access tier."
},
{
"name": "P80",
"value": "P80",
"description": "The P80 access tier."
},
{
"name": "Hot",
"value": "Hot",
"description": "The Hot access tier."
},
{
"name": "Cool",
"value": "Cool",
"description": "The Cool access tier."
},
{
"name": "Archive",
"value": "Archive",
"description": "The Archive access tier."
},
{
"name": "Premium",
"value": "Premium",
"description": "The Premium access tier."
},
{
"name": "Cold",
"value": "Cold",
"description": "The Cold access tier."
}
]
},
"x-ms-client-name": "tier"
},
{
"name": "If-Modified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifModifiedSince"
},
{
"name": "If-Unmodified-Since",
"in": "header",
"description": "Specify this value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifUnmodifiedSince"
},
{
"name": "If-None-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a non-matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifNoneMatch"
},
{
"name": "If-Match",
"in": "header",
"description": "Specify this value to operate only on a blob with a matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "ifMatch"
},
{
"name": "x-ms-if-tags",
"in": "header",
"description": "Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.",
"required": false,
"type": "string",
"x-ms-client-name": "ifTags"
},
{
"name": "x-ms-source-if-modified-since",
"in": "header",
"description": "Specify this value to operate only on a source blob if it has been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "sourceIfModifiedSince"
},
{
"name": "x-ms-source-if-unmodified-since",
"in": "header",
"description": "Specify this header value to operate only on a blob if it has not been modified since the specified date-time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "sourceIfUnmodifiedSince"
},
{
"name": "x-ms-source-if-match",
"in": "header",
"description": "Specify this value to operate only on a source blob with a matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "sourceIfMatch"
},
{
"name": "x-ms-source-if-none-match",
"in": "header",
"description": "Specify this value to operate only on a source blob with a non-matching Etag value.",
"required": false,
"type": "string",
"x-ms-client-name": "sourceIfNoneMatch"
},
{
"name": "x-ms-source-if-tags",
"in": "header",
"description": "Specifies a SQL-like where clause on blob tags to operate only on a source blob with matching tags.",
"required": false,
"type": "string",
"x-ms-client-name": "sourceIfTags"
},
{
"name": "x-ms-source-content-md5",
"in": "header",
"description": "Specifies the MD5 hash calculated for the range of bytes that must be read from the copy source.",
"required": false,
"type": "string",
"format": "byte",
"x-ms-client-name": "sourceContentMd5"
},
{
"name": "x-ms-tags",
"in": "header",
"description": "The blob tags.",
"required": false,
"type": "string",
"x-ms-client-name": "BlobTagsString"
},
{
"name": "x-ms-copy-source",
"in": "header",
"description": "Specifies the name of the source URL for the copy operation. The value should be URL-encoded as it would appear in a request URI.",
"required": true,
"type": "string",
"x-ms-client-name": "copySource"
},
{
"name": "Content-Length",
"in": "header",
"description": "Required to be 0 for Put Blob from URL operation.",
"required": true,
"type": "number",
"enum": [
0
],
"x-ms-client-name": "contentLength"
},
{
"name": "x-ms-copy-source-blob-properties",
"in": "header",
"description": "Indicates if properties from the source blob should be copied. Default is true.",
"required": false,
"type": "boolean",
"x-ms-client-name": "copySourceBlobProperties"
},
{
"name": "x-ms-copy-source-authorization",
"in": "header",
"description": "Only the Bearer authorization scheme is supported, and the value must be a valid OAuth access token for the copy source.",
"required": false,
"type": "string",
"x-ms-client-name": "copySourceAuthorization"
},
{
"name": "x-ms-copy-source-tag-option",
"in": "header",
"description": "Indicates if source tags should be copied or replaced with the tags specified. Default is 'Replace'.",
"required": false,
"type": "string",
"enum": [
"REPLACE",
"COPY"
],
"x-ms-enum": {
"name": "BlobCopySourceTags",
"modelAsString": false,
"values": [
{
"name": "Replace",
"value": "REPLACE",
"description": "The blob tags will be replaced."
},
{
"name": "Copy",
"value": "COPY",
"description": "The blob tags will be copied from the source."
}
]
},
"x-ms-client-name": "copySourceTags"
},
{
"name": "x-ms-blob-type",
"in": "header",
"description": "The type of the blob.",
"required": true,
"type": "string",
"enum": [
"BlockBlob"
],
"x-ms-enum": {
"modelAsString": false
},
"x-ms-client-name": "blobType"
},
{
"name": "x-ms-file-request-intent",
"in": "header",
"description": "Specifies the file request token intent.",
"required": false,
"type": "string",
"enum": [
"backup"
],
"x-ms-enum": {
"name": "FileShareTokenIntent",
"modelAsString": true,
"values": [
{
"name": "Backup",
"value": "backup",
"description": "The file share token intent is backup."
}
]
},
"x-ms-client-name": "fileRequestIntent"
}
],
"responses": {
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"headers": {
"Content-MD5": {
"type": "string",
"format": "byte",
"description": "The blob content MD5 hash. Only returned if the full blob is read."
},
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "Date-time value generated by the service that indicates the time at which the response was initiated."
},
"ETag": {
"type": "string",
"description": "An opaque identifier for the current state of the resource."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the resource was last modified."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-encryption-key-sha256": {
"type": "string",
"description": "The SHA-256 hash of the provided encryption key."
},
"x-ms-encryption-scope": {
"type": "string",
"description": "Specifies the encryption scope used to encrypt the data."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-request-server-encrypted": {
"type": "boolean",
"description": "Indicates whether the contents of the request are successfully encrypted."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
},
"x-ms-version-id": {
"type": "string",
"description": "The version ID of the blob."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-copy-source-error-code": {
"type": "string",
"description": "The error code for the copy source."
},
"x-ms-copy-source-status-code": {
"type": "integer",
"format": "int32",
"description": "The status code for the copy source."
},
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
}
},
"definitions": {
"AccessPolicy": {
"type": "object",
"description": "Represents an access policy.",
"properties": {
"Start": {
"type": "string",
"format": "date-time",
"description": "The date-time the policy is active.",
"x-ms-client-name": "start"
},
"Expiry": {
"type": "string",
"format": "date-time",
"description": "The date-time the policy expires.",
"x-ms-client-name": "expiry"
},
"Permission": {
"type": "string",
"description": "The permissions for the policy.",
"x-ms-client-name": "permission"
}
}
},
"AccessTier": {
"type": "string",
"description": "The access tiers.",
"enum": [
"P4",
"P6",
"P10",
"P15",
"P20",
"P30",
"P40",
"P50",
"P60",
"P70",
"P80",
"Hot",
"Cool",
"Archive",
"Premium",
"Cold"
],
"x-ms-enum": {
"name": "AccessTier",
"modelAsString": true,
"values": [
{
"name": "P4",
"value": "P4",
"description": "The P4 access tier."
},
{
"name": "P6",
"value": "P6",
"description": "The P6 access tier."
},
{
"name": "P10",
"value": "P10",
"description": "The P10 access tier."
},
{
"name": "P15",
"value": "P15",
"description": "The P15 access tier."
},
{
"name": "P20",
"value": "P20",
"description": "The P20 access tier."
},
{
"name": "P30",
"value": "P30",
"description": "The P30 access tier."
},
{
"name": "P40",
"value": "P40",
"description": "The P40 access tier."
},
{
"name": "P50",
"value": "P50",
"description": "The P50 access tier."
},
{
"name": "P60",
"value": "P60",
"description": "The P60 access tier."
},
{
"name": "P70",
"value": "P70",
"description": "The P70 access tier."
},
{
"name": "P80",
"value": "P80",
"description": "The P80 access tier."
},
{
"name": "Hot",
"value": "Hot",
"description": "The Hot access tier."
},
{
"name": "Cool",
"value": "Cool",
"description": "The Cool access tier."
},
{
"name": "Archive",
"value": "Archive",
"description": "The Archive access tier."
},
{
"name": "Premium",
"value": "Premium",
"description": "The Premium access tier."
},
{
"name": "Cold",
"value": "Cold",
"description": "The Cold access tier."
}
]
}
},
"AccountKind": {
"type": "string",
"description": "The account kind.",
"enum": [
"Storage",
"BlobStorage",
"StorageV2",
"FileStorage",
"BlockBlobStorage"
],
"x-ms-enum": {
"name": "AccountKind",
"modelAsString": false,
"values": [
{
"name": "Storage",
"value": "Storage",
"description": "A general-purpose account."
},
{
"name": "BlobStorage",
"value": "BlobStorage",
"description": "A blob storage account."
},
{
"name": "StorageV2",
"value": "StorageV2",
"description": "A storage V2 account."
},
{
"name": "FileStorage",
"value": "FileStorage",
"description": "A file storage account."
},
{
"name": "BlockBlobStorage",
"value": "BlockBlobStorage",
"description": "A block blob storage account."
}
]
}
},
"ArchiveStatus": {
"type": "string",
"description": "The archive status.",
"enum": [
"rehydrate-pending-to-hot",
"rehydrate-pending-to-cool",
"rehydrate-pending-to-cold"
],
"x-ms-enum": {
"name": "ArchiveStatus",
"modelAsString": true,
"values": [
{
"name": "RehydratePendingToHot",
"value": "rehydrate-pending-to-hot",
"description": "The archive status is rehydrating pending to Hot."
},
{
"name": "RehydratePendingToCool",
"value": "rehydrate-pending-to-cool",
"description": "The archive status is rehydrating pending to Cool."
},
{
"name": "RehydratePendingToCold",
"value": "rehydrate-pending-to-cold",
"description": "The archive status is rehydrating pending to Cold."
}
]
}
},
"ArrowConfiguration": {
"type": "object",
"description": "Represents the Apache Arrow configuration.",
"properties": {
"Schema": {
"type": "array",
"description": "The Apache Arrow schema.",
"items": {
"$ref": "#/definitions/ArrowField"
},
"xml": {
"wrapped": true
},
"x-ms-client-name": "schema"
}
},
"required": [
"Schema"
]
},
"ArrowField": {
"type": "object",
"description": "Represents an Apache Arrow field.",
"properties": {
"Type": {
"type": "string",
"description": "The arrow field type.",
"x-ms-client-name": "type"
},
"Name": {
"type": "string",
"description": "The arrow field name.",
"x-ms-client-name": "name"
},
"Precision": {
"type": "integer",
"format": "int32",
"description": "The arrow field precision.",
"x-ms-client-name": "precision"
},
"Scale": {
"type": "integer",
"format": "int32",
"description": "The arrow field scale.",
"x-ms-client-name": "scale"
}
},
"required": [
"Type"
],
"xml": {
"name": "Field"
}
},
"Azure.Core.eTag": {
"type": "string",
"description": "The ETag (or entity tag) HTTP response header is an identifier for a specific version of a resource.\nIt lets caches be more efficient and save bandwidth, as a web server does not need to resend a full response if the content was not changed.\n\nIt is a string of ASCII characters placed between double quotes, like \"675af34563dc-tr34\".",
"xml": {
"name": "eTag"
}
},
"Azure.Core.uuid": {
"type": "string",
"format": "uuid",
"description": "Universally Unique Identifier",
"xml": {
"name": "uuid"
}
},
"BlobCopySourceTags": {
"type": "string",
"description": "The blob copy source tags types.",
"enum": [
"REPLACE",
"COPY"
],
"x-ms-enum": {
"name": "BlobCopySourceTags",
"modelAsString": false,
"values": [
{
"name": "Replace",
"value": "REPLACE",
"description": "The blob tags will be replaced."
},
{
"name": "Copy",
"value": "COPY",
"description": "The blob tags will be copied from the source."
}
]
}
},
"BlobDeleteType": {
"type": "string",
"description": "The type of blob deletions.",
"enum": [
"Permanent"
],
"x-ms-enum": {
"name": "BlobDeleteType",
"modelAsString": false,
"values": [
{
"name": "Permanent",
"value": "Permanent",
"description": "Permanently delete the blob."
}
]
}
},
"BlobExpiryOptions": {
"type": "string",
"description": "The blob expiry options.",
"enum": [
"NeverExpire",
"RelativeToCreation",
"RelativeToNow",
"Absolute"
],
"x-ms-enum": {
"name": "BlobExpiryOptions",
"modelAsString": true,
"values": [
{
"name": "NeverExpire",
"value": "NeverExpire",
"description": "Never expire."
},
{
"name": "RelativeToCreation",
"value": "RelativeToCreation",
"description": "Relative to creation time."
},
{
"name": "RelativeToNow",
"value": "RelativeToNow",
"description": "Relative to now."
},
{
"name": "Absolute",
"value": "Absolute",
"description": "Absolute time."
}
]
}
},
"BlobHierarchyList": {
"type": "object",
"description": "Represents an array of blobs.",
"properties": {
"Blob": {
"type": "array",
"description": "The blob items.",
"items": {
"$ref": "#/definitions/BlobItem"
},
"xml": {
"wrapped": false
},
"x-ms-client-name": "blobItems"
},
"BlobPrefix": {
"type": "array",
"description": "The blob prefixes.",
"items": {
"$ref": "#/definitions/BlobPrefix"
},
"xml": {
"wrapped": false
},
"x-ms-client-name": "blobPrefixes"
}
},
"required": [
"Blob"
]
},
"BlobItem": {
"type": "object",
"description": "Represents a blob.",
"properties": {
"Name": {
"$ref": "#/definitions/BlobName",
"description": "The name of the blob.",
"x-ms-client-name": "name"
},
"Deleted": {
"type": "boolean",
"description": "Whether the blob is deleted.",
"x-ms-client-name": "deleted"
},
"Snapshot": {
"type": "string",
"description": "The snapshot of the blob.",
"x-ms-client-name": "snapshot"
},
"VersionId": {
"type": "string",
"description": "The version ID of the blob.",
"x-ms-client-name": "versionId"
},
"IsCurrentVersion": {
"type": "boolean",
"description": "Whether the blob is the current version.",
"x-ms-client-name": "isCurrentVersion"
},
"Properties": {
"$ref": "#/definitions/BlobProperties",
"description": "The properties of the blob.",
"x-ms-client-name": "properties"
},
"Metadata": {
"$ref": "#/definitions/BlobMetadata",
"description": "The metadata of the blob.",
"x-ms-client-name": "metadata"
},
"Tags": {
"$ref": "#/definitions/BlobTags",
"description": "The tags of the blob.",
"x-ms-client-name": "blobTags"
},
"OrMetadata": {
"$ref": "#/definitions/ObjectReplicationMetadata",
"description": "The object replication metadata of the blob.",
"x-ms-client-name": "objectReplicationMetadata"
},
"HasVersionsOnly": {
"type": "boolean",
"description": "Whether the blob has versions only.",
"x-ms-client-name": "hasVersionsOnly"
}
},
"required": [
"Name",
"Deleted",
"Snapshot",
"Properties"
],
"xml": {
"name": "Blob"
}
},
"BlobMetadata": {
"type": "object",
"description": "The blob metadata.",
"properties": {
"Encrypted": {
"type": "string",
"description": "Whether the blob metadata is encrypted.",
"xml": {
"attribute": true
},
"x-ms-client-name": "encrypted"
}
},
"additionalProperties": {
"type": "string"
}
},
"BlobName": {
"type": "object",
"description": "Represents a blob name.",
"properties": {
"Encoded": {
"type": "boolean",
"description": "Whether the blob name is encoded.",
"xml": {
"attribute": true
},
"x-ms-client-name": "encoded"
},
"content": {
"type": "string",
"description": "The blob name.",
"xml": {
"x-ms-text": true
}
}
}
},
"BlobPrefix": {
"type": "object",
"description": "Represents a blob prefix.",
"properties": {
"Name": {
"$ref": "#/definitions/BlobName",
"description": "The blob name.",
"x-ms-client-name": "name"
}
},
"required": [
"Name"
]
},
"BlobProperties": {
"type": "object",
"description": "The properties of a blob.",
"properties": {
"Creation-Time": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time the blob was created.",
"x-ms-client-name": "creationTime"
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time the blob was last modified.",
"x-ms-client-name": "lastModified"
},
"Etag": {
"$ref": "#/definitions/Azure.Core.eTag",
"description": "The blob ETag.",
"x-ms-client-name": "eTag"
},
"Content-Length": {
"type": "integer",
"format": "int64",
"description": "The content length of the blob.",
"x-ms-client-name": "contentLength"
},
"Content-Type": {
"type": "string",
"description": "The content type of the blob.",
"x-ms-client-name": "contentType"
},
"Content-Encoding": {
"type": "string",
"description": "The content encoding of the blob.",
"x-ms-client-name": "contentEncoding"
},
"Content-Language": {
"type": "string",
"description": "The content language of the blob.",
"x-ms-client-name": "contentLanguage"
},
"Content-MD5": {
"type": "string",
"format": "byte",
"description": "The content MD5 of the blob.",
"x-ms-client-name": "contentMd5"
},
"Content-Disposition": {
"type": "string",
"description": "The content disposition of the blob.",
"x-ms-client-name": "contentDisposition"
},
"Cache-Control": {
"type": "string",
"description": "The cache control of the blob.",
"x-ms-client-name": "cacheControl"
},
"x-ms-blob-sequence-number": {
"type": "integer",
"format": "int64",
"description": "The sequence number of the blob.",
"x-ms-client-name": "blobSequenceNumber"
},
"BlobType": {
"$ref": "#/definitions/BlobType",
"description": "The blob type.",
"x-ms-client-name": "blobType"
},
"LeaseStatus": {
"$ref": "#/definitions/LeaseStatus",
"description": "The lease status of the blob.",
"x-ms-client-name": "leaseStatus"
},
"LeaseState": {
"$ref": "#/definitions/LeaseState",
"description": "The lease state of the blob.",
"x-ms-client-name": "leaseState"
},
"LeaseDuration": {
"$ref": "#/definitions/LeaseDuration",
"description": "The lease duration of the blob.",
"x-ms-client-name": "leaseDuration"
},
"CopyId": {
"type": "string",
"description": "The copy ID of the blob.",
"x-ms-client-name": "copyId"
},
"CopyStatus": {
"$ref": "#/definitions/CopyStatus",
"description": "The copy status of the blob.",
"x-ms-client-name": "copyStatus"
},
"CopySource": {
"type": "string",
"description": "The copy source of the blob.",
"x-ms-client-name": "copySource"
},
"CopyProgress": {
"type": "string",
"description": "The copy progress of the blob.",
"x-ms-client-name": "copyProgress"
},
"CopyCompletionTime": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The copy completion date-time of the blob.",
"x-ms-client-name": "copyCompletionTime"
},
"CopyStatusDescription": {
"type": "string",
"description": "The copy status description of the blob.",
"x-ms-client-name": "copyStatusDescription"
},
"ServerEncrypted": {
"type": "boolean",
"description": "Whether the blob is encrypted on the server.",
"x-ms-client-name": "serverEncrypted"
},
"IncrementalCopy": {
"type": "boolean",
"description": "Whether the blob is an incremental copy.",
"x-ms-client-name": "incrementalCopy"
},
"DestinationSnapshot": {
"type": "string",
"description": "The name of the destination snapshot.",
"x-ms-client-name": "destinationSnapshot"
},
"DeletedTime": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time the blob was deleted.",
"x-ms-client-name": "deletedTime"
},
"RemainingRetentionDays": {
"type": "integer",
"format": "int32",
"description": "The remaining retention days of the blob.",
"x-ms-client-name": "remainingRetentionDays"
},
"AccessTier": {
"$ref": "#/definitions/AccessTier",
"description": "The access tier of the blob.",
"x-ms-client-name": "accessTier"
},
"AccessTierInferred": {
"type": "boolean",
"description": "Whether the access tier is inferred.",
"x-ms-client-name": "accessTierInferred"
},
"ArchiveStatus": {
"$ref": "#/definitions/ArchiveStatus",
"description": "The archive status of the blob.",
"x-ms-client-name": "archiveStatus"
},
"CustomerProvidedKeySha256": {
"type": "string",
"description": "The SHA-256 hash of the blob's encryption key, if provided.",
"x-ms-client-name": "customerProvidedKeySha256"
},
"EncryptionScope": {
"type": "string",
"description": "The encryption scope of the blob.",
"x-ms-client-name": "encryptionScope"
},
"AccessTierChangeTime": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the access tier of the blob changed.",
"x-ms-client-name": "accessTierChangeTime"
},
"TagCount": {
"type": "integer",
"format": "int32",
"description": "The number of tags for the blob.",
"x-ms-client-name": "tagCount"
},
"Expiry-Time": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The expiry time of the blob.",
"x-ms-client-name": "expiresOn"
},
"Sealed": {
"type": "boolean",
"description": "Whether the blob is sealed.",
"x-ms-client-name": "isSealed"
},
"RehydratePriority": {
"$ref": "#/definitions/RehydratePriority",
"description": "The rehydrate priority of the blob.",
"x-ms-client-name": "rehydratePriority"
},
"LastAccessTime": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time the blob was last accessed.",
"x-ms-client-name": "lastAccessedOn"
},
"ImmutabilityPolicyUntilDate": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time the immutability policy of the blob expires.",
"x-ms-client-name": "immutabilityPolicyExpiresOn"
},
"ImmutabilityPolicyMode": {
"$ref": "#/definitions/ImmutabilityPolicyMode",
"description": "The immutability policy mode of the blob.",
"x-ms-client-name": "immutabilityPolicyMode"
},
"LegalHold": {
"type": "boolean",
"description": "Whether the blob is under legal hold.",
"x-ms-client-name": "legalHold"
}
},
"required": [
"Last-Modified",
"Etag"
],
"xml": {
"name": "Properties"
}
},
"BlobServiceProperties": {
"type": "object",
"description": "The blob service properties.",
"properties": {
"Logging": {
"$ref": "#/definitions/Logging",
"description": "The logging properties.",
"x-ms-client-name": "logging"
},
"HourMetrics": {
"$ref": "#/definitions/Metrics",
"description": "The hour metrics properties.",
"x-ms-client-name": "hourMetrics"
},
"MinuteMetrics": {
"$ref": "#/definitions/Metrics",
"description": "The minute metrics properties.",
"x-ms-client-name": "minuteMetrics"
},
"Cors": {
"type": "array",
"description": "The CORS properties.",
"items": {
"$ref": "#/definitions/CorsRule"
},
"xml": {
"wrapped": true
},
"x-ms-client-name": "cors"
},
"DefaultServiceVersion": {
"type": "string",
"description": "The default service version.",
"x-ms-client-name": "defaultServiceVersion"
},
"DeleteRetentionPolicy": {
"$ref": "#/definitions/RetentionPolicy",
"description": "The delete retention policy.",
"x-ms-client-name": "deleteRetentionPolicy"
},
"StaticWebsite": {
"$ref": "#/definitions/StaticWebsite",
"description": "The static website properties.",
"x-ms-client-name": "staticWebsite"
}
},
"xml": {
"name": "StorageServiceProperties"
}
},
"BlobTag": {
"type": "object",
"description": "A key-value pair associated with a blob.",
"properties": {
"Key": {
"type": "string",
"description": "The key of the tag.",
"x-ms-client-name": "key"
},
"Value": {
"type": "string",
"description": "The value of the tag.",
"x-ms-client-name": "value"
}
},
"required": [
"Key",
"Value"
],
"xml": {
"name": "Tag"
}
},
"BlobTags": {
"type": "object",
"description": "A list of blob tags.",
"properties": {
"TagSet": {
"type": "array",
"description": "A list of blob tags.",
"items": {
"$ref": "#/definitions/BlobTag"
},
"xml": {
"wrapped": true
},
"x-ms-client-name": "blobTagSet"
}
},
"required": [
"TagSet"
],
"xml": {
"name": "Tags"
}
},
"BlobType": {
"type": "string",
"description": "The blob type.",
"enum": [
"BlockBlob",
"PageBlob",
"AppendBlob"
],
"x-ms-enum": {
"name": "BlobType",
"modelAsString": false,
"values": [
{
"name": "BlockBlob",
"value": "BlockBlob",
"description": "The blob is a block blob."
},
{
"name": "PageBlob",
"value": "PageBlob",
"description": "The blob is a page blob."
},
{
"name": "AppendBlob",
"value": "AppendBlob",
"description": "The blob is an append blob."
}
]
}
},
"Block": {
"type": "object",
"description": "Represents a single block in a block blob.",
"properties": {
"Name": {
"$ref": "#/definitions/base64Bytes",
"description": "The base64 encoded block ID.",
"x-ms-client-name": "name"
},
"Size": {
"type": "integer",
"format": "int64",
"description": "The block size in bytes.",
"x-ms-client-name": "size"
}
},
"required": [
"Name",
"Size"
]
},
"BlockList": {
"type": "object",
"description": "Contains the committed and uncommitted blocks in a block blob.",
"properties": {
"CommittedBlocks": {
"type": "array",
"description": "The list of committed blocks.",
"items": {
"$ref": "#/definitions/Block"
},
"xml": {
"wrapped": true
},
"x-ms-client-name": "committedBlocks"
},
"UncommittedBlocks": {
"type": "array",
"description": "The list of uncommitted blocks.",
"items": {
"$ref": "#/definitions/Block"
},
"xml": {
"wrapped": true
},
"x-ms-client-name": "uncommittedBlocks"
}
}
},
"BlockListType": {
"type": "string",
"description": "The block list types.",
"enum": [
"committed",
"uncommitted",
"all"
],
"x-ms-enum": {
"name": "BlockListType",
"modelAsString": false,
"values": [
{
"name": "Committed",
"value": "committed",
"description": "Committed blocks."
},
{
"name": "Uncommitted",
"value": "uncommitted",
"description": "Uncommitted blocks."
},
{
"name": "All",
"value": "all",
"description": "Both committed and uncommitted blocks."
}
]
}
},
"BlockLookupList": {
"type": "object",
"description": "The block lookup list.",
"properties": {
"Committed": {
"type": "array",
"description": "The committed blocks.",
"items": {
"$ref": "#/definitions/base64Bytes"
},
"xml": {
"wrapped": false
},
"x-ms-client-name": "committed"
},
"Uncommitted": {
"type": "array",
"description": "The uncommitted blocks.",
"items": {
"$ref": "#/definitions/base64Bytes"
},
"xml": {
"wrapped": false
},
"x-ms-client-name": "uncommitted"
},
"Latest": {
"type": "array",
"description": "The latest blocks.",
"items": {
"$ref": "#/definitions/base64Bytes"
},
"xml": {
"wrapped": false
},
"x-ms-client-name": "latest"
}
},
"xml": {
"name": "BlockList"
}
},
"ClearRange": {
"type": "object",
"description": "A clear range.",
"properties": {
"Start": {
"type": "integer",
"format": "int64",
"description": "The start of the byte range.",
"x-ms-client-name": "start"
},
"End": {
"type": "integer",
"format": "int64",
"description": "The end of the byte range.",
"x-ms-client-name": "end"
}
},
"required": [
"Start",
"End"
]
},
"ContainerItem": {
"type": "object",
"description": "Represents a container.",
"properties": {
"Name": {
"type": "string",
"description": "The name of the container.",
"x-ms-client-name": "name"
},
"Deleted": {
"type": "boolean",
"description": "Whether the container is soft-deleted.",
"x-ms-client-name": "deleted"
},
"Version": {
"type": "string",
"description": "The version of the container.",
"x-ms-client-name": "version"
},
"Properties": {
"$ref": "#/definitions/ContainerProperties",
"description": "The properties of the container.",
"x-ms-client-name": "properties"
},
"Metadata": {
"type": "object",
"description": "The metadata of the container.",
"additionalProperties": {
"type": "string"
},
"x-ms-client-name": "metadata"
}
},
"required": [
"Name",
"Properties"
],
"xml": {
"name": "Container"
}
},
"ContainerProperties": {
"type": "object",
"description": "The properties of a container.",
"properties": {
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time that the container was last modified.",
"x-ms-client-name": "lastModified"
},
"Etag": {
"$ref": "#/definitions/Azure.Core.eTag",
"description": "The ETag of the container.",
"x-ms-client-name": "eTag"
},
"LeaseStatus": {
"$ref": "#/definitions/LeaseStatus",
"description": "The lease status of the container.",
"x-ms-client-name": "leaseStatus"
},
"LeaseState": {
"$ref": "#/definitions/LeaseState",
"description": "The lease state of the container.",
"x-ms-client-name": "leaseState"
},
"LeaseDuration": {
"$ref": "#/definitions/LeaseDuration",
"description": "The lease duration of the container.",
"x-ms-client-name": "leaseDuration"
},
"PublicAccess": {
"$ref": "#/definitions/PublicAccessType",
"description": "The public access type of the container.",
"x-ms-client-name": "publicAccess"
},
"HasImmutabilityPolicy": {
"type": "boolean",
"description": "Whether the container has an immutability policy.",
"x-ms-client-name": "hasImmutabilityPolicy"
},
"HasLegalHold": {
"type": "boolean",
"description": "Whether the container has a legal hold.",
"x-ms-client-name": "hasLegalHold"
},
"DefaultEncryptionScope": {
"type": "string",
"description": "The default encryption scope of the container.",
"x-ms-client-name": "defaultEncryptionScope"
},
"DenyEncryptionScopeOverride": {
"type": "boolean",
"description": "Whether to prevent encryption scope override.",
"x-ms-client-name": "preventEncryptionScopeOverride"
},
"DeletedTime": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The date-time the container was deleted.",
"x-ms-client-name": "deletedTime"
},
"RemainingRetentionDays": {
"type": "integer",
"format": "int32",
"description": "The remaining retention days of the container.",
"x-ms-client-name": "remainingRetentionDays"
},
"ImmutableStorageWithVersioningEnabled": {
"type": "boolean",
"description": "Whether immutable storage with versioning is enabled.",
"x-ms-client-name": "isImmutableStorageWithVersioningEnabled"
}
},
"required": [
"Last-Modified",
"Etag"
]
},
"CopyStatus": {
"type": "string",
"description": "The copy status.",
"enum": [
"pending",
"success",
"failed",
"aborted"
],
"x-ms-enum": {
"name": "CopyStatus",
"modelAsString": false,
"values": [
{
"name": "Pending",
"value": "pending",
"description": "The copy operation is pending."
},
{
"name": "Success",
"value": "success",
"description": "The copy operation succeeded."
},
{
"name": "Failed",
"value": "failed",
"description": "The copy operation failed."
},
{
"name": "Aborted",
"value": "aborted",
"description": "The copy operation was aborted."
}
]
}
},
"CorsRule": {
"type": "object",
"description": "A Cross-Origin Resource Sharing (CORS) rule.",
"properties": {
"AllowedOrigins": {
"type": "string",
"description": "The allowed origins.",
"x-ms-client-name": "allowedOrigins"
},
"AllowedMethods": {
"type": "string",
"description": "The allowed methods.",
"x-ms-client-name": "allowedMethods"
},
"AllowedHeaders": {
"type": "string",
"description": "The allowed headers.",
"x-ms-client-name": "allowedHeaders"
},
"ExposedHeaders": {
"type": "string",
"description": "The exposed headers.",
"x-ms-client-name": "exposedHeaders"
},
"MaxAgeInSeconds": {
"type": "integer",
"format": "int32",
"description": "The maximum age in seconds.",
"minimum": 0,
"x-ms-client-name": "maxAgeInSeconds"
}
},
"required": [
"AllowedOrigins",
"AllowedMethods",
"AllowedHeaders",
"ExposedHeaders",
"MaxAgeInSeconds"
]
},
"DeleteSnapshotsOptionType": {
"type": "string",
"description": "Specifies the delete behavior of blob snapshots.",
"enum": [
"only",
"include"
],
"x-ms-enum": {
"name": "DeleteSnapshotsOptionType",
"modelAsString": false,
"values": [
{
"name": "Only",
"value": "only",
"description": "Only delete the snapshots."
},
{
"name": "Include",
"value": "include",
"description": "Delete the blob and snapshots."
}
]
}
},
"DelimitedTextConfiguration": {
"type": "object",
"description": "Represents the delimited text configuration.",
"properties": {
"ColumnSeparator": {
"type": "string",
"description": "The string used to separate columns.",
"x-ms-client-name": "columnSeparator"
},
"FieldQuote": {
"type": "string",
"description": "The string used to quote a specific field.",
"x-ms-client-name": "fieldQuote"
},
"RecordSeparator": {
"type": "string",
"description": "The string used to separate records.",
"x-ms-client-name": "recordSeparator"
},
"EscapeChar": {
"type": "string",
"description": "The string used to escape a quote character in a field.",
"x-ms-client-name": "escapeChar"
},
"HasHeaders": {
"type": "boolean",
"description": "Represents whether the data has headers.",
"x-ms-client-name": "headersPresent"
}
}
},
"EncryptionAlgorithmType": {
"type": "string",
"description": "The algorithm used to produce the encryption key hash.",
"enum": [
"AES256"
],
"x-ms-enum": {
"name": "EncryptionAlgorithmType",
"modelAsString": false,
"values": [
{
"name": "AES256",
"value": "AES256",
"description": "The AES256 encryption algorithm."
}
]
}
},
"Error": {
"type": "object",
"description": "The error response.\n\nThis defines the wire format only. Language SDKs wrap this in idiomatic error types.",
"properties": {
"Code": {
"$ref": "#/definitions/StorageErrorCode",
"description": "The error code.",
"x-ms-client-name": "code"
},
"Message": {
"type": "string",
"description": "The error message.",
"x-ms-client-name": "message"
},
"CopySourceStatusCode": {
"type": "integer",
"format": "int32",
"description": "The copy source status code.",
"x-ms-client-name": "copySourceStatusCode"
},
"CopySourceErrorCode": {
"type": "string",
"description": "The copy source error code.",
"x-ms-client-name": "copySourceErrorCode"
},
"CopySourceErrorMessage": {
"type": "string",
"description": "The copy source error message.",
"x-ms-client-name": "copySourceErrorMessage"
}
}
},
"FileShareTokenIntent": {
"type": "string",
"description": "The file share token intent types.",
"enum": [
"backup"
],
"x-ms-enum": {
"name": "FileShareTokenIntent",
"modelAsString": true,
"values": [
{
"name": "Backup",
"value": "backup",
"description": "The file share token intent is backup."
}
]
}
},
"FilterBlobItem": {
"type": "object",
"description": "The filtered blob item.",
"properties": {
"Name": {
"type": "string",
"description": "The name of the blob.",
"x-ms-client-name": "name"
},
"ContainerName": {
"type": "string",
"description": "The name of the container.",
"x-ms-client-name": "containerName"
},
"Tags": {
"$ref": "#/definitions/BlobTags",
"description": "The tags of the blob.",
"x-ms-client-name": "tags"
},
"VersionId": {
"type": "string",
"description": "The version ID of the blob.",
"x-ms-client-name": "versionId"
},
"IsCurrentVersion": {
"type": "boolean",
"description": "Whether it is the current version of the blob.",
"x-ms-client-name": "isCurrentVersion"
}
},
"required": [
"Name",
"ContainerName"
],
"xml": {
"name": "Blob"
}
},
"FilterBlobsIncludeItem": {
"type": "string",
"description": "Specifies what type of blobs should be returned as part of the filter operation.",
"enum": [
"none",
"versions"
],
"x-ms-enum": {
"name": "FilterBlobsIncludeItem",
"modelAsString": false,
"values": [
{
"name": "None",
"value": "none",
"description": "The filter includes no versions."
},
{
"name": "Versions",
"value": "versions",
"description": "The filter includes versions."
}
]
}
},
"FilteredBlobResponse": {
"type": "object",
"description": "The result of the Find Blobs by Tags API.",
"properties": {
"ServiceEndpoint": {
"type": "string",
"description": "The service endpoint.",
"xml": {
"attribute": true
},
"x-ms-client-name": "serviceEndpoint"
},
"Where": {
"type": "string",
"description": "The filter expression for the blobs.",
"x-ms-client-name": "where"
},
"Blobs": {
"type": "array",
"description": "The list of filtered blobs.",
"items": {
"$ref": "#/definitions/FilterBlobItem"
},
"xml": {
"wrapped": true
},
"x-ms-client-name": "blobItems"
},
"NextMarker": {
"type": "string",
"description": "An opaque string value that identifies the portion of the result set to be returned with the next operation. Use this value in the next request to continue the listing operation.",
"x-ms-client-name": "nextMarker"
}
},
"required": [
"ServiceEndpoint",
"Where",
"Blobs"
],
"xml": {
"name": "EnumerationResults"
}
},
"GeoReplication": {
"type": "object",
"description": "Geo-replication information for the secondary storage service.",
"properties": {
"Status": {
"$ref": "#/definitions/GeoReplicationStatusType",
"description": "The status of the secondary location.",
"x-ms-client-name": "status"
},
"LastSyncTime": {
"type": "string",
"format": "date-time-rfc7231",
"description": "A date-time value that indicates where 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.",
"x-ms-client-name": "lastSyncTime"
}
},
"required": [
"Status",
"LastSyncTime"
]
},
"GeoReplicationStatusType": {
"type": "string",
"description": "The geo-replication status.",
"enum": [
"live",
"bootstrap",
"unavailable"
],
"x-ms-enum": {
"name": "GeoReplicationStatusType",
"modelAsString": true,
"values": [
{
"name": "Live",
"value": "live",
"description": "Geo-replication is live."
},
{
"name": "Bootstrap",
"value": "bootstrap",
"description": "Geo-replication is bootstrap."
},
{
"name": "Unavailable",
"value": "unavailable",
"description": "Geo-replication is unavailable."
}
]
}
},
"ImmutabilityPolicyMode": {
"type": "string",
"description": "The immutability policy mode.",
"enum": [
"mutable",
"locked",
"unlocked"
],
"x-ms-enum": {
"name": "ImmutabilityPolicyMode",
"modelAsString": false,
"values": [
{
"name": "Mutable",
"value": "mutable",
"description": "Response only. The immutability policy is mutable."
},
{
"name": "Locked",
"value": "locked",
"description": "The immutability policy is locked."
},
{
"name": "Unlocked",
"value": "unlocked",
"description": "The immutability policy is unlocked."
}
]
}
},
"JsonTextConfiguration": {
"type": "object",
"description": "Represents the JSON text configuration.",
"properties": {
"RecordSeparator": {
"type": "string",
"description": "The string used to separate records.",
"x-ms-client-name": "recordSeparator"
}
}
},
"KeyInfo": {
"type": "object",
"description": "Key information.",
"properties": {
"Start": {
"type": "string",
"format": "date-time",
"description": "The date-time the key is active.",
"x-ms-client-name": "start"
},
"Expiry": {
"type": "string",
"format": "date-time",
"description": "The date-time the key expires.",
"x-ms-client-name": "expiry"
}
},
"required": [
"Start",
"Expiry"
]
},
"LeaseDuration": {
"type": "string",
"description": "The lease duration.",
"enum": [
"infinite",
"fixed"
],
"x-ms-enum": {
"name": "LeaseDuration",
"modelAsString": false,
"values": [
{
"name": "Infinite",
"value": "infinite",
"description": "The lease is of infinite duration."
},
{
"name": "Fixed",
"value": "fixed",
"description": "The lease is of fixed duration."
}
]
}
},
"LeaseState": {
"type": "string",
"description": "The lease state.",
"enum": [
"available",
"leased",
"expired",
"breaking",
"broken"
],
"x-ms-enum": {
"name": "LeaseState",
"modelAsString": false,
"values": [
{
"name": "Available",
"value": "available",
"description": "The lease is available."
},
{
"name": "Leased",
"value": "leased",
"description": "The lease is currently leased."
},
{
"name": "Expired",
"value": "expired",
"description": "The lease is expired."
},
{
"name": "Breaking",
"value": "breaking",
"description": "The lease is breaking."
},
{
"name": "Broken",
"value": "broken",
"description": "The lease is broken."
}
]
}
},
"LeaseStatus": {
"type": "string",
"description": "The lease status.",
"enum": [
"unlocked",
"locked"
],
"x-ms-enum": {
"name": "LeaseStatus",
"modelAsString": false,
"values": [
{
"name": "Unlocked",
"value": "unlocked",
"description": "The lease is unlocked."
},
{
"name": "Locked",
"value": "locked",
"description": "The lease is locked."
}
]
}
},
"ListBlobsHierarchicalResponse": {
"type": "object",
"description": "The result of the List Blobs Hierarchical API.",
"properties": {
"ServiceEndpoint": {
"type": "string",
"description": "The service endpoint.",
"xml": {
"attribute": true
},
"x-ms-client-name": "serviceEndpoint"
},
"ContainerName": {
"type": "string",
"description": "The container name.",
"xml": {
"attribute": true
},
"x-ms-client-name": "containerName"
},
"Delimiter": {
"type": "string",
"description": "The delimiter of the blobs.",
"x-ms-client-name": "delimiter"
},
"Prefix": {
"type": "string",
"description": "The prefix of the blobs.",
"x-ms-client-name": "prefix"
},
"Marker": {
"type": "string",
"description": "An opaque string value that identifies the portion of the result set returned with this operation.",
"x-ms-client-name": "marker"
},
"MaxResults": {
"type": "integer",
"format": "int32",
"description": "The maximum number of blobs to be returned with this operation.",
"x-ms-client-name": "maxResults"
},
"Blobs": {
"$ref": "#/definitions/BlobHierarchyList",
"description": "The list of hierarchical blobs.",
"x-ms-client-name": "hierarchicalList"
},
"NextMarker": {
"type": "string",
"description": "An opaque string value that identifies the portion of the result set to be returned with the next operation. Use this value in the next request to continue the listing operation.",
"x-ms-client-name": "nextMarker"
}
},
"required": [
"ServiceEndpoint",
"ContainerName",
"Blobs"
],
"xml": {
"name": "EnumerationResults"
}
},
"ListBlobsIncludeItem": {
"type": "string",
"description": "Specifies additional datasets to include when listing blobs in a container.",
"enum": [
"copy",
"deleted",
"metadata",
"snapshots",
"uncommittedblobs",
"versions",
"tags",
"immutabilitypolicy",
"legalhold",
"deletedwithversions"
],
"x-ms-enum": {
"name": "ListBlobsIncludeItem",
"modelAsString": false,
"values": [
{
"name": "Copy",
"value": "copy",
"description": "Include copies."
},
{
"name": "Deleted",
"value": "deleted",
"description": "Include deleted blobs."
},
{
"name": "Metadata",
"value": "metadata",
"description": "Include metadata."
},
{
"name": "Snapshots",
"value": "snapshots",
"description": "Include snapshots."
},
{
"name": "UncommittedBlobs",
"value": "uncommittedblobs",
"description": "Include uncommitted blobs."
},
{
"name": "Versions",
"value": "versions",
"description": "Include versions."
},
{
"name": "Tags",
"value": "tags",
"description": "Include tags."
},
{
"name": "ImmutabilityPolicy",
"value": "immutabilitypolicy",
"description": "Include immutability policies."
},
{
"name": "LegalHold",
"value": "legalhold",
"description": "Include legal hold."
},
{
"name": "DeletedWithVersions",
"value": "deletedwithversions",
"description": "Include deleted with versions."
}
]
}
},
"ListBlobsResponse": {
"type": "object",
"description": "The result of the List Blobs API.",
"properties": {
"ServiceEndpoint": {
"type": "string",
"description": "The service endpoint.",
"xml": {
"attribute": true
},
"x-ms-client-name": "serviceEndpoint"
},
"ContainerName": {
"type": "string",
"description": "The container name.",
"xml": {
"attribute": true
},
"x-ms-client-name": "containerName"
},
"Prefix": {
"type": "string",
"description": "The prefix of the list operation.",
"x-ms-client-name": "prefix"
},
"Marker": {
"type": "string",
"description": "An opaque string value that identifies the portion of the result set returned with this operation.",
"x-ms-client-name": "marker"
},
"MaxResults": {
"type": "integer",
"format": "int32",
"description": "The maximum number of blobs to be returned with this operation.",
"x-ms-client-name": "maxResults"
},
"Blobs": {
"type": "array",
"description": "The list of blobs.",
"items": {
"$ref": "#/definitions/BlobItem"
},
"xml": {
"wrapped": true
},
"x-ms-client-name": "blobItems"
},
"NextMarker": {
"type": "string",
"description": "An opaque string value that identifies the portion of the result set to be returned with the next operation. Use this value in the next request to continue the listing operation.",
"x-ms-client-name": "nextMarker"
}
},
"required": [
"ServiceEndpoint",
"ContainerName",
"Blobs"
],
"xml": {
"name": "EnumerationResults"
}
},
"ListContainersIncludeType": {
"type": "string",
"description": "Specifies what additional information should be returned as part of the list operation.",
"enum": [
"metadata",
"deleted",
"system"
],
"x-ms-enum": {
"name": "ListContainersIncludeType",
"modelAsString": false,
"values": [
{
"name": "metadata",
"value": "metadata",
"description": "Include metadata."
},
{
"name": "deleted",
"value": "deleted",
"description": "Include soft-deleted containers."
},
{
"name": "system",
"value": "system",
"description": "Include system containers."
}
]
}
},
"ListContainersResponse": {
"type": "object",
"description": "The result of the List Containers API.",
"properties": {
"ServiceEndpoint": {
"type": "string",
"description": "The service endpoint.",
"xml": {
"attribute": true
},
"x-ms-client-name": "serviceEndpoint"
},
"Prefix": {
"type": "string",
"description": "The prefix of the containers.",
"x-ms-client-name": "prefix"
},
"Marker": {
"type": "string",
"description": "An opaque string value that identifies the portion of the result set returned with this operation.",
"x-ms-client-name": "marker"
},
"MaxResults": {
"type": "integer",
"format": "int32",
"description": "The maximum number of containers to be returned with this operation.",
"x-ms-client-name": "maxResults"
},
"Containers": {
"type": "array",
"description": "The list of containers.",
"items": {
"$ref": "#/definitions/ContainerItem"
},
"xml": {
"wrapped": true
},
"x-ms-client-name": "containerItems"
},
"NextMarker": {
"type": "string",
"description": "An opaque string value that identifies the portion of the result set to be returned with the next operation. Use this value in the next request to continue the listing operation."
}
},
"required": [
"ServiceEndpoint",
"Containers"
],
"xml": {
"name": "EnumerationResults"
}
},
"Logging": {
"type": "object",
"description": "Azure Analytics logging settings.",
"properties": {
"Version": {
"type": "string",
"description": "The version of the logging properties.",
"x-ms-client-name": "version"
},
"Delete": {
"type": "boolean",
"description": "Whether delete operation is logged.",
"x-ms-client-name": "delete"
},
"Read": {
"type": "boolean",
"description": "Whether read operation is logged.",
"x-ms-client-name": "read"
},
"Write": {
"type": "boolean",
"description": "Whether write operation is logged.",
"x-ms-client-name": "write"
},
"RetentionPolicy": {
"$ref": "#/definitions/RetentionPolicy",
"description": "The retention policy of the logs.",
"x-ms-client-name": "retentionPolicy"
}
},
"required": [
"Version",
"Delete",
"Read",
"Write",
"RetentionPolicy"
]
},
"Metrics": {
"type": "object",
"description": "The metrics properties.",
"properties": {
"Version": {
"type": "string",
"description": "The version of the metrics properties.",
"x-ms-client-name": "version"
},
"Enabled": {
"type": "boolean",
"description": "Whether the metrics are enabled.",
"x-ms-client-name": "enabled"
},
"IncludeAPIs": {
"type": "boolean",
"description": "Whether to include API in the metrics.",
"x-ms-client-name": "includeApis"
},
"RetentionPolicy": {
"$ref": "#/definitions/RetentionPolicy",
"description": "The retention policy of the metrics.",
"x-ms-client-name": "retentionPolicy"
}
},
"required": [
"Enabled"
]
},
"ObjectReplicationMetadata": {
"type": "object",
"description": "The object replication metadata.",
"additionalProperties": {
"type": "string"
},
"xml": {
"name": "OrMetadata"
}
},
"PageList": {
"type": "object",
"description": "The result of the Get Pages API.",
"properties": {
"PageRange": {
"type": "array",
"description": "The page ranges.",
"items": {
"$ref": "#/definitions/PageRange"
},
"xml": {
"wrapped": false
},
"x-ms-client-name": "pageRange"
},
"ClearRange": {
"type": "array",
"description": "The clear ranges.",
"items": {
"$ref": "#/definitions/ClearRange"
},
"xml": {
"wrapped": false
},
"x-ms-client-name": "clearRange"
},
"NextMarker": {
"type": "string",
"description": "An opaque string value that identifies the portion of the result set to be returned with the next operation. Use this value in the next request to continue the listing operation.",
"x-ms-client-name": "nextMarker"
}
}
},
"PageRange": {
"type": "object",
"description": "A page range.",
"properties": {
"Start": {
"type": "integer",
"format": "int64",
"description": "The start of the byte range.",
"x-ms-client-name": "start"
},
"End": {
"type": "integer",
"format": "int64",
"description": "The end of the byte range.",
"x-ms-client-name": "end"
}
},
"required": [
"Start",
"End"
]
},
"ParquetConfiguration": {
"type": "object",
"description": "Represents the Parquet configuration.",
"additionalProperties": {}
},
"PremiumPageBlobAccessTier": {
"type": "string",
"description": "The premium page blob access tier types.",
"enum": [
"P4",
"P6",
"P10",
"P15",
"P20",
"P30",
"P40",
"P50",
"P60",
"P70",
"P80"
],
"x-ms-enum": {
"name": "PremiumPageBlobAccessTier",
"modelAsString": true,
"values": [
{
"name": "P4",
"value": "P4",
"description": "The premium page blob access tier is P4."
},
{
"name": "P6",
"value": "P6",
"description": "The premium page blob access tier is P6."
},
{
"name": "P10",
"value": "P10",
"description": "The premium page blob access tier is P10."
},
{
"name": "P15",
"value": "P15",
"description": "The premium page blob access tier is P15."
},
{
"name": "P20",
"value": "P20",
"description": "The premium page blob access tier is P20."
},
{
"name": "P30",
"value": "P30",
"description": "The premium page blob access tier is P30."
},
{
"name": "P40",
"value": "P40",
"description": "The premium page blob access tier is P40."
},
{
"name": "P50",
"value": "P50",
"description": "The premium page blob access tier is P50."
},
{
"name": "P60",
"value": "P60",
"description": "The premium page blob access tier is P60."
},
{
"name": "P70",
"value": "P70",
"description": "The premium page blob access tier is P70."
},
{
"name": "P80",
"value": "P80",
"description": "The premium page blob access tier is P80."
}
]
}
},
"PublicAccessType": {
"type": "string",
"description": "The public access type.",
"enum": [
"blob",
"container"
],
"x-ms-enum": {
"name": "PublicAccessType",
"modelAsString": true,
"values": [
{
"name": "Blob",
"value": "blob",
"description": "Blob access."
},
{
"name": "Container",
"value": "container",
"description": "Container access."
}
]
}
},
"QueryFormat": {
"type": "object",
"description": "The query format settings.",
"properties": {
"Type": {
"$ref": "#/definitions/QueryType",
"description": "The query type.",
"x-ms-client-name": "type"
},
"DelimitedTextConfiguration": {
"$ref": "#/definitions/DelimitedTextConfiguration",
"description": "The delimited text configuration.",
"x-ms-client-name": "delimitedTextConfiguration"
},
"JsonTextConfiguration": {
"$ref": "#/definitions/JsonTextConfiguration",
"description": "The JSON text configuration.",
"x-ms-client-name": "jsonTextConfiguration"
},
"ArrowConfiguration": {
"$ref": "#/definitions/ArrowConfiguration",
"description": "The Apache Arrow configuration.",
"x-ms-client-name": "arrowConfiguration"
},
"ParquetTextConfiguration": {
"$ref": "#/definitions/ParquetConfiguration",
"description": "The Parquet configuration.",
"x-ms-client-name": "parquetTextConfiguration"
}
},
"required": [
"Type"
]
},
"QueryRequest": {
"type": "object",
"description": "Groups the set of query request settings.",
"properties": {
"QueryType": {
"$ref": "#/definitions/QueryRequestType",
"description": "Required. The type of the provided query expression.",
"x-ms-client-name": "queryType"
},
"Expression": {
"type": "string",
"description": "The query expression. The maximum size of the query expression is 256KiB.",
"x-ms-client-name": "expression"
},
"InputSerialization": {
"$ref": "#/definitions/QuerySerialization",
"description": "The input serialization settings.",
"x-ms-client-name": "inputSerialization"
},
"OutputSerialization": {
"$ref": "#/definitions/QuerySerialization",
"description": "The output serialization settings.",
"x-ms-client-name": "outputSerialization"
}
},
"required": [
"QueryType",
"Expression"
]
},
"QueryRequestType": {
"type": "string",
"description": "The query request type.",
"enum": [
"SQL"
],
"x-ms-enum": {
"name": "QueryRequestType",
"modelAsString": false,
"values": [
{
"name": "SQL",
"value": "SQL",
"description": "The SQL request query type."
}
]
}
},
"QuerySerialization": {
"type": "object",
"description": "The query serialization settings.",
"properties": {
"Format": {
"$ref": "#/definitions/QueryFormat",
"description": "The query format.",
"x-ms-client-name": "format"
}
},
"required": [
"Format"
]
},
"QueryType": {
"type": "string",
"description": "The query format type.",
"enum": [
"delimited",
"json",
"arrow",
"parquet"
],
"x-ms-enum": {
"name": "QueryType",
"modelAsString": false,
"values": [
{
"name": "Delimited",
"value": "delimited",
"description": "The query format type is delimited."
},
{
"name": "JSON",
"value": "json",
"description": "The query format type is JSON."
},
{
"name": "Arrow",
"value": "arrow",
"description": "The query format type is Apache Arrow."
},
{
"name": "Parquet",
"value": "parquet",
"description": "The query format type is Parquet."
}
]
},
"xml": {
"name": "Type"
}
},
"RehydratePriority": {
"type": "string",
"description": "The priority of the rehydrate operation.",
"enum": [
"High",
"Standard"
],
"x-ms-enum": {
"name": "RehydratePriority",
"modelAsString": true,
"values": [
{
"name": "High",
"value": "High",
"description": "The rehydrate priority is high."
},
{
"name": "Standard",
"value": "Standard",
"description": "The rehydrate priority is standard."
}
]
}
},
"RetentionPolicy": {
"type": "object",
"description": "The retention policy.",
"properties": {
"Enabled": {
"type": "boolean",
"description": "Whether the policy is enabled.",
"x-ms-client-name": "enabled"
},
"Days": {
"type": "integer",
"format": "int32",
"description": "The number of days to retain the logs.",
"minimum": 1,
"x-ms-client-name": "days"
},
"AllowPermanentDelete": {
"type": "boolean",
"description": "Whether to allow permanent delete.",
"x-ms-client-name": "allowPermanentDelete"
}
},
"required": [
"Enabled"
]
},
"SequenceNumberActionType": {
"type": "string",
"description": "The sequence number actions.",
"enum": [
"increment",
"max",
"update"
],
"x-ms-enum": {
"name": "SequenceNumberActionType",
"modelAsString": false,
"values": [
{
"name": "Increment",
"value": "increment",
"description": "Increment the sequence number."
},
{
"name": "Max",
"value": "max",
"description": "Set the maximum for the sequence number."
},
{
"name": "Update",
"value": "update",
"description": "Update the sequence number."
}
]
}
},
"SignedIdentifier": {
"type": "object",
"description": "A signed identifier.",
"properties": {
"Id": {
"type": "string",
"description": "The unique ID for the signed identifier.",
"x-ms-client-name": "id"
},
"AccessPolicy": {
"$ref": "#/definitions/AccessPolicy",
"description": "The access policy for the signed identifier.",
"x-ms-client-name": "accessPolicy"
}
},
"required": [
"Id"
]
},
"SignedIdentifiers": {
"type": "object",
"description": "List of signed identifiers.",
"properties": {
"SignedIdentifier": {
"type": "array",
"description": "The list of signed identifiers.",
"items": {
"$ref": "#/definitions/SignedIdentifier"
},
"xml": {
"wrapped": false
},
"x-ms-client-name": "items"
}
},
"required": [
"SignedIdentifier"
]
},
"SkuName": {
"type": "string",
"description": "The account SKU.",
"enum": [
"Standard_LRS",
"Standard_GRS",
"Standard_RAGRS",
"Standard_ZRS",
"Premium_LRS"
],
"x-ms-enum": {
"name": "SkuName",
"modelAsString": false,
"values": [
{
"name": "StandardLRS",
"value": "Standard_LRS",
"description": "The standard LRS SKU."
},
{
"name": "StandardGRS",
"value": "Standard_GRS",
"description": "The standard GRS SKU."
},
{
"name": "StandardRAGRS",
"value": "Standard_RAGRS",
"description": "The standard RAGRS SKU."
},
{
"name": "StandardZRS",
"value": "Standard_ZRS",
"description": "The standard ZRS SKU."
},
{
"name": "PremiumLRS",
"value": "Premium_LRS",
"description": "The premium LRS SKU."
}
]
}
},
"StaticWebsite": {
"type": "object",
"description": "The properties that enable an account to host a static website.",
"properties": {
"Enabled": {
"type": "boolean",
"description": "Indicates whether this account is hosting a static website.",
"x-ms-client-name": "enabled"
},
"IndexDocument": {
"type": "string",
"description": "The index document.",
"x-ms-client-name": "indexDocument"
},
"ErrorDocument404Path": {
"type": "string",
"description": "The error document.",
"x-ms-client-name": "errorDocument404Path"
},
"DefaultIndexDocumentPath": {
"type": "string",
"description": "Absolute path of the default index page.",
"x-ms-client-name": "defaultIndexDocumentPath"
}
},
"required": [
"Enabled"
]
},
"StorageErrorCode": {
"type": "string",
"description": "Error codes returned by the Azure Blob Storage service.",
"enum": [
"AccountAlreadyExists",
"AccountBeingCreated",
"AccountIsDisabled",
"AuthenticationFailed",
"AuthorizationFailure",
"ConditionHeadersNotSupported",
"ConditionNotMet",
"EmptyMetadataKey",
"InsufficientAccountPermissions",
"InternalError",
"InvalidAuthenticationInfo",
"InvalidHeaderValue",
"InvalidHttpVerb",
"InvalidInput",
"InvalidMd5",
"InvalidMetadata",
"InvalidQueryParameterValue",
"InvalidRange",
"InvalidRequestUrl",
"InvalidResourceName",
"InvalidUri",
"InvalidXmlDocument",
"InvalidXmlNodeValue",
"Md5Mismatch",
"MetadataTooLarge",
"MissingContentLengthHeader",
"MissingRequiredXmlNode",
"MissingRequiredHeader",
"MissingRequiredQueryParameter",
"MultipleConditionHeadersNotSupported",
"NoAuthenticationInformation",
"OperationTimedOut",
"OutOfRangeInput",
"OutOfRangeQueryParameterValue",
"RequestBodyTooLarge",
"ResourceTypeMismatch",
"RequestUrlFailedToParse",
"ResourceAlreadyExists",
"ResourceNotFound",
"ServerBusy",
"UnsupportedHeader",
"UnsupportedXmlNode",
"UnsupportedQueryParameter",
"UnsupportedHttpVerb",
"AppendPositionConditionNotMet",
"BlobAlreadyExists",
"BlobImmutableDueToPolicy",
"BlobNotFound",
"BlobOverwritten",
"BlobTierInadequateForContentLength",
"BlobUsesCustomerSpecifiedEncryption",
"BlockCountExceedsLimit",
"BlockListTooLong",
"CannotChangeToLowerTier",
"CannotVerifyCopySource",
"ContainerAlreadyExists",
"ContainerBeingDeleted",
"ContainerDisabled",
"ContainerNotFound",
"ContentLengthLargerThanTierLimit",
"CopyAcrossAccountsNotSupported",
"CopyIdMismatch",
"FeatureVersionMismatch",
"IncrementalCopyBlobMismatch",
"IncrementalCopyOfEarlierVersionSnapshotNotAllowed",
"IncrementalCopySourceMustBeSnapshot",
"InfiniteLeaseDurationRequired",
"InvalidBlobOrBlock",
"InvalidBlobTier",
"InvalidBlobType",
"InvalidBlockId",
"InvalidBlockList",
"InvalidOperation",
"InvalidPageRange",
"InvalidSourceBlobType",
"InvalidSourceBlobUrl",
"InvalidVersionForPageBlobOperation",
"LeaseAlreadyPresent",
"LeaseAlreadyBroken",
"LeaseIdMismatchWithBlobOperation",
"LeaseIdMismatchWithContainerOperation",
"LeaseIdMismatchWithLeaseOperation",
"LeaseIdMissing",
"LeaseIsBreakingAndCannotBeAcquired",
"LeaseIsBreakingAndCannotBeChanged",
"LeaseIsBrokenAndCannotBeRenewed",
"LeaseLost",
"LeaseNotPresentWithBlobOperation",
"LeaseNotPresentWithContainerOperation",
"LeaseNotPresentWithLeaseOperation",
"MaxBlobSizeConditionNotMet",
"NoPendingCopyOperation",
"OperationNotAllowedOnIncrementalCopyBlob",
"PendingCopyOperation",
"PreviousSnapshotNotFound",
"PreviousSnapshotOperationNotSupported",
"PreviousSnapshotCannotBeNewer",
"SequenceNumberConditionNotMet",
"SequenceNumberIncrementTooLarge",
"SnapshotCountExceeded",
"SnapshotOperationRateExceeded",
"SnapshotsPresent",
"SourceConditionNotMet",
"SystemInUse",
"TargetConditionNotMet",
"UnauthorizedBlobOverwrite",
"BlobBeingRehydrated",
"BlobArchived",
"BlobNotArchived",
"AuthorizationSourceIPMismatch",
"AuthorizationProtocolMismatch",
"AuthorizationPermissionMismatch",
"AuthorizationServiceMismatch",
"AuthorizationResourceTypeMismatch",
"BlobAccessTierNotSupportedForAccountType"
],
"x-ms-enum": {
"name": "StorageErrorCode",
"modelAsString": true,
"values": [
{
"name": "AccountAlreadyExists",
"value": "AccountAlreadyExists",
"description": "Account already exists."
},
{
"name": "AccountBeingCreated",
"value": "AccountBeingCreated",
"description": "Account is being created."
},
{
"name": "AccountIsDisabled",
"value": "AccountIsDisabled",
"description": "Account is disabled."
},
{
"name": "AuthenticationFailed",
"value": "AuthenticationFailed",
"description": "Authentication failed."
},
{
"name": "AuthorizationFailure",
"value": "AuthorizationFailure",
"description": "Authorization failure."
},
{
"name": "ConditionHeadersNotSupported",
"value": "ConditionHeadersNotSupported",
"description": "Condition headers not supported."
},
{
"name": "ConditionNotMet",
"value": "ConditionNotMet",
"description": "Condition not met."
},
{
"name": "EmptyMetadataKey",
"value": "EmptyMetadataKey",
"description": "Empty metadata key."
},
{
"name": "InsufficientAccountPermissions",
"value": "InsufficientAccountPermissions",
"description": "Insufficient account permissions."
},
{
"name": "InternalError",
"value": "InternalError",
"description": "Internal error."
},
{
"name": "InvalidAuthenticationInfo",
"value": "InvalidAuthenticationInfo",
"description": "Invalid authentication information."
},
{
"name": "InvalidHeaderValue",
"value": "InvalidHeaderValue",
"description": "Invalid header value."
},
{
"name": "InvalidHttpVerb",
"value": "InvalidHttpVerb",
"description": "Invalid HTTP verb."
},
{
"name": "InvalidInput",
"value": "InvalidInput",
"description": "Invalid input."
},
{
"name": "InvalidMd5",
"value": "InvalidMd5",
"description": "Invalid MD5."
},
{
"name": "InvalidMetadata",
"value": "InvalidMetadata",
"description": "Invalid metadata."
},
{
"name": "InvalidQueryParameterValue",
"value": "InvalidQueryParameterValue",
"description": "Invalid query parameter value."
},
{
"name": "InvalidRange",
"value": "InvalidRange",
"description": "Invalid range."
},
{
"name": "InvalidRequestUrl",
"value": "InvalidRequestUrl",
"description": "Invalid request URL."
},
{
"name": "InvalidResourceName",
"value": "InvalidResourceName",
"description": "Invalid resource name."
},
{
"name": "InvalidUri",
"value": "InvalidUri",
"description": "Invalid URI."
},
{
"name": "InvalidXmlDocument",
"value": "InvalidXmlDocument",
"description": "Invalid XML document."
},
{
"name": "InvalidXmlNodeValue",
"value": "InvalidXmlNodeValue",
"description": "Invalid XML node value."
},
{
"name": "Md5Mismatch",
"value": "Md5Mismatch",
"description": "MD5 mismatch."
},
{
"name": "MetadataTooLarge",
"value": "MetadataTooLarge",
"description": "Metadata too large."
},
{
"name": "MissingContentLengthHeader",
"value": "MissingContentLengthHeader",
"description": "Missing content length header."
},
{
"name": "MissingRequiredXmlNode",
"value": "MissingRequiredXmlNode",
"description": "Missing required XML node."
},
{
"name": "MissingRequiredHeader",
"value": "MissingRequiredHeader",
"description": "Missing required header."
},
{
"name": "MissingRequiredQueryParameter",
"value": "MissingRequiredQueryParameter",
"description": "Missing required query parameter."
},
{
"name": "MultipleConditionHeadersNotSupported",
"value": "MultipleConditionHeadersNotSupported",
"description": "Multiple condition headers not supported."
},
{
"name": "NoAuthenticationInformation",
"value": "NoAuthenticationInformation",
"description": "No authentication information."
},
{
"name": "OperationTimedOut",
"value": "OperationTimedOut",
"description": "Operation timed out."
},
{
"name": "OutOfRangeInput",
"value": "OutOfRangeInput",
"description": "Out of range input."
},
{
"name": "OutOfRangeQueryParameterValue",
"value": "OutOfRangeQueryParameterValue",
"description": "Out of range query parameter value."
},
{
"name": "RequestBodyTooLarge",
"value": "RequestBodyTooLarge",
"description": "Request body too large."
},
{
"name": "ResourceTypeMismatch",
"value": "ResourceTypeMismatch",
"description": "Resource type mismatch."
},
{
"name": "RequestUrlFailedToParse",
"value": "RequestUrlFailedToParse",
"description": "Request URL failed to parse."
},
{
"name": "ResourceAlreadyExists",
"value": "ResourceAlreadyExists",
"description": "Resource already exists."
},
{
"name": "ResourceNotFound",
"value": "ResourceNotFound",
"description": "Resource not found."
},
{
"name": "ServerBusy",
"value": "ServerBusy",
"description": "Server busy."
},
{
"name": "UnsupportedHeader",
"value": "UnsupportedHeader",
"description": "Unsupported header."
},
{
"name": "UnsupportedXmlNode",
"value": "UnsupportedXmlNode",
"description": "Unsupported XML node."
},
{
"name": "UnsupportedQueryParameter",
"value": "UnsupportedQueryParameter",
"description": "Unsupported query parameter."
},
{
"name": "UnsupportedHttpVerb",
"value": "UnsupportedHttpVerb",
"description": "Unsupported HTTP verb."
},
{
"name": "AppendPositionConditionNotMet",
"value": "AppendPositionConditionNotMet",
"description": "Append position condition not met."
},
{
"name": "BlobAlreadyExists",
"value": "BlobAlreadyExists",
"description": "Blob already exists."
},
{
"name": "BlobImmutableDueToPolicy",
"value": "BlobImmutableDueToPolicy",
"description": "Blob is immutable due to policy."
},
{
"name": "BlobNotFound",
"value": "BlobNotFound",
"description": "Blob not found."
},
{
"name": "BlobOverwritten",
"value": "BlobOverwritten",
"description": "Blob overwritten."
},
{
"name": "BlobTierInadequateForContentLength",
"value": "BlobTierInadequateForContentLength",
"description": "Blob tier inadequate for content length."
},
{
"name": "BlobUsesCustomerSpecifiedEncryption",
"value": "BlobUsesCustomerSpecifiedEncryption",
"description": "Blob uses customer specified encryption."
},
{
"name": "BlockCountExceedsLimit",
"value": "BlockCountExceedsLimit",
"description": "Block count exceeds limit."
},
{
"name": "BlockListTooLong",
"value": "BlockListTooLong",
"description": "Block list too long."
},
{
"name": "CannotChangeToLowerTier",
"value": "CannotChangeToLowerTier",
"description": "Cannot change to lower tier."
},
{
"name": "CannotVerifyCopySource",
"value": "CannotVerifyCopySource",
"description": "Cannot verify copy source."
},
{
"name": "ContainerAlreadyExists",
"value": "ContainerAlreadyExists",
"description": "Container already exists."
},
{
"name": "ContainerBeingDeleted",
"value": "ContainerBeingDeleted",
"description": "Container being deleted."
},
{
"name": "ContainerDisabled",
"value": "ContainerDisabled",
"description": "Container disabled."
},
{
"name": "ContainerNotFound",
"value": "ContainerNotFound",
"description": "Container not found."
},
{
"name": "ContentLengthLargerThanTierLimit",
"value": "ContentLengthLargerThanTierLimit",
"description": "Content length larger than tier limit."
},
{
"name": "CopyAcrossAccountsNotSupported",
"value": "CopyAcrossAccountsNotSupported",
"description": "Copy across accounts not supported."
},
{
"name": "CopyIdMismatch",
"value": "CopyIdMismatch",
"description": "Copy ID mismatch."
},
{
"name": "FeatureVersionMismatch",
"value": "FeatureVersionMismatch",
"description": "Feature version mismatch."
},
{
"name": "IncrementalCopyBlobMismatch",
"value": "IncrementalCopyBlobMismatch",
"description": "Incremental copy blob mismatch."
},
{
"name": "IncrementalCopyOfEarlierVersionSnapshotNotAllowed",
"value": "IncrementalCopyOfEarlierVersionSnapshotNotAllowed",
"description": "Incremental copy of an earlier version snapshot is not allowed."
},
{
"name": "IncrementalCopySourceMustBeSnapshot",
"value": "IncrementalCopySourceMustBeSnapshot",
"description": "Incremental copy source must be snapshot."
},
{
"name": "InfiniteLeaseDurationRequired",
"value": "InfiniteLeaseDurationRequired",
"description": "Infinite lease duration required."
},
{
"name": "InvalidBlobOrBlock",
"value": "InvalidBlobOrBlock",
"description": "Invalid blob or block."
},
{
"name": "InvalidBlobTier",
"value": "InvalidBlobTier",
"description": "Invalid blob tier."
},
{
"name": "InvalidBlobType",
"value": "InvalidBlobType",
"description": "Invalid blob type."
},
{
"name": "InvalidBlockId",
"value": "InvalidBlockId",
"description": "Invalid block ID."
},
{
"name": "InvalidBlockList",
"value": "InvalidBlockList",
"description": "Invalid block list."
},
{
"name": "InvalidOperation",
"value": "InvalidOperation",
"description": "Invalid operation."
},
{
"name": "InvalidPageRange",
"value": "InvalidPageRange",
"description": "Invalid page range."
},
{
"name": "InvalidSourceBlobType",
"value": "InvalidSourceBlobType",
"description": "Invalid source blob type."
},
{
"name": "InvalidSourceBlobUrl",
"value": "InvalidSourceBlobUrl",
"description": "Invalid source blob URL."
},
{
"name": "InvalidVersionForPageBlobOperation",
"value": "InvalidVersionForPageBlobOperation",
"description": "Invalid version for page blob operation."
},
{
"name": "LeaseAlreadyPresent",
"value": "LeaseAlreadyPresent",
"description": "Lease already present."
},
{
"name": "LeaseAlreadyBroken",
"value": "LeaseAlreadyBroken",
"description": "Lease already broken."
},
{
"name": "LeaseIdMismatchWithBlobOperation",
"value": "LeaseIdMismatchWithBlobOperation",
"description": "Lease ID mismatch with blob operation."
},
{
"name": "LeaseIdMismatchWithContainerOperation",
"value": "LeaseIdMismatchWithContainerOperation",
"description": "Lease ID mismatch with container operation."
},
{
"name": "LeaseIdMismatchWithLeaseOperation",
"value": "LeaseIdMismatchWithLeaseOperation",
"description": "Lease ID mismatch with lease operation."
},
{
"name": "LeaseIdMissing",
"value": "LeaseIdMissing",
"description": "Lease ID missing."
},
{
"name": "LeaseIsBreakingAndCannotBeAcquired",
"value": "LeaseIsBreakingAndCannotBeAcquired",
"description": "Lease is breaking and cannot be acquired."
},
{
"name": "LeaseIsBreakingAndCannotBeChanged",
"value": "LeaseIsBreakingAndCannotBeChanged",
"description": "Lease is breaking and cannot be changed."
},
{
"name": "LeaseIsBrokenAndCannotBeRenewed",
"value": "LeaseIsBrokenAndCannotBeRenewed",
"description": "Lease is broken and cannot be renewed."
},
{
"name": "LeaseLost",
"value": "LeaseLost",
"description": "Lease lost."
},
{
"name": "LeaseNotPresentWithBlobOperation",
"value": "LeaseNotPresentWithBlobOperation",
"description": "Lease not present with blob operation."
},
{
"name": "LeaseNotPresentWithContainerOperation",
"value": "LeaseNotPresentWithContainerOperation",
"description": "Lease not present with container operation."
},
{
"name": "LeaseNotPresentWithLeaseOperation",
"value": "LeaseNotPresentWithLeaseOperation",
"description": "Lease not present with lease operation."
},
{
"name": "MaxBlobSizeConditionNotMet",
"value": "MaxBlobSizeConditionNotMet",
"description": "Maximum blob size condition not met."
},
{
"name": "NoPendingCopyOperation",
"value": "NoPendingCopyOperation",
"description": "No pending copy operation."
},
{
"name": "OperationNotAllowedOnIncrementalCopyBlob",
"value": "OperationNotAllowedOnIncrementalCopyBlob",
"description": "Operation not allowed on incremental copy blob."
},
{
"name": "PendingCopyOperation",
"value": "PendingCopyOperation",
"description": "Pending copy operation."
},
{
"name": "PreviousSnapshotNotFound",
"value": "PreviousSnapshotNotFound",
"description": "Previous snapshot not found."
},
{
"name": "PreviousSnapshotOperationNotSupported",
"value": "PreviousSnapshotOperationNotSupported",
"description": "Previous snapshot operation not supported."
},
{
"name": "PreviousSnapshotCannotBeNewer",
"value": "PreviousSnapshotCannotBeNewer",
"description": "Previous snapshot cannot be newer."
},
{
"name": "SequenceNumberConditionNotMet",
"value": "SequenceNumberConditionNotMet",
"description": "Sequence number condition not met."
},
{
"name": "SequenceNumberIncrementTooLarge",
"value": "SequenceNumberIncrementTooLarge",
"description": "Sequence number increment too large."
},
{
"name": "SnapshotCountExceeded",
"value": "SnapshotCountExceeded",
"description": "Snapshot count exceeded."
},
{
"name": "SnapshotOperationRateExceeded",
"value": "SnapshotOperationRateExceeded",
"description": "Snapshot operation rate exceeded."
},
{
"name": "SnapshotsPresent",
"value": "SnapshotsPresent",
"description": "Snapshots present."
},
{
"name": "SourceConditionNotMet",
"value": "SourceConditionNotMet",
"description": "Source condition not met."
},
{
"name": "SystemInUse",
"value": "SystemInUse",
"description": "System in use."
},
{
"name": "TargetConditionNotMet",
"value": "TargetConditionNotMet",
"description": "Target condition not met."
},
{
"name": "UnauthorizedBlobOverwrite",
"value": "UnauthorizedBlobOverwrite",
"description": "Unauthorized blob overwrite."
},
{
"name": "BlobBeingRehydrated",
"value": "BlobBeingRehydrated",
"description": "Blob being rehydrated."
},
{
"name": "BlobArchived",
"value": "BlobArchived",
"description": "Blob archived."
},
{
"name": "BlobNotArchived",
"value": "BlobNotArchived",
"description": "Blob not archived."
},
{
"name": "AuthorizationSourceIPMismatch",
"value": "AuthorizationSourceIPMismatch",
"description": "Authorization source IP mismatch."
},
{
"name": "AuthorizationProtocolMismatch",
"value": "AuthorizationProtocolMismatch",
"description": "Authorization protocol mismatch."
},
{
"name": "AuthorizationPermissionMismatch",
"value": "AuthorizationPermissionMismatch",
"description": "Authorization permission mismatch."
},
{
"name": "AuthorizationServiceMismatch",
"value": "AuthorizationServiceMismatch",
"description": "Authorization service mismatch."
},
{
"name": "AuthorizationResourceTypeMismatch",
"value": "AuthorizationResourceTypeMismatch",
"description": "Authorization resource type mismatch."
},
{
"name": "BlobAccessTierNotSupportedForAccountType",
"value": "BlobAccessTierNotSupportedForAccountType",
"description": "Blob access tier not supported for account type."
}
]
}
},
"StorageServiceStats": {
"type": "object",
"description": "Stats for the storage service.",
"properties": {
"GeoReplication": {
"$ref": "#/definitions/GeoReplication",
"description": "The geo-replication stats.",
"x-ms-client-name": "geoReplication"
}
}
},
"UserDelegationKey": {
"type": "object",
"description": "A user delegation key.",
"properties": {
"SignedOid": {
"$ref": "#/definitions/Azure.Core.uuid",
"description": "The Entra ID object ID in GUID format.",
"x-ms-client-name": "signedOid"
},
"SignedTid": {
"$ref": "#/definitions/Azure.Core.uuid",
"description": "The Entra ID tenant ID in GUID format.",
"x-ms-client-name": "signedTid"
},
"SignedStart": {
"type": "string",
"format": "date-time",
"description": "The date-time the key is active.",
"x-ms-client-name": "signedStart"
},
"SignedExpiry": {
"type": "string",
"format": "date-time",
"description": "The date-time the key expires.",
"x-ms-client-name": "signedExpiry"
},
"SignedService": {
"type": "string",
"description": "Abbreviation of the Azure Storage service that accepts the key.",
"x-ms-client-name": "signedService"
},
"SignedVersion": {
"type": "string",
"description": "The service version that created the key.",
"x-ms-client-name": "signedVersion"
},
"Value": {
"$ref": "#/definitions/base64Bytes",
"description": "The base64 encoded key value.",
"x-ms-client-name": "value"
}
},
"required": [
"SignedOid",
"SignedTid",
"SignedStart",
"SignedExpiry",
"SignedService",
"SignedVersion",
"Value"
]
},
"base64Bytes": {
"type": "string",
"format": "byte"
}
},
"parameters": {}
}