Share via


az storage container policy

Manage container stored access policies.

Commands

Name Description Type Status
az storage container policy create

Create a stored access policy on the containing object.

Core GA
az storage container policy delete

Delete a stored access policy on a containing object.

Core GA
az storage container policy list

List stored access policies on a containing object.

Core GA
az storage container policy show

Show a stored access policy on a containing object.

Core GA
az storage container policy update

Set a stored access policy on a containing object.

Core GA

az storage container policy create

Experimental Preview Deprecated

Create a stored access policy on the containing object.

az storage container policy create --container-name
                                   --name
                                   [--account-key]
                                   [--account-name]
                                   [--auth-mode {key}]
                                   [--blob-endpoint]
                                   [--connection-string]
                                   [--expiry]
                                   [--lease-id]
                                   [--permissions]
                                   [--start]

Examples

Required Parameters

--container-name -c
Experimental Preview Deprecated

The container name.

--name -n
Experimental Preview Deprecated

The stored access policy name.

Optional Parameters

--account-key
Experimental Preview Deprecated

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

--account-name
Experimental Preview Deprecated

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
Experimental Preview Deprecated

The mode in which to run the command. 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
--blob-endpoint
Experimental Preview Deprecated

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.

--connection-string
Experimental Preview Deprecated

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--expiry
Experimental Preview Deprecated

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

--lease-id
Experimental Preview Deprecated

The container lease ID.

--permissions
Experimental Preview Deprecated

Allowed values: (a)dd (c)reate (d)elete (e)xecute (f)ilter_by_tags (i)set_immutability_policy (l)ist (m)ove (r)ead (t)ag (w)rite (x)delete_previous_version (y)permanent_delete. Can be combined.

--start
Experimental Preview Deprecated

Start UTC datetime (Y-m-d'T'H:M:S'Z'). Defaults to time of request.

Global Parameters
--debug
Experimental Preview Deprecated

Increase logging verbosity to show all debug logs.

--help -h
Experimental Preview Deprecated

Show this help message and exit.

--only-show-errors
Experimental Preview Deprecated

Only show errors, suppressing warnings.

--output -o
Experimental Preview Deprecated

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query
Experimental Preview Deprecated

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

--subscription
Experimental Preview Deprecated

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

--verbose
Experimental Preview Deprecated

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

az storage container policy delete

Experimental Preview Deprecated

Delete a stored access policy on a containing object.

az storage container policy delete --container-name
                                   --name
                                   [--account-key]
                                   [--account-name]
                                   [--auth-mode {key}]
                                   [--blob-endpoint]
                                   [--connection-string]
                                   [--lease-id]

Examples

Required Parameters

--container-name -c
Experimental Preview Deprecated

The container name.

--name -n
Experimental Preview Deprecated

The stored access policy name.

Optional Parameters

--account-key
Experimental Preview Deprecated

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

--account-name
Experimental Preview Deprecated

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
Experimental Preview Deprecated

The mode in which to run the command. 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
--blob-endpoint
Experimental Preview Deprecated

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.

--connection-string
Experimental Preview Deprecated

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--lease-id
Experimental Preview Deprecated

The container lease ID.

Global Parameters
--debug
Experimental Preview Deprecated

Increase logging verbosity to show all debug logs.

--help -h
Experimental Preview Deprecated

Show this help message and exit.

--only-show-errors
Experimental Preview Deprecated

Only show errors, suppressing warnings.

--output -o
Experimental Preview Deprecated

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query
Experimental Preview Deprecated

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

--subscription
Experimental Preview Deprecated

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

--verbose
Experimental Preview Deprecated

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

az storage container policy list

Experimental Preview Deprecated

List stored access policies on a containing object.

az storage container policy list --container-name
                                 [--account-key]
                                 [--account-name]
                                 [--auth-mode {key}]
                                 [--blob-endpoint]
                                 [--connection-string]
                                 [--lease-id]

Examples

Required Parameters

--container-name -c
Experimental Preview Deprecated

The container name.

Optional Parameters

--account-key
Experimental Preview Deprecated

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

--account-name
Experimental Preview Deprecated

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
Experimental Preview Deprecated

The mode in which to run the command. 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
--blob-endpoint
Experimental Preview Deprecated

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.

--connection-string
Experimental Preview Deprecated

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--lease-id
Experimental Preview Deprecated

The container lease ID.

Global Parameters
--debug
Experimental Preview Deprecated

Increase logging verbosity to show all debug logs.

--help -h
Experimental Preview Deprecated

Show this help message and exit.

--only-show-errors
Experimental Preview Deprecated

Only show errors, suppressing warnings.

--output -o
Experimental Preview Deprecated

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query
Experimental Preview Deprecated

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

--subscription
Experimental Preview Deprecated

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

--verbose
Experimental Preview Deprecated

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

az storage container policy show

Experimental Preview Deprecated

Show a stored access policy on a containing object.

az storage container policy show --container-name
                                 --name
                                 [--account-key]
                                 [--account-name]
                                 [--auth-mode {key}]
                                 [--blob-endpoint]
                                 [--connection-string]
                                 [--lease-id]

Examples

Required Parameters

--container-name -c
Experimental Preview Deprecated

The container name.

--name -n
Experimental Preview Deprecated

The stored access policy name.

Optional Parameters

--account-key
Experimental Preview Deprecated

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

--account-name
Experimental Preview Deprecated

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
Experimental Preview Deprecated

The mode in which to run the command. 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
--blob-endpoint
Experimental Preview Deprecated

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.

--connection-string
Experimental Preview Deprecated

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--lease-id
Experimental Preview Deprecated

The container lease ID.

Global Parameters
--debug
Experimental Preview Deprecated

Increase logging verbosity to show all debug logs.

--help -h
Experimental Preview Deprecated

Show this help message and exit.

--only-show-errors
Experimental Preview Deprecated

Only show errors, suppressing warnings.

--output -o
Experimental Preview Deprecated

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query
Experimental Preview Deprecated

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

--subscription
Experimental Preview Deprecated

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

--verbose
Experimental Preview Deprecated

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

az storage container policy update

Experimental Preview Deprecated

Set a stored access policy on a containing object.

az storage container policy update --container-name
                                   --name
                                   [--account-key]
                                   [--account-name]
                                   [--auth-mode {key}]
                                   [--blob-endpoint]
                                   [--connection-string]
                                   [--expiry]
                                   [--lease-id]
                                   [--permissions]
                                   [--start]

Examples

Required Parameters

--container-name -c
Experimental Preview Deprecated

The container name.

--name -n
Experimental Preview Deprecated

The stored access policy name.

Optional Parameters

--account-key
Experimental Preview Deprecated

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

--account-name
Experimental Preview Deprecated

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
Experimental Preview Deprecated

The mode in which to run the command. 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
--blob-endpoint
Experimental Preview Deprecated

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.

--connection-string
Experimental Preview Deprecated

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--expiry
Experimental Preview Deprecated

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

--lease-id
Experimental Preview Deprecated

The container lease ID.

--permissions
Experimental Preview Deprecated

Allowed values: (a)dd (c)reate (d)elete (e)xecute (f)ilter_by_tags (i)set_immutability_policy (l)ist (m)ove (r)ead (t)ag (w)rite (x)delete_previous_version (y)permanent_delete. Can be combined.

--start
Experimental Preview Deprecated

Start UTC datetime (Y-m-d'T'H:M:S'Z'). Defaults to time of request.

Global Parameters
--debug
Experimental Preview Deprecated

Increase logging verbosity to show all debug logs.

--help -h
Experimental Preview Deprecated

Show this help message and exit.

--only-show-errors
Experimental Preview Deprecated

Only show errors, suppressing warnings.

--output -o
Experimental Preview Deprecated

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query
Experimental Preview Deprecated

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

--subscription
Experimental Preview Deprecated

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

--verbose
Experimental Preview Deprecated

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