az storage blob

Reference

Note

This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. Learn more about extensions.

Manage object storage for unstructured data (blobs).

Please specify one of the following authentication parameters for your commands: --auth-mode, --account-key, --connection-string, --sas-token. You also can use corresponding environment variables to store your authentication credentials, e.g. AZURE_STORAGE_KEY, AZURE_STORAGE_CONNECTION_STRING and AZURE_STORAGE_SAS_TOKEN.

Commands

Name	Description	Type	Status
az storage blob access	Manage the access control properties of a blob when Hierarchical Namespace is enabled.	Extension	Deprecated
az storage blob access set	Set the access control properties of a blob.	Extension	Deprecated
az storage blob access show	Show the access control properties of a blob.	Extension	Deprecated
az storage blob access update	Update the access control properties of a blob.	Extension	Deprecated
az storage blob copy	Manage blob copy operations. Use `az storage blob show` to check the status of the blobs.	Core and Extension	GA
az storage blob copy cancel	Abort an ongoing copy operation.	Core	GA
az storage blob copy start	Copy a blob asynchronously. Use `az storage blob show` to check the status of the blobs.	Core	GA
az storage blob copy start (storage-blob-preview extension)	Start a copy blob job.	Extension	GA
az storage blob copy start-batch	Copy multiple blobs to a blob container. Use `az storage blob show` to check the status of the blobs.	Core	GA
az storage blob delete	Mark a blob or snapshot for deletion.	Core	GA
az storage blob delete (storage-blob-preview extension)	Mark a blob or snapshot for deletion.	Extension	GA
az storage blob delete-batch	Delete blobs from a blob container recursively.	Core	GA
az storage blob directory	Manage blob directories in storage account container.	Extension	Deprecated
az storage blob directory access	Manage the access control properties of a directory when Hierarchical Namespace is enabled.	Extension	Preview and Deprecated
az storage blob directory access set	Set the access control properties of a directory.	Extension	Preview and Deprecated
az storage blob directory access show	Show the access control properties of a directory.	Extension	Preview and Deprecated
az storage blob directory access update	Update the access control properties of a directory.	Extension	Preview and Deprecated
az storage blob directory create	Create a storage blob directory in a storage container.	Extension	Deprecated
az storage blob directory delete	Delete a storage blob directory in a storage container.	Extension	Deprecated
az storage blob directory download	Download blobs to a local file path.	Extension	Deprecated
az storage blob directory exists	Check for the existence of a blob directory in a storage container.	Extension	Deprecated
az storage blob directory list	List blobs and blob subdirectories in a storage directory.	Extension	Deprecated
az storage blob directory metadata	Manage directory metadata.	Extension	Deprecated
az storage blob directory metadata show	Show all user-defined metadata for the specified blob directory.	Extension	Deprecated
az storage blob directory metadata update	Set user-defined metadata for the specified blob directory as one or more name-value pairs.	Extension	Deprecated
az storage blob directory move	Move a storage directory to another storage blob directory in a storage container.	Extension	Deprecated
az storage blob directory show	Show a storage blob directory properties in a storage container.	Extension	Deprecated
az storage blob directory upload	Upload blobs or subdirectories to a storage blob directory.	Extension	Deprecated
az storage blob download	Download a blob to a file path.	Core	GA
az storage blob download-batch	Download blobs from a blob container recursively.	Core	GA
az storage blob exists	Check for the existence of a blob in a container.	Core	GA
az storage blob filter	List blobs across all containers whose tags match a given search expression.	Extension	Preview
az storage blob generate-sas	Generate a shared access signature for the blob.	Core	GA
az storage blob generate-sas (storage-blob-preview extension)	Generate a shared access signature for the blob.	Extension	GA
az storage blob immutability-policy	Manage blob immutability policy.	Core	GA
az storage blob immutability-policy delete	Delete blob's immutability policy.	Core	GA
az storage blob immutability-policy set	Set blob's immutability policy.	Core	GA
az storage blob incremental-copy	Manage blob incremental copy operations.	Core	GA
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 lease	Manage storage blob leases.	Core	GA
az storage blob lease acquire	Request a new lease.	Core	GA
az storage blob lease break	Break the lease, if the container or blob has an active lease.	Core	GA
az storage blob lease change	Change the lease ID of an active lease.	Core	GA
az storage blob lease release	Release the lease.	Core	GA
az storage blob lease renew	Renew the lease.	Core	GA
az storage blob list	List blobs in a given container.	Core	GA
az storage blob metadata	Manage blob metadata.	Core	GA
az storage blob metadata show	Return all user-defined metadata for the specified blob or snapshot.	Core	GA
az storage blob metadata update	Sets user-defined metadata for the blob as one or more name-value pairs.	Core	GA
az storage blob move	Move a blob in a storage container.	Extension	Preview and Deprecated
az storage blob query	Enable users to select/project on blob or blob snapshot data by providing simple query expressions.	Core	Preview
az storage blob restore	Restore blobs in the specified blob ranges.	Core	GA
az storage blob rewrite	Create a new Block Blob where the content of the blob is read from a given URL.	Core	Preview
az storage blob service-properties	Manage storage blob service properties.	Core and Extension	GA
az storage blob service-properties delete-policy	Manage storage blob delete-policy service properties.	Core	GA
az storage blob service-properties delete-policy show	Show the storage blob delete-policy.	Core	GA
az storage blob service-properties delete-policy update	Update the storage blob delete-policy.	Core	GA
az storage blob service-properties show	Gets the properties of a storage account's Blob service, including Azure Storage Analytics.	Core	GA
az storage blob service-properties update	Update storage blob service properties.	Core	GA
az storage blob service-properties update (storage-blob-preview extension)	Update storage blob service properties.	Extension	GA
az storage blob set-legal-hold	Set blob legal hold.	Core	GA
az storage blob set-tier	Set the block or page tiers on the blob.	Core	GA
az storage blob set-tier (storage-blob-preview extension)	Set the block or page tiers on the blob.	Extension	GA
az storage blob show	Get the details of a blob.	Core	GA
az storage blob show (storage-blob-preview extension)	Get the details of a blob.	Extension	GA
az storage blob snapshot	Creates a snapshot of the blob.	Core	GA
az storage blob sync	Sync blobs recursively to a storage blob container.	Core	Preview
az storage blob tag	Manage blob tags.	Extension	Preview
az storage blob tag list	Get tags on a blob or specific blob version, or snapshot.	Extension	Preview
az storage blob tag set	Set tags on a blob or specific blob version, but not snapshot.	Extension	Preview
az storage blob undelete	Restore soft deleted blob or snapshot.	Core	GA
az storage blob update	Sets system properties on the blob.	Core	GA
az storage blob upload	Upload a file to a storage blob.	Core	GA
az storage blob upload-batch	Upload files from a local directory to a blob container.	Core	GA
az storage blob url	Create the url to access a blob.	Core	GA

az storage blob delete

Edit

Mark a blob or snapshot for deletion.

The blob is marked for later deletion during garbage collection. In order to delete a blob, all of its snapshots must also be deleted. Both can be removed at the same time.

az storage blob delete [--account-key]
                       [--account-name]
                       [--auth-mode {key, login}]
                       [--blob-endpoint]
                       [--blob-url]
                       [--connection-string]
                       [--container-name]
                       [--delete-snapshots {include, only}]
                       [--if-match]
                       [--if-modified-since]
                       [--if-none-match]
                       [--if-unmodified-since]
                       [--lease-id]
                       [--name]
                       [--sas-token]
                       [--snapshot]
                       [--tags-condition]
                       [--timeout]

Examples

Delete a blob.

az storage blob delete -c mycontainer -n MyBlob

Delete a blob using login credentials.

az storage blob delete -c mycontainer -n MyBlob --account-name mystorageaccount --auth-mode login

Optional Parameters

--account-key

Storage account key. Must be used in conjunction with storage account name or service endpoint. 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.

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

Accepted values: key, login

--blob-endpoint

Storage data service endpoint. Must be used in conjunction with either storage account key or a SAS token. You can find each service primary endpoint with az storage account show. Environment variable: AZURE_STORAGE_SERVICE_ENDPOINT.

--blob-url

The full endpoint URL to the Blob, including SAS token and snapshot if used. This could be either the primary endpoint, or the secondary endpoint depending on the current location_mode.

--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--container-name -c

The container name.

--delete-snapshots

Required if the blob has associated snapshots. Values include: "only": Deletes only the blobs snapshots. "include": Deletes the blob along with all snapshots.

Accepted values: include, only

--if-match

An ETag value, or the wildcard character (*). Specify this header to perform the operation only if the resource's ETag matches the value specified.

--if-modified-since

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

--if-none-match

An ETag value, or the wildcard character (). Specify this header to perform the operation only if the resource's ETag does not match the value specified. Specify the wildcard character () to perform the operation only if the resource does not exist, and fail the operation if it does exist.

--if-unmodified-since

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

--lease-id

Required if the blob has an active lease.

--name -n

The blob name.

--sas-token

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

--snapshot

The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to delete.

--tags-condition

Specify a SQL where clause on blob tags to operate only on blobs with a matching value.

--timeout

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az storage blob delete (storage-blob-preview extension)

Mark a blob or snapshot for deletion.

The blob is marked for later deletion during garbage collection. In order to delete a blob, all of its snapshots must also be deleted. Both can be removed at the same time.

az storage blob delete [--account-key]
                       [--account-name]
                       [--auth-mode {key, login}]
                       [--blob-endpoint]
                       [--blob-url]
                       [--connection-string]
                       [--container-name]
                       [--delete-snapshots {include, only}]
                       [--if-match]
                       [--if-modified-since]
                       [--if-none-match]
                       [--if-unmodified-since]
                       [--lease-id]
                       [--name]
                       [--sas-token]
                       [--snapshot]
                       [--tags-condition]
                       [--timeout]
                       [--version-id]

Examples

Delete a blob.

az storage blob delete -c mycontainer -n MyBlob

Delete a blob using login credentials.

az storage blob delete -c mycontainer -n MyBlob --account-name mystorageaccount --auth-mode login

Optional Parameters

--account-key

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

--account-name

--auth-mode

Accepted values: key, login

--blob-endpoint

--blob-url

The full endpoint URL to the Blob, including SAS token and snapshot if used. This could be either the primary endpoint, or the secondary endpoint depending on the current location_mode.

--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--container-name -c

The container name.

--delete-snapshots

Required if the blob has associated snapshots. "only": Deletes only the blobs snapshots. "include": Deletes the blob along with all snapshots.

Accepted values: include, only

--if-match

An ETag value, or the wildcard character (*). Specify this header to perform the operation only if the resource's ETag matches the value specified.

--if-modified-since

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

--if-none-match

--if-unmodified-since

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

--lease-id

Required if the blob has an active lease.

--name -n

The blob name.

--sas-token

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

--snapshot

The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve.

--tags-condition

Specify a SQL where clause on blob tags to operate only on blobs with a matching value.

--timeout

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

--version-id

An optional blob version ID. This parameter is only for versioning enabled account.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az storage blob delete-batch

Edit

Delete blobs from a blob container recursively.

az storage blob delete-batch --source
                             [--account-key]
                             [--account-name]
                             [--auth-mode {key, login}]
                             [--blob-endpoint]
                             [--connection-string]
                             [--delete-snapshots {include, only}]
                             [--dryrun]
                             [--if-match]
                             [--if-modified-since]
                             [--if-none-match]
                             [--if-unmodified-since]
                             [--lease-id]
                             [--pattern]
                             [--sas-token]
                             [--timeout]

Examples

Delete all blobs ending with ".py" in a container that have not been modified for 10 days.

date=`date -d "10 days ago" '+%Y-%m-%dT%H:%MZ'`
az storage blob delete-batch -s mycontainer --account-name mystorageaccount --pattern "*.py" --if-unmodified-since $date --auth-mode login

Delete all the blobs in a directory named "dir" in a container named "mycontainer".

az storage blob delete-batch -s mycontainer --pattern "dir/*"

Delete the blobs with the format 'cli-2018-xx-xx.txt' or 'cli-2019-xx-xx.txt' in a container.

az storage blob delete-batch -s mycontainer --pattern "cli-201[89]-??-??.txt"

Delete all blobs with the format 'cli-201x-xx-xx.txt' except cli-2018-xx-xx.txt' and 'cli-2019-xx-xx.txt' in a container.

az storage blob delete-batch -s mycontainer --pattern "cli-201[!89]-??-??.txt"

Required Parameters

--source -s

The blob container from where the files will be deleted.

The source can be the container URL or the container name. When the source is the container URL, the storage account name will be parsed from the URL.

Optional Parameters

--account-key

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

--account-name

--auth-mode

Accepted values: key, login

--blob-endpoint

--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--delete-snapshots

Required if the blob has associated snapshots.

Accepted values: include, only

--dryrun

Show the summary of the operations to be taken instead of actually deleting the file(s).

If this is specified, it will ignore all the Precondition Arguments that include --if-modified-since and --if-unmodified-since. So the file(s) will be deleted with the command without --dryrun may be different from the result list with --dryrun flag on.

Default value: False

--if-match

An ETag value, or the wildcard character (*). Specify this header to perform the operation only if the resource's ETag matches the value specified.

--if-modified-since

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

--if-none-match

An ETag value, or the wildcard character (*).

Specify this header to perform the operation only if the resource's ETag does not match the value specified. Specify the wildcard character (*) to perform the operation only if the resource does not exist, and fail the operation if it does exist.

--if-unmodified-since

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

--lease-id

The active lease id for the blob.

--pattern

The pattern used for globbing files or blobs in the source. The supported patterns are '*', '?', '[seq]', and '[!seq]'. For more information, please refer to https://docs.python.org/3/library/fnmatch.html.

When you use '*' in --pattern, it will match any character including the the directory separator '/'. You can also try "az storage remove" command with --include and --exclude with azure cli >= 2.0.70 to match multiple patterns.

--sas-token

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

--timeout

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az storage blob download

Edit

Download a blob to a file path.

az storage blob download [--account-key]
                         [--account-name]
                         [--auth-mode {key, login}]
                         [--blob-endpoint]
                         [--blob-url]
                         [--connection-string]
                         [--container-name]
                         [--end-range]
                         [--file]
                         [--if-match]
                         [--if-modified-since]
                         [--if-none-match]
                         [--if-unmodified-since]
                         [--lease-id]
                         [--max-connections]
                         [--name]
                         [--no-progress]
                         [--open-mode]
                         [--overwrite {false, true}]
                         [--sas-token]
                         [--snapshot]
                         [--start-range]
                         [--tags-condition]
                         [--timeout]
                         [--validate-content]
                         [--version-id]

Examples

Download a blob.

az storage blob download -f /path/to/file -c mycontainer -n MyBlob

Download a blob content to stdout(pipe support).

az storage blob download -c mycontainer -n myblob --account-name mystorageaccount --account-key myaccountkey

Optional Parameters

--account-key

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

--account-name

--auth-mode

Accepted values: key, login

--blob-endpoint

--blob-url

The full endpoint URL to the Blob, including SAS token and snapshot if used. This could be either the primary endpoint, or the secondary endpoint depending on the current location_mode.

--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--container-name -c

The container name.

--end-range

End of byte range to use for downloading a section of the blob. If end_range is given, start_range must be provided. The start_range and end_range params are inclusive. Ex: start_range=0, end_range=511 will download first 512 bytes of blob.

--file -f

Path of file to write out to. If not specified, stdout will be used and max_connections will be set to 1.

--if-match

An ETag value, or the wildcard character (*). Specify this header to perform the operation only if the resource's ETag matches the value specified.

--if-modified-since

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

--if-none-match

--if-unmodified-since

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

--lease-id

Required if the blob has an active lease.

--max-connections

The number of parallel connections with which to download.

Default value: 2

--name -n

The blob name.

--no-progress

Include this flag to disable progress reporting for the command.

Default value: False

--open-mode

Mode to use when opening the file. Note that specifying append only open_mode prevents parallel download. So, max_connections must be set to 1 if this open_mode is used.

Default value: wb

--overwrite

Overwrite an existing file when specified. Default value is true.

Accepted values: false, true

Default value: True

--sas-token

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

--snapshot

The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve.

--start-range

Start of byte range to use for downloading a section of the blob. If no end_range is given, all bytes after the start_range will be downloaded. The start_range and end_range params are inclusive. Ex: start_range=0, end_range=511 will download first 512 bytes of blob.

--tags-condition

Specify a SQL where clause on blob tags to operate only on blobs with a matching value.

--timeout

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

--validate-content

If true, calculates an MD5 hash for each chunk of the blob. The storage service checks the hash of the content that has arrived with the hash that was sent. This is primarily valuable for detecting bitflips on the wire if using http instead of https, as https (the default), will already validate. Note that this MD5 hash is not stored with the blob. Also note that if enabled, the memory-efficient algorithm will not be used because computing the MD5 hash requires buffering entire blocks, and doing so defeats the purpose of the memory-efficient algorithm.

Default value: False

--version-id

An optional blob version ID. This parameter is only for versioning enabled account.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az storage blob download-batch

Edit

Download blobs from a blob container recursively.

az storage blob download-batch --destination
                               --source
                               [--account-key]
                               [--account-name]
                               [--auth-mode {key, login}]
                               [--blob-endpoint]
                               [--connection-string]
                               [--dryrun]
                               [--max-connections]
                               [--no-progress]
                               [--overwrite {false, true}]
                               [--pattern]
                               [--sas-token]

Examples

Download all blobs that end with .py

az storage blob download-batch -d . --pattern "*.py" -s mycontainer --account-name mystorageaccount --account-key 00000000

Download all blobs in a directory named "dir" from container named "mycontainer".

az storage blob download-batch -d . -s mycontainer --pattern "dir/*"

Download all blobs with the format 'cli-2018-xx-xx.txt' or 'cli-2019-xx-xx.txt' in container to current path.

az storage blob download-batch -d . -s mycontainer --pattern "cli-201[89]-??-??.txt"

Download all blobs with the format 'cli-201x-xx-xx.txt' except cli-2018-xx-xx.txt' and 'cli-2019-xx-xx.txt' in container to current path.

az storage blob download-batch -d . -s mycontainer --pattern "cli-201[!89]-??-??.txt"

Required Parameters

--destination -d

The existing destination folder for this download operation.

--source -s

The blob container from where the files will be downloaded.

The source can be the container URL or the container name. When the source is the container URL, the storage account name will be parsed from the URL.

Optional Parameters

--account-key

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

--account-name

--auth-mode

Accepted values: key, login

--blob-endpoint

--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--dryrun

Show the summary of the operations to be taken instead of actually downloading the file(s).

Default value: False

--max-connections

The number of parallel connections with which to download.

Default value: 2

--no-progress

Include this flag to disable progress reporting for the command.

Default value: False

--overwrite

Overwrite an existing file when specified. Default value is false.

Accepted values: false, true

Default value: False

--pattern

When you use '*' in --pattern, it will match any character including the the directory separator '/'.

--sas-token

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az storage blob exists

Edit

Check for the existence of a blob in a container.

az storage blob exists [--account-key]
                       [--account-name]
                       [--auth-mode {key, login}]
                       [--blob-endpoint]
                       [--blob-url]
                       [--connection-string]
                       [--container-name]
                       [--name]
                       [--sas-token]
                       [--snapshot]
                       [--timeout]

Examples

Check for the existence of a blob in a container. (autogenerated)

az storage blob exists --account-key 00000000 --account-name MyAccount --container-name mycontainer --name MyBlob

Optional Parameters

--account-key

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

--account-name

--auth-mode

Accepted values: key, login

--blob-endpoint

--blob-url

The full endpoint URL to the Blob, including SAS token and snapshot if used. This could be either the primary endpoint, or the secondary endpoint depending on the current location_mode.

--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--container-name -c

The container name.

--name -n

The blob name.

--sas-token

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

--snapshot

The snapshot parameter is an opaque DateTime value that, when present, specifies the snapshot.

--timeout

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az storage blob filter

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List blobs across all containers whose tags match a given search expression.

az storage blob filter --tag-filter
                       [--account-key]
                       [--account-name]
                       [--auth-mode {key, login}]
                       [--blob-endpoint]
                       [--connection-string]
                       [--container-name]
                       [--sas-token]

Required Parameters

--tag-filter

The expression to find blobs whose tags matches the specified condition. eg. ""yourtagname"='firsttag' and "yourtagname2"='secondtag'".

Optional Parameters

--account-key

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

--account-name

--auth-mode

Accepted values: key, login

--blob-endpoint

--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--container-name -c

Used when you want to list blobs under a specified container.

--sas-token

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az storage blob generate-sas

Edit

Generate a shared access signature for the blob.

az storage blob generate-sas [--account-key]
                             [--account-name]
                             [--as-user]
                             [--auth-mode {key, login}]
                             [--blob-endpoint]
                             [--blob-url]
                             [--cache-control]
                             [--connection-string]
                             [--container-name]
                             [--content-disposition]
                             [--content-encoding]
                             [--content-language]
                             [--content-type]
                             [--encryption-scope]
                             [--expiry]
                             [--full-uri]
                             [--https-only]
                             [--ip]
                             [--name]
                             [--permissions]
                             [--policy-name]
                             [--snapshot]
                             [--start]
                             [--timeout]

Examples

Generate a sas token for a blob with read-only permissions.

end=`date -u -d "30 minutes" '+%Y-%m-%dT%H:%MZ'`
az storage blob generate-sas -c myycontainer -n MyBlob --permissions r --expiry $end --https-only

Generate a sas token for a blob with ip range specified.

end=`date -u -d "30 minutes" '+%Y-%m-%dT%H:%MZ'`
az storage blob generate-sas -c myycontainer -n MyBlob --ip "176.134.171.0-176.134.171.255" --permissions r --expiry $end --https-only

Generate a shared access signature for the blob. (autogenerated)

az storage blob generate-sas --account-key 00000000 --account-name MyStorageAccount --container-name mycontainer --expiry 2018-01-01T00:00:00Z --name MyBlob --permissions r

Optional Parameters

--account-key

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

--account-name

--as-user

Indicates that this command return the SAS signed with the user delegation key. The expiry parameter and '--auth-mode login' are required if this argument is specified.

Default value: False

--auth-mode

Accepted values: key, login

--blob-endpoint

--blob-url

The full endpoint URL to the Blob, including SAS token and snapshot if used. This could be either the primary endpoint, or the secondary endpoint depending on the current location_mode.

--cache-control

Response header value for Cache-Control when resource is accessed using this shared access signature.

--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--container-name -c

The container name.

--content-disposition

Response header value for Content-Disposition when resource is accessed using this shared access signature.

--content-encoding

Response header value for Content-Encoding when resource is accessed using this shared access signature.

--content-language

Response header value for Content-Language when resource is accessed using this shared access signature.

--content-type

Response header value for Content-Type when resource is accessed using this shared access signature.

--encryption-scope

A predefined encryption scope used to encrypt the data on the service.

--expiry

Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS becomes invalid. Do not use if a stored access policy is referenced with --policy-name that specifies this value.

--full-uri

Indicates that this command return the full blob URI and the shared access signature token.

Default value: False

--https-only

Only permit requests made with the HTTPS protocol. If omitted, requests from both the HTTP and HTTPS protocol are permitted.

--ip

Specifies the IP address or range of IP addresses from which to accept requests. Supports only IPv4 style addresses.

--name -n

The blob name.

--permissions

The permissions the SAS grants. Allowed values: (a)dd (c)reate (d)elete (e)xecute (i)set_immutability_policy (m)ove (r)ead (t)ag (w)rite (x)delete_previous_version (y)permanent_delete. Do not use if a stored access policy is referenced with --id that specifies this value. Can be combined.

--policy-name

The name of a stored access policy within the container's ACL.

--snapshot

An optional blob snapshot ID. Opaque DateTime value that, when present, specifies the blob snapshot to grant permission.

--start

Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS becomes valid. Do not use if a stored access policy is referenced with --policy-name that specifies this value. Defaults to the time of the request.

--timeout

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az storage blob generate-sas (storage-blob-preview extension)

Generate a shared access signature for the blob.

az storage blob generate-sas --container-name
                             --name
                             [--account-key]
                             [--account-name]
                             [--as-user]
                             [--auth-mode {key, login}]
                             [--blob-endpoint]
                             [--cache-control]
                             [--connection-string]
                             [--content-disposition]
                             [--content-encoding]
                             [--content-language]
                             [--content-type]
                             [--expiry]
                             [--full-uri]
                             [--https-only]
                             [--ip]
                             [--permissions]
                             [--policy-name]
                             [--snapshot]
                             [--start]
                             [--version-id]

Examples

Generate a sas token for a blob with read-only permissions.

end=`date -u -d "30 minutes" '+%Y-%m-%dT%H:%MZ'`
az storage blob generate-sas -c myycontainer -n MyBlob --permissions r --expiry $end --https-only

Generate a sas token for a blob with ip range specified.

end=`date -u -d "30 minutes" '+%Y-%m-%dT%H:%MZ'`
az storage blob generate-sas -c myycontainer -n MyBlob --ip "176.134.171.0-176.134.171.255" --permissions r --expiry $end --https-only

Generate a shared access signature for the blob. (autogenerated)

az storage blob generate-sas --account-key 00000000 --account-name MyStorageAccount --container-name mycontainer --expiry 2018-01-01T00:00:00Z --name MyBlob --permissions r

Required Parameters

--container-name -c

The container name.

--name -n

The blob name.

Optional Parameters

--account-key

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

--account-name

--as-user

Indicates that this command return the SAS signed with the user delegation key. The expiry parameter and '--auth-mode login' are required if this argument is specified.

Default value: False

--auth-mode

Accepted values: key, login

--blob-endpoint

--cache-control

Response header value for Cache-Control when resource is accessedusing this shared access signature.

--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--content-disposition

Response header value for Content-Disposition when resource is accessedusing this shared access signature.

--content-encoding

Response header value for Content-Encoding when resource is accessedusing this shared access signature.

--content-language

Response header value for Content-Language when resource is accessedusing this shared access signature.

--content-type

Response header value for Content-Type when resource is accessedusing this shared access signature.

--expiry

Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS becomes invalid. Do not use if a stored access policy is referenced with --id that specifies this value.

--full-uri

Indicate that this command return the full blob URI and the shared access signature token.

Default value: False

--https-only

Only permit requests made with the HTTPS protocol. If omitted, requests from both the HTTP and HTTPS protocol are permitted.

--ip

Specify an IP address or a range of IP addresses from which to accept requests. If the IP address from which the request originates does not match the IP address or address range specified on the SAS token, the request is not authenticated. For example, specifying ip=168.1.5.65 or ip=168.1.5.60-168.1.5.70 on the SAS restricts the request to those IP addresses.

--permissions

The permissions the SAS grants. Allowed values: (a)dd (c)reate (d)elete (x)delete_previous_version (e)xecute (m)ove (p)ermanent_delete (r)ead (s)et_immutability_policy (t)ag (w)rite. Do not use if a stored access policy is referenced with --policy-name that specifies this value. Can be combined.

--policy-name

The name of a stored access policy within the container's ACL.

--snapshot

The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve.

--start

Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS becomes valid. Do not use if a stored access policy is referenced with --id that specifies this value. Defaults to the time of the request.

--version-id

Preview

An optional blob version ID. This parameter is only for versioning enabled account.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az storage blob list

Edit

List blobs in a given container.

az storage blob list --container-name
                     [--account-key]
                     [--account-name]
                     [--auth-mode {key, login}]
                     [--blob-endpoint]
                     [--connection-string]
                     [--delimiter]
                     [--include]
                     [--marker]
                     [--num-results]
                     [--prefix]
                     [--sas-token]
                     [--show-next-marker]
                     [--timeout]

Examples

List all storage blobs in a container whose names start with 'foo'; will match names such as 'foo', 'foobar', and 'foo/bar'

az storage blob list -c mycontainer --prefix foo

Required Parameters

--container-name -c

The container name.

Optional Parameters

--account-key

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

--account-name

--auth-mode

Accepted values: key, login

--blob-endpoint

--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--delimiter

When the request includes this parameter, the operation returns a BlobPrefix element in the result list 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.

--include

Specify one or more additional datasets to include in the response. Options include: (c)opy, (d)eleted, (m)etadata, (s)napshots, (v)ersions, (t)ags, (i)mmutabilitypolicy, (l)egalhold, (d)eletedwithversions. Can be combined.

--marker

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. If specified, this generator will begin returning results from the point where the previous generator stopped.

--num-results

Specify the maximum number to return. If the request does not specify num_results, 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 remaining of the results. Provide "*" to return all.

Default value: 5000

--prefix

Filter the results to return only blobs whose name begins with the specified prefix.

--sas-token

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

--show-next-marker

Show nextMarker in result when specified.

--timeout

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az storage blob move

Preview Deprecated

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

This command has been deprecated and will be removed in future release. Use 'az storage fs file move' instead. For more information go to https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/storage/docs/ADLS%20Gen2.md

Move a blob in a storage container.

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

Examples

Move a blob in a storage container.

az storage blob move -c MyContainer -d DestinationBlobPath -s SourceBlobPath --account-name MyStorageAccount

Required Parameters

--container-name -c

The container name.

--destination-blob -d

The destination blob name. It should be an absolute path under the container. e.g.'topdir1/dirbar'.

--source-blob -s

The source blob name. It should be an absolute path under the container. e.g.'topdir1/dirsubfoo'.

Optional Parameters

--account-key

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

--account-name

--auth-mode

Accepted values: key, login

--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--lease-id

Optional. A lease ID for the new_path. The new_path must have an active lease and the lease ID must match.

--sas-token

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

--source-if-match

Optional. An ETag value. Specify this header to perform the rename operation only if the source's ETag matches the value specified.

--source-if-modified-since

Optional. A date and time value. Specify this header to perform the rename operation only if the source has been modified since the specified date and time.

--source-if-none-match

Optional. An ETag value or the special wildcard ("*") value. Specify this header to perform the rename operation only if the source's ETag does not match the value specified.

--source-if-unmodified-since

Optional. A date and time value. Specify this header to perform the rename operation only if the source has not been modified since the specified date and time.

--source-lease-id

Optional. A lease ID for the source_path. The source_path must have an active lease and the lease ID must match.

--timeout

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az storage blob query

Edit

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Enable users to select/project on blob or blob snapshot data by providing simple query expressions.

az storage blob query --query-expression
                      [--account-key]
                      [--account-name]
                      [--auth-mode {key, login}]
                      [--blob-endpoint]
                      [--blob-url]
                      [--connection-string]
                      [--container-name]
                      [--if-match]
                      [--if-modified-since]
                      [--if-none-match]
                      [--if-unmodified-since]
                      [--in-column-separator]
                      [--in-escape-char]
                      [--in-has-header]
                      [--in-line-separator]
                      [--in-quote-char]
                      [--in-record-separator]
                      [--input-format {csv, json}]
                      [--lease-id]
                      [--name]
                      [--out-column-separator]
                      [--out-escape-char]
                      [--out-has-header]
                      [--out-line-separator]
                      [--out-quote-char]
                      [--out-record-separator]
                      [--output-format {csv, json}]
                      [--result-file]
                      [--sas-token]
                      [--tags-condition]
                      [--timeout]

Examples

Enable users to select/project on blob by providing simple query expressions.

az storage blob query -c mycontainer -n myblob --query-expression "SELECT _2 from BlobStorage"

Enable users to select/project on blob by providing simple query expressions and save in target file.

az storage blob query -c mycontainer -n myblob --query-expression "SELECT _2 from BlobStorage" --result-file result.csv

Required Parameters

--query-expression

The query expression in SQL. The maximum size of the query expression is 256KiB. For more information about the expression syntax, please see https://docs.microsoft.com/azure/storage/blobs/query-acceleration-sql-reference.

Optional Parameters

--account-key

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

--account-name

--auth-mode

Accepted values: key, login

--blob-endpoint

--blob-url

The full endpoint URL to the Blob, including SAS token and snapshot if used. This could be either the primary endpoint, or the secondary endpoint depending on the current location_mode.

--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--container-name -c

The container name.

--if-match

An ETag value, or the wildcard character (*). Specify this header to perform the operation only if the resource's ETag matches the value specified.

--if-modified-since

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

--if-none-match

--if-unmodified-since

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

--in-column-separator

The string used to separate columns.

Default value: ,

--in-escape-char

The string used as an escape character. Default to empty.

--in-has-header

Whether the blob data includes headers in the first line. The default value is False, meaning that the data will be returned inclusive of the first line. If set to True, the data will be returned exclusive of the first line.

Default value: False

--in-line-separator

The string used to separate records.

Default value:

--in-quote-char

The string used to quote a specific field.

Default value: "

--in-record-separator

The string used to separate records.

Default value:

--input-format

Serialization type of the data currently stored in the blob. The default is to treat the blob data as CSV data formatted in the default dialect.The blob data will be reformatted according to that profile when blob format is specified. If you choose json, please specify Output Json Text Configuration Arguments accordingly; If you choose csv, please specify Output Delimited Text Configuration Arguments.

Accepted values: csv, json

--lease-id

Required if the blob has an active lease.

--name -n

The blob name.

--out-column-separator

The string used to separate columns.

Default value: ,

--out-escape-char

The string used as an escape character. Default to empty.

--out-has-header

Default value: False

--out-line-separator

The string used to separate records.

Default value:

--out-quote-char

The string used to quote a specific field.

Default value: "

--out-record-separator

The string used to separate records.

Default value:

--output-format

Output serialization type for the data stream. By default the data will be returned as it is represented in the blob. By providing an output format, the blob data will be reformatted according to that profile. If you choose json, please specify Output Json Text Configuration Arguments accordingly; If you choose csv, please specify Output Delimited Text Configuration Arguments.

Accepted values: csv, json

--result-file

Specify the file path to save result.

--sas-token

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

--tags-condition

Specify a SQL where clause on blob tags to operate only on blobs with a matching value.

--timeout

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az storage blob restore

Edit

Restore blobs in the specified blob ranges.

az storage blob restore --account-name
                        --time-to-restore
                        [--blob-range]
                        [--no-wait]
                        [--resource-group]

Examples

Restore blobs in two specified blob ranges. For examples, (container1/blob1, container2/blob2) and (container2/blob3..container2/blob4).

az storage blob restore --account-name mystorageaccount -g MyResourceGroup -t 2020-02-27T03:59:59Z -r container1/blob1 container2/blob2 -r container2/blob3 container2/blob4

Restore blobs in the specified blob ranges from account start to account end.

az storage blob restore --account-name mystorageaccount -g MyResourceGroup -t 2020-02-27T03:59:59Z -r "" ""

Restore blobs in the specified blob range.

time=`date -u -d "30 minutes" '+%Y-%m-%dT%H:%MZ'`
az storage blob restore --account-name mystorageaccount -g MyResourceGroup -t $time -r container0/blob1 container0/blob2

Restore blobs in the specified blob range without wait and query blob restore status with 'az storage account show'.

time=`date -u -d "30 minutes" '+%Y-%m-%dT%H:%MZ'`
az storage blob restore --account-name mystorageaccount -g MyResourceGroup -t $time -r container0/blob1 container0/blob2 --no-wait

Required Parameters

--account-name -n

The storage account name.

--time-to-restore -t

Restore blob to the specified time, which should be UTC datetime in (Y-m-d'T'H:M:S'Z').

Optional Parameters

--blob-range -r

Blob ranges to restore. You need to two values to specify start_range and end_range for each blob range, e.g. -r blob1 blob2. Note: Empty means account start as start range value, and means account end for end range.

--no-wait

Do not wait for the long-running operation to finish.

Default value: False

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az storage blob rewrite

Edit

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a new Block Blob where the content of the blob is read from a given URL.

The content of an existing blob is overwritten with the new blob.

az storage blob rewrite --container-name
                        --name
                        --source-uri
                        [--account-key]
                        [--account-name]
                        [--auth-mode {key, login}]
                        [--blob-endpoint]
                        [--connection-string]
                        [--encryption-scope]
                        [--if-match]
                        [--if-modified-since]
                        [--if-none-match]
                        [--if-unmodified-since]
                        [--lease-id]
                        [--sas-token]
                        [--tags-condition]
                        [--tier {Archive, Cold, Cool, Hot, P10, P15, P20, P30, P4, P40, P50, P6, P60, P70, P80}]
                        [--timeout]

Examples

Update encryption scope for existing blob.

az storage blob rewrite --source-uri https://srcaccount.blob.core.windows.net/mycontainer/myblob?<sastoken> --encryption-scope newscope -c mycontainer -n myblob --account-name mystorageaccount --account-key 0000-0000

Required Parameters

--container-name -c

The container name.

--name -n

The blob name.

--source-uri -u

A URL of up to 2 KB in length that specifies a 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.

Optional Parameters

--account-key

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

--account-name

--auth-mode

Accepted values: key, login

--blob-endpoint

--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--encryption-scope

A predefined encryption scope used to encrypt the data on the service. An encryption scope can be created using the Management API and referenced here by name. If a default encryption scope has been defined at the container, this value will override it if the container-level scope is configured to allow overrides. Otherwise an error will be raised.

--if-match

An ETag value, or the wildcard character (*). Specify this header to perform the operation only if the resource's ETag matches the value specified.

--if-modified-since

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

--if-none-match

--if-unmodified-since

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

--lease-id

Required if the blob has an active lease. Value can be a BlobLeaseClient object or the lease ID as a string.

--sas-token

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

--tags-condition

Specify a SQL where clause on blob tags to operate only on blobs with a matching value.

--tier

A standard blob tier value to set the blob to. For this version of the library, this is only applicable to block blobs on standard storage accounts.

Accepted values: Archive, Cold, Cool, Hot, P10, P15, P20, P30, P4, P40, P50, P6, P60, P70, P80

--timeout

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az storage blob set-legal-hold

Edit

Set blob legal hold.

az storage blob set-legal-hold --container-name
                               --legal-hold {false, true}
                               --name
                               [--account-key]
                               [--account-name]
                               [--auth-mode {key, login}]
                               [--blob-endpoint]
                               [--connection-string]
                               [--sas-token]
                               [--timeout]

Examples

Configure blob legal hold.

az storage blob set-legal-hold --legal-hold -c mycontainer -n myblob --account-name mystorageaccount --account-key 0000-0000

Clear blob legal hold.

az storage blob set-legal-hold --legal-hold false -c mycontainer -n myblob --account-name mystorageaccount --account-key 0000-0000

Required Parameters

--container-name -c

The container name.

--legal-hold

Specified if a legal hold should be set on the blob.

Accepted values: false, true

--name -n

The blob name.

Optional Parameters

--account-key

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

--account-name

--auth-mode

Accepted values: key, login

--blob-endpoint

--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 or service endpoint. Environment variable: AZURE_STORAGE_SAS_TOKEN.

--timeout

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az storage blob set-tier

Edit

Set the block or page tiers on the blob.

For block blob this command only supports block blob on standard storage accounts. For page blob, this command only supports for page blobs on premium accounts.

az storage blob set-tier --tier
                         [--account-key]
                         [--account-name]
                         [--auth-mode {key, login}]
                         [--blob-endpoint]
                         [--blob-url]
                         [--connection-string]
                         [--container-name]
                         [--name]
                         [--rehydrate-priority {High, Standard}]
                         [--sas-token]
                         [--timeout]
                         [--type {block, page}]

Examples

Set the block or page tiers on the blob. (autogenerated)

az storage blob set-tier --account-key 00000000 --account-name MyAccount --container-name mycontainer --name MyBlob --tier P10

Required Parameters

--tier

The tier value to set the blob to.

Optional Parameters

--account-key

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

--account-name

--auth-mode

Accepted values: key, login

--blob-endpoint

--blob-url

The full endpoint URL to the Blob, including SAS token and snapshot if used. This could be either the primary endpoint, or the secondary endpoint depending on the current location_mode.

--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--container-name -c

The container name.

--name -n

The blob name.

--rehydrate-priority -r

Preview

Indicate the priority with which to rehydrate an archived blob. The priority can be set on a blob only once, default value is Standard.

Accepted values: High, Standard

--sas-token

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

--timeout

The timeout parameter is expressed in seconds. This method may make multiple calls to the Azure service and the timeout will apply to each call individually.

--type -t

The blob type.

Accepted values: block, page

Default value: block

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az storage blob set-tier (storage-blob-preview extension)

Set the block or page tiers on the blob.

For block blob this command only supports block blob on standard storage accounts. For page blob, this command only supports for page blobs on premium accounts.

az storage blob set-tier --tier
                         [--account-key]
                         [--account-name]
                         [--auth-mode {key, login}]
                         [--blob-endpoint]
                         [--blob-url]
                         [--connection-string]
                         [--container-name]
                         [--name]
                         [--rehydrate-priority {High, Standard}]
                         [--sas-token]
                         [--tags-condition]
                         [--timeout]
                         [--type {block, page}]
                         [--version-id]

Examples

Set the block or page tiers on the blob. (autogenerated)

az storage blob set-tier --account-key 00000000 --account-name MyAccount --container-name mycontainer --name MyBlob --tier P10

Required Parameters

--tier

The tier value to set the blob to.

Optional Parameters

--account-key

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

--account-name

--auth-mode

Accepted values: key, login

--blob-endpoint

--blob-url

The full endpoint URL to the Blob, including SAS token and snapshot if used. This could be either the primary endpoint, or the secondary endpoint depending on the current location_mode.

--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--container-name -c

The container name.

--name -n

The blob name.

--rehydrate-priority -r

Preview

Indicate the priority with which to rehydrate an archived blob.

Accepted values: High, Standard

--sas-token

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

--tags-condition

Specify a SQL where clause on blob tags to operate only on blobs with a matching value.

--timeout

The timeout parameter is expressed in seconds. This method may make multiple calls to the Azure service and the timeout will apply to each call individually.

--type -t

The blob type.

Accepted values: block, page

Default value: block

--version-id

An optional blob version ID. This parameter is only for versioning enabled account.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az storage blob show

Edit

Get the details of a blob.

az storage blob show [--account-key]
                     [--account-name]
                     [--auth-mode {key, login}]
                     [--blob-endpoint]
                     [--blob-url]
                     [--connection-string]
                     [--container-name]
                     [--if-match]
                     [--if-modified-since]
                     [--if-none-match]
                     [--if-unmodified-since]
                     [--lease-id]
                     [--name]
                     [--sas-token]
                     [--snapshot]
                     [--tags-condition]
                     [--timeout]

Examples

Show all properties of a blob.

az storage blob show -c mycontainer -n MyBlob

Get the details of a blob (autogenerated)

az storage blob show --account-name mystorageccount --account-key 00000000 --container-name mycontainer --name MyBlob

Optional Parameters

--account-key

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

--account-name

--auth-mode

Accepted values: key, login

--blob-endpoint

--blob-url

The full endpoint URL to the Blob, including SAS token and snapshot if used. This could be either the primary endpoint, or the secondary endpoint depending on the current location_mode.

--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--container-name -c

The container name.

--if-match

An ETag value, or the wildcard character (*). Specify this header to perform the operation only if the resource's ETag matches the value specified.

--if-modified-since

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

--if-none-match

--if-unmodified-since

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

--lease-id

Required if the blob has an active lease.

--name -n

The blob name.

--sas-token

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

--snapshot

The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve.

--tags-condition

Specify a SQL where clause on blob tags to operate only on blobs with a matching value.

--timeout

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az storage blob show (storage-blob-preview extension)

Get the details of a blob.

az storage blob show [--account-key]
                     [--account-name]
                     [--auth-mode {key, login}]
                     [--blob-endpoint]
                     [--blob-url]
                     [--connection-string]
                     [--container-name]
                     [--if-match]
                     [--if-modified-since]
                     [--if-none-match]
                     [--if-unmodified-since]
                     [--lease-id]
                     [--name]
                     [--sas-token]
                     [--snapshot]
                     [--tags-condition]
                     [--timeout]
                     [--version-id]

Examples

Show all properties of a blob.

az storage blob show -c mycontainer -n MyBlob

Get the details of a blob (autogenerated)

az storage blob show --account-name mystorageccount --account-key 00000000 --container-name mycontainer --name MyBlob

Optional Parameters

--account-key

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

--account-name

--auth-mode

Accepted values: key, login

--blob-endpoint

--blob-url

The full endpoint URL to the Blob, including SAS token and snapshot if used. This could be either the primary endpoint, or the secondary endpoint depending on the current location_mode.

--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--container-name -c

The container name.

--if-match

An ETag value, or the wildcard character (*). Specify this header to perform the operation only if the resource's ETag matches the value specified.

--if-modified-since

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

--if-none-match

--if-unmodified-since

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

--lease-id

Required if the blob has an active lease.

--name -n

The blob name.

--sas-token

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

--snapshot

The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve.

--tags-condition

Specify a SQL where clause on blob tags to operate only on blobs with a matching value.

--timeout

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

--version-id

Preview

An optional blob version ID. This parameter is only for versioning enabled account.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az storage blob snapshot

Edit

Creates a snapshot of the blob.

A snapshot is a read-only version of a blob that's taken at a point in time. It can be read, copied, or deleted, but not modified. Snapshots provide a way to back up a blob as it appears at a moment in time. A snapshot of a blob has the same name as the base blob from which the snapshot is taken, with a DateTime value appended to indicate the time at which the snapshot was taken.

az storage blob snapshot [--account-key]
                         [--account-name]
                         [--auth-mode {key, login}]
                         [--blob-endpoint]
                         [--blob-url]
                         [--connection-string]
                         [--container-name]
                         [--if-match]
                         [--if-modified-since]
                         [--if-none-match]
                         [--if-unmodified-since]
                         [--lease-id]
                         [--metadata]
                         [--name]
                         [--sas-token]
                         [--tags-condition]
                         [--timeout]

Optional Parameters

--account-key

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

--account-name

--auth-mode

Accepted values: key, login

--blob-endpoint

--blob-url

The full endpoint URL to the Blob, including SAS token and snapshot if used. This could be either the primary endpoint, or the secondary endpoint depending on the current location_mode.

--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--container-name -c

The container name.

--if-match

An ETag value, or the wildcard character (*). Specify this header to perform the operation only if the resource's ETag matches the value specified.

--if-modified-since

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

--if-none-match

--if-unmodified-since

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

--lease-id

Required if the blob has an active lease.

--metadata

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

--name -n

The blob name.

--sas-token

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

--tags-condition

Specify a SQL where clause on blob tags to operate only on blobs with a matching value.

--timeout

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az storage blob sync

Edit

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Sync blobs recursively to a storage blob container.

az storage blob sync --container
                     --source
                     [--account-key]
                     [--account-name]
                     [--auth-mode {key, login}]
                     [--connection-string]
                     [--delete-destination {false, prompt, true}]
                     [--destination]
                     [--exclude-path]
                     [--exclude-pattern]
                     [--include-pattern]
                     [--sas-token]
                     [<EXTRA_OPTIONS>]

Examples

Sync a single blob to a container.

az storage blob sync -c mycontainer -s "path/to/file" -d NewBlob

Sync a directory to a container.

az storage blob sync -c mycontainer --account-name mystorageccount --account-key 00000000 -s "path/to/directory"

Sync a directory to a container with azcopy options pass-through (in this case capping the upload bandwith to 20 MBit/s).

az storage blob sync -c mycontainer --account-name mystorageccount --account-key 00000000 -s "path/to/directory" -- --cap-mbps=20

Required Parameters

--container -c

The sync destination container.

--source -s

The source file path to sync from.

Optional Parameters

--account-key

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

--account-name

--auth-mode

Accepted values: key, login

--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--delete-destination

Defines whether to delete extra files from the destination that are not present at the source. Could be set to true, false, or prompt. If set to prompt, the user will be asked a question before scheduling files and blobs for deletion.

Accepted values: false, prompt, true

Default value: true

--destination -d

The destination path that will be prepended to the blob name.

--exclude-path

Exclude these paths. This option does not support wildcard characters (*). Checks relative path prefix. For example: myFolder;myFolder/subDirName/file.pdf.

--exclude-pattern

Exclude these files where the name matches the pattern list. For example: .jpg;.pdf;exactName. This option supports wildcard characters (*).

--include-pattern

Include only these files where the name matches the pattern list. For example: .jpg;.pdf;exactName. This option supports wildcard characters (*).

--sas-token

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

<EXTRA_OPTIONS>

Experimental

Other options which will be passed through to azcopy as it is. Please put all the extra options after a --.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az storage blob undelete

Edit

Restore soft deleted blob or snapshot.

Operation will only be successful if used within the specified number of days set in the delete retention policy. Attempting to undelete a blob or snapshot that is not soft deleted will succeed without any changes.

az storage blob undelete [--account-key]
                         [--account-name]
                         [--auth-mode {key, login}]
                         [--blob-endpoint]
                         [--blob-url]
                         [--connection-string]
                         [--container-name]
                         [--name]
                         [--sas-token]
                         [--timeout]

Examples

Undelete a blob.

az storage blob undelete -c mycontainer -n MyBlob

Undelete a blob using login credentials.

az storage blob undelete -c mycontainer -n MyBlob --account-name mystorageaccount --auth-mode login

Optional Parameters

--account-key

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

--account-name

--auth-mode

Accepted values: key, login

--blob-endpoint

--blob-url

The full endpoint URL to the Blob, including SAS token and snapshot if used. This could be either the primary endpoint, or the secondary endpoint depending on the current location_mode.

--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--container-name -c

The container name.

--name -n

The blob name.

--sas-token

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

--timeout

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az storage blob update

Edit

Sets system properties on the blob.

If one property is set for the content_settings, all properties will be overridden.

az storage blob update --container-name
                       --name
                       [--account-key]
                       [--account-name]
                       [--auth-mode {key, login}]
                       [--blob-endpoint]
                       [--clear-content-settings {false, true}]
                       [--connection-string]
                       [--content-cache]
                       [--content-disposition]
                       [--content-encoding]
                       [--content-language]
                       [--content-md5]
                       [--content-type]
                       [--if-match]
                       [--if-modified-since]
                       [--if-none-match]
                       [--if-unmodified-since]
                       [--lease-id]
                       [--sas-token]
                       [--tags-condition]
                       [--timeout]

Required Parameters

--container-name -c

The container name.

--name -n

The blob name.

Optional Parameters

--account-key

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

--account-name

--auth-mode

Accepted values: key, login

--blob-endpoint

--clear-content-settings

If this flag is set, then if any one or more of the following properties (--content-cache-control, --content-disposition, --content-encoding, --content-language, --content-md5, --content-type) is set, then all of these properties are set together. If a value is not provided for a given property when at least one of the properties listed below is set, then that property will be cleared.

Accepted values: false, true

--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--content-cache --content-cache-control

The cache control string.

--content-disposition

Conveys additional information about how to process the response payload, and can also be used to attach additional metadata.

--content-encoding

The content encoding type.

--content-language

The content language.

--content-md5

The content's MD5 hash.

--content-type

The content MIME type.

--if-match

An ETag value, or the wildcard character (*). Specify this header to perform the operation only if the resource's ETag matches the value specified.

--if-modified-since

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

--if-none-match

--if-unmodified-since

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

--lease-id

Required if the blob has an active lease.

--sas-token

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

--tags-condition

Specify a SQL where clause on blob tags to operate only on blobs with a matching value.

--timeout

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az storage blob upload

Edit

Upload a file to a storage blob.

Create a new blob from a file path, or updates the content of an existing blob with automatic chunking and progress notifications.

az storage blob upload [--account-key]
                       [--account-name]
                       [--auth-mode {key, login}]
                       [--blob-endpoint]
                       [--blob-url]
                       [--connection-string]
                       [--container-name]
                       [--content-cache]
                       [--content-disposition]
                       [--content-encoding]
                       [--content-language]
                       [--content-md5]
                       [--content-type]
                       [--data]
                       [--encryption-scope]
                       [--file]
                       [--if-match]
                       [--if-modified-since]
                       [--if-none-match]
                       [--if-unmodified-since]
                       [--lease-id]
                       [--length]
                       [--max-connections]
                       [--maxsize-condition]
                       [--metadata]
                       [--name]
                       [--no-progress]
                       [--overwrite {false, true}]
                       [--sas-token]
                       [--socket-timeout]
                       [--tags]
                       [--tags-condition]
                       [--tier]
                       [--timeout]
                       [--type {append, block, page}]
                       [--validate-content]

Examples

Upload to a blob.

az storage blob upload -f /path/to/file -c mycontainer -n MyBlob

Upload to a blob with blob sas url.

az storage blob upload -f /path/to/file --blob-url https://mystorageaccount.blob.core.windows.net/mycontainer/myblob?sv=2019-02-02&st=2020-12-22T07%3A07%3A29Z&se=2020-12-23T07%3A07%3A29Z&sr=b&sp=racw&sig=redacted

Upload a file to a storage blob. (autogenerated)

az storage blob upload --account-name mystorageaccount --account-key 0000-0000 --container-name mycontainer --file /path/to/file --name myblob

Upload a string to a blob.

az storage blob upload --data "teststring" -c mycontainer -n myblob --account-name mystorageaccount --account-key 0000-0000

Upload to a through pipe.

echo $data | az storage blob upload --data @- -c mycontainer -n myblob --account-name mystorageaccount --account-key 0000-0000

Optional Parameters

--account-key

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

--account-name

--auth-mode

Accepted values: key, login

--blob-endpoint

--blob-url

The full endpoint URL to the Blob, including SAS token and snapshot if used. This could be either the primary endpoint, or the secondary endpoint depending on the current location_mode.

--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--container-name -c

The container name.

--content-cache --content-cache-control

The cache control string.

--content-disposition

Conveys additional information about how to process the response payload, and can also be used to attach additional metadata.

--content-encoding

The content encoding type.

--content-language

The content language.

--content-md5

The content's MD5 hash.

--content-type

The content MIME type.

--data

Preview

The blob data to upload.

--encryption-scope

A predefined encryption scope used to encrypt the data on the service.

--file -f

Path of the file to upload as the blob content.

--if-match

An ETag value, or the wildcard character (*). Specify this header to perform the operation only if the resource's ETag matches the value specified.

--if-modified-since

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

--if-none-match

--if-unmodified-since

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

--lease-id

Required if the blob has an active lease.

--length

Preview

Number of bytes to read from the stream. This is optional, but should be supplied for optimal performance. Cooperate with --data.

--max-connections

Maximum number of parallel connections to use when the blob size exceeds 64MB.

Default value: 2

--maxsize-condition

The max length in bytes permitted for an append blob.

--metadata

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

--name -n

The blob name.

--no-progress

Include this flag to disable progress reporting for the command.

Default value: False

--overwrite

Whether the blob to be uploaded should overwrite the current data. If True, blob upload operation will overwrite the existing data. If set to False, the operation will fail with ResourceExistsError. The exception to the above is with Append blob types: if set to False and the data already exists, an error will not be raised and the data will be appended to the existing blob. If set overwrite=True, then the existing append blob will be deleted, and a new one created. Defaults to False.

Accepted values: false, true

--sas-token

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

--socket-timeout

The socket timeout(secs), used by the service to regulate data flow.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--tags-condition

Specify a SQL where clause on blob tags to operate only on blobs with a matching value.

--tier

The tier value to set the blob to. For page blob, the tier correlates to the size of the blob and number of allowed IOPS. Possible values are P10, P15, P20, P30, P4, P40, P50, P6, P60, P70, P80 and this is only applicable to page blobs on premium storage accounts; For block blob, possible values are Archive, Cold, Cool, and Hot. This is only applicable to block blobs on standard storage accounts.

--timeout

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

--type -t

Default to 'page' for *.vhd files, or 'block' otherwise.

Accepted values: append, block, page

--validate-content

Specify that an MD5 hash shall be calculated for each chunk of the blob and verified by the service when the chunk has arrived.

Default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az storage blob upload-batch

Edit

Upload files from a local directory to a blob container.

az storage blob upload-batch --destination
                             --source
                             [--account-key]
                             [--account-name]
                             [--auth-mode {key, login}]
                             [--blob-endpoint]
                             [--connection-string]
                             [--content-cache]
                             [--content-disposition]
                             [--content-encoding]
                             [--content-language]
                             [--content-md5]
                             [--content-type]
                             [--destination-path]
                             [--dryrun]
                             [--if-match]
                             [--if-modified-since]
                             [--if-none-match]
                             [--if-unmodified-since]
                             [--lease-id]
                             [--max-connections]
                             [--maxsize-condition]
                             [--metadata]
                             [--no-progress]
                             [--overwrite {false, true}]
                             [--pattern]
                             [--sas-token]
                             [--socket-timeout]
                             [--tags]
                             [--tags-condition]
                             [--tier]
                             [--timeout]
                             [--type {append, block, page}]
                             [--validate-content]

Examples

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

az storage blob upload-batch -d mycontainer --account-name mystorageaccount --account-key 00000000 -s <path-to-directory> --pattern "*.py" --if-unmodified-since 2018-08-27T20:51Z

Upload all files from local path directory to a container named "mycontainer".

az storage blob upload-batch -d mycontainer -s <path-to-directory>

Upload all files with the format 'cli-2018-xx-xx.txt' or 'cli-2019-xx-xx.txt' in local path directory.

az storage blob upload-batch -d mycontainer -s <path-to-directory> --pattern "cli-201[89]-??-??.txt"

Upload all files with the format 'cli-201x-xx-xx.txt' except cli-2018-xx-xx.txt' and 'cli-2019-xx-xx.txt' in a container.

az storage blob upload-batch -d mycontainer -s <path-to-directory> --pattern "cli-201[!89]-??-??.txt"

Required Parameters

--destination -d

The blob container where the files will be uploaded.

The destination can be the container URL or the container name. When the destination is the container URL, the storage account name will be parsed from the URL.

--source -s

The directory where the files to be uploaded are located.

Optional Parameters

--account-key

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

--account-name

--auth-mode

Accepted values: key, login

--blob-endpoint

--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--content-cache --content-cache-control

The cache control string.

--content-disposition

Conveys additional information about how to process the response payload, and can also be used to attach additional metadata.

--content-encoding

The content encoding type.

--content-language

The content language.

--content-md5

The content's MD5 hash.

--content-type

The content MIME type.

--destination-path

The destination path that will be prepended to the blob name.

--dryrun

Show the summary of the operations to be taken instead of actually uploading the file(s).

Default value: False

--if-match

An ETag value, or the wildcard character (*). Specify this header to perform the operation only if the resource's ETag matches the value specified.

--if-modified-since

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

--if-none-match

An ETag value, or the wildcard character (*).

--if-unmodified-since

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

--lease-id

The active lease id for the blob.

--max-connections

Maximum number of parallel connections to use when the blob size exceeds 64MB.

Default value: 2

--maxsize-condition

The max length in bytes permitted for an append blob.

--metadata

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

--no-progress

Include this flag to disable progress reporting for the command.

Default value: False

--overwrite

Accepted values: false, true

--pattern

When you use '*' in --pattern, it will match any character including the the directory separator '/'.

--sas-token

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

--socket-timeout

Deprecated

Argument 'socket_timeout' has been deprecated and will be removed in a future release.

The socket timeout(secs), used by the service to regulate data flow.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--tags-condition

Specify a SQL where clause on blob tags to operate only on blobs with a matching value.

--tier

--timeout

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

--type -t

Defaults to 'page' for *.vhd files, or 'block' otherwise. The setting will override blob types for every file.

Accepted values: append, block, page

--validate-content

Specifies that an MD5 hash shall be calculated for each chunk of the blob and verified by the service when the chunk has arrived.

Default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az storage blob url

Edit

Create the url to access a blob.

az storage blob url --container-name
                    --name
                    [--account-key]
                    [--account-name]
                    [--auth-mode {key, login}]
                    [--blob-endpoint]
                    [--connection-string]
                    [--protocol {http, https}]
                    [--sas-token]
                    [--snapshot]

Examples

Create the url to access a blob (autogenerated)

az storage blob url --connection-string $connectionString --container-name container1 --name blob1

Create the url to access a blob (autogenerated)

az storage blob url --account-name storageacct --account-key 00000000 --container-name container1 --name blob1

Required Parameters

--container-name -c

The container name.

--name -n

The blob name.

Optional Parameters

--account-key

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

--account-name

--auth-mode

Accepted values: key, login

--blob-endpoint

--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--protocol

Protocol to use.

Accepted values: http, https

Default value: https

--sas-token

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

--snapshot

An string value that uniquely identifies the snapshot. The value of this query parameter indicates the snapshot version.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

Share via

az storage blob

Commands

az storage blob delete

Examples

Optional Parameters

az storage blob delete (storage-blob-preview extension)

Examples

Optional Parameters

az storage blob delete-batch

Examples

Required Parameters

Optional Parameters

az storage blob download

Examples

Optional Parameters

az storage blob download-batch

Examples

Required Parameters

Optional Parameters

az storage blob exists

Examples

Optional Parameters

az storage blob filter

Required Parameters

Optional Parameters

az storage blob generate-sas

Examples

Optional Parameters

az storage blob generate-sas (storage-blob-preview extension)

Examples

Required Parameters

Optional Parameters

az storage blob list

Examples

Required Parameters

Optional Parameters

az storage blob move

Examples

Required Parameters

Optional Parameters

az storage blob query

Examples

Required Parameters

Optional Parameters

az storage blob restore

Examples

Required Parameters

Optional Parameters

az storage blob rewrite

Examples

Required Parameters

Optional Parameters

az storage blob set-legal-hold

Examples

Required Parameters

Optional Parameters

az storage blob set-tier

Examples

Required Parameters

Optional Parameters

az storage blob set-tier (storage-blob-preview extension)

Examples

Required Parameters

Optional Parameters

az storage blob show

Examples

Optional Parameters

az storage blob show (storage-blob-preview extension)

Examples

Optional Parameters

az storage blob snapshot

Optional Parameters

az storage blob sync

Examples

Required Parameters

Optional Parameters

az storage blob undelete

Examples

Optional Parameters