Share via

az storage blob incremental-copy

Manage blob incremental copy operations.

Commands

Name Description Type Status
az storage blob incremental-copy cancel

Aborts a pending copy_blob operation, and leaves a destination blob with zero length and full metadata.

 Core GA
az storage blob incremental-copy start

Copies an incremental copy of a blob asynchronously.

 Core GA

az storage blob incremental-copy cancel

Edit

Aborts a pending copy_blob operation, and leaves a destination blob with zero length and full metadata.

az storage blob incremental-copy cancel --container-name
                                        --copy-id
                                        --name
                                        [--account-key]
                                        [--account-name]
                                        [--auth-mode {key, login}]
                                        [--connection-string]
                                        [--lease-id]
                                        [--sas-token]
                                        [--timeout]

Required Parameters

--container-name -c

The container name.

--copy-id

Copy identifier provided in the copy.id of the original copy_blob operation.

--name -n

The blob name.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-key

Storage account key. Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_KEY.

Property Value
Parameter group: Storage Account Arguments
--account-name

Storage account name. Related environment variable: AZURE_STORAGE_ACCOUNT. Must be used in conjunction with either storage account key or a SAS token. If neither are present, the command will try to query the storage account key using the authenticated Azure account. If a large number of storage commands are executed the API quota may be hit.

Property Value
Parameter group: Storage Account Arguments
--auth-mode

The mode in which to run the command. "login" mode will directly use your login credentials for the authentication. The legacy "key" mode will attempt to query for an account key if no authentication parameters for the account are provided. Environment variable: AZURE_STORAGE_AUTH_MODE.

Property Value
Accepted values: key, login
--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

Property Value
Parameter group: Storage Account Arguments
--lease-id

Required if the destination blob has an active infinite lease.

--sas-token

A Shared Access Signature (SAS). Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_SAS_TOKEN.

Property Value
Parameter group: Storage Account Arguments
--timeout

Request timeout in seconds. Applies to each call to the service.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az storage blob incremental-copy start

Edit

Copies an incremental copy of a blob asynchronously.

This operation returns a copy operation properties object, including a copy ID you can use to check or abort the copy operation. The Blob service copies blobs on a best-effort basis. The source blob for an incremental copy operation must be a page blob. Call get_blob_properties on the destination blob to check the status of the copy operation. The final blob will be committed when the copy completes.

az storage blob incremental-copy start --destination-blob
                                       --destination-container
                                       [--account-key]
                                       [--account-name]
                                       [--auth-mode {key, login}]
                                       [--connection-string]
                                       [--destination-if-match]
                                       [--destination-if-modified-since]
                                       [--destination-if-none-match]
                                       [--destination-if-unmodified-since]
                                       [--destination-lease-id]
                                       [--metadata]
                                       [--sas-token]
                                       [--source-account-key]
                                       [--source-account-name]
                                       [--source-blob]
                                       [--source-container]
                                       [--source-lease-id]
                                       [--source-sas]
                                       [--source-snapshot]
                                       [--source-uri]
                                       [--timeout]

Examples

Upload all files that end with .py unless blob exists and has been modified since given date.

az storage blob incremental-copy start --source-container MySourceContainer --source-blob MyBlob --source-account-name MySourceAccount --source-account-key MySourceKey --source-snapshot MySnapshot --destination-container MyDestinationContainer --destination-blob MyDestinationBlob

Copies an incremental copy of a blob asynchronously. (autogenerated)

az storage blob incremental-copy start --account-key 00000000 --account-name MyAccount --destination-blob MyDestinationBlob --destination-container MyDestinationContainer --source-account-key MySourceKey --source-account-name MySourceAccount --source-blob MyBlob --source-container MySourceContainer --source-snapshot MySnapshot

Copy an incremental copy of a blob asynchronously. (autogenerated)

az storage blob incremental-copy start --connection-string myconnectionstring --destination-blob mydestinationblob --destination-container MyDestinationContainer --source-uri https://storage.blob.core.windows.net/photos

Required Parameters

--destination-blob -b

Name of the destination blob. If the exists, it will be overwritten.

--destination-container -c

The container name.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-key

Storage account key. Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_KEY.

Property Value
Parameter group: Storage Account Arguments
--account-name

Storage account name. Related environment variable: AZURE_STORAGE_ACCOUNT. Must be used in conjunction with either storage account key or a SAS token. If neither are present, the command will try to query the storage account key using the authenticated Azure account. If a large number of storage commands are executed the API quota may be hit.

Property Value
Parameter group: Storage Account Arguments
--auth-mode

The mode in which to run the command. "login" mode will directly use your login credentials for the authentication. The legacy "key" mode will attempt to query for an account key if no authentication parameters for the account are provided. Environment variable: AZURE_STORAGE_AUTH_MODE.

Property Value
Accepted values: key, login
--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

Property Value
Parameter group: Storage Account Arguments
--destination-if-match

An ETag value, or the wildcard character (*). Specify an ETag value for this conditional header to copy the blob only if the specified ETag value matches the ETag value for an existing destination blob. If the ETag for the destination blob does not match the ETag specified for If-Match, the Blob service returns status code 412 (Precondition Failed).

Property Value
Parameter group: Pre-condition Arguments
--destination-if-modified-since

Commence only if modified since supplied UTC datetime (Y-m-d'T'H:M'Z').

Property Value
Parameter group: Pre-condition Arguments
--destination-if-none-match

An ETag value, or the wildcard character (). Specify an ETag value for this conditional header to copy the blob only if the specified ETag value does not match the ETag value for the destination blob. Specify the wildcard character () to perform the operation only if the destination blob does not exist. If the specified condition isn't met, the Blob service returns status code 412 (Precondition Failed).

Property Value
Parameter group: Pre-condition Arguments
--destination-if-unmodified-since

Commence only if unmodified since supplied UTC datetime (Y-m-d'T'H:M'Z').

Property Value
Parameter group: Pre-condition Arguments
--destination-lease-id

The lease ID specified for this header must match the lease ID of the destination blob. If the request does not include the lease ID or it is not valid, the operation fails with status code 412 (Precondition Failed).

--metadata

Metadata in space-separated key=value pairs. This overwrites any existing metadata.

--sas-token

A Shared Access Signature (SAS). Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_SAS_TOKEN.

Property Value
Parameter group: Storage Account Arguments
--source-account-key

The storage account key of the source blob.

Property Value
Parameter group: Copy Source Arguments
--source-account-name

The storage account name of the source blob.

Property Value
Parameter group: Copy Source Arguments
--source-blob

The blob name for the source storage account.

Property Value
Parameter group: Copy Source Arguments
--source-container

The container name for the source storage account.

Property Value
Parameter group: Copy Source Arguments
--source-lease-id

Specify this to perform the Copy Blob operation only if the lease ID given matches the active lease ID of the source blob.

Property Value
Parameter group: Copy Source Arguments
--source-sas

The shared access signature for the source storage account.

Property Value
Parameter group: Copy Source Arguments
--source-snapshot

The blob snapshot for the source storage account.

Property Value
Parameter group: Copy Source Arguments
--source-uri -u

A URL of up to 2 KB in length that specifies an Azure page blob. The value should be URL-encoded as it would appear in a request URI. The copy source must be a snapshot and include a valid SAS token or be public. Example: https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=<DateTime>&sastoken.

Property Value
Parameter group: Copy Source Arguments
--timeout

Request timeout in seconds. Applies to each call to the service.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False