Abort Copy Blob

The Abort Copy Blob operation cancels a pending Copy Blob operation, and leaves a destination blob with zero length and full metadata. This operation applies to version 2012-02-12 and newer.

Request

Construct the Abort Copy Blob operation as follows. HTTPS is recommended. Replace myaccount with the name of your storage account, mycontainer with the name of your container, and myblob with the name of your destination blob. Replace <id> with the copy identifier provided in the x-ms-copy-id header of the original Copy Blob operation.

Beginning with version 2013-08-15, you can specify a shared access signature for the destination blob if it's in the same account as the source blob. Beginning with version 2015-04-05, you can also specify a shared access signature for the destination blob if it's in a different storage account.

PUT method request URI	HTTP version
https://myaccount.blob.core.windows.net/mycontainer/myblob?comp=copy&copyid=<id>	HTTP/1.1

Emulated storage service URI

When you're making a request against the local storage service, specify the local hostname and Azure Blob Storage port as 127.0.0.1:10000, followed by the local storage account name:

PUT method request URI	HTTP version
http://127.0.0.1:10000/devstoreaccount1/mycontainer/myblob?comp=copy&copyid=<id>	HTTP/1.1

For more information, see Use the Azurite emulator for local Azure Storage development.

URI parameters

You can specify the following additional parameter on the request URI.

Parameter	Description
timeout	Optional. The timeout parameter is expressed in seconds. For more information, see Setting timeouts for Blob Storage operations.

Request headers

The following table describes required and optional request headers.

Request header	Description
Authorization	Required. Specifies the authorization scheme, account name, and signature. For more information, see Authorize requests to Azure Storage.
Date or x-ms-date	Required. Specifies the Coordinated Universal Time (UTC) for the request. For more information, see Authorize requests to Azure Storage.
x-ms-version	Required for all authorized requests. For more information, see Versioning for the Azure Storage services.
x-ms-lease-id:<ID>	Required if the destination blob has an active infinite lease.
x-ms-copy-action: abort	Required.
x-ms-client-request-id	Optional. Provides a client-generated, opaque value with a 1-kibibyte (KiB) character limit that's recorded in the logs when logging is configured. We highly recommend that you use this header to correlate client-side activities with requests that the server receives. For more information, see Monitor Azure Blob Storage.

Request body

None.

Response

The response includes an HTTP status code and a set of response headers.

Status code

A successful operation returns status code 204 (No Content). For information about status codes, see Status and error codes.

Response headers

The response for this operation includes the following headers. The response can also include additional standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.

Response header	Description
x-ms-request-id	This header uniquely identifies the request that was made, and can be used for troubleshooting the request. For more information, see Troubleshooting API operations.
x-ms-version	Indicates the version of Blob Storage used to run the request.
Date	A UTC date/time value generated by the service that indicates the time at which the response was initiated.
x-ms-client-request-id	You can use this header to troubleshoot requests and corresponding responses. The value of this header is equal to the value of the x-ms-client-request-id header if it is present in the request. The value is, at most, 1024 visible ASCII characters. If the x-ms-client-request-id header isn't present in the request, this header isn't present in the response.

Authorization

Authorization is required when calling any data access operation in Azure Storage. You can authorize the Abort Copy Blob operation as described below.

Important

Microsoft recommends using Microsoft Entra ID with managed identities to authorize requests to Azure Storage. Microsoft Entra ID provides superior security and ease of use compared to Shared Key authorization.

Microsoft Entra ID (recommended)

Azure Storage supports using Microsoft Entra ID to authorize requests to blob data. With Microsoft Entra ID, you can use Azure role-based access control (Azure RBAC) to grant permissions to a security principal. The security principal may be a user, group, application service principal, or Azure managed identity. The security principal is authenticated by Microsoft Entra ID to return an OAuth 2.0 token. The token can then be used to authorize a request against the Blob service.

To learn more about authorization using Microsoft Entra ID, see Authorize access to blobs using Microsoft Entra ID.

Permissions

Listed below are the RBAC action necessary for a Microsoft Entra user, group, managed identity, or service principal to call the Abort Copy Blob operation, and the least privileged built-in Azure RBAC role that includes this action:

• Azure RBAC action: Microsoft.Storage/storageAccounts/blobServices/containers/blobs/write (for writing to an existing blob) or Microsoft.Storage/storageAccounts/blobServices/containers/blobs/add/action (for writing a new blob to the destination)
• Least privileged built-in role: Storage Blob Data Contributor

To learn more about assigning roles using Azure RBAC, see Assign an Azure role for access to blob data.

Shared access signatures (SAS)

A shared access signature (SAS) provides secure delegated access to resources in a storage account. With a SAS, you have granular control over how a client can access data. You can specify what resource the client may access, what permissions they have to those resources, and how long the SAS is valid.

The Abort Copy Blob operation supports three types of shared access signatures: user delegation SAS, service SAS, and account SAS.

As a security best practice, we recommend that you use Microsoft Entra credentials rather than the storage account key, which can be more easily compromised. If your application design requires shared access signatures, use Microsoft Entra credentials to create a user delegation SAS, when possible.

When Shared Key access is disallowed for the storage account, a service SAS token or an account SAS token will not be permitted on a request to Blob Storage. To learn more, see Understand how disallowing Shared Key affects SAS tokens.

User delegation SAS

A user delegation SAS is secured with Microsoft Entra credentials and also by the permissions specified for the SAS.

Calling the Abort Copy Blob operation using a SAS token delegated to a blob resource requires the Write (w) permission as part of the user delegation SAS token.

To learn more about the user delegation SAS, see Create a user delegation SAS.

Service SAS

A service SAS is secured with the storage account key. A service SAS delegates access to a resource in a single Azure Storage service, such as blob storage.

Calling the Abort Copy Blob operation using a SAS token delegated to a blob resource requires the Write (w) permission as part of the service SAS token.

To learn more about the service SAS, see Create a service SAS.

Account SAS

An account SAS is secured with the storage account key. An account SAS delegates access to resources in one or more of the storage services. All of the operations available via a service or user delegation SAS are also available via an account SAS.

The following table indicates the signed resource type and signed permissions to specify when delegating access:

Operation	Signed service	Signed resource type	Signed permission
Abort Copy Blob	Blob (b)	Object (o)	Write (w)

To learn more about the account SAS, see Create an account SAS.

Shared key

The Abort Copy Blob operation supports Shared Key authorization. Authorizing with account keys is not recommended for most scenarios, as it's less secure.

Microsoft recommends disallowing Shared Key authorization for the storage account when possible. For more information, see Prevent authorization with Shared Key.

Remarks

When you cancel a pending Copy Blob operation, the destination blob’s x-ms-copy-status header is set to aborted. Canceling a copy operation results in a destination blob of zero length for block blobs, append blobs, and page blobs. However, the metadata for the destination blob will have the new values copied from the source blob, or set explicitly in the Copy Blob operation call. To keep the original metadata from before the copy, make a snapshot of the destination blob before calling Copy Blob.

You can only cancel a copy operation that is pending. Trying to cancel a copy that has completed, or failed, results in a conflict error. Trying to cancel a copy operation by using an incorrect copy ID also results in a conflict error.

Billing

Pricing requests can originate from clients that use Blob Storage APIs, either directly through the Blob Storage REST API, or from an Azure Storage client library. These requests accrue charges per transaction. The type of transaction affects how the account is charged. For example, read transactions accrue to a different billing category than write transactions. The following table shows the billing category for Abort Copy Blob requests based on the storage account type:

Operation	Storage account type	Billing category
Abort Copy Blob	Premium block blob Standard general-purpose v2	Other operations
Abort Copy Blob	Standard general-purpose v1	Write operations

To learn about pricing for the specified billing category, see Azure Blob Storage Pricing.

See also

Authorize requests to Azure Storage
Status and error codes
Azure Blob Storage error codes
Copy Blob operation