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

az storage message

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

管理队列存储消息。

请为命令指定以下身份验证参数之一：--auth-mode、--account-key、--connection-string、--sas-token。 还可以使用相应的环境变量来存储身份验证凭据，例如AZURE_STORAGE_KEY、AZURE_STORAGE_CONNECTION_STRING和AZURE_STORAGE_SAS_TOKEN。

命令

名称	说明	类型	状态
az storage message clear	从指定队列中删除所有消息。	核心	预览
az storage message delete	删除指定的消息。	核心	预览版
az storage message get	从队列前面检索一个或多个消息。	核心	预览
az storage message peek	从队列前面检索一个或多个消息，但不改变消息的可见性。	核心	预览版
az storage message put	将新消息添加到消息队列的后面。	核心	预览版
az storage message update	更新消息的可见性超时。	核心	预览版

az storage message clear

预览

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

从指定队列中删除所有消息。

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

示例

从指定队列中删除所有消息。

az storage message clear -q myqueue --account-name mystorageaccount

必需参数

--queue-name -q

队列名称。

可选参数

--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 message delete

预览

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

删除指定的消息。

az storage message delete --id
                          --pop-receipt
                          --queue-name
                          [--account-key]
                          [--account-name]
                          [--auth-mode {key, login}]
                          [--connection-string]
                          [--queue-endpoint]
                          [--sas-token]
                          [--timeout]

示例

删除指定的消息。

az storage message delete --id messageid --pop-receipt popreceiptreturned -q myqueue --account-name mystorageaccount

必需参数

--id

标识要删除的消息的消息 ID。

--pop-receipt

从之前调用 ：func：~get_messages 或 ：func：~update_message 操作返回的有效弹出回执值。

--queue-name -q

队列名称。

可选参数

--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 message get

预览

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

从队列前面检索一个或多个消息。

az storage message get --queue-name
                       [--account-key]
                       [--account-name]
                       [--auth-mode {key, login}]
                       [--connection-string]
                       [--num-messages]
                       [--queue-endpoint]
                       [--sas-token]
                       [--timeout]
                       [--visibility-timeout]

示例

从队列前面检索一条消息，并将可见性超时重置为 5 分钟后。

az storage message get -q myqueue --visibility-timeout 300 --account-name mystorageaccount

必需参数

--queue-name -q

队列名称。

可选参数

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

--num-messages

一个非零整数值，该值指定要从队列中检索的消息数，最大为 32。 如果可见较少，则返回可见消息。 默认情况下，使用此操作从队列中检索单个消息。

默认值: 1

--queue-endpoint

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

--sas-token

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

--timeout

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

--visibility-timeout

指定相对于服务器时间的新可见性超时值（以秒为单位）。 新值必须大于或等于 1 秒，并且不能大于 7 天。 消息的可见性超时可以设置为晚于到期时间的值。

全局参数

--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 message peek

预览

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

从队列前面检索一个或多个消息，但不改变消息的可见性。

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

示例

从队列前面检索 5 条消息（请勿更改消息的可见性）。

az storage message peek -q myqueue --num-messages 5 --account-name mystorageaccount

必需参数

--queue-name -q

队列名称。

可选参数

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

--num-messages

一个非零整数值，该值指定要从队列中查看的消息数，最大为 32。 默认情况下，使用此操作从队列中查看单个消息。

--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 message put

预览

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

将新消息添加到消息队列的后面。

az storage message put --content
                       --queue-name
                       [--account-key]
                       [--account-name]
                       [--auth-mode {key, login}]
                       [--connection-string]
                       [--queue-endpoint]
                       [--sas-token]
                       [--time-to-live]
                       [--timeout]
                       [--visibility-timeout]

示例

添加新邮件，该邮件将在一天内直播。

az storage message put -q myqueue --content mymessagecontent --time-to-live 86400 --account-name mystorageaccount

必需参数

--content

消息内容，最大大小为 64知识库(KB)。

--queue-name -q

队列名称。

可选参数

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

--time-to-live

指定消息的生存时间间隔（以秒为单位）。 生存时间可以是任何正数或 -1（对于无穷大）。 如果省略此参数，则默认生存时间为 7 天。

--timeout

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

--visibility-timeout

如果未指定，则默认值为 0。 指定相对于服务器时间的新可见性超时值（以秒为单位）。 该值必须大于或等于 0，并且不能大于 7 天。 消息的可见性超时不能设置为晚于到期时间的值。 应将visibility_timeout设置为小于time_to_live值的值。

全局参数

--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 message update

预览

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

更新消息的可见性超时。

az storage message update --id
                          --pop-receipt
                          --queue-name
                          [--account-key]
                          [--account-name]
                          [--auth-mode {key, login}]
                          [--connection-string]
                          [--content]
                          [--queue-endpoint]
                          [--sas-token]
                          [--timeout]
                          [--visibility-timeout]

示例

更新消息的可见性超时和内容。

az storage message update --id messageid --pop-receipt popreceiptreturned -q myqueue
--visibility-timeout 3600 --content newmessagecontent --account-name mystorageaccount

必需参数

--id

标识要删除的消息的消息 ID。

--pop-receipt

从之前调用 ：func：~get_messages 或 ：func：~update_message 操作返回的有效弹出回执值。

--queue-name -q

队列名称。

可选参数

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

--content

消息内容，最大大小为 64知识库(KB)。

--queue-endpoint

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

--sas-token

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

--timeout

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

--visibility-timeout

如果未指定，则默认值为 0。 指定相对于服务器时间的新可见性超时值（以秒为单位）。 新值必须大于或等于 0，并且不能大于 7 天。 消息的可见性超时不能设置为晚于到期时间的值。 消息可以更新，直到它已被删除或已过期。

全局参数

--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 获取完整的调试日志。