az storage container legal-hold

Manage container legal holds.

Commands

Name	Description	Type	Status
az storage container legal-hold clear	Clear legal hold tags.	Core	GA
az storage container legal-hold set	Set legal hold tags.	Core	GA
az storage container legal-hold show	Get the legal hold properties of a container.	Core	GA

az storage container legal-hold clear

Clear legal hold tags.

az storage container legal-hold clear --account-name
                                      --container-name
                                      --tags
                                      [--allow-protected-append-writes-all --w-all {false, true}]
                                      [--resource-group]

Examples

Clear legal hold tags.

az storage container legal-hold clear --tags tag1 tag2 --container-name mycontainer --account-name mystorageccount -g MyResourceGroup

Required Parameters

--account-name

Storage account name. Related environment variable: AZURE_STORAGE_ACCOUNT.

--container-name -c

The container name.

--tags

Space-separated tags. Each tag should be 3 to 23 alphanumeric characters and is normalized to lower case.

Optional Parameters

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

--allow-protected-append-writes-all --w-all

When enabled, new blocks can be written to both Append and Block Blobs while maintaining legal hold protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted.

Property	Value
Accepted values:	false, true

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

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

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

--query

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

--subscription

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

--verbose

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

Property	Value
Default value:	False

az storage container legal-hold set

Set legal hold tags.

az storage container legal-hold set --account-name
                                    --container-name
                                    --tags
                                    [--allow-protected-append-writes-all --w-all {false, true}]
                                    [--resource-group]

Examples

Set legal hold tags.

az storage container legal-hold set --tags tag1 tag2 --container-name mycontainer --account-name mystorageccount -g MyResourceGroup

Required Parameters

--account-name

Storage account name. Related environment variable: AZURE_STORAGE_ACCOUNT.

--container-name -c

The container name.

--tags

Space-separated tags. Each tag should be 3 to 23 alphanumeric characters and is normalized to lower case.

Optional Parameters

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

--allow-protected-append-writes-all --w-all

When enabled, new blocks can be written to both Append and Block Blobs while maintaining legal hold protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted.

Property	Value
Accepted values:	false, true

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

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

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

--query

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

--subscription

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

--verbose

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

Property	Value
Default value:	False

az storage container legal-hold show

Get the legal hold properties of a container.

az storage container legal-hold show --account-name
                                     --container-name
                                     [--resource-group]

Examples

Get the legal hold properties of a container. (autogenerated)

az storage container legal-hold show --account-name mystorageccount --container-name mycontainer

Required Parameters

--account-name

Storage account name. Related environment variable: AZURE_STORAGE_ACCOUNT.

--container-name -c

The container name.

Optional Parameters

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

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

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

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

--query

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

--subscription

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

--verbose

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

Property	Value
Default value:	False