az storage blob immutability-policy
Manage blob immutability policy.
Commands
Name | Description | Type | Status |
---|---|---|---|
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 immutability-policy delete
Delete blob's immutability policy.
az storage blob immutability-policy delete --container-name
--name
[--account-key]
[--account-name]
[--auth-mode {key, login}]
[--blob-endpoint]
[--connection-string]
[--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
Required Parameters
The container name.
The blob name.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Storage account key. Must be used in conjunction with storage account name or service endpoint. Environment variable: AZURE_STORAGE_KEY.
Property | Value |
---|---|
Parameter group: | Storage Account Arguments |
Storage account name. Related environment variable: AZURE_STORAGE_ACCOUNT. Must be used in conjunction with either storage account key or a SAS token. If neither are present, the command will try to query the storage account key using the authenticated Azure account. If a large number of storage commands are executed the API quota may be hit.
Property | Value |
---|---|
Parameter group: | Storage Account Arguments |
The mode in which to run the command. "login" mode will directly use your login credentials for the authentication. The legacy "key" mode will attempt to query for an account key if no authentication parameters for the account are provided. Environment variable: AZURE_STORAGE_AUTH_MODE.
Property | Value |
---|---|
Accepted values: | key, login |
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.
Property | Value |
---|---|
Parameter group: | Storage Account Arguments |
Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.
Property | Value |
---|---|
Parameter group: | Storage Account Arguments |
A Shared Access Signature (SAS). Must be used in conjunction with storage account name or service endpoint. Environment variable: AZURE_STORAGE_SAS_TOKEN.
Property | Value |
---|---|
Parameter group: | Storage Account Arguments |
Request timeout in seconds. Applies to each call to the service.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az storage blob immutability-policy set
Set blob's immutability policy.
az storage blob immutability-policy set --container-name
--name
[--account-key]
[--account-name]
[--auth-mode {key, login}]
[--blob-endpoint]
[--connection-string]
[--expiry-time]
[--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
Required Parameters
The container name.
The blob name.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Storage account key. Must be used in conjunction with storage account name or service endpoint. Environment variable: AZURE_STORAGE_KEY.
Property | Value |
---|---|
Parameter group: | Storage Account Arguments |
Storage account name. Related environment variable: AZURE_STORAGE_ACCOUNT. Must be used in conjunction with either storage account key or a SAS token. If neither are present, the command will try to query the storage account key using the authenticated Azure account. If a large number of storage commands are executed the API quota may be hit.
Property | Value |
---|---|
Parameter group: | Storage Account Arguments |
The mode in which to run the command. "login" mode will directly use your login credentials for the authentication. The legacy "key" mode will attempt to query for an account key if no authentication parameters for the account are provided. Environment variable: AZURE_STORAGE_AUTH_MODE.
Property | Value |
---|---|
Accepted values: | key, login |
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.
Property | Value |
---|---|
Parameter group: | Storage Account Arguments |
Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.
Property | Value |
---|---|
Parameter group: | Storage Account Arguments |
Expiration UTC datetime in (Y-m-d'T'H:M:S'Z').
Lock or Unlock the policy.
Property | Value |
---|---|
Accepted values: | Locked, Unlocked |
A Shared Access Signature (SAS). Must be used in conjunction with storage account name or service endpoint. Environment variable: AZURE_STORAGE_SAS_TOKEN.
Property | Value |
---|---|
Parameter group: | Storage Account Arguments |
Request timeout in seconds. Applies to each call to the service.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |