你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

az storage queue

此命令组处于预览状态,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus

管理存储队列。

命令

名称 说明 类型 Status
az storage queue create

在给定帐户下创建队列。

核心 预览
az storage queue delete

删除指定的队列及其包含的任何消息。

核心 预览
az storage queue exists

返回一个布尔值,该值指示队列是否存在。

核心 预览
az storage queue generate-sas

为队列生成共享访问签名。将返回的签名与 QueueService 的 sas_token 参数一起使用。

核心 预览版
az storage queue list

列出存储帐户中的队列。

核心 预览
az storage queue metadata

管理存储队列的元数据。

核心 预览
az storage queue metadata show

返回指定队列的所有用户定义的元数据。

核心 预览版
az storage queue metadata update

在指定的队列上设置用户定义的元数据。

核心 预览版
az storage queue policy

管理存储队列的共享访问策略。

核心 预览
az storage queue policy create

在包含对象上创建存储的访问策略。

核心 预览版
az storage queue policy delete

删除包含对象的存储访问策略。

核心 预览
az storage queue policy list

列出包含对象的存储访问策略。

核心 预览
az storage queue policy show

显示包含对象的存储访问策略。

核心 预览
az storage queue policy update

在包含对象上设置存储的访问策略。

核心 预览
az storage queue stats

检索与队列服务副本 (replica)相关的统计信息。 仅当为存储帐户启用读取访问异地冗余副本 (replica)时,它才可用。

核心 预览版

az storage queue create

预览

命令组“存储队列”处于预览状态,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus

在给定帐户下创建队列。

az storage queue create --name
                        [--account-key]
                        [--account-name]
                        [--auth-mode {key, login}]
                        [--connection-string]
                        [--fail-on-exist]
                        [--metadata]
                        [--queue-endpoint]
                        [--sas-token]
                        [--timeout]

示例

使用元数据在给定帐户下创建队列。

az storage queue create -n myqueue --metadata key1=value1 key2=value2 --account-name mystorageaccount

必需参数

--name -n

队列名称。

可选参数

--account-key

存储帐户密钥。 必须与存储帐户名称或服务终结点结合使用。 环境变量:AZURE_STORAGE_KEY。

--account-name

存储帐户名称。 相关环境变量:AZURE_STORAGE_ACCOUNT。 必须与存储帐户密钥或 SAS 令牌结合使用。 如果两者都不存在,该命令将尝试使用经过身份验证的 Azure 帐户查询存储帐户密钥。 如果执行了大量存储命令,可能会命中 API 配额。

--auth-mode

运行命令的模式。 “登录”模式将直接使用登录凭据进行身份验证。 如果未提供帐户的身份验证参数,则旧版“密钥”模式将尝试查询帐户密钥。 环境变量:AZURE_STORAGE_AUTH_MODE。

接受的值: key, login
--connection-string

存储帐户连接字符串。 环境变量:AZURE_STORAGE_CONNECTION_STRING。

--fail-on-exist

指定队列已存在时是否引发异常。

默认值: False
--metadata

空格分隔键=值对中的元数据。 这会覆盖任何现有元数据。

--queue-endpoint

存储数据服务终结点。 必须与存储帐户密钥或 SAS 令牌结合使用。 可以使用 .. 查找每个服务主终结点 az storage account show。 环境变量:AZURE_STORAGE_标准版RVICE_ENDPOINT。

--sas-token

共享访问签名(SAS)。 必须与存储帐户名称或服务终结点结合使用。 环境变量:AZURE_STORAGE_SAS_TOKEN。

--timeout

请求超时(以秒为单位)。 适用于对服务的每个调用。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az storage queue delete

预览

命令组“存储队列”处于预览状态,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus

删除指定的队列及其包含的任何消息。

az storage queue delete --name
                        [--account-key]
                        [--account-name]
                        [--auth-mode {key, login}]
                        [--connection-string]
                        [--fail-not-exist]
                        [--queue-endpoint]
                        [--sas-token]
                        [--timeout]

示例

删除指定的队列,如果队列不存在,则引发异常。

az storage queue delete -n myqueue --fail-not-exist --account-name mystorageaccount

必需参数

--name -n

队列名称。

可选参数

--account-key

存储帐户密钥。 必须与存储帐户名称或服务终结点结合使用。 环境变量:AZURE_STORAGE_KEY。

--account-name

存储帐户名称。 相关环境变量:AZURE_STORAGE_ACCOUNT。 必须与存储帐户密钥或 SAS 令牌结合使用。 如果两者都不存在,该命令将尝试使用经过身份验证的 Azure 帐户查询存储帐户密钥。 如果执行了大量存储命令,可能会命中 API 配额。

--auth-mode

运行命令的模式。 “登录”模式将直接使用登录凭据进行身份验证。 如果未提供帐户的身份验证参数,则旧版“密钥”模式将尝试查询帐户密钥。 环境变量:AZURE_STORAGE_AUTH_MODE。

接受的值: key, login
--connection-string

存储帐户连接字符串。 环境变量:AZURE_STORAGE_CONNECTION_STRING。

--fail-not-exist

指定在队列不存在时是否引发异常。

默认值: False
--queue-endpoint

存储数据服务终结点。 必须与存储帐户密钥或 SAS 令牌结合使用。 可以使用 .. 查找每个服务主终结点 az storage account show。 环境变量:AZURE_STORAGE_标准版RVICE_ENDPOINT。

--sas-token

共享访问签名(SAS)。 必须与存储帐户名称或服务终结点结合使用。 环境变量:AZURE_STORAGE_SAS_TOKEN。

--timeout

请求超时(以秒为单位)。 适用于对服务的每个调用。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az storage queue exists

预览

命令组“存储队列”处于预览状态,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus

返回一个布尔值,该值指示队列是否存在。

az storage queue exists --name
                        [--account-key]
                        [--account-name]
                        [--auth-mode {key, login}]
                        [--connection-string]
                        [--queue-endpoint]
                        [--sas-token]
                        [--timeout]

示例

检查队列是否存在。

az storage queue exists -n myqueue --account-name mystorageaccount

必需参数

--name -n

队列名称。

可选参数

--account-key

存储帐户密钥。 必须与存储帐户名称或服务终结点结合使用。 环境变量:AZURE_STORAGE_KEY。

--account-name

存储帐户名称。 相关环境变量:AZURE_STORAGE_ACCOUNT。 必须与存储帐户密钥或 SAS 令牌结合使用。 如果两者都不存在,该命令将尝试使用经过身份验证的 Azure 帐户查询存储帐户密钥。 如果执行了大量存储命令,可能会命中 API 配额。

--auth-mode

运行命令的模式。 “登录”模式将直接使用登录凭据进行身份验证。 如果未提供帐户的身份验证参数,则旧版“密钥”模式将尝试查询帐户密钥。 环境变量:AZURE_STORAGE_AUTH_MODE。

接受的值: key, login
--connection-string

存储帐户连接字符串。 环境变量:AZURE_STORAGE_CONNECTION_STRING。

--queue-endpoint

存储数据服务终结点。 必须与存储帐户密钥或 SAS 令牌结合使用。 可以使用 .. 查找每个服务主终结点 az storage account show。 环境变量:AZURE_STORAGE_标准版RVICE_ENDPOINT。

--sas-token

共享访问签名(SAS)。 必须与存储帐户名称或服务终结点结合使用。 环境变量:AZURE_STORAGE_SAS_TOKEN。

--timeout

请求超时(以秒为单位)。 适用于对服务的每个调用。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az storage queue generate-sas

预览

命令组“存储队列”处于预览状态,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus

为队列生成共享访问签名。将返回的签名与 QueueService 的 sas_token 参数一起使用。

az storage queue generate-sas --name
                              [--account-key]
                              [--account-name]
                              [--connection-string]
                              [--expiry]
                              [--https-only]
                              [--ip]
                              [--permissions]
                              [--policy-name]
                              [--queue-endpoint]
                              [--start]

示例

为具有只读权限的队列生成 SAS 令牌。

end=`date -u -d "30 minutes" '+%Y-%m-%dT%H:%MZ'`
az storage queue generate-sas -n myqueue --account-name mystorageaccount --permissions r --expiry $end --https-only

为指定 IP 范围的队列生成 SAS 令牌。

end=`date -u -d "30 minutes" '+%Y-%m-%dT%H:%MZ'`
az storage queue generate-sas -n myqueue --account-name mystorageaccount --ip "176.134.171.0-176.134.171.255" --permissions r --expiry $end --https-only

必需参数

--name -n

队列名称。

可选参数

--account-key

存储帐户密钥。 必须与存储帐户名称或服务终结点结合使用。 环境变量:AZURE_STORAGE_KEY。

--account-name

存储帐户名称。 相关环境变量:AZURE_STORAGE_ACCOUNT。 必须与存储帐户密钥或 SAS 令牌结合使用。 如果两者都不存在,该命令将尝试使用经过身份验证的 Azure 帐户查询存储帐户密钥。 如果执行了大量存储命令,可能会命中 API 配额。

--connection-string

存储帐户连接字符串。 环境变量:AZURE_STORAGE_CONNECTION_STRING。

--expiry

指定 SAS 无效的 UTC 日期时间(Y-m-d'T'H:M'Z')。 如果使用指定此值的 --policy-name 引用存储的访问策略,请不要使用。

--https-only

仅允许使用 HTTPS 协议发出的请求。 如果省略,则允许来自 HTTP 和 HTTPS 协议的请求。

--ip

指定要从中接受请求的 IP 地址或 IP 地址范围。 仅支持 IPv4 样式地址。

--permissions

SAS 授予的权限。 允许的值:(a)dd (p)rocess (r)ead (u)pdate。 如果使用指定此值的 --id 引用存储访问策略,请不要使用。 可以组合使用。

--policy-name

共享 ACL 中存储的访问策略的名称。

--queue-endpoint

存储数据服务终结点。 必须与存储帐户密钥或 SAS 令牌结合使用。 可以使用 .. 查找每个服务主终结点 az storage account show。 环境变量:AZURE_STORAGE_标准版RVICE_ENDPOINT。

--start

指定 SAS 生效的 UTC 日期/时间(Y-m-d'T'H:M'Z')。 如果使用指定此值的 --policy-name 引用存储的访问策略,请不要使用。 默认为请求的时间。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az storage queue list

预览

命令组“存储队列”处于预览状态,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus

列出存储帐户中的队列。

az storage queue list [--account-key]
                      [--account-name]
                      [--auth-mode {key, login}]
                      [--connection-string]
                      [--include-metadata]
                      [--marker]
                      [--num-results]
                      [--prefix]
                      [--queue-endpoint]
                      [--sas-token]
                      [--show-next-marker]
                      [--timeout]

示例

列出名称以“myprefix”开头的存储帐户“mystorageaccount”(帐户名称)下的队列

az storage queue list --prefix myprefix --account-name mystorageaccount

可选参数

--account-key

存储帐户密钥。 必须与存储帐户名称或服务终结点结合使用。 环境变量:AZURE_STORAGE_KEY。

--account-name

存储帐户名称。 相关环境变量:AZURE_STORAGE_ACCOUNT。 必须与存储帐户密钥或 SAS 令牌结合使用。 如果两者都不存在,该命令将尝试使用经过身份验证的 Azure 帐户查询存储帐户密钥。 如果执行了大量存储命令,可能会命中 API 配额。

--auth-mode

运行命令的模式。 “登录”模式将直接使用登录凭据进行身份验证。 如果未提供帐户的身份验证参数,则旧版“密钥”模式将尝试查询帐户密钥。 环境变量:AZURE_STORAGE_AUTH_MODE。

接受的值: key, login
--connection-string

存储帐户连接字符串。 环境变量:AZURE_STORAGE_CONNECTION_STRING。

--include-metadata

指定在响应中返回队列元数据。

默认值: False
--marker

一个字符串值,该值标识要在下一个列表操作中返回的容器列表部分。 如果列表操作未返回剩余的所有容器,则返回响应正文中的 NextMarker 值,该容器将随当前页一起列出。 如果指定,此生成器将从上一个生成器停止的点开始返回结果。

--num-results

指定要返回的最大数字。 如果请求未指定num_results,或指定大于 5000 的值,服务器将返回最多 5000 个项目。 请注意,如果列表操作跨越分区边界,则服务将返回一个继续标记,用于检索其余结果。 提供“*”以全部返回。

默认值: 5000
--prefix

筛选结果以仅返回名称以指定前缀开头的队列。

--queue-endpoint

存储数据服务终结点。 必须与存储帐户密钥或 SAS 令牌结合使用。 可以使用 .. 查找每个服务主终结点 az storage account show。 环境变量:AZURE_STORAGE_标准版RVICE_ENDPOINT。

--sas-token

共享访问签名(SAS)。 必须与存储帐户名称或服务终结点结合使用。 环境变量:AZURE_STORAGE_SAS_TOKEN。

--show-next-marker

指定后,在结果中显示 nextMarker。

--timeout

请求超时(以秒为单位)。 适用于对服务的每个调用。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az storage queue stats

预览

命令组“存储队列”处于预览状态,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus

检索与队列服务副本 (replica)相关的统计信息。 仅当为存储帐户启用读取访问异地冗余副本 (replica)时,它才可用。

az storage queue stats [--account-key]
                       [--account-name]
                       [--auth-mode {key, login}]
                       [--connection-string]
                       [--queue-endpoint]
                       [--sas-token]
                       [--timeout]

示例

显示与队列服务副本 (replica)相关的统计信息。

az storage queue stats --account-name mystorageaccount

可选参数

--account-key

存储帐户密钥。 必须与存储帐户名称或服务终结点结合使用。 环境变量:AZURE_STORAGE_KEY。

--account-name

存储帐户名称。 相关环境变量:AZURE_STORAGE_ACCOUNT。 必须与存储帐户密钥或 SAS 令牌结合使用。 如果两者都不存在,该命令将尝试使用经过身份验证的 Azure 帐户查询存储帐户密钥。 如果执行了大量存储命令,可能会命中 API 配额。

--auth-mode

运行命令的模式。 “登录”模式将直接使用登录凭据进行身份验证。 如果未提供帐户的身份验证参数,则旧版“密钥”模式将尝试查询帐户密钥。 环境变量:AZURE_STORAGE_AUTH_MODE。

接受的值: key, login
--connection-string

存储帐户连接字符串。 环境变量:AZURE_STORAGE_CONNECTION_STRING。

--queue-endpoint

存储数据服务终结点。 必须与存储帐户密钥或 SAS 令牌结合使用。 可以使用 .. 查找每个服务主终结点 az storage account show。 环境变量:AZURE_STORAGE_标准版RVICE_ENDPOINT。

--sas-token

共享访问签名(SAS)。 必须与存储帐户名称或服务终结点结合使用。 环境变量:AZURE_STORAGE_SAS_TOKEN。

--timeout

请求超时(以秒为单位)。 适用于对服务的每个调用。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。