az storage blob immutability-policy

Note

This reference is part of the storage-blob-preview extension for Azure CLI and requires version 2.27.0 or higher. The extension will automatically install the first time you run an az storage blob immutability-policy command. Learn more about extensions.

Manage blob immutability policy.

Commands

az storage blob immutability-policy delete

Delete blob's immutability policy.

az storage blob immutability-policy set

Set blob's immutability policy.

az storage blob immutability-policy delete

Delete blob's immutability policy.

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

Examples

Delete an unlocked immutability policy.

az storage blob immutability-policy delete -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. 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-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. Environment variable: AZURE_STORAGE_SAS_TOKEN.

--timeout

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

az storage blob immutability-policy set

Set blob's immutability policy.

az storage blob immutability-policy set [--account-key]
                                        [--account-name]
                                        [--auth-mode {key, login}]
                                        [--blob-url]
                                        [--connection-string]
                                        [--container-name]
                                        [--expiry-time]
                                        [--name]
                                        [--policy-mode {Locked, Unlocked}]
                                        [--sas-token]
                                        [--timeout]

Examples

Set an unlocked immutability policy.

az storage blob immutability-policy set --expiry-time 2021-09-07T08:00:00Z --policy-mode Unlocked -c mycontainer -n myblob --account-name mystorageaccount

Lock a immutability policy.

az storage blob immutability-policy set --policy-mode Locked -c mycontainer -n myblob --account-name mystorageaccount

Optional Parameters

--account-key

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

--account-name

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

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

--expiry-time

Expiration UTC datetime in (Y-m-d'T'H:M:S'Z').

--name -n

The blob name.

--policy-mode

Lock or Unlock the policy.

accepted values: Locked, Unlocked
--sas-token

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

--timeout

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