az storage file copy

Manage file copy operations.

Commands

az storage file copy cancel Aborts a pending copy_file operation, and leaves a destination file with zero length and full metadata.
az storage file copy start Copies a file asynchronously.
az storage file copy start-batch Copy multiple files or blobs to a file share.

az storage file copy cancel

Aborts a pending copy_file operation, and leaves a destination file with zero length and full metadata.

az storage file copy cancel --copy-id
--directory-name
--file-name
--share-name
[--account-key]
[--account-name]
[--connection-string]
[--sas-token]
[--timeout]

Required Parameters

--copy-id

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

--directory-name -d

The directory name.

--file-name

Name of destination file.

--share-name -s

The file share name.

Optional Parameters

--account-key

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

--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.

--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--sas-token

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

--timeout

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

az storage file copy start

Copies a file asynchronously.

az storage file copy start --copy-source
--directory-name
--file-name
--share-name
[--account-key]
[--account-name]
[--connection-string]
[--metadata]
[--sas-token]
[--timeout]

Required Parameters

--copy-source

A URL of up to 2 KB in length that specifies an Azure file or blob. The value should be URL-encoded as it would appear in a request URI. If the source is in another account, the source must either be public or must be authenticated via a shared access signature. If the source is public, no authentication is required. Examples: https://myaccount.file.core.windows.net/myshare/mydir/myfile https://otheraccount.file.core.windows.net/myshare/mydir/myfile?sastoken.

--directory-name -d

The directory name.

--file-name

Name of the destination file. If the destination file exists, it will be overwritten. Otherwise, it will be created.

--share-name -s

The file share name.

Optional Parameters

--account-key

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

--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.

--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--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.

--timeout

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

az storage file copy start-batch

Copy multiple files or blobs to a file share.

az storage file copy start-batch --source-client
[--account-key]
[--account-name]
[--connection-string]
[--destination-path]
[--destination-share]
[--dryrun]
[--metadata]
[--pattern]
[--sas-token]
[--source-container]
[--source-sas]
[--source-share]
[--timeout]

Required Parameters

--source-client

Optional Parameters

--account-key

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

--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.

--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--destination-path

The directory where the source data is copied to. If omitted, data is copied to the root directory.

--destination-share

The file share where the source data is copied to.

--dryrun

List the files and blobs to be copied. No actual data transfer will occur.

--metadata

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

--pattern

The pattern used for globbing files and blobs. The supported patterns are '*', '?', '[seq', and '[!seq]'.

--sas-token

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

--source-container

The source container blobs are copied from.

--source-sas

The shared access signature for the source storage account.

--source-share

The source share files are copied from.

--timeout

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