openapi: 3.0.0 info: title: Azure Blob Storage version: 2025-01-05 x-ms-code-generation-settings: header: MIT strictSpecAdherence: false paths: {} x-ms-paths: /?restype=service&comp=properties: put: tags: - service 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: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" requestBody: content: application/xml: schema: $ref: "#/components/schemas/StorageServiceProperties" description: The StorageService properties. required: true x-ms-parameter-location: method responses: "202": description: Success (Accepted) headers: x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" get: tags: - service operationId: Service_GetProperties description: gets the properties of a storage account's Blob service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules. parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" responses: "200": description: Success. headers: x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageServiceProperties" default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - name: restype description: restype in: query required: true schema: type: string enum: - service - name: comp description: comp in: query required: true schema: type: string enum: - properties /?restype=service&comp=stats: get: tags: - service 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: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" responses: "200": description: Success. headers: x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 content: application/xml: schema: $ref: "#/components/schemas/StorageServiceStats" default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - name: restype description: restype in: query required: true schema: type: string enum: - service - name: comp description: comp in: query required: true schema: type: string enum: - stats /?comp=list: get: tags: - service operationId: Service_ListContainersSegment description: The List Containers Segment operation returns a list of the containers under the specified account parameters: - $ref: "#/components/parameters/Prefix" - $ref: "#/components/parameters/Marker" - $ref: "#/components/parameters/MaxResults" - $ref: "#/components/parameters/ListContainersInclude" - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" responses: "200": description: Success. headers: x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string content: application/xml: schema: $ref: "#/components/schemas/ListContainersSegmentResponse" default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" x-ms-pageable: nextLinkName: NextMarker parameters: - name: comp description: comp in: query required: true schema: type: string enum: - list /?restype=service&comp=userdelegationkey: post: tags: - service 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: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" requestBody: content: application/xml: schema: $ref: "#/components/schemas/KeyInfo" description: Key information required: true x-ms-parameter-location: method responses: "200": description: Success. headers: x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 content: application/xml: schema: $ref: "#/components/schemas/UserDelegationKey" default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - name: restype description: restype in: query required: true schema: type: string enum: - service - name: comp description: comp in: query required: true schema: type: string enum: - userdelegationkey /?restype=account&comp=properties: get: tags: - service operationId: Service_GetAccountInfo description: "Returns the sku name and account kind " parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" responses: "200": description: Success (OK) headers: x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 x-ms-sku-name: x-ms-client-name: SkuName x-ms-enum: name: SkuName modelAsString: false description: Identifies the sku name of the account schema: type: string enum: - Standard_LRS - Standard_GRS - Standard_RAGRS - Standard_ZRS - Premium_LRS x-ms-account-kind: x-ms-client-name: AccountKind x-ms-enum: name: AccountKind modelAsString: false description: Identifies the account kind schema: type: string enum: - Storage - BlobStorage - StorageV2 - FileStorage - BlockBlobStorage x-ms-is-hns-enabled: x-ms-client-name: IsHierarchicalNamespaceEnabled description: Version 2019-07-07 and newer. Indicates if the account has a hierarchical namespace enabled. schema: type: boolean default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - name: restype description: restype in: query required: true schema: type: string enum: - account - name: comp description: comp in: query required: true schema: type: string enum: - properties /?comp=batch: post: tags: - service operationId: Service_SubmitBatch description: The Batch operation allows multiple API calls to be embedded into a single HTTP request. parameters: - $ref: "#/components/parameters/ContentLength" - $ref: "#/components/parameters/MultipartContentType" - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" requestBody: $ref: "#/components/requestBodies/Service_SubmitBatchBody" responses: "200": description: Success. headers: Content-Type: description: The media type of the body of the response. For batch requests, this is multipart/mixed; boundary=batchresponse_GUID schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string content: application/xml: schema: type: object format: file default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - name: comp description: comp in: query required: true schema: type: string enum: - batch /?comp=blobs: get: tags: - service operationId: Service_FilterBlobs description: The Filter Blobs operation enables callers to list blobs across all containers whose tags match a given search expression. Filter blobs searches across all containers within a storage account but can be scoped within the expression to a single container. parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/FilterBlobsWhere" - $ref: "#/components/parameters/Marker" - $ref: "#/components/parameters/MaxResults" - $ref: "#/components/parameters/FilterBlobsInclude" responses: "200": description: Success headers: x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 content: application/xml: schema: $ref: "#/components/schemas/FilterBlobSegment" default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - name: comp description: comp in: query required: true schema: type: string enum: - blobs "/{containerName}?restype=container": put: tags: - container operationId: Container_Create description: creates a new container under the specified account. If the container with the same name already exists, the operation fails parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/Metadata" - $ref: "#/components/parameters/BlobPublicAccess" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/DefaultEncryptionScope" - $ref: "#/components/parameters/DenyEncryptionScopeOverride" - $ref: "#/components/parameters/ContainerName" - name: restype description: restype in: query required: true schema: type: string enum: - container responses: "201": description: Success, Container created. headers: ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Last-Modified: description: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" get: tags: - container 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: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/LeaseIdOptional" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/ContainerName" - name: restype description: restype in: query required: true schema: type: string enum: - container responses: "200": description: Success headers: x-ms-meta: x-ms-client-name: Metadata x-ms-header-collection-prefix: x-ms-meta- schema: type: string ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Last-Modified: description: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 x-ms-lease-duration: x-ms-client-name: LeaseDuration description: When a blob is leased, specifies whether the lease is of infinite or fixed duration. x-ms-enum: name: LeaseDurationType modelAsString: false schema: type: string enum: - infinite - fixed x-ms-lease-state: x-ms-client-name: LeaseState description: Lease state of the blob. x-ms-enum: name: LeaseStateType modelAsString: false schema: type: string enum: - available - leased - expired - breaking - broken x-ms-lease-status: x-ms-client-name: LeaseStatus description: The current lease status of the blob. x-ms-enum: name: LeaseStatusType modelAsString: false schema: type: string enum: - locked - unlocked x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 x-ms-blob-public-access: x-ms-client-name: BlobPublicAccess description: Indicated whether data in the container may be accessed publicly and the level of access x-ms-enum: name: PublicAccessType modelAsString: true schema: type: string enum: - container - blob x-ms-has-immutability-policy: x-ms-client-name: HasImmutabilityPolicy description: Indicates whether the container has an immutability policy set on it. schema: type: boolean x-ms-has-legal-hold: x-ms-client-name: HasLegalHold description: Indicates whether the container has a legal hold. schema: type: boolean x-ms-default-encryption-scope: x-ms-client-name: DefaultEncryptionScope description: The default encryption scope for the container. schema: type: string x-ms-deny-encryption-scope-override: x-ms-client-name: DenyEncryptionScopeOverride description: Indicates whether the container's default encryption scope can be overriden. schema: type: boolean x-ms-immutable-storage-with-versioning-enabled: x-ms-client-name: IsImmutableStorageWithVersioningEnabled description: Indicates whether version level worm is enabled on a container. schema: type: boolean default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" delete: tags: - container operationId: Container_Delete description: operation marks the specified container for deletion. The container and any blobs contained within it are later deleted during garbage collection parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/LeaseIdOptional" - $ref: "#/components/parameters/IfModifiedSince" - $ref: "#/components/parameters/IfUnmodifiedSince" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/ContainerName" - name: restype description: restype in: query required: true schema: type: string enum: - container responses: "202": description: Accepted headers: x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - name: restype description: restype in: query required: true schema: type: string enum: - container "/{containerName}?restype=container&comp=metadata": put: tags: - container operationId: Container_SetMetadata description: operation sets one or more user-defined name-value pairs for the specified container. parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/LeaseIdOptional" - $ref: "#/components/parameters/Metadata" - $ref: "#/components/parameters/IfModifiedSince" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/ContainerName" - name: restype description: restype in: query required: true schema: type: string enum: - container - name: comp description: comp in: query required: true schema: type: string enum: - metadata responses: "200": description: Success headers: ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Last-Modified: description: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - name: restype description: restype in: query required: true schema: type: string enum: - container - name: comp description: comp in: query required: true schema: type: string enum: - metadata "/{containerName}?restype=container&comp=acl": get: tags: - container operationId: Container_GetAccessPolicy description: gets the permissions for the specified container. The permissions indicate whether container data may be accessed publicly. parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/LeaseIdOptional" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/ContainerName" - name: restype description: restype in: query required: true schema: type: string enum: - container - name: comp description: comp in: query required: true schema: type: string enum: - acl responses: "200": description: Success headers: x-ms-blob-public-access: x-ms-client-name: BlobPublicAccess description: Indicated whether data in the container may be accessed publicly and the level of access x-ms-enum: name: PublicAccessType modelAsString: true schema: type: string enum: - container - blob ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Last-Modified: description: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 content: application/xml: schema: $ref: "#/components/schemas/SignedIdentifiers" default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" put: tags: - container operationId: Container_SetAccessPolicy description: sets the permissions for the specified container. The permissions indicate whether blobs in a container may be accessed publicly. parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/LeaseIdOptional" - $ref: "#/components/parameters/BlobPublicAccess" - $ref: "#/components/parameters/IfModifiedSince" - $ref: "#/components/parameters/IfUnmodifiedSince" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/ContainerName" - name: restype description: restype in: query required: true schema: type: string enum: - container - name: comp description: comp in: query required: true schema: type: string enum: - acl requestBody: content: application/xml: schema: $ref: "#/components/schemas/SignedIdentifiers" description: the acls for the container x-ms-parameter-location: method responses: "200": description: Success. headers: ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Last-Modified: description: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - name: restype description: restype in: query required: true schema: type: string enum: - container - name: comp description: comp in: query required: true schema: type: string enum: - acl "/{containerName}?restype=container&comp=undelete": put: tags: - container operationId: Container_Restore description: Restores a previously-deleted container. parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/DeletedContainerName" - $ref: "#/components/parameters/DeletedContainerVersion" - $ref: "#/components/parameters/ContainerName" - name: restype description: restype in: query required: true schema: type: string enum: - container - name: comp description: comp in: query required: true schema: type: string enum: - undelete responses: "201": description: Created. headers: x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - name: restype description: restype in: query required: true schema: type: string enum: - container - name: comp description: comp in: query required: true schema: type: string enum: - undelete "/{containerName}?restype=container&comp=rename": put: tags: - container operationId: Container_Rename description: Renames an existing container. parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/SourceContainerName" - $ref: "#/components/parameters/SourceLeaseId" - $ref: "#/components/parameters/ContainerName" - name: restype description: restype in: query required: true schema: type: string enum: - container - name: comp description: comp in: query required: true schema: type: string enum: - rename responses: "200": description: Created. headers: x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - name: restype description: restype in: query required: true schema: type: string enum: - container - name: comp description: comp in: query required: true schema: type: string enum: - rename "/{containerName}?restype=container&comp=batch": post: tags: - container operationId: Container_SubmitBatch description: The Batch operation allows multiple API calls to be embedded into a single HTTP request. parameters: - $ref: "#/components/parameters/ContentLength" - $ref: "#/components/parameters/MultipartContentType" - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/ContainerName" - name: restype description: restype in: query required: true schema: type: string enum: - container - name: comp description: comp in: query required: true schema: type: string enum: - batch requestBody: $ref: "#/components/requestBodies/Service_SubmitBatchBody" responses: "202": description: Success. headers: Content-Type: description: The media type of the body of the response. For batch requests, this is multipart/mixed; boundary=batchresponse_GUID schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string content: application/xml: schema: type: object format: file default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - name: restype description: restype in: query required: true schema: type: string enum: - container - name: comp description: comp in: query required: true schema: type: string enum: - batch "/{containerName}?restype=container&comp=blobs": get: tags: - container operationId: Container_FilterBlobs description: The Filter Blobs operation enables callers to list blobs in a container whose tags match a given search expression. Filter blobs searches within the given container. parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/FilterBlobsWhere" - $ref: "#/components/parameters/Marker" - $ref: "#/components/parameters/MaxResults" - $ref: "#/components/parameters/FilterBlobsInclude" - $ref: "#/components/parameters/ContainerName" - name: restype description: restype in: query required: true schema: type: string enum: - container - name: comp description: comp in: query required: true schema: type: string enum: - blobs responses: "200": description: Success headers: x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 content: application/xml: schema: $ref: "#/components/schemas/FilterBlobSegment" default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - name: restype description: restype in: query required: true schema: type: string enum: - container - name: comp description: comp in: query required: true schema: type: string enum: - blobs "/{containerName}?comp=lease&restype=container&acquire": put: tags: - container operationId: Container_AcquireLease description: "[Update] establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite" parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/LeaseDuration" - $ref: "#/components/parameters/ProposedLeaseIdOptional" - $ref: "#/components/parameters/IfModifiedSince" - $ref: "#/components/parameters/IfUnmodifiedSince" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/ContainerName" - name: comp description: comp in: query required: true schema: type: string enum: - lease - name: restype description: restype in: query required: true schema: type: string enum: - container responses: "201": description: The Acquire operation completed successfully. headers: ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Last-Modified: description: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 x-ms-lease-id: x-ms-client-name: LeaseId description: Uniquely identifies a container's lease schema: type: string x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - name: comp description: comp in: query required: true schema: type: string enum: - lease - name: restype description: restype in: query required: true schema: type: string enum: - container - name: x-ms-lease-action x-ms-client-name: action in: header required: true x-ms-enum: name: LeaseAction modelAsString: false x-ms-parameter-location: method description: Describes what lease action to take. schema: type: string enum: - acquire "/{containerName}?comp=lease&restype=container&release": put: tags: - container operationId: Container_ReleaseLease description: "[Update] establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite" parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/LeaseIdRequired" - $ref: "#/components/parameters/IfModifiedSince" - $ref: "#/components/parameters/IfUnmodifiedSince" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/ContainerName" - name: comp description: comp in: query required: true schema: type: string enum: - lease - name: restype description: restype in: query required: true schema: type: string enum: - container responses: "200": description: The Release operation completed successfully. headers: ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Last-Modified: description: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - name: comp description: comp in: query required: true schema: type: string enum: - lease - name: restype description: restype in: query required: true schema: type: string enum: - container - name: x-ms-lease-action x-ms-client-name: action in: header required: true x-ms-enum: name: LeaseAction modelAsString: false x-ms-parameter-location: method description: Describes what lease action to take. schema: type: string enum: - release "/{containerName}?comp=lease&restype=container&renew": put: tags: - container operationId: Container_RenewLease description: "[Update] establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite" parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/LeaseIdRequired" - $ref: "#/components/parameters/IfModifiedSince" - $ref: "#/components/parameters/IfUnmodifiedSince" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/ContainerName" - name: comp description: comp in: query required: true schema: type: string enum: - lease - name: restype description: restype in: query required: true schema: type: string enum: - container responses: "200": description: The Renew operation completed successfully. headers: ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Last-Modified: description: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 x-ms-lease-id: x-ms-client-name: LeaseId description: Uniquely identifies a container's lease schema: type: string x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - name: comp description: comp in: query required: true schema: type: string enum: - lease - name: restype description: restype in: query required: true schema: type: string enum: - container - name: x-ms-lease-action x-ms-client-name: action in: header required: true x-ms-enum: name: LeaseAction modelAsString: false x-ms-parameter-location: method description: Describes what lease action to take. schema: type: string enum: - renew "/{containerName}?comp=lease&restype=container&break": put: tags: - container operationId: Container_BreakLease description: "[Update] establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite" parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/LeaseBreakPeriod" - $ref: "#/components/parameters/IfModifiedSince" - $ref: "#/components/parameters/IfUnmodifiedSince" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/ContainerName" - name: comp description: comp in: query required: true schema: type: string enum: - lease - name: restype description: restype in: query required: true schema: type: string enum: - container responses: "202": description: The Break operation completed successfully. headers: ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Last-Modified: description: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 x-ms-lease-time: x-ms-client-name: LeaseTime description: Approximate time remaining in the lease period, in seconds. schema: type: integer x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - name: comp description: comp in: query required: true schema: type: string enum: - lease - name: restype description: restype in: query required: true schema: type: string enum: - container - name: x-ms-lease-action x-ms-client-name: action in: header required: true x-ms-enum: name: LeaseAction modelAsString: false x-ms-parameter-location: method description: Describes what lease action to take. schema: type: string enum: - break "/{containerName}?comp=lease&restype=container&change": put: tags: - container operationId: Container_ChangeLease description: "[Update] establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite" parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/LeaseIdRequired" - $ref: "#/components/parameters/ProposedLeaseIdRequired" - $ref: "#/components/parameters/IfModifiedSince" - $ref: "#/components/parameters/IfUnmodifiedSince" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/ContainerName" - name: comp description: comp in: query required: true schema: type: string enum: - lease - name: restype description: restype in: query required: true schema: type: string enum: - container responses: "200": description: The Change operation completed successfully. headers: ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Last-Modified: description: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 x-ms-lease-id: x-ms-client-name: LeaseId description: Uniquely identifies a container's lease schema: type: string x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - name: comp description: comp in: query required: true schema: type: string enum: - lease - name: restype description: restype in: query required: true schema: type: string enum: - container - name: x-ms-lease-action x-ms-client-name: action in: header required: true x-ms-enum: name: LeaseAction modelAsString: false x-ms-parameter-location: method description: Describes what lease action to take. schema: type: string enum: - change "/{containerName}?restype=container&comp=list&flat": get: tags: - containers operationId: Container_ListBlobFlatSegment description: "[Update] The List Blobs operation returns a list of the blobs under the specified container" parameters: - $ref: "#/components/parameters/Prefix" - $ref: "#/components/parameters/Marker" - $ref: "#/components/parameters/MaxResults" - $ref: "#/components/parameters/ListBlobsInclude" - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/ContainerName" - name: restype description: restype in: query required: true schema: type: string enum: - container - name: comp description: comp in: query required: true schema: type: string enum: - list responses: "200": description: Success. headers: Content-Type: description: The media type of the body of the response. For List Blobs this is 'application/xml' schema: type: string x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 content: application/xml: schema: $ref: "#/components/schemas/ListBlobsFlatSegmentResponse" default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" x-ms-pageable: nextLinkName: NextMarker parameters: - $ref: "#/components/parameters/ContainerName" - name: restype description: restype in: query required: true schema: type: string enum: - container - name: comp description: comp in: query required: true schema: type: string enum: - list "/{containerName}?restype=container&comp=list&hierarchy": get: tags: - containers operationId: Container_ListBlobHierarchySegment description: "[Update] The List Blobs operation returns a list of the blobs under the specified container" parameters: - $ref: "#/components/parameters/Prefix" - $ref: "#/components/parameters/Delimiter" - $ref: "#/components/parameters/Marker" - $ref: "#/components/parameters/MaxResults" - $ref: "#/components/parameters/ListBlobsInclude" - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/ContainerName" - name: restype description: restype in: query required: true schema: type: string enum: - container - name: comp description: comp in: query required: true schema: type: string enum: - list responses: "200": description: Success. headers: Content-Type: description: The media type of the body of the response. For List Blobs this is 'application/xml' schema: type: string x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 content: application/xml: schema: $ref: "#/components/schemas/ListBlobsHierarchySegmentResponse" default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" x-ms-pageable: nextLinkName: NextMarker parameters: - $ref: "#/components/parameters/ContainerName" - name: restype description: restype in: query required: true schema: type: string enum: - container - name: comp description: comp in: query required: true schema: type: string enum: - list "/{containerName}?restype=account&comp=properties": get: tags: - container operationId: Container_GetAccountInfo description: "Returns the sku name and account kind " parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/ContainerName" - name: restype description: restype in: query required: true schema: type: string enum: - account - name: comp description: comp in: query required: true schema: type: string enum: - properties responses: "200": description: Success (OK) headers: x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 x-ms-sku-name: x-ms-client-name: SkuName x-ms-enum: name: SkuName modelAsString: false description: Identifies the sku name of the account schema: type: string enum: - Standard_LRS - Standard_GRS - Standard_RAGRS - Standard_ZRS - Premium_LRS x-ms-account-kind: x-ms-client-name: AccountKind x-ms-enum: name: AccountKind modelAsString: false description: Identifies the account kind schema: type: string enum: - Storage - BlobStorage - StorageV2 - FileStorage - BlockBlobStorage x-ms-is-hns-enabled: x-ms-client-name: IsHierarchicalNamespaceEnabled description: Version 2019-07-07 and newer. Indicates if the account has a hierarchical namespace enabled. schema: type: boolean default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - name: restype description: restype in: query required: true schema: type: string enum: - account - name: comp description: comp in: query required: true schema: type: string enum: - properties "/{containerName}/{blob}": get: tags: - blob operationId: Blob_Download description: The Download operation reads or downloads a blob from the system, including its metadata and properties. You can also call Download to read a snapshot. parameters: - $ref: "#/components/parameters/Snapshot" - $ref: "#/components/parameters/VersionId" - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/Range" - $ref: "#/components/parameters/LeaseIdOptional" - $ref: "#/components/parameters/GetRangeContentMD5" - $ref: "#/components/parameters/GetRangeContentCRC64" - $ref: "#/components/parameters/StructuredBodyGet" - $ref: "#/components/parameters/EncryptionKey" - $ref: "#/components/parameters/EncryptionKeySha256" - $ref: "#/components/parameters/EncryptionAlgorithm" - $ref: "#/components/parameters/IfModifiedSince" - $ref: "#/components/parameters/IfUnmodifiedSince" - $ref: "#/components/parameters/IfMatch" - $ref: "#/components/parameters/IfNoneMatch" - $ref: "#/components/parameters/IfTags" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" responses: "200": description: Returns the content of the entire blob. headers: Last-Modified: description: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 x-ms-creation-time: x-ms-client-name: CreationTime description: Returns the date and time the blob was created. schema: type: string format: date-time-rfc1123 x-ms-meta: x-ms-client-name: Metadata x-ms-header-collection-prefix: x-ms-meta- schema: type: string x-ms-or-policy-id: x-ms-client-name: ObjectReplicationPolicyId description: Optional. Only valid when Object Replication is enabled for the storage container and on the destination blob of the replication. schema: type: string x-ms-or: x-ms-client-name: ObjectReplicationRules x-ms-header-collection-prefix: x-ms-or- description: Optional. Only valid when Object Replication is enabled for the storage container and on the source blob of the replication. When retrieving this header, it will return the header with the policy id and rule id (e.g. x-ms-or-policyid_ruleid), and the value will be the status of the replication (e.g. complete, failed). schema: type: string Content-Length: description: The number of bytes present in the response body. schema: type: integer format: int64 Content-Type: description: The media type of the body of the response. For Download Blob this is 'application/octet-stream' schema: type: string Content-Range: description: Indicates the range of bytes returned in the event that the client requested a subset of the blob by setting the 'Range' request header. schema: type: string ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Content-MD5: description: If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity. schema: type: string format: byte Content-Encoding: description: This header returns the value that was specified for the Content-Encoding request header schema: type: string Cache-Control: description: This header is returned if it was previously specified for the blob. schema: type: string Content-Disposition: description: This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified. schema: type: string Content-Language: description: This header returns the value that was specified for the Content-Language request header. schema: type: string x-ms-blob-sequence-number: x-ms-client-name: BlobSequenceNumber description: The current sequence number for a page blob. This header is not returned for block blobs or append blobs schema: type: integer format: int64 x-ms-blob-type: x-ms-client-name: BlobType description: The blob's type. x-ms-enum: name: BlobType modelAsString: false schema: type: string enum: - BlockBlob - PageBlob - AppendBlob x-ms-copy-completion-time: x-ms-client-name: CopyCompletionTime description: Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List. schema: type: string format: date-time-rfc1123 x-ms-copy-status-description: x-ms-client-name: CopyStatusDescription description: Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List schema: type: string x-ms-copy-id: x-ms-client-name: CopyId description: String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy. schema: type: string x-ms-copy-progress: x-ms-client-name: CopyProgress description: Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob. Can show between 0 and Content-Length bytes copied. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List schema: type: string x-ms-copy-source: x-ms-client-name: CopySource description: URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List. schema: type: string x-ms-copy-status: x-ms-client-name: CopyStatus description: State of the copy operation identified by x-ms-copy-id. x-ms-enum: name: CopyStatusType modelAsString: false schema: type: string enum: - pending - success - aborted - failed x-ms-lease-duration: x-ms-client-name: LeaseDuration description: When a blob is leased, specifies whether the lease is of infinite or fixed duration. x-ms-enum: name: LeaseDurationType modelAsString: false schema: type: string enum: - infinite - fixed x-ms-lease-state: x-ms-client-name: LeaseState description: Lease state of the blob. x-ms-enum: name: LeaseStateType modelAsString: false schema: type: string enum: - available - leased - expired - breaking - broken x-ms-lease-status: x-ms-client-name: LeaseStatus description: The current lease status of the blob. x-ms-enum: name: LeaseStatusType modelAsString: false schema: type: string enum: - locked - unlocked x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string x-ms-version-id: x-ms-client-name: VersionId description: A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob. schema: type: string x-ms-is-current-version: x-ms-client-name: IsCurrentVersion description: The value of this header indicates whether version of this blob is a current version, see also x-ms-version-id header. schema: type: boolean Accept-Ranges: description: Indicates that the service supports requests for partial blob content. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 x-ms-blob-committed-block-count: x-ms-client-name: BlobCommittedBlockCount description: The number of committed blocks present in the blob. This header is returned only for append blobs. schema: type: integer x-ms-server-encrypted: x-ms-client-name: IsServerEncrypted description: The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the blob is unencrypted, or if only parts of the blob/application metadata are encrypted). schema: type: boolean x-ms-encryption-key-sha256: x-ms-client-name: EncryptionKeySha256 description: The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key. schema: type: string x-ms-encryption-scope: x-ms-client-name: EncryptionScope description: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. schema: type: string x-ms-blob-content-md5: x-ms-client-name: BlobContentMD5 description: If the blob has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole blob's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range schema: type: string format: byte x-ms-tag-count: x-ms-client-name: TagCount description: The number of tags associated with the blob schema: type: integer format: int64 x-ms-blob-sealed: x-ms-client-name: IsSealed description: If this blob has been sealed schema: type: boolean x-ms-last-access-time: x-ms-client-name: LastAccessed description: UTC date/time value generated by the service that indicates the time at which the blob was last read or written to schema: type: string format: date-time-rfc1123 x-ms-immutability-policy-until-date: x-ms-client-name: ImmutabilityPolicyExpiresOn description: UTC date/time value generated by the service that indicates the time at which the blob immutability policy will expire. schema: type: string format: date-time-rfc1123 x-ms-immutability-policy-mode: x-ms-client-name: ImmutabilityPolicyMode x-ms-enum: name: BlobImmutabilityPolicyMode modelAsString: false description: Indicates immutability policy mode. schema: type: string enum: - Mutable - Unlocked - Locked x-ms-legal-hold: x-ms-client-name: LegalHold description: Indicates if a legal hold is present on the blob. schema: type: boolean x-ms-structured-body: x-ms-client-name: StructuredBodyType description: Indicates the response body contains a structured message and specifies the message schema version and properties. schema: type: string x-ms-structured-content-length: x-ms-client-name: StructuredContentLength 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. schema: type: integer format: int64 content: application/xml: schema: type: object format: file "206": description: Returns the content of a specified range of the blob. headers: Last-Modified: description: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 x-ms-creation-time: x-ms-client-name: CreationTime description: Returns the date and time the blob was created. schema: type: string format: date-time-rfc1123 x-ms-meta: x-ms-client-name: Metadata x-ms-header-collection-prefix: x-ms-meta- schema: type: string x-ms-or-policy-id: x-ms-client-name: ObjectReplicationPolicyId description: Optional. Only valid when Object Replication is enabled for the storage container and on the destination blob of the replication. schema: type: string x-ms-or: x-ms-client-name: ObjectReplicationRules x-ms-header-collection-prefix: x-ms-or- description: Optional. Only valid when Object Replication is enabled for the storage container and on the source blob of the replication. When retrieving this header, it will return the header with the policy id and rule id (e.g. x-ms-or-policyid_ruleid), and the value will be the status of the replication (e.g. complete, failed). schema: type: string Content-Length: description: The number of bytes present in the response body. schema: type: integer format: int64 Content-Type: description: The media type of the body of the response. For Download Blob this is 'application/octet-stream' schema: type: string Content-Range: description: Indicates the range of bytes returned in the event that the client requested a subset of the blob by setting the 'Range' request header. schema: type: string ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Content-MD5: description: If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity. schema: type: string format: byte Content-Encoding: description: This header returns the value that was specified for the Content-Encoding request header schema: type: string Cache-Control: description: This header is returned if it was previously specified for the blob. schema: type: string Content-Disposition: description: This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified. schema: type: string Content-Language: description: This header returns the value that was specified for the Content-Language request header. schema: type: string x-ms-blob-sequence-number: x-ms-client-name: BlobSequenceNumber description: The current sequence number for a page blob. This header is not returned for block blobs or append blobs schema: type: integer format: int64 x-ms-blob-type: x-ms-client-name: BlobType description: The blob's type. x-ms-enum: name: BlobType modelAsString: false schema: type: string enum: - BlockBlob - PageBlob - AppendBlob x-ms-content-crc64: x-ms-client-name: ContentCrc64 description: If the request is to read a specified range and the x-ms-range-get-content-crc64 is set to true, then the request returns a crc64 for the range, as long as the range size is less than or equal to 4 MB. If both x-ms-range-get-content-crc64 & x-ms-range-get-content-md5 is specified in the same request, it will fail with 400(Bad Request) schema: type: string format: byte x-ms-copy-completion-time: x-ms-client-name: CopyCompletionTime description: Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List. schema: type: string format: date-time-rfc1123 x-ms-copy-status-description: x-ms-client-name: CopyStatusDescription description: Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List schema: type: string x-ms-copy-id: x-ms-client-name: CopyId description: String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy. schema: type: string x-ms-copy-progress: x-ms-client-name: CopyProgress description: Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob. Can show between 0 and Content-Length bytes copied. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List schema: type: string x-ms-copy-source: x-ms-client-name: CopySource description: URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List. schema: type: string x-ms-copy-status: x-ms-client-name: CopyStatus description: State of the copy operation identified by x-ms-copy-id. x-ms-enum: name: CopyStatusType modelAsString: false schema: type: string enum: - pending - success - aborted - failed x-ms-lease-duration: x-ms-client-name: LeaseDuration description: When a blob is leased, specifies whether the lease is of infinite or fixed duration. x-ms-enum: name: LeaseDurationType modelAsString: false schema: type: string enum: - infinite - fixed x-ms-lease-state: x-ms-client-name: LeaseState description: Lease state of the blob. x-ms-enum: name: LeaseStateType modelAsString: false schema: type: string enum: - available - leased - expired - breaking - broken x-ms-lease-status: x-ms-client-name: LeaseStatus description: The current lease status of the blob. x-ms-enum: name: LeaseStatusType modelAsString: false schema: type: string enum: - locked - unlocked x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string x-ms-version-id: x-ms-client-name: VersionId description: A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob. schema: type: string x-ms-is-current-version: x-ms-client-name: IsCurrentVersion description: The value of this header indicates whether version of this blob is a current version, see also x-ms-version-id header. schema: type: boolean Accept-Ranges: description: Indicates that the service supports requests for partial blob content. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 x-ms-blob-committed-block-count: x-ms-client-name: BlobCommittedBlockCount description: The number of committed blocks present in the blob. This header is returned only for append blobs. schema: type: integer x-ms-server-encrypted: x-ms-client-name: IsServerEncrypted description: The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the blob is unencrypted, or if only parts of the blob/application metadata are encrypted). schema: type: boolean x-ms-encryption-key-sha256: x-ms-client-name: EncryptionKeySha256 description: The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key. schema: type: string x-ms-encryption-scope: x-ms-client-name: EncryptionScope description: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. schema: type: string x-ms-blob-content-md5: x-ms-client-name: BlobContentMD5 description: If the blob has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole blob's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range schema: type: string format: byte x-ms-tag-count: x-ms-client-name: TagCount description: The number of tags associated with the blob schema: type: integer format: int64 x-ms-blob-sealed: x-ms-client-name: IsSealed description: If this blob has been sealed schema: type: boolean x-ms-last-access-time: x-ms-client-name: LastAccessed description: UTC date/time value generated by the service that indicates the time at which the blob was last read or written to schema: type: string format: date-time-rfc1123 x-ms-immutability-policy-until-date: x-ms-client-name: ImmutabilityPolicyExpiresOn description: UTC date/time value generated by the service that indicates the time at which the blob immutability policy will expire. schema: type: string format: date-time-rfc1123 x-ms-immutability-policy-mode: x-ms-client-name: ImmutabilityPolicyMode description: Indicates immutability policy mode. schema: type: string x-ms-legal-hold: x-ms-client-name: LegalHold description: Indicates if a legal hold is present on the blob. schema: type: boolean x-ms-structured-body: x-ms-client-name: StructuredBodyType description: Indicates the response body contains a structured message and specifies the message schema version and properties. schema: type: string x-ms-structured-content-length: x-ms-client-name: StructuredContentLength 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. schema: type: integer format: int64 content: application/xml: schema: type: object format: file default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" head: tags: - blob operationId: Blob_GetProperties description: The Get Properties operation returns all user-defined metadata, standard HTTP properties, and system properties for the blob. It does not return the content of the blob. parameters: - $ref: "#/components/parameters/Snapshot" - $ref: "#/components/parameters/VersionId" - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/LeaseIdOptional" - $ref: "#/components/parameters/EncryptionKey" - $ref: "#/components/parameters/EncryptionKeySha256" - $ref: "#/components/parameters/EncryptionAlgorithm" - $ref: "#/components/parameters/IfModifiedSince" - $ref: "#/components/parameters/IfUnmodifiedSince" - $ref: "#/components/parameters/IfMatch" - $ref: "#/components/parameters/IfNoneMatch" - $ref: "#/components/parameters/IfTags" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" responses: "200": description: Returns the properties of the blob. headers: Last-Modified: description: Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 x-ms-creation-time: x-ms-client-name: CreationTime description: Returns the date and time the blob was created. schema: type: string format: date-time-rfc1123 x-ms-meta: x-ms-client-name: Metadata x-ms-header-collection-prefix: x-ms-meta- schema: type: string x-ms-or-policy-id: x-ms-client-name: ObjectReplicationPolicyId description: Optional. Only valid when Object Replication is enabled for the storage container and on the destination blob of the replication. schema: type: string x-ms-or: x-ms-client-name: ObjectReplicationRules x-ms-header-collection-prefix: x-ms-or- description: Optional. Only valid when Object Replication is enabled for the storage container and on the source blob of the replication. When retrieving this header, it will return the header with the policy id and rule id (e.g. x-ms-or-policyid_ruleid), and the value will be the status of the replication (e.g. complete, failed). schema: type: string x-ms-blob-type: x-ms-client-name: BlobType description: The blob's type. x-ms-enum: name: BlobType modelAsString: false schema: type: string enum: - BlockBlob - PageBlob - AppendBlob x-ms-copy-completion-time: x-ms-client-name: CopyCompletionTime description: Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List. schema: type: string format: date-time-rfc1123 x-ms-copy-status-description: x-ms-client-name: CopyStatusDescription description: Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List schema: type: string x-ms-copy-id: x-ms-client-name: CopyId description: String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy. schema: type: string x-ms-copy-progress: x-ms-client-name: CopyProgress description: Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob. Can show between 0 and Content-Length bytes copied. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List schema: type: string x-ms-copy-source: x-ms-client-name: CopySource description: URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List. schema: type: string x-ms-copy-status: x-ms-client-name: CopyStatus description: State of the copy operation identified by x-ms-copy-id. x-ms-enum: name: CopyStatusType modelAsString: false schema: type: string enum: - pending - success - aborted - failed x-ms-incremental-copy: x-ms-client-name: IsIncrementalCopy description: Included if the blob is incremental copy blob. schema: type: boolean x-ms-copy-destination-snapshot: x-ms-client-name: DestinationSnapshot description: Included if the blob is incremental copy blob or incremental copy snapshot, if x-ms-copy-status is success. Snapshot time of the last successful incremental copy snapshot for this blob. schema: type: string x-ms-lease-duration: x-ms-client-name: LeaseDuration description: When a blob is leased, specifies whether the lease is of infinite or fixed duration. x-ms-enum: name: LeaseDurationType modelAsString: false schema: type: string enum: - infinite - fixed x-ms-lease-state: x-ms-client-name: LeaseState description: Lease state of the blob. x-ms-enum: name: LeaseStateType modelAsString: false schema: type: string enum: - available - leased - expired - breaking - broken x-ms-lease-status: x-ms-client-name: LeaseStatus description: The current lease status of the blob. x-ms-enum: name: LeaseStatusType modelAsString: false schema: type: string enum: - locked - unlocked Content-Length: description: The number of bytes present in the response body. schema: type: integer format: int64 Content-Type: description: The content type specified for the blob. The default content type is 'application/octet-stream' schema: type: string ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Content-MD5: description: If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity. schema: type: string format: byte Content-Encoding: description: This header returns the value that was specified for the Content-Encoding request header schema: type: string Content-Disposition: description: This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified. schema: type: string Content-Language: description: This header returns the value that was specified for the Content-Language request header. schema: type: string Cache-Control: description: This header is returned if it was previously specified for the blob. schema: type: string x-ms-blob-sequence-number: x-ms-client-name: BlobSequenceNumber description: The current sequence number for a page blob. This header is not returned for block blobs or append blobs schema: type: integer format: int64 x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 Accept-Ranges: description: Indicates that the service supports requests for partial blob content. schema: type: string x-ms-blob-committed-block-count: x-ms-client-name: BlobCommittedBlockCount description: The number of committed blocks present in the blob. This header is returned only for append blobs. schema: type: integer x-ms-server-encrypted: x-ms-client-name: IsServerEncrypted description: The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the blob is unencrypted, or if only parts of the blob/application metadata are encrypted). schema: type: boolean x-ms-encryption-key-sha256: x-ms-client-name: EncryptionKeySha256 description: The SHA-256 hash of the encryption key used to encrypt the metadata. This header is only returned when the metadata was encrypted with a customer-provided key. schema: type: string x-ms-encryption-scope: x-ms-client-name: EncryptionScope description: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. schema: type: string x-ms-access-tier: x-ms-client-name: AccessTier description: The tier of page blob on a premium storage account or tier of block blob on blob storage LRS accounts. For a list of allowed premium page blob tiers, see https://learn.microsoft.com/azure/virtual-machines/disks-types#premium-ssd. For blob storage LRS accounts, valid values are Hot/Cool/Archive. schema: type: string x-ms-access-tier-inferred: x-ms-client-name: AccessTierInferred description: For page blobs on a premium storage account only. If the access tier is not explicitly set on the blob, the tier is inferred based on its content length and this header will be returned with true value. schema: type: boolean x-ms-archive-status: x-ms-client-name: ArchiveStatus description: For blob storage LRS accounts, valid values are rehydrate-pending-to-hot/rehydrate-pending-to-cool. If the blob is being rehydrated and is not complete then this header is returned indicating that rehydrate is pending and also tells the destination tier. schema: type: string x-ms-access-tier-change-time: x-ms-client-name: AccessTierChangeTime description: The time the tier was changed on the object. This is only returned if the tier on the block blob was ever set. schema: type: string format: date-time-rfc1123 x-ms-version-id: x-ms-client-name: VersionId description: A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob. schema: type: string x-ms-is-current-version: x-ms-client-name: IsCurrentVersion description: The value of this header indicates whether version of this blob is a current version, see also x-ms-version-id header. schema: type: boolean x-ms-tag-count: x-ms-client-name: TagCount description: The number of tags associated with the blob schema: type: integer format: int64 x-ms-expiry-time: x-ms-client-name: ExpiresOn description: The time this blob will expire. schema: type: string format: date-time-rfc1123 x-ms-blob-sealed: x-ms-client-name: IsSealed description: If this blob has been sealed schema: type: boolean x-ms-rehydrate-priority: x-ms-client-name: RehydratePriority description: If an object is in rehydrate pending state then this header is returned with priority of rehydrate. Valid values are High and Standard. schema: type: string x-ms-last-access-time: x-ms-client-name: LastAccessed description: UTC date/time value generated by the service that indicates the time at which the blob was last read or written to schema: type: string format: date-time-rfc1123 x-ms-immutability-policy-until-date: x-ms-client-name: ImmutabilityPolicyExpiresOn description: UTC date/time value generated by the service that indicates the time at which the blob immutability policy will expire. schema: type: string format: date-time-rfc1123 x-ms-immutability-policy-mode: x-ms-client-name: ImmutabilityPolicyMode x-ms-enum: name: BlobImmutabilityPolicyMode modelAsString: false description: Indicates immutability policy mode. schema: type: string enum: - Mutable - Unlocked - Locked x-ms-legal-hold: x-ms-client-name: LegalHold description: Indicates if a legal hold is present on the blob. schema: type: boolean default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" delete: tags: - blob operationId: Blob_Delete description: If the storage account's soft delete feature is disabled then, when a blob is deleted, it is permanently removed from the storage account. If the storage account's soft delete feature is enabled, then, when a blob is deleted, it is marked for deletion and becomes inaccessible immediately. However, the blob service retains the blob or snapshot for the number of days specified by the DeleteRetentionPolicy section of [Storage service properties] (Set-Blob-Service-Properties.md). After the specified number of days has passed, the blob's data is permanently removed from the storage account. Note that you continue to be charged for the soft-deleted blob's storage until it is permanently removed. Use the List Blobs API and specify the "include=deleted" query parameter to discover which blobs and snapshots have been soft deleted. You can then use the Undelete Blob API to restore a soft-deleted blob. All other operations on a soft-deleted blob or snapshot causes the service to return an HTTP status code of 404 (ResourceNotFound). parameters: - $ref: "#/components/parameters/Snapshot" - $ref: "#/components/parameters/VersionId" - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/LeaseIdOptional" - $ref: "#/components/parameters/DeleteSnapshots" - $ref: "#/components/parameters/IfModifiedSince" - $ref: "#/components/parameters/IfUnmodifiedSince" - $ref: "#/components/parameters/IfMatch" - $ref: "#/components/parameters/IfNoneMatch" - $ref: "#/components/parameters/IfTags" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/BlobDeleteType" responses: "202": description: The delete request was accepted and the blob will be deleted. headers: x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - $ref: "#/components/parameters/Blob" "/{containerName}/{blob}?PageBlob": put: tags: - blob operationId: PageBlob_Create description: The Create operation creates a new page blob. parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/ContentLength" - $ref: "#/components/parameters/PremiumPageBlobAccessTierOptional" - $ref: "#/components/parameters/BlobContentType" - $ref: "#/components/parameters/BlobContentEncoding" - $ref: "#/components/parameters/BlobContentLanguage" - $ref: "#/components/parameters/BlobContentMD5" - $ref: "#/components/parameters/BlobCacheControl" - $ref: "#/components/parameters/Metadata" - $ref: "#/components/parameters/LeaseIdOptional" - $ref: "#/components/parameters/BlobContentDisposition" - $ref: "#/components/parameters/EncryptionKey" - $ref: "#/components/parameters/EncryptionKeySha256" - $ref: "#/components/parameters/EncryptionAlgorithm" - $ref: "#/components/parameters/EncryptionScope" - $ref: "#/components/parameters/IfModifiedSince" - $ref: "#/components/parameters/IfUnmodifiedSince" - $ref: "#/components/parameters/IfMatch" - $ref: "#/components/parameters/IfNoneMatch" - $ref: "#/components/parameters/IfTags" - $ref: "#/components/parameters/BlobContentLengthRequired" - $ref: "#/components/parameters/BlobSequenceNumber" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/BlobTagsHeader" - $ref: "#/components/parameters/ImmutabilityPolicyExpiry" - $ref: "#/components/parameters/ImmutabilityPolicyMode" - $ref: "#/components/parameters/LegalHoldOptional" responses: "201": description: The blob was created. headers: ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Last-Modified: description: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 Content-MD5: description: If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity. schema: type: string format: byte x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string x-ms-version-id: x-ms-client-name: VersionId description: A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 x-ms-request-server-encrypted: x-ms-client-name: IsServerEncrypted description: The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. schema: type: boolean x-ms-encryption-key-sha256: x-ms-client-name: EncryptionKeySha256 description: The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key. schema: type: string x-ms-encryption-scope: x-ms-client-name: EncryptionScope description: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. schema: type: string default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - $ref: "#/components/parameters/Blob" - name: x-ms-blob-type x-ms-client-name: blobType in: header required: true x-ms-parameter-location: method description: "Specifies the type of blob to create: block blob, page blob, or append blob." x-ms-enum: name: BlobType modelAsString: false schema: type: string enum: - PageBlob "/{containerName}/{blob}?AppendBlob": put: tags: - blob operationId: AppendBlob_Create description: The Create Append Blob operation creates a new append blob. parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/ContentLength" - $ref: "#/components/parameters/BlobContentType" - $ref: "#/components/parameters/BlobContentEncoding" - $ref: "#/components/parameters/BlobContentLanguage" - $ref: "#/components/parameters/BlobContentMD5" - $ref: "#/components/parameters/BlobCacheControl" - $ref: "#/components/parameters/Metadata" - $ref: "#/components/parameters/LeaseIdOptional" - $ref: "#/components/parameters/BlobContentDisposition" - $ref: "#/components/parameters/EncryptionKey" - $ref: "#/components/parameters/EncryptionKeySha256" - $ref: "#/components/parameters/EncryptionAlgorithm" - $ref: "#/components/parameters/EncryptionScope" - $ref: "#/components/parameters/IfModifiedSince" - $ref: "#/components/parameters/IfUnmodifiedSince" - $ref: "#/components/parameters/IfMatch" - $ref: "#/components/parameters/IfNoneMatch" - $ref: "#/components/parameters/IfTags" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/BlobTagsHeader" - $ref: "#/components/parameters/ImmutabilityPolicyExpiry" - $ref: "#/components/parameters/ImmutabilityPolicyMode" - $ref: "#/components/parameters/LegalHoldOptional" responses: "201": description: The blob was created. headers: ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Last-Modified: description: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 Content-MD5: description: If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity. schema: type: string format: byte x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string x-ms-version-id: x-ms-client-name: VersionId description: A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 x-ms-request-server-encrypted: x-ms-client-name: IsServerEncrypted description: The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. schema: type: boolean x-ms-encryption-key-sha256: x-ms-client-name: EncryptionKeySha256 description: The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key. schema: type: string x-ms-encryption-scope: x-ms-client-name: EncryptionScope description: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. schema: type: string default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - $ref: "#/components/parameters/Blob" - name: x-ms-blob-type x-ms-client-name: blobType in: header required: true x-ms-parameter-location: method description: "Specifies the type of blob to create: block blob, page blob, or append blob." x-ms-enum: name: BlobType modelAsString: false schema: type: string enum: - AppendBlob "/{containerName}/{blob}?BlockBlob": put: tags: - blob operationId: BlockBlob_Upload description: The Upload Block Blob operation updates the content of an existing block blob. Updating an existing block blob overwrites any existing metadata on the blob. Partial updates are not supported with Put Blob; the content of the existing blob is overwritten with the content of the new blob. To perform a partial update of the content of a block blob, use the Put Block List operation. parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/ContentMD5" - $ref: "#/components/parameters/ContentLength" - $ref: "#/components/parameters/BlobContentType" - $ref: "#/components/parameters/BlobContentEncoding" - $ref: "#/components/parameters/BlobContentLanguage" - $ref: "#/components/parameters/BlobContentMD5" - $ref: "#/components/parameters/BlobCacheControl" - $ref: "#/components/parameters/Metadata" - $ref: "#/components/parameters/LeaseIdOptional" - $ref: "#/components/parameters/BlobContentDisposition" - $ref: "#/components/parameters/EncryptionKey" - $ref: "#/components/parameters/EncryptionKeySha256" - $ref: "#/components/parameters/EncryptionAlgorithm" - $ref: "#/components/parameters/EncryptionScope" - $ref: "#/components/parameters/AccessTierOptional" - $ref: "#/components/parameters/IfModifiedSince" - $ref: "#/components/parameters/IfUnmodifiedSince" - $ref: "#/components/parameters/IfMatch" - $ref: "#/components/parameters/IfNoneMatch" - $ref: "#/components/parameters/IfTags" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/BlobTagsHeader" - $ref: "#/components/parameters/ImmutabilityPolicyExpiry" - $ref: "#/components/parameters/ImmutabilityPolicyMode" - $ref: "#/components/parameters/LegalHoldOptional" - $ref: "#/components/parameters/ContentCrc64" - $ref: "#/components/parameters/StructuredBodyPut" - $ref: "#/components/parameters/StructuredContentLength" requestBody: $ref: "#/components/requestBodies/BlockBlob_UploadBody" responses: "201": description: The blob was updated. headers: ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Last-Modified: description: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 Content-MD5: description: If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity. schema: type: string format: byte x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string x-ms-version-id: x-ms-client-name: VersionId description: A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 x-ms-request-server-encrypted: x-ms-client-name: IsServerEncrypted description: The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. schema: type: boolean x-ms-encryption-key-sha256: x-ms-client-name: EncryptionKeySha256 description: The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key. schema: type: string x-ms-encryption-scope: x-ms-client-name: EncryptionScope description: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. schema: type: string x-ms-structured-body: x-ms-client-name: StructuredBodyType description: Indicates the structured message body was accepted and mirrors back the message schema version and properties. schema: type: string default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - $ref: "#/components/parameters/Blob" - name: x-ms-blob-type x-ms-client-name: blobType in: header required: true x-ms-parameter-location: method description: "Specifies the type of blob to create: block blob, page blob, or append blob." x-ms-enum: name: BlobType modelAsString: false schema: type: string enum: - BlockBlob "/{containerName}/{blob}?BlockBlob&fromUrl": put: tags: - blob operationId: BlockBlob_PutBlobFromUrl description: The Put Blob from URL operation creates a new Block Blob where the contents of the blob are read from a given URL. This API is supported beginning with the 2020-04-08 version. Partial updates are not supported with Put Blob from URL; the content of an existing blob is overwritten with the content of the new blob. To perform partial updates to a block blob’s contents using a source URL, use the Put Block from URL API in conjunction with Put Block List. parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/ContentMD5" - $ref: "#/components/parameters/ContentLength" - $ref: "#/components/parameters/BlobContentType" - $ref: "#/components/parameters/BlobContentEncoding" - $ref: "#/components/parameters/BlobContentLanguage" - $ref: "#/components/parameters/BlobContentMD5" - $ref: "#/components/parameters/BlobCacheControl" - $ref: "#/components/parameters/Metadata" - $ref: "#/components/parameters/LeaseIdOptional" - $ref: "#/components/parameters/BlobContentDisposition" - $ref: "#/components/parameters/EncryptionKey" - $ref: "#/components/parameters/EncryptionKeySha256" - $ref: "#/components/parameters/EncryptionAlgorithm" - $ref: "#/components/parameters/EncryptionScope" - $ref: "#/components/parameters/AccessTierOptional" - $ref: "#/components/parameters/IfModifiedSince" - $ref: "#/components/parameters/IfUnmodifiedSince" - $ref: "#/components/parameters/IfMatch" - $ref: "#/components/parameters/IfNoneMatch" - $ref: "#/components/parameters/IfTags" - $ref: "#/components/parameters/SourceIfModifiedSince" - $ref: "#/components/parameters/SourceIfUnmodifiedSince" - $ref: "#/components/parameters/SourceIfMatch" - $ref: "#/components/parameters/SourceIfNoneMatch" - $ref: "#/components/parameters/SourceIfTags" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/SourceContentMD5" - $ref: "#/components/parameters/BlobTagsHeader" - $ref: "#/components/parameters/CopySource" - $ref: "#/components/parameters/CopySourceBlobProperties" - $ref: "#/components/parameters/CopySourceAuthorization" - $ref: "#/components/parameters/CopySourceTags" responses: "201": description: The blob was updated. headers: ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Last-Modified: description: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 Content-MD5: description: If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity. schema: type: string format: byte x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string x-ms-version-id: x-ms-client-name: VersionId description: A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 x-ms-request-server-encrypted: x-ms-client-name: IsServerEncrypted description: The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. schema: type: boolean x-ms-encryption-key-sha256: x-ms-client-name: EncryptionKeySha256 description: The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key. schema: type: string x-ms-encryption-scope: x-ms-client-name: EncryptionScope description: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. schema: type: string default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - $ref: "#/components/parameters/Blob" - name: x-ms-blob-type x-ms-client-name: blobType in: header required: true x-ms-parameter-location: method description: "Specifies the type of blob to create: block blob, page blob, or append blob." x-ms-enum: name: BlobType modelAsString: false schema: type: string enum: - BlockBlob "/{containerName}/{blob}?comp=undelete": put: tags: - blob operationId: Blob_Undelete description: Undelete a blob that was previously soft deleted parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" responses: "200": description: The blob was undeleted successfully. headers: x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated. schema: type: string format: date-time-rfc1123 default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - $ref: "#/components/parameters/Blob" - name: comp description: comp in: query required: true schema: type: string enum: - undelete "/{containerName}/{blob}?comp=expiry": put: tags: - blob operationId: Blob_SetExpiry description: Sets the time a blob will expire and be deleted. parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/BlobExpiryOptions" - $ref: "#/components/parameters/BlobExpiryTime" responses: "200": description: The blob expiry was set successfully. headers: ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Last-Modified: description: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated. schema: type: string format: date-time-rfc1123 default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - $ref: "#/components/parameters/Blob" - name: comp description: comp in: query required: true schema: type: string enum: - expiry "/{containerName}/{blob}?comp=properties&SetHTTPHeaders": put: tags: - blob operationId: Blob_SetHTTPHeaders description: The Set HTTP Headers operation sets system properties on the blob parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/BlobCacheControl" - $ref: "#/components/parameters/BlobContentType" - $ref: "#/components/parameters/BlobContentMD5" - $ref: "#/components/parameters/BlobContentEncoding" - $ref: "#/components/parameters/BlobContentLanguage" - $ref: "#/components/parameters/LeaseIdOptional" - $ref: "#/components/parameters/IfModifiedSince" - $ref: "#/components/parameters/IfUnmodifiedSince" - $ref: "#/components/parameters/IfMatch" - $ref: "#/components/parameters/IfNoneMatch" - $ref: "#/components/parameters/IfTags" - $ref: "#/components/parameters/BlobContentDisposition" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" responses: "200": description: The properties were set successfully. headers: ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Last-Modified: description: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 x-ms-blob-sequence-number: x-ms-client-name: BlobSequenceNumber description: The current sequence number for a page blob. This header is not returned for block blobs or append blobs schema: type: integer format: int64 x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - $ref: "#/components/parameters/Blob" - name: comp description: comp in: query required: true schema: type: string enum: - properties "/{containerName}/{blob}?comp=immutabilityPolicies": put: tags: - blob operationId: Blob_SetImmutabilityPolicy description: The Set Immutability Policy operation sets the immutability policy on the blob parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/IfUnmodifiedSince" - $ref: "#/components/parameters/ImmutabilityPolicyExpiry" - $ref: "#/components/parameters/ImmutabilityPolicyMode" - $ref: "#/components/parameters/Snapshot" - $ref: "#/components/parameters/VersionId" responses: "200": description: The immutability policy was successfully set. headers: x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 x-ms-immutability-policy-until-date: x-ms-client-name: ImmutabilityPolicyExpiry description: Indicates the time the immutability policy will expire. schema: type: string format: date-time-rfc1123 x-ms-immutability-policy-mode: x-ms-client-name: ImmutabilityPolicyMode x-ms-enum: name: BlobImmutabilityPolicyMode modelAsString: false description: Indicates immutability policy mode. schema: type: string enum: - Mutable - Unlocked - Locked default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" delete: tags: - blob operationId: Blob_DeleteImmutabilityPolicy description: The Delete Immutability Policy operation deletes the immutability policy on the blob parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/Snapshot" - $ref: "#/components/parameters/VersionId" responses: "200": description: The delete immutability policy request was accepted and the immutability policy will be deleted. headers: x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - $ref: "#/components/parameters/Blob" - name: comp description: comp in: query required: true schema: type: string enum: - immutabilityPolicies "/{containerName}/{blob}?comp=legalhold": put: tags: - blob operationId: Blob_SetLegalHold description: The Set Legal Hold operation sets a legal hold on the blob. parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/LegalHoldRequired" - $ref: "#/components/parameters/Snapshot" - $ref: "#/components/parameters/VersionId" responses: "200": description: The legal hold was successfully set on the blob. headers: x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 x-ms-legal-hold: x-ms-client-name: LegalHold description: Indicates if the blob has a legal hold. schema: type: boolean default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - $ref: "#/components/parameters/Blob" - name: comp description: comp in: query required: true schema: type: string enum: - legalhold "/{containerName}/{blob}?comp=metadata": put: tags: - blob operationId: Blob_SetMetadata description: The Set Blob Metadata operation sets user-defined metadata for the specified blob as one or more name-value pairs parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/Metadata" - $ref: "#/components/parameters/LeaseIdOptional" - $ref: "#/components/parameters/EncryptionKey" - $ref: "#/components/parameters/EncryptionKeySha256" - $ref: "#/components/parameters/EncryptionAlgorithm" - $ref: "#/components/parameters/EncryptionScope" - $ref: "#/components/parameters/IfModifiedSince" - $ref: "#/components/parameters/IfUnmodifiedSince" - $ref: "#/components/parameters/IfMatch" - $ref: "#/components/parameters/IfNoneMatch" - $ref: "#/components/parameters/IfTags" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" responses: "200": description: The metadata was set successfully. headers: ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Last-Modified: description: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string x-ms-version-id: x-ms-client-name: VersionId description: A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 x-ms-request-server-encrypted: x-ms-client-name: IsServerEncrypted description: The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. schema: type: boolean x-ms-encryption-key-sha256: x-ms-client-name: EncryptionKeySha256 description: The SHA-256 hash of the encryption key used to encrypt the metadata. This header is only returned when the metadata was encrypted with a customer-provided key. schema: type: string x-ms-encryption-scope: x-ms-client-name: EncryptionScope description: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. schema: type: string default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - $ref: "#/components/parameters/Blob" - name: comp description: comp in: query required: true schema: type: string enum: - metadata "/{containerName}/{blob}?comp=lease&acquire": put: tags: - blob operationId: Blob_AcquireLease description: "[Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations" parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/LeaseDuration" - $ref: "#/components/parameters/ProposedLeaseIdOptional" - $ref: "#/components/parameters/IfModifiedSince" - $ref: "#/components/parameters/IfUnmodifiedSince" - $ref: "#/components/parameters/IfMatch" - $ref: "#/components/parameters/IfNoneMatch" - $ref: "#/components/parameters/IfTags" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" responses: "201": description: The Acquire operation completed successfully. headers: ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Last-Modified: description: Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 x-ms-lease-id: x-ms-client-name: LeaseId description: Uniquely identifies a blobs' lease schema: type: string x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - $ref: "#/components/parameters/Blob" - name: comp description: comp in: query required: true schema: type: string enum: - lease - name: x-ms-lease-action x-ms-client-name: action in: header required: true x-ms-enum: name: LeaseAction modelAsString: false x-ms-parameter-location: method description: Describes what lease action to take. schema: type: string enum: - acquire "/{containerName}/{blob}?comp=lease&release": put: tags: - blob operationId: Blob_ReleaseLease description: "[Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations" parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/LeaseIdRequired" - $ref: "#/components/parameters/IfModifiedSince" - $ref: "#/components/parameters/IfUnmodifiedSince" - $ref: "#/components/parameters/IfMatch" - $ref: "#/components/parameters/IfNoneMatch" - $ref: "#/components/parameters/IfTags" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" responses: "200": description: The Release operation completed successfully. headers: ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Last-Modified: description: Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - $ref: "#/components/parameters/Blob" - name: comp description: comp in: query required: true schema: type: string enum: - lease - name: x-ms-lease-action x-ms-client-name: action in: header required: true x-ms-enum: name: LeaseAction modelAsString: false x-ms-parameter-location: method description: Describes what lease action to take. schema: type: string enum: - release "/{containerName}/{blob}?comp=lease&renew": put: tags: - blob operationId: Blob_RenewLease description: "[Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations" parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/LeaseIdRequired" - $ref: "#/components/parameters/IfModifiedSince" - $ref: "#/components/parameters/IfUnmodifiedSince" - $ref: "#/components/parameters/IfMatch" - $ref: "#/components/parameters/IfNoneMatch" - $ref: "#/components/parameters/IfTags" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" responses: "200": description: The Renew operation completed successfully. headers: ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Last-Modified: description: Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 x-ms-lease-id: x-ms-client-name: LeaseId description: Uniquely identifies a blobs' lease schema: type: string x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - $ref: "#/components/parameters/Blob" - name: comp description: comp in: query required: true schema: type: string enum: - lease - name: x-ms-lease-action x-ms-client-name: action in: header required: true x-ms-enum: name: LeaseAction modelAsString: false x-ms-parameter-location: method description: Describes what lease action to take. schema: type: string enum: - renew "/{containerName}/{blob}?comp=lease&change": put: tags: - blob operationId: Blob_ChangeLease description: "[Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations" parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/LeaseIdRequired" - $ref: "#/components/parameters/ProposedLeaseIdRequired" - $ref: "#/components/parameters/IfModifiedSince" - $ref: "#/components/parameters/IfUnmodifiedSince" - $ref: "#/components/parameters/IfMatch" - $ref: "#/components/parameters/IfNoneMatch" - $ref: "#/components/parameters/IfTags" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" responses: "200": description: The Change operation completed successfully. headers: ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Last-Modified: description: Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-lease-id: x-ms-client-name: LeaseId description: Uniquely identifies a blobs' lease schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - $ref: "#/components/parameters/Blob" - name: comp description: comp in: query required: true schema: type: string enum: - lease - name: x-ms-lease-action x-ms-client-name: action in: header required: true x-ms-enum: name: LeaseAction modelAsString: false x-ms-parameter-location: method description: Describes what lease action to take. schema: type: string enum: - change "/{containerName}/{blob}?comp=lease&break": put: tags: - blob operationId: Blob_BreakLease description: "[Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations" parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/LeaseBreakPeriod" - $ref: "#/components/parameters/IfModifiedSince" - $ref: "#/components/parameters/IfUnmodifiedSince" - $ref: "#/components/parameters/IfMatch" - $ref: "#/components/parameters/IfNoneMatch" - $ref: "#/components/parameters/IfTags" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" responses: "202": description: The Break operation completed successfully. headers: ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Last-Modified: description: Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 x-ms-lease-time: x-ms-client-name: LeaseTime description: Approximate time remaining in the lease period, in seconds. schema: type: integer x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - $ref: "#/components/parameters/Blob" - name: comp description: comp in: query required: true schema: type: string enum: - lease - name: x-ms-lease-action x-ms-client-name: action in: header required: true x-ms-enum: name: LeaseAction modelAsString: false x-ms-parameter-location: method description: Describes what lease action to take. schema: type: string enum: - break "/{containerName}/{blob}?comp=snapshot": put: tags: - blob operationId: Blob_CreateSnapshot description: The Create Snapshot operation creates a read-only snapshot of a blob parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/Metadata" - $ref: "#/components/parameters/EncryptionKey" - $ref: "#/components/parameters/EncryptionKeySha256" - $ref: "#/components/parameters/EncryptionAlgorithm" - $ref: "#/components/parameters/EncryptionScope" - $ref: "#/components/parameters/IfModifiedSince" - $ref: "#/components/parameters/IfUnmodifiedSince" - $ref: "#/components/parameters/IfMatch" - $ref: "#/components/parameters/IfNoneMatch" - $ref: "#/components/parameters/IfTags" - $ref: "#/components/parameters/LeaseIdOptional" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" responses: "201": description: The snaptshot was taken successfully. headers: x-ms-snapshot: x-ms-client-name: Snapshot description: Uniquely identifies the snapshot and indicates the snapshot version. It may be used in subsequent requests to access the snapshot schema: type: string ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Last-Modified: description: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string x-ms-version-id: x-ms-client-name: VersionId description: A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 x-ms-request-server-encrypted: x-ms-client-name: IsServerEncrypted description: True if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. For a snapshot request, this header is set to true when metadata was provided in the request and encrypted with a customer-provided key. schema: type: boolean default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - $ref: "#/components/parameters/Blob" - name: comp description: comp in: query required: true schema: type: string enum: - snapshot "/{containerName}/{blob}?comp=copy": put: tags: - blob operationId: Blob_StartCopyFromURL description: The Start Copy From URL operation copies a blob or an internet resource to a new blob. parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/Metadata" - $ref: "#/components/parameters/AccessTierOptional" - $ref: "#/components/parameters/RehydratePriority" - $ref: "#/components/parameters/SourceIfModifiedSince" - $ref: "#/components/parameters/SourceIfUnmodifiedSince" - $ref: "#/components/parameters/SourceIfMatch" - $ref: "#/components/parameters/SourceIfNoneMatch" - $ref: "#/components/parameters/SourceIfTags" - $ref: "#/components/parameters/IfModifiedSince" - $ref: "#/components/parameters/IfUnmodifiedSince" - $ref: "#/components/parameters/IfMatch" - $ref: "#/components/parameters/IfNoneMatch" - $ref: "#/components/parameters/IfTags" - $ref: "#/components/parameters/CopySource" - $ref: "#/components/parameters/LeaseIdOptional" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/BlobTagsHeader" - $ref: "#/components/parameters/SealBlob" - $ref: "#/components/parameters/ImmutabilityPolicyExpiry" - $ref: "#/components/parameters/ImmutabilityPolicyMode" - $ref: "#/components/parameters/LegalHoldOptional" responses: "202": description: The copy blob has been accepted with the specified copy status. headers: ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Last-Modified: description: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string x-ms-version-id: x-ms-client-name: VersionId description: A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 x-ms-copy-id: x-ms-client-name: CopyId description: String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy. schema: type: string x-ms-copy-status: x-ms-client-name: CopyStatus description: State of the copy operation identified by x-ms-copy-id. x-ms-enum: name: CopyStatusType modelAsString: false schema: type: string enum: - pending - success - aborted - failed default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - $ref: "#/components/parameters/Blob" - name: comp description: comp in: query required: true schema: type: string enum: - copy "/{containerName}/{blob}?comp=copy&sync": put: tags: - blob operationId: Blob_CopyFromURL description: The Copy From URL operation copies a blob or an internet resource to a new blob. It will not return a response until the copy is complete. parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/Metadata" - $ref: "#/components/parameters/AccessTierOptional" - $ref: "#/components/parameters/SourceIfModifiedSince" - $ref: "#/components/parameters/SourceIfUnmodifiedSince" - $ref: "#/components/parameters/SourceIfMatch" - $ref: "#/components/parameters/SourceIfNoneMatch" - $ref: "#/components/parameters/IfModifiedSince" - $ref: "#/components/parameters/IfUnmodifiedSince" - $ref: "#/components/parameters/IfMatch" - $ref: "#/components/parameters/IfNoneMatch" - $ref: "#/components/parameters/IfTags" - $ref: "#/components/parameters/CopySource" - $ref: "#/components/parameters/LeaseIdOptional" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/SourceContentMD5" - $ref: "#/components/parameters/BlobTagsHeader" - $ref: "#/components/parameters/ImmutabilityPolicyExpiry" - $ref: "#/components/parameters/ImmutabilityPolicyMode" - $ref: "#/components/parameters/LegalHoldOptional" - $ref: "#/components/parameters/CopySourceAuthorization" - $ref: "#/components/parameters/EncryptionScope" - $ref: "#/components/parameters/CopySourceTags" responses: "202": description: The copy has completed. headers: ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Last-Modified: description: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string x-ms-version-id: x-ms-client-name: VersionId description: A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 x-ms-copy-id: x-ms-client-name: CopyId description: String identifier for this copy operation. schema: type: string x-ms-copy-status: x-ms-client-name: CopyStatus description: State of the copy operation identified by x-ms-copy-id. x-ms-enum: name: SyncCopyStatusType modelAsString: false schema: type: string enum: - success Content-MD5: description: This response header is returned so that the client can check for the integrity of the copied content. This header is only returned if the source content MD5 was specified. schema: type: string format: byte x-ms-content-crc64: description: This response header is returned so that the client can check for the integrity of the copied content. schema: type: string format: byte x-ms-encryption-scope: x-ms-client-name: EncryptionScope description: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. schema: type: string default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - $ref: "#/components/parameters/Blob" - name: comp description: comp in: query required: true schema: type: string enum: - copy - name: x-ms-requires-sync description: This header indicates that this is a synchronous Copy Blob From URL instead of a Asynchronous Copy Blob. in: header required: true schema: type: string enum: - "true" "/{containerName}/{blob}?comp=copy©id": put: tags: - blob operationId: Blob_AbortCopyFromURL description: The Abort Copy From URL operation aborts a pending Copy From URL operation, and leaves a destination blob with zero length and full metadata. parameters: - $ref: "#/components/parameters/CopyId" - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/LeaseIdOptional" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" responses: "204": description: The delete request was accepted and the blob will be deleted. headers: x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - $ref: "#/components/parameters/Blob" - name: comp description: comp in: query required: true schema: type: string enum: - copy - name: x-ms-copy-action description: Copy action. x-ms-client-name: copyActionAbortConstant in: header required: true x-ms-parameter-location: method schema: type: string enum: - abort "/{containerName}/{blob}?comp=tier": put: tags: - blobs operationId: Blob_SetTier description: The Set Tier operation sets the tier on a blob. The operation is allowed on a page blob in a premium storage account and on a block blob in a blob storage account (locally redundant storage only). A premium page blob's tier determines the allowed size, IOPS, and bandwidth of the blob. A block blob's tier determines Hot/Cool/Archive storage type. This operation does not update the blob's ETag. parameters: - $ref: "#/components/parameters/Snapshot" - $ref: "#/components/parameters/VersionId" - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/AccessTierRequired" - $ref: "#/components/parameters/RehydratePriority" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/LeaseIdOptional" - $ref: "#/components/parameters/IfTags" responses: "200": description: The new tier will take effect immediately. headers: x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and newer. schema: type: string "202": description: The transition to the new tier is pending. headers: x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and newer. schema: type: string default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - $ref: "#/components/parameters/Blob" - name: comp description: comp in: query required: true schema: type: string enum: - tier "/{containerName}/{blob}?restype=account&comp=properties&blob": get: tags: - blob operationId: Blob_GetAccountInfo description: "Returns the sku name and account kind " parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" responses: "200": description: Success (OK) headers: x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 x-ms-sku-name: x-ms-client-name: SkuName x-ms-enum: name: SkuName modelAsString: false description: Identifies the sku name of the account schema: type: string enum: - Standard_LRS - Standard_GRS - Standard_RAGRS - Standard_ZRS - Premium_LRS x-ms-account-kind: x-ms-client-name: AccountKind x-ms-enum: name: AccountKind modelAsString: false description: Identifies the account kind schema: type: string enum: - Storage - BlobStorage - StorageV2 - FileStorage - BlockBlobStorage x-ms-is-hns-enabled: x-ms-client-name: IsHierarchicalNamespaceEnabled description: Version 2019-07-07 and newer. Indicates if the account has a hierarchical namespace enabled. schema: type: boolean default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - $ref: "#/components/parameters/Blob" - name: restype description: restype in: query required: true schema: type: string enum: - account - name: comp description: comp in: query required: true schema: type: string enum: - properties "/{containerName}/{blob}?comp=block": put: tags: - blockblob operationId: BlockBlob_StageBlock description: The Stage Block operation creates a new block to be committed as part of a blob parameters: - $ref: "#/components/parameters/BlockId" - $ref: "#/components/parameters/ContentLength" - $ref: "#/components/parameters/ContentMD5" - $ref: "#/components/parameters/ContentCrc64" - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/LeaseIdOptional" - $ref: "#/components/parameters/EncryptionKey" - $ref: "#/components/parameters/EncryptionKeySha256" - $ref: "#/components/parameters/EncryptionAlgorithm" - $ref: "#/components/parameters/EncryptionScope" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/StructuredBodyPut" - $ref: "#/components/parameters/StructuredContentLength" requestBody: $ref: "#/components/requestBodies/BlockBlob_UploadBody" responses: "201": description: The block was created. headers: Content-MD5: description: This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers. schema: type: string format: byte x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 x-ms-content-crc64: description: This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers. schema: type: string format: byte x-ms-request-server-encrypted: x-ms-client-name: IsServerEncrypted description: The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. schema: type: boolean x-ms-encryption-key-sha256: x-ms-client-name: EncryptionKeySha256 description: The SHA-256 hash of the encryption key used to encrypt the block. This header is only returned when the block was encrypted with a customer-provided key. schema: type: string x-ms-encryption-scope: x-ms-client-name: EncryptionScope description: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. schema: type: string x-ms-structured-body: x-ms-client-name: StructuredBodyType description: Indicates the structured message body was accepted and mirrors back the message schema version and properties. schema: type: string default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - $ref: "#/components/parameters/Blob" - name: comp description: comp in: query required: true schema: type: string enum: - block "/{containerName}/{blob}?comp=block&fromURL": put: tags: - blockblob operationId: BlockBlob_StageBlockFromURL description: The Stage Block operation creates a new block to be committed as part of a blob where the contents are read from a URL. parameters: - $ref: "#/components/parameters/BlockId" - $ref: "#/components/parameters/ContentLength" - $ref: "#/components/parameters/SourceUrl" - $ref: "#/components/parameters/SourceRange" - $ref: "#/components/parameters/SourceContentMD5" - $ref: "#/components/parameters/SourceContentCRC64" - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/EncryptionKey" - $ref: "#/components/parameters/EncryptionKeySha256" - $ref: "#/components/parameters/EncryptionAlgorithm" - $ref: "#/components/parameters/EncryptionScope" - $ref: "#/components/parameters/LeaseIdOptional" - $ref: "#/components/parameters/SourceIfModifiedSince" - $ref: "#/components/parameters/SourceIfUnmodifiedSince" - $ref: "#/components/parameters/SourceIfMatch" - $ref: "#/components/parameters/SourceIfNoneMatch" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/CopySourceAuthorization" responses: "201": description: The block was created. headers: Content-MD5: description: This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers. schema: type: string format: byte x-ms-content-crc64: description: This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers. schema: type: string format: byte x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 x-ms-request-server-encrypted: x-ms-client-name: IsServerEncrypted description: The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. schema: type: boolean x-ms-encryption-key-sha256: x-ms-client-name: EncryptionKeySha256 description: The SHA-256 hash of the encryption key used to encrypt the block. This header is only returned when the block was encrypted with a customer-provided key. schema: type: string x-ms-encryption-scope: x-ms-client-name: EncryptionScope description: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. schema: type: string default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - $ref: "#/components/parameters/Blob" - name: comp description: comp in: query required: true schema: type: string enum: - block "/{containerName}/{blob}?comp=blocklist": put: tags: - blockblob operationId: BlockBlob_CommitBlockList description: The Commit Block List operation writes a blob by specifying the list of block IDs that make up the blob. In order to be written as part of a blob, a block must have been successfully written to the server in a prior Put Block operation. You can call Put Block List to update a blob by uploading only those blocks that have changed, then committing the new and existing blocks together. You can do this by specifying whether to commit a block from the committed block list or from the uncommitted block list, or to commit the most recently uploaded version of the block, whichever list it may belong to. parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/BlobCacheControl" - $ref: "#/components/parameters/BlobContentType" - $ref: "#/components/parameters/BlobContentEncoding" - $ref: "#/components/parameters/BlobContentLanguage" - $ref: "#/components/parameters/BlobContentMD5" - $ref: "#/components/parameters/ContentMD5" - $ref: "#/components/parameters/ContentCrc64" - $ref: "#/components/parameters/Metadata" - $ref: "#/components/parameters/LeaseIdOptional" - $ref: "#/components/parameters/BlobContentDisposition" - $ref: "#/components/parameters/EncryptionKey" - $ref: "#/components/parameters/EncryptionKeySha256" - $ref: "#/components/parameters/EncryptionAlgorithm" - $ref: "#/components/parameters/EncryptionScope" - $ref: "#/components/parameters/AccessTierOptional" - $ref: "#/components/parameters/IfModifiedSince" - $ref: "#/components/parameters/IfUnmodifiedSince" - $ref: "#/components/parameters/IfMatch" - $ref: "#/components/parameters/IfNoneMatch" - $ref: "#/components/parameters/IfTags" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/BlobTagsHeader" - $ref: "#/components/parameters/ImmutabilityPolicyExpiry" - $ref: "#/components/parameters/ImmutabilityPolicyMode" - $ref: "#/components/parameters/LegalHoldOptional" requestBody: content: application/xml: schema: $ref: "#/components/schemas/BlockLookupList" description: Blob Blocks. required: true responses: "201": description: The block list was recorded. headers: ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Last-Modified: description: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 Content-MD5: description: This header is returned so that the client can check for message content integrity. This header refers to the content of the request, meaning, in this case, the list of blocks, and not the content of the blob itself. schema: type: string format: byte x-ms-content-crc64: description: This header is returned so that the client can check for message content integrity. This header refers to the content of the request, meaning, in this case, the list of blocks, and not the content of the blob itself. schema: type: string format: byte x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string x-ms-version-id: x-ms-client-name: VersionId description: A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 x-ms-request-server-encrypted: x-ms-client-name: IsServerEncrypted description: The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. schema: type: boolean x-ms-encryption-key-sha256: x-ms-client-name: EncryptionKeySha256 description: The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key. schema: type: string x-ms-encryption-scope: x-ms-client-name: EncryptionScope description: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. schema: type: string default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" get: tags: - blockblob operationId: BlockBlob_GetBlockList description: The Get Block List operation retrieves the list of blocks that have been uploaded as part of a block blob parameters: - $ref: "#/components/parameters/Snapshot" - $ref: "#/components/parameters/BlockListType" - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/LeaseIdOptional" - $ref: "#/components/parameters/IfTags" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" responses: "200": description: The page range was written. headers: Last-Modified: description: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Content-Type: description: The media type of the body of the response. For Get Block List this is 'application/xml' schema: type: string x-ms-blob-content-length: x-ms-client-name: BlobContentLength description: The size of the blob in bytes. schema: type: integer format: int64 x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 content: application/xml: schema: $ref: "#/components/schemas/BlockList" default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - $ref: "#/components/parameters/Blob" - name: comp description: comp in: query required: true schema: type: string enum: - blocklist "/{containerName}/{blob}?comp=page&update": put: tags: - pageblob operationId: PageBlob_UploadPages description: The Upload Pages operation writes a range of pages to a page blob parameters: - $ref: "#/components/parameters/ContentLength" - $ref: "#/components/parameters/ContentMD5" - $ref: "#/components/parameters/ContentCrc64" - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/Range" - $ref: "#/components/parameters/LeaseIdOptional" - $ref: "#/components/parameters/EncryptionKey" - $ref: "#/components/parameters/EncryptionKeySha256" - $ref: "#/components/parameters/EncryptionAlgorithm" - $ref: "#/components/parameters/EncryptionScope" - $ref: "#/components/parameters/IfSequenceNumberLessThanOrEqualTo" - $ref: "#/components/parameters/IfSequenceNumberLessThan" - $ref: "#/components/parameters/IfSequenceNumberEqualTo" - $ref: "#/components/parameters/IfModifiedSince" - $ref: "#/components/parameters/IfUnmodifiedSince" - $ref: "#/components/parameters/IfMatch" - $ref: "#/components/parameters/IfNoneMatch" - $ref: "#/components/parameters/IfTags" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/StructuredBodyPut" - $ref: "#/components/parameters/StructuredContentLength" requestBody: $ref: "#/components/requestBodies/BlockBlob_UploadBody" responses: "201": description: The page range was written. headers: ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Last-Modified: description: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 Content-MD5: description: If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity. schema: type: string format: byte x-ms-content-crc64: description: This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers. schema: type: string format: byte x-ms-blob-sequence-number: x-ms-client-name: BlobSequenceNumber description: The current sequence number for the page blob. schema: type: integer format: int64 x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 x-ms-request-server-encrypted: x-ms-client-name: IsServerEncrypted description: The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. schema: type: boolean x-ms-encryption-key-sha256: x-ms-client-name: EncryptionKeySha256 description: The SHA-256 hash of the encryption key used to encrypt the pages. This header is only returned when the pages were encrypted with a customer-provided key. schema: type: string x-ms-encryption-scope: x-ms-client-name: EncryptionScope description: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. schema: type: string x-ms-structured-body: x-ms-client-name: StructuredBodyType description: Indicates the structured message body was accepted and mirrors back the message schema version and properties. schema: type: string default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - $ref: "#/components/parameters/Blob" - name: comp description: comp in: query required: true schema: type: string enum: - page - name: x-ms-page-write x-ms-client-name: pageWrite in: header required: true x-ms-parameter-location: method description: >- Required. You may specify one of the following options: - Update: Writes the bytes specified by the request body into the specified range. The Range and Content-Length headers must match to perform the update. - Clear: Clears the specified range and releases the space used in storage for that range. To clear a range, set the Content-Length header to zero, and the Range header to a value that indicates the range to clear, up to maximum blob size. x-ms-enum: name: PageWriteType modelAsString: false schema: type: string enum: - update "/{containerName}/{blob}?comp=page&clear": put: tags: - pageblob operationId: PageBlob_ClearPages description: The Clear Pages operation clears a set of pages from a page blob parameters: - $ref: "#/components/parameters/ContentLength" - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/Range" - $ref: "#/components/parameters/LeaseIdOptional" - $ref: "#/components/parameters/EncryptionKey" - $ref: "#/components/parameters/EncryptionKeySha256" - $ref: "#/components/parameters/EncryptionAlgorithm" - $ref: "#/components/parameters/EncryptionScope" - $ref: "#/components/parameters/IfSequenceNumberLessThanOrEqualTo" - $ref: "#/components/parameters/IfSequenceNumberLessThan" - $ref: "#/components/parameters/IfSequenceNumberEqualTo" - $ref: "#/components/parameters/IfModifiedSince" - $ref: "#/components/parameters/IfUnmodifiedSince" - $ref: "#/components/parameters/IfMatch" - $ref: "#/components/parameters/IfNoneMatch" - $ref: "#/components/parameters/IfTags" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" responses: "201": description: The page range was cleared. headers: ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Last-Modified: description: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 Content-MD5: description: If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity. schema: type: string format: byte x-ms-content-crc64: description: This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers. schema: type: string format: byte x-ms-blob-sequence-number: x-ms-client-name: BlobSequenceNumber description: The current sequence number for the page blob. schema: type: integer format: int64 x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - $ref: "#/components/parameters/Blob" - name: comp description: comp in: query required: true schema: type: string enum: - page - name: x-ms-page-write x-ms-client-name: pageWrite in: header required: true x-ms-parameter-location: method description: >- Required. You may specify one of the following options: - Update: Writes the bytes specified by the request body into the specified range. The Range and Content-Length headers must match to perform the update. - Clear: Clears the specified range and releases the space used in storage for that range. To clear a range, set the Content-Length header to zero, and the Range header to a value that indicates the range to clear, up to maximum blob size. x-ms-enum: name: PageWriteType modelAsString: false schema: type: string enum: - clear "/{containerName}/{blob}?comp=page&update&fromUrl": put: tags: - pageblob operationId: PageBlob_UploadPagesFromURL description: The Upload Pages operation writes a range of pages to a page blob where the contents are read from a URL parameters: - $ref: "#/components/parameters/SourceUrl" - $ref: "#/components/parameters/SourceRangeRequiredPutPageFromUrl" - $ref: "#/components/parameters/SourceContentMD5" - $ref: "#/components/parameters/SourceContentCRC64" - $ref: "#/components/parameters/ContentLength" - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/RangeRequiredPutPageFromUrl" - $ref: "#/components/parameters/EncryptionKey" - $ref: "#/components/parameters/EncryptionKeySha256" - $ref: "#/components/parameters/EncryptionAlgorithm" - $ref: "#/components/parameters/EncryptionScope" - $ref: "#/components/parameters/LeaseIdOptional" - $ref: "#/components/parameters/IfSequenceNumberLessThanOrEqualTo" - $ref: "#/components/parameters/IfSequenceNumberLessThan" - $ref: "#/components/parameters/IfSequenceNumberEqualTo" - $ref: "#/components/parameters/IfModifiedSince" - $ref: "#/components/parameters/IfUnmodifiedSince" - $ref: "#/components/parameters/IfMatch" - $ref: "#/components/parameters/IfNoneMatch" - $ref: "#/components/parameters/IfTags" - $ref: "#/components/parameters/SourceIfModifiedSince" - $ref: "#/components/parameters/SourceIfUnmodifiedSince" - $ref: "#/components/parameters/SourceIfMatch" - $ref: "#/components/parameters/SourceIfNoneMatch" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/CopySourceAuthorization" responses: "201": description: The page range was written. headers: ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Last-Modified: description: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 Content-MD5: description: If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity. schema: type: string format: byte x-ms-content-crc64: description: This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers. schema: type: string format: byte x-ms-blob-sequence-number: x-ms-client-name: BlobSequenceNumber description: The current sequence number for the page blob. schema: type: integer format: int64 x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 x-ms-request-server-encrypted: x-ms-client-name: IsServerEncrypted description: The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. schema: type: boolean x-ms-encryption-key-sha256: x-ms-client-name: EncryptionKeySha256 description: The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key. schema: type: string x-ms-encryption-scope: x-ms-client-name: EncryptionScope description: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. schema: type: string default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - $ref: "#/components/parameters/Blob" - name: comp description: comp in: query required: true schema: type: string enum: - page - name: x-ms-page-write x-ms-client-name: pageWrite in: header required: true x-ms-parameter-location: method description: >- Required. You may specify one of the following options: - Update: Writes the bytes specified by the request body into the specified range. The Range and Content-Length headers must match to perform the update. - Clear: Clears the specified range and releases the space used in storage for that range. To clear a range, set the Content-Length header to zero, and the Range header to a value that indicates the range to clear, up to maximum blob size. x-ms-enum: name: PageWriteType modelAsString: false schema: type: string enum: - update "/{containerName}/{blob}?comp=pagelist": get: tags: - pageblob operationId: PageBlob_GetPageRanges description: The Get Page Ranges operation returns the list of valid page ranges for a page blob or snapshot of a page blob parameters: - $ref: "#/components/parameters/Snapshot" - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/Range" - $ref: "#/components/parameters/LeaseIdOptional" - $ref: "#/components/parameters/IfModifiedSince" - $ref: "#/components/parameters/IfUnmodifiedSince" - $ref: "#/components/parameters/IfMatch" - $ref: "#/components/parameters/IfNoneMatch" - $ref: "#/components/parameters/IfTags" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/Marker" - $ref: "#/components/parameters/MaxResults" responses: "200": description: Information on the page blob was found. headers: Last-Modified: description: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string x-ms-blob-content-length: x-ms-client-name: BlobContentLength description: The size of the blob in bytes. schema: type: integer format: int64 x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 content: application/xml: schema: $ref: "#/components/schemas/PageList" default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" x-ms-pageable: nextLinkName: NextMarker parameters: - $ref: "#/components/parameters/ContainerName" - $ref: "#/components/parameters/Blob" - name: comp description: comp in: query required: true schema: type: string enum: - pagelist "/{containerName}/{blob}?comp=pagelist&diff": get: tags: - pageblob operationId: PageBlob_GetPageRangesDiff description: The Get Page Ranges Diff operation returns the list of valid page ranges for a page blob that were changed between target blob and previous snapshot. parameters: - $ref: "#/components/parameters/Snapshot" - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/PrevSnapshot" - $ref: "#/components/parameters/PrevSnapshotUrl" - $ref: "#/components/parameters/Range" - $ref: "#/components/parameters/LeaseIdOptional" - $ref: "#/components/parameters/IfModifiedSince" - $ref: "#/components/parameters/IfUnmodifiedSince" - $ref: "#/components/parameters/IfMatch" - $ref: "#/components/parameters/IfNoneMatch" - $ref: "#/components/parameters/IfTags" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/Marker" - $ref: "#/components/parameters/MaxResults" responses: "200": description: Information on the page blob was found. headers: Last-Modified: description: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string x-ms-blob-content-length: x-ms-client-name: BlobContentLength description: The size of the blob in bytes. schema: type: integer format: int64 x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 content: application/xml: schema: $ref: "#/components/schemas/PageList" default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" x-ms-pageable: nextLinkName: NextMarker parameters: - $ref: "#/components/parameters/ContainerName" - $ref: "#/components/parameters/Blob" - name: comp description: comp in: query required: true schema: type: string enum: - pagelist "/{containerName}/{blob}?comp=properties&Resize": put: tags: - pageblob operationId: PageBlob_Resize description: Resize the Blob parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/LeaseIdOptional" - $ref: "#/components/parameters/EncryptionKey" - $ref: "#/components/parameters/EncryptionKeySha256" - $ref: "#/components/parameters/EncryptionAlgorithm" - $ref: "#/components/parameters/EncryptionScope" - $ref: "#/components/parameters/IfModifiedSince" - $ref: "#/components/parameters/IfUnmodifiedSince" - $ref: "#/components/parameters/IfMatch" - $ref: "#/components/parameters/IfNoneMatch" - $ref: "#/components/parameters/IfTags" - $ref: "#/components/parameters/BlobContentLengthRequired" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" responses: "200": description: The Blob was resized successfully headers: ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Last-Modified: description: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 x-ms-blob-sequence-number: x-ms-client-name: BlobSequenceNumber description: The current sequence number for a page blob. This header is not returned for block blobs or append blobs schema: type: integer format: int64 x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - $ref: "#/components/parameters/Blob" - name: comp description: comp in: query required: true schema: type: string enum: - properties "/{containerName}/{blob}?comp=properties&UpdateSequenceNumber": put: tags: - pageblob operationId: PageBlob_UpdateSequenceNumber description: Update the sequence number of the blob parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/LeaseIdOptional" - $ref: "#/components/parameters/IfModifiedSince" - $ref: "#/components/parameters/IfUnmodifiedSince" - $ref: "#/components/parameters/IfMatch" - $ref: "#/components/parameters/IfNoneMatch" - $ref: "#/components/parameters/IfTags" - $ref: "#/components/parameters/SequenceNumberAction" - $ref: "#/components/parameters/BlobSequenceNumber" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" responses: "200": description: The sequence numbers were updated successfully. headers: ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Last-Modified: description: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 x-ms-blob-sequence-number: x-ms-client-name: BlobSequenceNumber description: The current sequence number for a page blob. This header is not returned for block blobs or append blobs schema: type: integer format: int64 x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - $ref: "#/components/parameters/Blob" - name: comp description: comp in: query required: true schema: type: string enum: - properties "/{containerName}/{blob}?comp=incrementalcopy": put: tags: - pageblob operationId: PageBlob_CopyIncremental description: The Copy Incremental operation copies a snapshot of the source page blob to a destination page blob. The snapshot is copied such that only the differential changes between the previously copied snapshot are transferred to the destination. The copied snapshots are complete copies of the original snapshot and can be read or copied from as usual. This API is supported since REST version 2016-05-31. parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/IfModifiedSince" - $ref: "#/components/parameters/IfUnmodifiedSince" - $ref: "#/components/parameters/IfMatch" - $ref: "#/components/parameters/IfNoneMatch" - $ref: "#/components/parameters/IfTags" - $ref: "#/components/parameters/CopySource" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" responses: "202": description: The blob was copied. headers: ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Last-Modified: description: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 x-ms-copy-id: x-ms-client-name: CopyId description: String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy. schema: type: string x-ms-copy-status: x-ms-client-name: CopyStatus description: State of the copy operation identified by x-ms-copy-id. x-ms-enum: name: CopyStatusType modelAsString: false schema: type: string enum: - pending - success - aborted - failed default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - $ref: "#/components/parameters/Blob" - name: comp description: comp in: query required: true schema: type: string enum: - incrementalcopy "/{containerName}/{blob}?comp=appendblock": put: tags: - appendblob operationId: AppendBlob_AppendBlock description: The Append Block operation commits a new block of data to the end of an existing append blob. The Append Block operation is permitted only if the blob was created with x-ms-blob-type set to AppendBlob. Append Block is supported only on version 2015-02-21 version or later. parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/ContentLength" - $ref: "#/components/parameters/ContentMD5" - $ref: "#/components/parameters/ContentCrc64" - $ref: "#/components/parameters/LeaseIdOptional" - $ref: "#/components/parameters/BlobConditionMaxSize" - $ref: "#/components/parameters/BlobConditionAppendPos" - $ref: "#/components/parameters/EncryptionKey" - $ref: "#/components/parameters/EncryptionKeySha256" - $ref: "#/components/parameters/EncryptionAlgorithm" - $ref: "#/components/parameters/EncryptionScope" - $ref: "#/components/parameters/IfModifiedSince" - $ref: "#/components/parameters/IfUnmodifiedSince" - $ref: "#/components/parameters/IfMatch" - $ref: "#/components/parameters/IfNoneMatch" - $ref: "#/components/parameters/IfTags" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/StructuredBodyPut" - $ref: "#/components/parameters/StructuredContentLength" requestBody: $ref: "#/components/requestBodies/BlockBlob_UploadBody" responses: "201": description: The block was created. headers: ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Last-Modified: description: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 Content-MD5: description: If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity. schema: type: string format: byte x-ms-content-crc64: description: This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers. schema: type: string format: byte x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 x-ms-blob-append-offset: x-ms-client-name: BlobAppendOffset description: This response header is returned only for append operations. It returns the offset at which the block was committed, in bytes. schema: type: string x-ms-blob-committed-block-count: x-ms-client-name: BlobCommittedBlockCount description: The number of committed blocks present in the blob. This header is returned only for append blobs. schema: type: integer x-ms-request-server-encrypted: x-ms-client-name: IsServerEncrypted description: The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. schema: type: boolean x-ms-encryption-key-sha256: x-ms-client-name: EncryptionKeySha256 description: The SHA-256 hash of the encryption key used to encrypt the block. This header is only returned when the block was encrypted with a customer-provided key. schema: type: string x-ms-encryption-scope: x-ms-client-name: EncryptionScope description: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. schema: type: string x-ms-structured-body: x-ms-client-name: StructuredBodyType description: Indicates the structured message body was accepted and mirrors back the message schema version and properties. schema: type: string default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - $ref: "#/components/parameters/Blob" - name: comp description: comp in: query required: true schema: type: string enum: - appendblock "/{containerName}/{blob}?comp=appendblock&fromUrl": put: tags: - appendblob operationId: AppendBlob_AppendBlockFromUrl description: The Append Block operation commits a new block of data to the end of an existing append blob where the contents are read from a source url. The Append Block operation is permitted only if the blob was created with x-ms-blob-type set to AppendBlob. Append Block is supported only on version 2015-02-21 version or later. parameters: - $ref: "#/components/parameters/SourceUrl" - $ref: "#/components/parameters/SourceRange" - $ref: "#/components/parameters/SourceContentMD5" - $ref: "#/components/parameters/SourceContentCRC64" - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/ContentLength" - $ref: "#/components/parameters/ContentMD5" - $ref: "#/components/parameters/EncryptionKey" - $ref: "#/components/parameters/EncryptionKeySha256" - $ref: "#/components/parameters/EncryptionAlgorithm" - $ref: "#/components/parameters/EncryptionScope" - $ref: "#/components/parameters/LeaseIdOptional" - $ref: "#/components/parameters/BlobConditionMaxSize" - $ref: "#/components/parameters/BlobConditionAppendPos" - $ref: "#/components/parameters/IfModifiedSince" - $ref: "#/components/parameters/IfUnmodifiedSince" - $ref: "#/components/parameters/IfMatch" - $ref: "#/components/parameters/IfNoneMatch" - $ref: "#/components/parameters/IfTags" - $ref: "#/components/parameters/SourceIfModifiedSince" - $ref: "#/components/parameters/SourceIfUnmodifiedSince" - $ref: "#/components/parameters/SourceIfMatch" - $ref: "#/components/parameters/SourceIfNoneMatch" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/CopySourceAuthorization" responses: "201": description: The block was created. headers: ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Last-Modified: description: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 Content-MD5: description: If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity. schema: type: string format: byte x-ms-content-crc64: description: This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers. schema: type: string format: byte x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 x-ms-blob-append-offset: x-ms-client-name: BlobAppendOffset description: This response header is returned only for append operations. It returns the offset at which the block was committed, in bytes. schema: type: string x-ms-blob-committed-block-count: x-ms-client-name: BlobCommittedBlockCount description: The number of committed blocks present in the blob. This header is returned only for append blobs. schema: type: integer x-ms-encryption-key-sha256: x-ms-client-name: EncryptionKeySha256 description: The SHA-256 hash of the encryption key used to encrypt the block. This header is only returned when the block was encrypted with a customer-provided key. schema: type: string x-ms-encryption-scope: x-ms-client-name: EncryptionScope description: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. schema: type: string x-ms-request-server-encrypted: x-ms-client-name: IsServerEncrypted description: The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. schema: type: boolean default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - $ref: "#/components/parameters/Blob" - name: comp description: comp in: query required: true schema: type: string enum: - appendblock "/{containerName}/{blob}?comp=seal": put: tags: - appendblob operationId: AppendBlob_Seal description: The Seal operation seals the Append Blob to make it read-only. Seal is supported only on version 2019-12-12 version or later. parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/LeaseIdOptional" - $ref: "#/components/parameters/IfModifiedSince" - $ref: "#/components/parameters/IfUnmodifiedSince" - $ref: "#/components/parameters/IfMatch" - $ref: "#/components/parameters/IfNoneMatch" - $ref: "#/components/parameters/BlobConditionAppendPos" responses: "200": description: The blob was sealed. headers: ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Last-Modified: description: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 x-ms-blob-sealed: x-ms-client-name: IsSealed description: If this blob has been sealed schema: type: boolean default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - $ref: "#/components/parameters/Blob" - name: comp description: comp in: query required: true schema: type: string enum: - seal "/{containerName}/{blob}?comp=query": post: tags: - blob operationId: Blob_Query description: The Query operation enables users to select/project on blob data by providing simple query expressions. parameters: - $ref: "#/components/parameters/Snapshot" - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/LeaseIdOptional" - $ref: "#/components/parameters/EncryptionKey" - $ref: "#/components/parameters/EncryptionKeySha256" - $ref: "#/components/parameters/EncryptionAlgorithm" - $ref: "#/components/parameters/IfModifiedSince" - $ref: "#/components/parameters/IfUnmodifiedSince" - $ref: "#/components/parameters/IfMatch" - $ref: "#/components/parameters/IfNoneMatch" - $ref: "#/components/parameters/IfTags" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" requestBody: content: application/xml: schema: $ref: "#/components/schemas/QueryRequest" description: the query request x-ms-parameter-location: client responses: "200": description: Returns the content of the entire blob. headers: Last-Modified: description: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 x-ms-meta: x-ms-client-name: Metadata x-ms-header-collection-prefix: x-ms-meta- schema: type: string Content-Length: description: The number of bytes present in the response body. schema: type: integer format: int64 Content-Type: description: The media type of the body of the response. For Download Blob this is 'application/octet-stream' schema: type: string Content-Range: description: Indicates the range of bytes returned in the event that the client requested a subset of the blob by setting the 'Range' request header. schema: type: string ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Content-MD5: description: If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity. schema: type: string format: byte Content-Encoding: description: This header returns the value that was specified for the Content-Encoding request header schema: type: string Cache-Control: description: This header is returned if it was previously specified for the blob. schema: type: string Content-Disposition: description: This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified. schema: type: string Content-Language: description: This header returns the value that was specified for the Content-Language request header. schema: type: string x-ms-blob-sequence-number: x-ms-client-name: BlobSequenceNumber description: The current sequence number for a page blob. This header is not returned for block blobs or append blobs schema: type: integer format: int64 x-ms-blob-type: x-ms-client-name: BlobType description: The blob's type. x-ms-enum: name: BlobType modelAsString: false schema: type: string enum: - BlockBlob - PageBlob - AppendBlob x-ms-copy-completion-time: x-ms-client-name: CopyCompletionTime description: Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List. schema: type: string format: date-time-rfc1123 x-ms-copy-status-description: x-ms-client-name: CopyStatusDescription description: Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List schema: type: string x-ms-copy-id: x-ms-client-name: CopyId description: String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy. schema: type: string x-ms-copy-progress: x-ms-client-name: CopyProgress description: Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob. Can show between 0 and Content-Length bytes copied. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List schema: type: string x-ms-copy-source: x-ms-client-name: CopySource description: URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List. schema: type: string x-ms-copy-status: x-ms-client-name: CopyStatus description: State of the copy operation identified by x-ms-copy-id. x-ms-enum: name: CopyStatusType modelAsString: false schema: type: string enum: - pending - success - aborted - failed x-ms-lease-duration: x-ms-client-name: LeaseDuration description: When a blob is leased, specifies whether the lease is of infinite or fixed duration. x-ms-enum: name: LeaseDurationType modelAsString: false schema: type: string enum: - infinite - fixed x-ms-lease-state: x-ms-client-name: LeaseState description: Lease state of the blob. x-ms-enum: name: LeaseStateType modelAsString: false schema: type: string enum: - available - leased - expired - breaking - broken x-ms-lease-status: x-ms-client-name: LeaseStatus description: The current lease status of the blob. x-ms-enum: name: LeaseStatusType modelAsString: false schema: type: string enum: - locked - unlocked x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Accept-Ranges: description: Indicates that the service supports requests for partial blob content. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 x-ms-blob-committed-block-count: x-ms-client-name: BlobCommittedBlockCount description: The number of committed blocks present in the blob. This header is returned only for append blobs. schema: type: integer x-ms-server-encrypted: x-ms-client-name: IsServerEncrypted description: The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the blob is unencrypted, or if only parts of the blob/application metadata are encrypted). schema: type: boolean x-ms-encryption-key-sha256: x-ms-client-name: EncryptionKeySha256 description: The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key. schema: type: string x-ms-encryption-scope: x-ms-client-name: EncryptionScope description: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. schema: type: string x-ms-blob-content-md5: x-ms-client-name: BlobContentMD5 description: If the blob has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole blob's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range schema: type: string format: byte content: application/xml: schema: type: object format: file "206": description: Returns the content of a specified range of the blob. headers: Last-Modified: description: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. schema: type: string format: date-time-rfc1123 x-ms-meta: x-ms-client-name: Metadata x-ms-header-collection-prefix: x-ms-meta- schema: type: string Content-Length: description: The number of bytes present in the response body. schema: type: integer format: int64 Content-Type: description: The media type of the body of the response. For Download Blob this is 'application/octet-stream' schema: type: string Content-Range: description: Indicates the range of bytes returned in the event that the client requested a subset of the blob by setting the 'Range' request header. schema: type: string ETag: description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. schema: type: string Content-MD5: description: If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity. schema: type: string format: byte Content-Encoding: description: This header returns the value that was specified for the Content-Encoding request header schema: type: string Cache-Control: description: This header is returned if it was previously specified for the blob. schema: type: string Content-Disposition: description: This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified. schema: type: string Content-Language: description: This header returns the value that was specified for the Content-Language request header. schema: type: string x-ms-blob-sequence-number: x-ms-client-name: BlobSequenceNumber description: The current sequence number for a page blob. This header is not returned for block blobs or append blobs schema: type: integer format: int64 x-ms-blob-type: x-ms-client-name: BlobType description: The blob's type. x-ms-enum: name: BlobType modelAsString: false schema: type: string enum: - BlockBlob - PageBlob - AppendBlob x-ms-content-crc64: x-ms-client-name: ContentCrc64 description: If the request is to read a specified range and the x-ms-range-get-content-crc64 is set to true, then the request returns a crc64 for the range, as long as the range size is less than or equal to 4 MB. If both x-ms-range-get-content-crc64 and x-ms-range-get-content-md5 is specified in the same request, it will fail with 400(Bad Request) schema: type: string format: byte x-ms-copy-completion-time: x-ms-client-name: CopyCompletionTime description: Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List. schema: type: string format: date-time-rfc1123 x-ms-copy-status-description: x-ms-client-name: CopyStatusDescription description: Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List schema: type: string x-ms-copy-id: x-ms-client-name: CopyId description: String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy. schema: type: string x-ms-copy-progress: x-ms-client-name: CopyProgress description: Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob. Can show between 0 and Content-Length bytes copied. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List schema: type: string x-ms-copy-source: x-ms-client-name: CopySource description: URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List. schema: type: string x-ms-copy-status: x-ms-client-name: CopyStatus description: State of the copy operation identified by x-ms-copy-id. x-ms-enum: name: CopyStatusType modelAsString: false schema: type: string enum: - pending - success - aborted - failed x-ms-lease-duration: x-ms-client-name: LeaseDuration description: When a blob is leased, specifies whether the lease is of infinite or fixed duration. x-ms-enum: name: LeaseDurationType modelAsString: false schema: type: string enum: - infinite - fixed x-ms-lease-state: x-ms-client-name: LeaseState description: Lease state of the blob. x-ms-enum: name: LeaseStateType modelAsString: false schema: type: string enum: - available - leased - expired - breaking - broken x-ms-lease-status: x-ms-client-name: LeaseStatus description: The current lease status of the blob. x-ms-enum: name: LeaseStatusType modelAsString: false schema: type: string enum: - locked - unlocked x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Accept-Ranges: description: Indicates that the service supports requests for partial blob content. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 x-ms-blob-committed-block-count: x-ms-client-name: BlobCommittedBlockCount description: The number of committed blocks present in the blob. This header is returned only for append blobs. schema: type: integer x-ms-server-encrypted: x-ms-client-name: IsServerEncrypted description: The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the blob is unencrypted, or if only parts of the blob/application metadata are encrypted). schema: type: boolean x-ms-encryption-key-sha256: x-ms-client-name: EncryptionKeySha256 description: The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key. schema: type: string x-ms-encryption-scope: x-ms-client-name: EncryptionScope description: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. schema: type: string x-ms-blob-content-md5: x-ms-client-name: BlobContentMD5 description: If the blob has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole blob's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range schema: type: string format: byte content: application/xml: schema: type: object format: file default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - $ref: "#/components/parameters/Blob" - name: comp description: comp in: query required: true schema: type: string enum: - query "/{containerName}/{blob}?comp=tags": get: tags: - blob operationId: Blob_GetTags description: The Get Tags operation enables users to get the tags associated with a blob. parameters: - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/Snapshot" - $ref: "#/components/parameters/VersionId" - $ref: "#/components/parameters/IfTags" - $ref: "#/components/parameters/LeaseIdOptional" responses: "200": description: Retrieved blob tags headers: x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 content: application/xml: schema: $ref: "#/components/schemas/BlobTags" default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" put: tags: - blob operationId: Blob_SetTags description: The Set Tags operation enables users to set tags on a blob. parameters: - $ref: "#/components/parameters/ApiVersionParameter" - $ref: "#/components/parameters/Timeout" - $ref: "#/components/parameters/VersionId" - $ref: "#/components/parameters/ContentMD5" - $ref: "#/components/parameters/ContentCrc64" - $ref: "#/components/parameters/ClientRequestId" - $ref: "#/components/parameters/IfTags" - $ref: "#/components/parameters/LeaseIdOptional" requestBody: content: application/xml: schema: $ref: "#/components/schemas/BlobTags" description: Blob tags x-ms-parameter-location: method responses: "204": description: The tags were applied to the blob headers: x-ms-client-request-id: x-ms-client-name: ClientRequestId description: If a client request id header is sent in the request, this header will be present in the response with the same value. schema: type: string x-ms-request-id: x-ms-client-name: RequestId description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. schema: type: string x-ms-version: x-ms-client-name: Version description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. schema: type: string Date: description: UTC date/time value generated by the service that indicates the time at which the response was initiated schema: type: string format: date-time-rfc1123 default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode schema: type: string content: application/xml: schema: $ref: "#/components/schemas/StorageError" parameters: - $ref: "#/components/parameters/ContainerName" - $ref: "#/components/parameters/Blob" - name: comp description: comp in: query required: true schema: type: string enum: - tags servers: - url: "{url}" variables: url: description: The URL of the service account, container, or blob that is the target of the desired operation. x-ms-parameter-location: client x-ms-skip-url-encoding: true default: none components: parameters: Url: name: url description: The URL of the service account, container, or blob that is the target of the desired operation. x-ms-parameter-location: client required: true in: path x-ms-skip-url-encoding: true schema: type: string ApiVersionParameter: name: x-ms-version x-ms-parameter-location: client x-ms-client-name: version in: header required: true description: Specifies the version of the operation to use for this request. schema: type: string enum: - 2025-01-05 Blob: name: blob in: path required: true x-ms-parameter-location: method description: The blob name. schema: type: string minLength: 1 maxLength: 1024 pattern: ^[a-zA-Z0-9]+(?:/[a-zA-Z0-9]+)*(?:\.[a-zA-Z0-9]+){0,1}$ BlobCacheControl: name: x-ms-blob-cache-control x-ms-client-name: blobCacheControl in: header required: false x-ms-parameter-location: method x-ms-parameter-grouping: name: blob-HTTP-headers description: Optional. Sets the blob's cache control. If specified, this property is stored with the blob and returned with a read request. schema: type: string BlobConditionAppendPos: name: x-ms-blob-condition-appendpos x-ms-client-name: appendPosition in: header required: false x-ms-parameter-location: method x-ms-parameter-grouping: name: append-position-access-conditions description: Optional conditional header, used only for the Append Block operation. A number indicating the byte offset to compare. Append Block will succeed only if the append position is equal to this number. If it is not, the request will fail with the AppendPositionConditionNotMet error (HTTP status code 412 - Precondition Failed). schema: type: integer format: int64 BlobConditionMaxSize: name: x-ms-blob-condition-maxsize x-ms-client-name: maxSize in: header required: false x-ms-parameter-location: method x-ms-parameter-grouping: name: append-position-access-conditions description: Optional conditional header. The max length in bytes permitted for the append blob. If the Append Block operation would cause the blob to exceed that limit or if the blob size is already greater than the value specified in this header, the request will fail with MaxBlobSizeConditionNotMet error (HTTP status code 412 - Precondition Failed). schema: type: integer format: int64 BlobPublicAccess: name: x-ms-blob-public-access x-ms-client-name: access in: header required: false x-ms-parameter-location: method description: Specifies whether data in the container may be accessed publicly and the level of access x-ms-enum: name: PublicAccessType modelAsString: true schema: type: string enum: - container - blob BlobTagsHeader: name: x-ms-tags x-ms-client-name: BlobTagsString in: header required: false x-ms-parameter-location: method description: Optional. Used to set blob tags in various blob operations. schema: type: string AccessTierRequired: name: x-ms-access-tier x-ms-client-name: tier in: header required: true x-ms-enum: name: AccessTier modelAsString: true x-ms-parameter-location: method description: Indicates the tier to be set on the blob. schema: type: string enum: - P4 - P6 - P10 - P15 - P20 - P30 - P40 - P50 - P60 - P70 - P80 - Hot - Cool - Archive - Cold AccessTierOptional: name: x-ms-access-tier x-ms-client-name: tier in: header required: false x-ms-enum: name: AccessTier modelAsString: true x-ms-parameter-location: method description: Optional. Indicates the tier to be set on the blob. schema: type: string enum: - P4 - P6 - P10 - P15 - P20 - P30 - P40 - P50 - P60 - P70 - P80 - Hot - Cool - Archive - Cold PremiumPageBlobAccessTierOptional: name: x-ms-access-tier x-ms-client-name: tier in: header required: false x-ms-enum: name: PremiumPageBlobAccessTier modelAsString: true x-ms-parameter-location: method description: Optional. Indicates the tier to be set on the page blob. schema: type: string enum: - P4 - P6 - P10 - P15 - P20 - P30 - P40 - P50 - P60 - P70 - P80 RehydratePriority: name: x-ms-rehydrate-priority x-ms-client-name: rehydratePriority in: header required: false x-ms-enum: name: RehydratePriority modelAsString: true x-ms-parameter-location: method description: "Optional: Indicates the priority with which to rehydrate an archived blob." schema: type: string enum: - High - Standard BlobContentDisposition: name: x-ms-blob-content-disposition x-ms-client-name: blobContentDisposition in: header required: false x-ms-parameter-location: method x-ms-parameter-grouping: name: blob-HTTP-headers description: Optional. Sets the blob's Content-Disposition header. schema: type: string BlobContentEncoding: name: x-ms-blob-content-encoding x-ms-client-name: blobContentEncoding in: header required: false x-ms-parameter-location: method x-ms-parameter-grouping: name: blob-HTTP-headers description: Optional. Sets the blob's content encoding. If specified, this property is stored with the blob and returned with a read request. schema: type: string BlobContentLanguage: name: x-ms-blob-content-language x-ms-client-name: blobContentLanguage in: header required: false x-ms-parameter-location: method x-ms-parameter-grouping: name: blob-HTTP-headers description: Optional. Set the blob's content language. If specified, this property is stored with the blob and returned with a read request. schema: type: string BlobContentLengthOptional: name: x-ms-blob-content-length x-ms-client-name: blobContentLength in: header required: false x-ms-parameter-location: method description: This header specifies the maximum size for the page blob, up to 1 TB. The page blob size must be aligned to a 512-byte boundary. schema: type: integer format: int64 BlobContentLengthRequired: name: x-ms-blob-content-length x-ms-client-name: blobContentLength in: header required: true x-ms-parameter-location: method description: This header specifies the maximum size for the page blob, up to 1 TB. The page blob size must be aligned to a 512-byte boundary. schema: type: integer format: int64 BlobContentMD5: name: x-ms-blob-content-md5 x-ms-client-name: blobContentMD5 in: header required: false x-ms-parameter-location: method x-ms-parameter-grouping: name: blob-HTTP-headers description: Optional. An MD5 hash of the blob content. Note that this hash is not validated, as the hashes for the individual blocks were validated when each was uploaded. schema: type: string format: byte BlobContentType: name: x-ms-blob-content-type x-ms-client-name: blobContentType in: header required: false x-ms-parameter-location: method x-ms-parameter-grouping: name: blob-HTTP-headers description: Optional. Sets the blob's content type. If specified, this property is stored with the blob and returned with a read request. schema: type: string BlobDeleteType: name: deletetype x-ms-client-name: blobDeleteType in: query required: false x-ms-enum: name: BlobDeleteType modelAsString: false x-ms-parameter-location: method description: Optional. Only possible value is 'permanent', which specifies to permanently delete a blob if blob soft delete is enabled. schema: type: string enum: - Permanent BlobExpiryOptions: name: x-ms-expiry-option x-ms-client-name: ExpiryOptions in: header required: true x-ms-enum: name: BlobExpiryOptions modelAsString: true x-ms-parameter-location: method description: Required. Indicates mode of the expiry time schema: type: string enum: - NeverExpire - RelativeToCreation - RelativeToNow - Absolute BlobExpiryTime: name: x-ms-expiry-time x-ms-client-name: ExpiresOn in: header required: false x-ms-parameter-location: method description: The time to set the blob to expiry schema: type: string BlobSequenceNumber: name: x-ms-blob-sequence-number x-ms-client-name: blobSequenceNumber in: header required: false x-ms-parameter-location: method description: Set for page blobs only. The sequence number is a user-controlled value that you can use to track requests. The value of the sequence number must be between 0 and 2^63 - 1. schema: type: integer format: int64 default: 0 BlockId: name: blockid x-ms-client-name: blockId in: query required: true x-ms-parameter-location: method description: A valid Base64 string value that identifies the block. Prior to encoding, the string must be less than or equal to 64 bytes in size. For a given blob, the length of the value specified for the blockid parameter must be the same size for each block. schema: type: string BlockListType: name: blocklisttype x-ms-client-name: listType in: query required: true x-ms-parameter-location: method description: Specifies whether to return the list of committed blocks, the list of uncommitted blocks, or both lists together. x-ms-enum: name: BlockListType modelAsString: false schema: type: string enum: - committed - uncommitted - all default: committed CopyId: name: copyid x-ms-client-name: copyId in: query required: true x-ms-parameter-location: method description: The copy identifier provided in the x-ms-copy-id header of the original Copy Blob operation. schema: type: string ClientRequestId: name: x-ms-client-request-id x-ms-client-name: requestId in: header required: false x-ms-parameter-location: method description: Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. schema: type: string ContainerName: name: containerName in: path required: true x-ms-parameter-location: method description: The container name. schema: type: string ContentCrc64: name: x-ms-content-crc64 x-ms-client-name: transactionalContentCrc64 in: header required: false x-ms-parameter-location: method description: Specify the transactional crc64 for the body, to be validated by the service. schema: type: string format: byte ContentLength: name: Content-Length in: header required: true x-ms-parameter-location: method description: The length of the request. schema: type: integer format: int64 ContentMD5: name: Content-MD5 x-ms-client-name: transactionalContentMD5 in: header required: false x-ms-parameter-location: method description: Specify the transactional md5 for the body, to be validated by the service. schema: type: string format: byte CopySource: name: x-ms-copy-source x-ms-client-name: copySource in: header required: true x-ms-parameter-location: method description: Specifies the name of the source page blob snapshot. This value is a URL of up to 2 KB in length that specifies a page blob snapshot. The value should be URL-encoded as it would appear in a request URI. The source blob must either be public or must be authenticated via a shared access signature. schema: type: string CopySourceAuthorization: name: x-ms-copy-source-authorization x-ms-client-name: copySourceAuthorization in: header required: false x-ms-parameter-location: method description: Only Bearer type is supported. Credentials should be a valid OAuth access token to copy source. schema: type: string CopySourceBlobProperties: name: x-ms-copy-source-blob-properties x-ms-client-name: copySourceBlobProperties in: header required: false x-ms-parameter-location: method description: Optional, default is true. Indicates if properties from the source blob should be copied. schema: type: boolean CopySourceTags: name: x-ms-copy-source-tag-option x-ms-client-name: copySourceTags in: header required: false x-ms-enum: name: BlobCopySourceTags modelAsString: false x-ms-parameter-location: method description: Optional, default 'replace'. Indicates if source tags should be copied or replaced with the tags specified by x-ms-tags. schema: type: string enum: - REPLACE - COPY DeleteSnapshots: name: x-ms-delete-snapshots x-ms-client-name: deleteSnapshots description: "Required if the blob has associated snapshots. Specify one of the following two options: include: Delete the base blob and all of its snapshots. only: Delete only the blob's snapshots and not the blob itself" x-ms-parameter-location: method in: header required: false x-ms-enum: name: DeleteSnapshotsOptionType modelAsString: false schema: type: string enum: - include - only Delimiter: name: delimiter description: When the request includes this parameter, the operation returns a BlobPrefix element in the response body that acts as a placeholder for all blobs whose names begin with the same substring up to the appearance of the delimiter character. The delimiter may be a single character or a string. x-ms-parameter-location: method in: query required: true schema: type: string EncryptionKey: name: x-ms-encryption-key x-ms-client-name: encryptionKey in: header required: false x-ms-parameter-location: method x-ms-parameter-grouping: name: cpk-info description: Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. schema: type: string EncryptionKeySha256: name: x-ms-encryption-key-sha256 x-ms-client-name: encryptionKeySha256 in: header required: false x-ms-parameter-location: method x-ms-parameter-grouping: name: cpk-info description: The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. schema: type: string EncryptionAlgorithm: name: x-ms-encryption-algorithm x-ms-client-name: encryptionAlgorithm in: header required: false x-ms-enum: name: EncryptionAlgorithmType modelAsString: false x-ms-parameter-location: method x-ms-parameter-grouping: name: cpk-info description: The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. schema: type: string enum: - AES256 EncryptionScope: name: x-ms-encryption-scope x-ms-client-name: encryptionScope in: header required: false x-ms-parameter-location: method x-ms-parameter-grouping: name: cpk-scope-info description: Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. schema: type: string DefaultEncryptionScope: name: x-ms-default-encryption-scope x-ms-client-name: DefaultEncryptionScope in: header required: false x-ms-parameter-location: method x-ms-parameter-grouping: name: container-cpk-scope-info description: Optional. Version 2019-07-07 and later. Specifies the default encryption scope to set on the container and use for all future writes. schema: type: string DeletedContainerName: name: x-ms-deleted-container-name x-ms-client-name: DeletedContainerName in: header required: false x-ms-parameter-location: method description: Optional. Version 2019-12-12 and later. Specifies the name of the deleted container to restore. schema: type: string DeletedContainerVersion: name: x-ms-deleted-container-version x-ms-client-name: DeletedContainerVersion in: header required: false x-ms-parameter-location: method description: Optional. Version 2019-12-12 and later. Specifies the version of the deleted container to restore. schema: type: string DenyEncryptionScopeOverride: name: x-ms-deny-encryption-scope-override x-ms-client-name: PreventEncryptionScopeOverride in: header required: false x-ms-parameter-location: method x-ms-parameter-grouping: name: container-cpk-scope-info description: Optional. Version 2019-07-07 and newer. If true, prevents any request from specifying a different encryption scope than the scope set on the container. schema: type: boolean FilterBlobsInclude: name: include in: query required: false x-ms-parameter-location: method description: Include this parameter to specify one or more datasets to include in the response. style: form explode: false schema: type: array items: type: string enum: - none - versions x-ms-enum: name: FilterBlobsIncludeItem modelAsString: false FilterBlobsWhere: name: where in: query required: false description: Filters the results to return only to return only blobs whose tags match the specified expression. x-ms-parameter-location: method schema: type: string GetRangeContentMD5: name: x-ms-range-get-content-md5 x-ms-client-name: rangeGetContentMD5 in: header required: false x-ms-parameter-location: method description: When set to true and specified together with the Range, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4 MB in size. schema: type: boolean GetRangeContentCRC64: name: x-ms-range-get-content-crc64 x-ms-client-name: rangeGetContentCRC64 in: header required: false x-ms-parameter-location: method description: When set to true and specified together with the Range, the service returns the CRC64 hash for the range, as long as the range is less than or equal to 4 MB in size. schema: type: boolean StructuredBodyGet: name: x-ms-structured-body x-ms-client-name: StructuredBodyType in: header required: false x-ms-parameter-location: method description: Specifies the response content should be returned as a structured message and specifies the message schema version and properties. schema: type: string StructuredBodyPut: name: x-ms-structured-body x-ms-client-name: StructuredBodyType in: header required: false x-ms-parameter-location: method description: Required if the request body is a structured message. Specifies the message schema version and properties. schema: type: string StructuredContentLength: name: x-ms-structured-content-length x-ms-client-name: StructuredContentLength in: header required: false x-ms-parameter-location: method 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. schema: type: integer format: int64 IfMatch: name: If-Match x-ms-client-name: ifMatch in: header required: false x-ms-parameter-location: method x-ms-parameter-grouping: name: modified-access-conditions description: Specify an ETag value to operate only on blobs with a matching value. schema: type: string IfModifiedSince: name: If-Modified-Since x-ms-client-name: ifModifiedSince in: header required: false x-ms-parameter-location: method x-ms-parameter-grouping: name: modified-access-conditions description: Specify this header value to operate only on a blob if it has been modified since the specified date/time. schema: type: string format: date-time-rfc1123 IfNoneMatch: name: If-None-Match x-ms-client-name: ifNoneMatch in: header required: false x-ms-parameter-location: method x-ms-parameter-grouping: name: modified-access-conditions description: Specify an ETag value to operate only on blobs without a matching value. schema: type: string IfUnmodifiedSince: name: If-Unmodified-Since x-ms-client-name: ifUnmodifiedSince in: header required: false x-ms-parameter-location: method x-ms-parameter-grouping: name: modified-access-conditions description: Specify this header value to operate only on a blob if it has not been modified since the specified date/time. schema: type: string format: date-time-rfc1123 IfSequenceNumberEqualTo: name: x-ms-if-sequence-number-eq x-ms-client-name: ifSequenceNumberEqualTo in: header required: false x-ms-parameter-location: method x-ms-parameter-grouping: name: sequence-number-access-conditions description: Specify this header value to operate only on a blob if it has the specified sequence number. schema: type: integer format: int64 IfSequenceNumberLessThan: name: x-ms-if-sequence-number-lt x-ms-client-name: ifSequenceNumberLessThan in: header required: false x-ms-parameter-location: method x-ms-parameter-grouping: name: sequence-number-access-conditions description: Specify this header value to operate only on a blob if it has a sequence number less than the specified. schema: type: integer format: int64 IfSequenceNumberLessThanOrEqualTo: name: x-ms-if-sequence-number-le x-ms-client-name: ifSequenceNumberLessThanOrEqualTo in: header required: false x-ms-parameter-location: method x-ms-parameter-grouping: name: sequence-number-access-conditions description: Specify this header value to operate only on a blob if it has a sequence number less than or equal to the specified. schema: type: integer format: int64 IfTags: name: x-ms-if-tags x-ms-client-name: ifTags in: header required: false x-ms-parameter-location: method x-ms-parameter-grouping: name: modified-access-conditions description: Specify a SQL where clause on blob tags to operate only on blobs with a matching value. schema: type: string ImmutabilityPolicyExpiry: name: x-ms-immutability-policy-until-date x-ms-client-name: immutabilityPolicyExpiry in: header required: false x-ms-parameter-location: method description: Specifies the date time when the blobs immutability policy is set to expire. schema: type: string format: date-time-rfc1123 ImmutabilityPolicyMode: name: x-ms-immutability-policy-mode x-ms-client-name: immutabilityPolicyMode in: header required: false x-ms-enum: name: BlobImmutabilityPolicyMode modelAsString: false x-ms-parameter-location: method description: Specifies the immutability policy mode to set on the blob. schema: type: string enum: - Unlocked - Locked ListBlobsInclude: name: include in: query required: false x-ms-parameter-location: method description: Include this parameter to specify one or more datasets to include in the response. style: form explode: false schema: type: array items: type: string enum: - copy - deleted - metadata - snapshots - uncommittedblobs - versions - tags - immutabilitypolicy - legalhold - deletedwithversions x-ms-enum: name: ListBlobsIncludeItem modelAsString: false ListContainersInclude: name: include in: query required: false x-ms-parameter-location: method description: Include this parameter to specify that the container's metadata be returned as part of the response body. style: form explode: false schema: type: array items: type: string enum: - metadata - deleted - system x-ms-enum: name: ListContainersIncludeType modelAsString: false LeaseBreakPeriod: name: x-ms-lease-break-period x-ms-client-name: breakPeriod in: header required: false x-ms-parameter-location: method description: For a break operation, proposed duration the lease should continue before it is broken, in seconds, between 0 and 60. This break period is only used if it is shorter than the time remaining on the lease. If longer, the time remaining on the lease is used. A new lease will not be available before the break period has expired, but the lease may be held for longer than the break period. If this header does not appear with a break operation, a fixed-duration lease breaks after the remaining lease period elapses, and an infinite lease breaks immediately. schema: type: integer LeaseDuration: name: x-ms-lease-duration x-ms-client-name: duration in: header required: false x-ms-parameter-location: method description: Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires. A non-infinite lease can be between 15 and 60 seconds. A lease duration cannot be changed using renew or change. schema: type: integer LeaseIdOptional: name: x-ms-lease-id x-ms-client-name: leaseId in: header required: false x-ms-parameter-location: method x-ms-parameter-grouping: name: lease-access-conditions description: If specified, the operation only succeeds if the resource's lease is active and matches this ID. schema: type: string LeaseIdRequired: name: x-ms-lease-id x-ms-client-name: leaseId in: header required: true x-ms-parameter-location: method description: Specifies the current lease ID on the resource. schema: type: string LegalHoldOptional: name: x-ms-legal-hold x-ms-client-name: legalHold in: header required: false x-ms-parameter-location: method description: Specified if a legal hold should be set on the blob. schema: type: boolean LegalHoldRequired: name: x-ms-legal-hold x-ms-client-name: legalHold in: header required: true x-ms-parameter-location: method description: Specified if a legal hold should be set on the blob. schema: type: boolean Marker: name: marker in: query required: false description: A string value that identifies the portion of the list of containers to be returned with the next listing operation. The operation returns the NextMarker value within the response body if the listing operation did not return all containers remaining to be listed with the current page. The NextMarker value can be used as the value for the marker parameter in a subsequent call to request the next page of list items. The marker value is opaque to the client. x-ms-parameter-location: method schema: type: string MaxResults: name: maxresults in: query required: false x-ms-parameter-location: method description: Specifies the maximum number of containers to return. If the request does not specify maxresults, or specifies a value greater than 5000, the server will return up to 5000 items. Note that if the listing operation crosses a partition boundary, then the service will return a continuation token for retrieving the remainder of the results. For this reason, it is possible that the service will return fewer results than specified by maxresults, or than the default of 5000. schema: type: integer minimum: 1 Metadata: name: x-ms-meta x-ms-client-name: metadata in: header required: false x-ms-parameter-location: method description: Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. x-ms-header-collection-prefix: x-ms-meta- schema: type: string MultipartContentType: name: Content-Type x-ms-client-name: multipartContentType in: header required: true x-ms-parameter-location: method description: "Required. The value of this header must be multipart/mixed with a batch boundary. Example header value: multipart/mixed; boundary=batch_" schema: type: string ObjectReplicationPolicyId: name: x-ms-or-policy-id x-ms-client-name: objectReplicationPolicyId in: header required: false x-ms-parameter-location: method description: Optional. Only valid when Object Replication is enabled for the storage container and on the destination blob of the replication. schema: type: string ObjectReplicationRules: name: x-ms-or x-ms-client-name: ObjectReplicationRules in: header required: false x-ms-parameter-location: method description: Optional. Only valid when Object Replication is enabled for the storage container and on the source blob of the replication. When retrieving this header, it will return the header with the policy id and rule id (e.g. x-ms-or-policyid_ruleid), and the value will be the status of the replication (e.g. complete, failed). x-ms-header-collection-prefix: x-ms-or- schema: type: string Prefix: name: prefix in: query required: false description: Filters the results to return only containers whose name begins with the specified prefix. x-ms-parameter-location: method schema: type: string PrevSnapshot: name: prevsnapshot in: query required: false x-ms-parameter-location: method description: Optional in version 2015-07-08 and newer. The prevsnapshot parameter is a DateTime value that specifies that the response will contain only pages that were changed between target blob and previous snapshot. Changed pages include both updated and cleared pages. The target blob may be a snapshot, as long as the snapshot specified by prevsnapshot is the older of the two. Note that incremental snapshots are currently supported only for blobs created on or after January 1, 2016. schema: type: string PrevSnapshotUrl: name: x-ms-previous-snapshot-url x-ms-client-name: prevSnapshotUrl in: header required: false x-ms-parameter-location: method description: Optional. This header is only supported in service versions 2019-04-19 and after and specifies the URL of a previous snapshot of the target blob. The response will only contain pages that were changed between the target blob and its previous snapshot. schema: type: string ProposedLeaseIdOptional: name: x-ms-proposed-lease-id x-ms-client-name: proposedLeaseId in: header required: false x-ms-parameter-location: method description: Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats. schema: type: string ProposedLeaseIdRequired: name: x-ms-proposed-lease-id x-ms-client-name: proposedLeaseId in: header required: true x-ms-parameter-location: method description: Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats. schema: type: string Range: name: x-ms-range x-ms-client-name: range in: header required: false x-ms-parameter-location: method description: Return only the bytes of the blob in the specified range. schema: type: string RangeRequiredPutPageFromUrl: name: x-ms-range x-ms-client-name: range in: header required: true x-ms-parameter-location: method description: The range of bytes to which the source range would be written. The range should be 512 aligned and range-end is required. schema: type: string SequenceNumberAction: name: x-ms-sequence-number-action x-ms-client-name: sequenceNumberAction in: header required: true x-ms-parameter-location: method description: Required if the x-ms-blob-sequence-number header is set for the request. This property applies to page blobs only. This property indicates how the service should modify the blob's sequence number x-ms-enum: name: SequenceNumberActionType modelAsString: false schema: type: string enum: - max - update - increment Snapshot: name: snapshot in: query required: false x-ms-parameter-location: method description: The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. For more information on working with blob snapshots, see Creating a Snapshot of a Blob. schema: type: string VersionId: name: versionid x-ms-client-name: versionId in: query required: false x-ms-parameter-location: method description: The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to operate on. It's for service version 2019-10-10 and newer. schema: type: string SealBlob: name: x-ms-seal-blob x-ms-client-name: SealBlob in: header required: false x-ms-parameter-location: method description: Overrides the sealed state of the destination blob. Service version 2019-12-12 and newer. schema: type: boolean SourceContainerName: name: x-ms-source-container-name x-ms-client-name: SourceContainerName in: header required: true x-ms-parameter-location: method description: Required. Specifies the name of the container to rename. schema: type: string SourceContentMD5: name: x-ms-source-content-md5 x-ms-client-name: sourceContentMD5 in: header required: false x-ms-parameter-location: method description: Specify the md5 calculated for the range of bytes that must be read from the copy source. schema: type: string format: byte SourceContentCRC64: name: x-ms-source-content-crc64 x-ms-client-name: sourceContentcrc64 in: header required: false x-ms-parameter-location: method description: Specify the crc64 calculated for the range of bytes that must be read from the copy source. schema: type: string format: byte SourceRange: name: x-ms-source-range x-ms-client-name: sourceRange in: header required: false x-ms-parameter-location: method description: Bytes of source data in the specified range. schema: type: string SourceRangeRequiredPutPageFromUrl: name: x-ms-source-range x-ms-client-name: sourceRange in: header required: true x-ms-parameter-location: method description: Bytes of source data in the specified range. The length of this range should match the ContentLength header and x-ms-range/Range destination range header. schema: type: string SourceIfMatch: name: x-ms-source-if-match x-ms-client-name: sourceIfMatch in: header required: false x-ms-parameter-location: method x-ms-parameter-grouping: name: source-modified-access-conditions description: Specify an ETag value to operate only on blobs with a matching value. schema: type: string SourceIfModifiedSince: name: x-ms-source-if-modified-since x-ms-client-name: sourceIfModifiedSince in: header required: false x-ms-parameter-location: method x-ms-parameter-grouping: name: source-modified-access-conditions description: Specify this header value to operate only on a blob if it has been modified since the specified date/time. schema: type: string format: date-time-rfc1123 SourceIfNoneMatch: name: x-ms-source-if-none-match x-ms-client-name: sourceIfNoneMatch in: header required: false x-ms-parameter-location: method x-ms-parameter-grouping: name: source-modified-access-conditions description: Specify an ETag value to operate only on blobs without a matching value. schema: type: string SourceIfUnmodifiedSince: name: x-ms-source-if-unmodified-since x-ms-client-name: sourceIfUnmodifiedSince in: header required: false x-ms-parameter-location: method x-ms-parameter-grouping: name: source-modified-access-conditions description: Specify this header value to operate only on a blob if it has not been modified since the specified date/time. schema: type: string format: date-time-rfc1123 SourceLeaseId: name: x-ms-source-lease-id x-ms-client-name: sourceLeaseId in: header required: false x-ms-parameter-location: method description: A lease ID for the source path. If specified, the source path must have an active lease and the lease ID must match. schema: type: string SourceIfTags: name: x-ms-source-if-tags x-ms-client-name: sourceIfTags in: header required: false x-ms-parameter-location: method x-ms-parameter-grouping: name: source-modified-access-conditions description: Specify a SQL where clause on blob tags to operate only on blobs with a matching value. schema: type: string SourceUrl: name: x-ms-copy-source x-ms-client-name: sourceUrl in: header required: true x-ms-parameter-location: method description: Specify a URL to the copy source. schema: type: string Timeout: name: timeout in: query required: false x-ms-parameter-location: method description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. schema: type: integer minimum: 0 requestBodies: Service_SubmitBatchBody: content: application/xml: schema: type: object format: file description: Initial data required: true x-ms-parameter-location: method BlockBlob_UploadBody: content: application/octet-stream: schema: type: object format: file description: Initial data required: true x-ms-parameter-location: method schemas: KeyInfo: type: object required: - Start - Expiry description: Key information properties: Start: description: The date-time the key is active in ISO 8601 UTC time type: string Expiry: description: The date-time the key expires in ISO 8601 UTC time type: string UserDelegationKey: type: object required: - SignedOid - SignedTid - SignedStart - SignedExpiry - SignedService - SignedVersion - Value description: A user delegation key properties: SignedOid: description: The Azure Active Directory object ID in GUID format. type: string SignedTid: description: The Azure Active Directory tenant ID in GUID format type: string SignedStart: description: The date-time the key is active type: string format: date-time SignedExpiry: description: The date-time the key expires type: string format: date-time SignedService: description: Abbreviation of the Azure Storage service that accepts the key type: string SignedVersion: description: The service version that created the key type: string Value: description: The key as a base64 string type: string PublicAccessType: type: string enum: - container - blob x-ms-enum: name: PublicAccessType modelAsString: true CopyStatus: type: string enum: - pending - success - aborted - failed x-ms-enum: name: CopyStatusType modelAsString: false LeaseDuration: type: string enum: - infinite - fixed x-ms-enum: name: LeaseDurationType modelAsString: false LeaseState: type: string enum: - available - leased - expired - breaking - broken x-ms-enum: name: LeaseStateType modelAsString: false LeaseStatus: type: string enum: - locked - unlocked x-ms-enum: name: LeaseStatusType modelAsString: false StorageError: type: object properties: Message: type: string AccessPolicy: type: object description: An Access policy properties: Start: description: the date-time the policy is active type: string format: date-time Expiry: description: the date-time the policy expires type: string format: date-time Permission: description: the permissions for the acl policy type: string AccessTier: 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 ArchiveStatus: type: string enum: - rehydrate-pending-to-hot - rehydrate-pending-to-cool - rehydrate-pending-to-cold x-ms-enum: name: ArchiveStatus modelAsString: true BlobItemInternal: xml: name: Blob description: An Azure Storage blob type: object required: - Name - Deleted - Snapshot - Properties properties: Name: $ref: "#/components/schemas/BlobName" Deleted: type: boolean Snapshot: type: string VersionId: type: string IsCurrentVersion: type: boolean Properties: $ref: "#/components/schemas/BlobPropertiesInternal" Metadata: $ref: "#/components/schemas/BlobMetadata" BlobTags: $ref: "#/components/schemas/BlobTags" ObjectReplicationMetadata: $ref: "#/components/schemas/ObjectReplicationMetadata" HasVersionsOnly: type: boolean BlobPropertiesInternal: xml: name: Properties description: Properties of a blob type: object required: - Etag - Last-Modified properties: Creation-Time: type: string format: date-time-rfc1123 Last-Modified: type: string format: date-time-rfc1123 Etag: type: string Content-Length: type: integer format: int64 description: Size in bytes Content-Type: type: string Content-Encoding: type: string Content-Language: type: string Content-MD5: type: string format: byte Content-Disposition: type: string Cache-Control: type: string x-ms-blob-sequence-number: x-ms-client-name: blobSequenceNumber type: integer format: int64 BlobType: type: string enum: - BlockBlob - PageBlob - AppendBlob x-ms-enum: name: BlobType modelAsString: false LeaseStatus: $ref: "#/components/schemas/LeaseStatus" LeaseState: $ref: "#/components/schemas/LeaseState" LeaseDuration: $ref: "#/components/schemas/LeaseDuration" CopyId: type: string CopyStatus: $ref: "#/components/schemas/CopyStatus" CopySource: type: string CopyProgress: type: string CopyCompletionTime: type: string format: date-time-rfc1123 CopyStatusDescription: type: string ServerEncrypted: type: boolean IncrementalCopy: type: boolean DestinationSnapshot: type: string DeletedTime: type: string format: date-time-rfc1123 RemainingRetentionDays: type: integer AccessTier: $ref: "#/components/schemas/AccessTier" AccessTierInferred: type: boolean ArchiveStatus: $ref: "#/components/schemas/ArchiveStatus" CustomerProvidedKeySha256: type: string EncryptionScope: type: string description: The name of the encryption scope under which the blob is encrypted. AccessTierChangeTime: type: string format: date-time-rfc1123 TagCount: type: integer Expiry-Time: x-ms-client-name: ExpiresOn type: string format: date-time-rfc1123 Sealed: x-ms-client-name: IsSealed type: boolean RehydratePriority: $ref: "#/components/schemas/RehydratePriority" LastAccessTime: x-ms-client-name: LastAccessedOn type: string format: date-time-rfc1123 ImmutabilityPolicyUntilDate: x-ms-client-name: ImmutabilityPolicyExpiresOn type: string format: date-time-rfc1123 ImmutabilityPolicyMode: type: string enum: - Mutable - Unlocked - Locked x-ms-enum: name: BlobImmutabilityPolicyMode modelAsString: false LegalHold: type: boolean ListBlobsFlatSegmentResponse: xml: name: EnumerationResults description: An enumeration of blobs type: object required: - ServiceEndpoint - ContainerName - Segment properties: ServiceEndpoint: type: string xml: attribute: true ContainerName: type: string xml: attribute: true Prefix: type: string Marker: type: string MaxResults: type: integer Segment: $ref: "#/components/schemas/BlobFlatListSegment" NextMarker: type: string ListBlobsHierarchySegmentResponse: xml: name: EnumerationResults description: An enumeration of blobs type: object required: - ServiceEndpoint - ContainerName - Segment properties: ServiceEndpoint: type: string xml: attribute: true ContainerName: type: string xml: attribute: true Prefix: type: string Marker: type: string MaxResults: type: integer Delimiter: type: string Segment: $ref: "#/components/schemas/BlobHierarchyListSegment" NextMarker: type: string BlobFlatListSegment: xml: name: Blobs required: - BlobItems type: object properties: BlobItems: type: array items: $ref: "#/components/schemas/BlobItemInternal" BlobHierarchyListSegment: xml: name: Blobs type: object required: - BlobItems properties: BlobPrefixes: type: array items: $ref: "#/components/schemas/BlobPrefix" BlobItems: type: array items: $ref: "#/components/schemas/BlobItemInternal" BlobPrefix: type: object required: - Name properties: Name: $ref: "#/components/schemas/BlobName" BlobName: type: object properties: Encoded: xml: attribute: true name: Encoded type: boolean description: Indicates if the blob name is encoded. content: xml: x-ms-text: true type: string description: The name of the blob. BlobTag: xml: name: Tag type: object required: - Key - Value properties: Key: type: string Value: type: string BlobTags: type: object xml: name: Tags description: Blob tags required: - BlobTagSet properties: BlobTagSet: xml: wrapped: true name: TagSet type: array items: $ref: "#/components/schemas/BlobTag" Block: type: object required: - Name - Size description: Represents a single block in a block blob. It describes the block's ID and size. properties: Name: description: The base64 encoded block ID. type: string Size: description: The block size in bytes. type: integer format: int64 BlockList: type: object properties: CommittedBlocks: xml: wrapped: true type: array items: $ref: "#/components/schemas/Block" UncommittedBlocks: xml: wrapped: true type: array items: $ref: "#/components/schemas/Block" BlockLookupList: type: object properties: Committed: type: array items: type: string xml: name: Committed Uncommitted: type: array items: type: string xml: name: Uncommitted Latest: type: array items: type: string xml: name: Latest xml: name: BlockList ContainerItem: xml: name: Container type: object required: - Name - Properties description: An Azure Storage container properties: Name: type: string Deleted: type: boolean Version: type: string Properties: $ref: "#/components/schemas/ContainerProperties" Metadata: $ref: "#/components/schemas/ContainerMetadata" ContainerProperties: type: object required: - Last-Modified - Etag description: Properties of a container properties: Last-Modified: type: string format: date-time-rfc1123 Etag: type: string LeaseStatus: $ref: "#/components/schemas/LeaseStatus" LeaseState: $ref: "#/components/schemas/LeaseState" LeaseDuration: $ref: "#/components/schemas/LeaseDuration" PublicAccess: $ref: "#/components/schemas/PublicAccessType" HasImmutabilityPolicy: type: boolean HasLegalHold: type: boolean DefaultEncryptionScope: type: string DenyEncryptionScopeOverride: type: boolean x-ms-client-name: PreventEncryptionScopeOverride DeletedTime: type: string format: date-time-rfc1123 RemainingRetentionDays: type: integer ImmutableStorageWithVersioningEnabled: x-ms-client-name: IsImmutableStorageWithVersioningEnabled type: boolean description: Indicates if version level worm is enabled on this container. DelimitedTextConfiguration: xml: name: DelimitedTextConfiguration description: Groups the settings used for interpreting the blob data if the blob is delimited text formatted. type: object properties: ColumnSeparator: type: string description: The string used to separate columns. xml: name: ColumnSeparator FieldQuote: type: string description: The string used to quote a specific field. xml: name: FieldQuote RecordSeparator: type: string description: The string used to separate records. xml: name: RecordSeparator EscapeChar: type: string description: The string used as an escape character. xml: name: EscapeChar HeadersPresent: type: boolean description: Represents whether the data has headers. xml: name: HasHeaders JsonTextConfiguration: xml: name: JsonTextConfiguration description: json text configuration type: object properties: RecordSeparator: type: string description: The string used to separate records. xml: name: RecordSeparator ArrowConfiguration: xml: name: ArrowConfiguration description: Groups the settings used for formatting the response if the response should be Arrow formatted. type: object required: - Schema properties: Schema: type: array items: $ref: "#/components/schemas/ArrowField" xml: wrapped: true name: Schema ParquetConfiguration: xml: name: ParquetTextConfiguration description: parquet configuration type: object ArrowField: xml: name: Field description: Groups settings regarding specific field of an arrow schema type: object required: - Type properties: Type: type: string Name: type: string Precision: type: integer Scale: type: integer ListContainersSegmentResponse: xml: name: EnumerationResults description: An enumeration of containers type: object required: - ServiceEndpoint - ContainerItems properties: ServiceEndpoint: type: string xml: attribute: true Prefix: type: string Marker: type: string MaxResults: type: integer ContainerItems: xml: wrapped: true name: Containers type: array items: $ref: "#/components/schemas/ContainerItem" NextMarker: type: string CorsRule: description: CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page from calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain type: object required: - AllowedOrigins - AllowedMethods - AllowedHeaders - ExposedHeaders - MaxAgeInSeconds properties: AllowedOrigins: description: The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive match with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS. type: string AllowedMethods: description: The methods (HTTP request verbs) that the origin domain may use for a CORS request. (comma separated) type: string AllowedHeaders: description: the request headers that the origin domain may specify on the CORS request. type: string ExposedHeaders: description: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer type: string MaxAgeInSeconds: description: The maximum amount time that a browser should cache the preflight OPTIONS request. type: integer minimum: 0 ErrorCode: description: Error codes returned by the service type: string enum: - AccountAlreadyExists - AccountBeingCreated - AccountIsDisabled - AuthenticationFailed - AuthorizationFailure - ConditionHeadersNotSupported - ConditionNotMet - EmptyMetadataKey - InsufficientAccountPermissions - InternalError - InvalidAuthenticationInfo - InvalidHeaderValue - InvalidHttpVerb - InvalidInput - InvalidMd5 - InvalidMetadata - InvalidQueryParameterValue - InvalidRange - InvalidResourceName - InvalidUri - InvalidXmlDocument - InvalidXmlNodeValue - Md5Mismatch - MetadataTooLarge - MissingContentLengthHeader - MissingRequiredQueryParameter - MissingRequiredHeader - MissingRequiredXmlNode - MultipleConditionHeadersNotSupported - 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 - NoAuthenticationInformation - NoPendingCopyOperation - OperationNotAllowedOnIncrementalCopyBlob - PendingCopyOperation - PreviousSnapshotCannotBeNewer - PreviousSnapshotNotFound - PreviousSnapshotOperationNotSupported - 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 FilterBlobItem: xml: name: Blob description: Blob info from a Filter Blobs API call type: object required: - Name - ContainerName properties: Name: type: string ContainerName: type: string Tags: $ref: "#/components/schemas/BlobTags" VersionId: type: string IsCurrentVersion: type: boolean FilterBlobSegment: description: The result of a Filter Blobs API call xml: name: EnumerationResults type: object required: - ServiceEndpoint - Where - Blobs properties: ServiceEndpoint: type: string xml: attribute: true Where: type: string Blobs: xml: name: Blobs wrapped: true type: array items: $ref: "#/components/schemas/FilterBlobItem" NextMarker: type: string GeoReplication: description: Geo-Replication information for the Secondary Storage Service type: object required: - Status - LastSyncTime properties: Status: description: The status of the secondary location type: string enum: - live - bootstrap - unavailable x-ms-enum: name: GeoReplicationStatusType modelAsString: true LastSyncTime: description: A GMT date/time value, to the second. All primary writes preceding this value are guaranteed to be available for read operations at the secondary. Primary writes after this point in time may or may not be available for reads. type: string format: date-time-rfc1123 Logging: description: Azure Analytics Logging settings. type: object required: - Version - Delete - Read - Write - RetentionPolicy properties: Version: description: The version of Storage Analytics to configure. type: string Delete: description: Indicates whether all delete requests should be logged. type: boolean Read: description: Indicates whether all read requests should be logged. type: boolean Write: description: Indicates whether all write requests should be logged. type: boolean RetentionPolicy: $ref: "#/components/schemas/RetentionPolicy" ContainerMetadata: type: object xml: name: Metadata additionalProperties: type: string BlobMetadata: type: object xml: name: Metadata properties: Encrypted: type: string xml: attribute: true additionalProperties: type: string ObjectReplicationMetadata: type: object xml: name: OrMetadata additionalProperties: type: string Metrics: description: a summary of request statistics grouped by API in hour or minute aggregates for blobs required: - Enabled properties: Version: description: The version of Storage Analytics to configure. type: string Enabled: description: Indicates whether metrics are enabled for the Blob service. type: boolean IncludeAPIs: description: Indicates whether metrics should generate summary statistics for called API operations. type: boolean RetentionPolicy: $ref: "#/components/schemas/RetentionPolicy" PageList: description: the list of pages type: object properties: PageRange: type: array items: $ref: "#/components/schemas/PageRange" ClearRange: type: array items: $ref: "#/components/schemas/ClearRange" NextMarker: type: string PageRange: type: object required: - Start - End properties: Start: type: integer format: int64 xml: name: Start End: type: integer format: int64 xml: name: End xml: name: PageRange ClearRange: type: object required: - Start - End properties: Start: type: integer format: int64 xml: name: Start End: type: integer format: int64 xml: name: End xml: name: ClearRange QueryRequest: description: Groups the set of query request settings. type: object required: - QueryType - Expression properties: QueryType: type: string description: Required. The type of the provided query expression. xml: name: QueryType enum: - SQL Expression: type: string description: The query expression in SQL. The maximum size of the query expression is 256KiB. xml: name: Expression InputSerialization: $ref: "#/components/schemas/QuerySerialization" OutputSerialization: $ref: "#/components/schemas/QuerySerialization" xml: name: QueryRequest QueryFormat: type: object required: - Type properties: Type: $ref: "#/components/schemas/QueryType" DelimitedTextConfiguration: $ref: "#/components/schemas/DelimitedTextConfiguration" JsonTextConfiguration: $ref: "#/components/schemas/JsonTextConfiguration" ArrowConfiguration: $ref: "#/components/schemas/ArrowConfiguration" ParquetTextConfiguration: $ref: "#/components/schemas/ParquetConfiguration" QuerySerialization: type: object required: - Format properties: Format: $ref: "#/components/schemas/QueryFormat" QueryType: type: string description: The quick query format type. enum: - delimited - json - arrow - parquet x-ms-enum: name: QueryFormatType modelAsString: false xml: name: Type RehydratePriority: description: If an object is in rehydrate pending state then this header is returned with priority of rehydrate. Valid values are High and Standard. type: string enum: - High - Standard x-ms-enum: name: RehydratePriority modelAsString: true xml: name: RehydratePriority RetentionPolicy: description: the retention policy which determines how long the associated data should persist type: object required: - Enabled properties: Enabled: description: Indicates whether a retention policy is enabled for the storage service type: boolean Days: description: Indicates the number of days that metrics or logging or soft-deleted data should be retained. All data older than this value will be deleted type: integer minimum: 1 AllowPermanentDelete: description: Indicates whether permanent delete is allowed on this storage account. type: boolean SignedIdentifier: xml: name: SignedIdentifier description: signed identifier type: object required: - Id - AccessPolicy properties: Id: type: string description: a unique id AccessPolicy: $ref: "#/components/schemas/AccessPolicy" SignedIdentifiers: description: a collection of signed identifiers type: array items: $ref: "#/components/schemas/SignedIdentifier" xml: wrapped: true name: SignedIdentifiers StaticWebsite: description: The properties that enable an account to host a static website type: object required: - Enabled properties: Enabled: description: Indicates whether this account is hosting a static website type: boolean IndexDocument: description: The default name of the index page under each directory type: string ErrorDocument404Path: description: The absolute path of the custom 404 page type: string DefaultIndexDocumentPath: description: Absolute path of the default index page type: string StorageServiceProperties: description: Storage Service Properties. type: object properties: Logging: $ref: "#/components/schemas/Logging" HourMetrics: $ref: "#/components/schemas/Metrics" MinuteMetrics: $ref: "#/components/schemas/Metrics" Cors: description: The set of CORS rules. type: array items: $ref: "#/components/schemas/CorsRule" xml: wrapped: true DefaultServiceVersion: description: The default version to use for requests to the Blob service if an incoming request's version is not specified. Possible values include version 2008-10-27 and all more recent versions type: string DeleteRetentionPolicy: $ref: "#/components/schemas/RetentionPolicy" StaticWebsite: $ref: "#/components/schemas/StaticWebsite" StorageServiceStats: description: Stats for the storage service. type: object properties: GeoReplication: $ref: "#/components/schemas/GeoReplication"