az storage queue policy

Manage shared access policies for a storage queue.

Commands

az storage queue policy create Create a stored access policy on the containing object.
az storage queue policy delete Delete a stored access policy on a containing object.
az storage queue policy list List stored access policies on a containing object.
az storage queue policy show Show a stored access policy on a containing object.
az storage queue policy update Set a stored access policy on a containing object.

az storage queue policy create

Create a stored access policy on the containing object.

az storage queue policy create --name
--queue-name
[--account-key]
[--account-name]
[--auth-mode {key, login}]
[--connection-string]
[--expiry]
[--permissions]
[--sas-token]
[--start]

Required Parameters

--name -n

The stored access policy name.

--queue-name -q

The queue name.

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
--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--expiry

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

--permissions

Allowed values: (a)dd (p)rocess (r)ead (u)pdate. Can be combined.

--sas-token

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

--start

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

az storage queue policy delete

Delete a stored access policy on a containing object.

az storage queue policy delete --name
--queue-name
[--account-key]
[--account-name]
[--auth-mode {key, login}]
[--connection-string]
[--sas-token]

Required Parameters

--name -n

The stored access policy name.

--queue-name -q

The queue name.

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

az storage queue policy list

List stored access policies on a containing object.

az storage queue policy list --queue-name
[--account-key]
[--account-name]
[--auth-mode {key, login}]
[--connection-string]
[--sas-token]

Required Parameters

--queue-name -q

The queue name.

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

az storage queue policy show

Show a stored access policy on a containing object.

az storage queue policy show --name
--queue-name
[--account-key]
[--account-name]
[--auth-mode {key, login}]
[--connection-string]
[--sas-token]

Required Parameters

--name -n

The stored access policy name.

--queue-name -q

The queue name.

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

az storage queue policy update

Set a stored access policy on a containing object.

az storage queue policy update --name
--queue-name
[--account-key]
[--account-name]
[--auth-mode {key, login}]
[--connection-string]
[--expiry]
[--permissions]
[--sas-token]
[--start]

Required Parameters

--name -n

The stored access policy name.

--queue-name -q

The queue name.

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
--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--expiry

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

--permissions

Allowed values: (a)dd (p)rocess (r)ead (u)pdate. Can be combined.

--sas-token

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

--start

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