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

az notification-hub

注意

此参考是 Azure CLI（版本 2.49.0 或更高版本）的通知中心扩展的一部分。 该扩展将在首次运行 az notification-hub 命令时自动安装。 详细了解扩展。

此命令组是试验性的，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

管理通知中心。

命令

名称	说明	类型	状态
az notification-hub authorization-rule	用于管理通知中心授权规则的命令。	扩展	实验
az notification-hub authorization-rule create	为通知中心创建授权规则。	分机	实验
az notification-hub authorization-rule delete	删除 notificationHub 授权规则。	分机	实验
az notification-hub authorization-rule list	列出通知中心的授权规则。	分机	实验
az notification-hub authorization-rule list-keys	列出通知中心的主要和辅助连接字符串。	分机	实验
az notification-hub authorization-rule regenerate-keys	将主密钥/辅助密钥重新生成到通知中心授权规则。	扩展	实验
az notification-hub authorization-rule show	按名称显示通知中心的授权规则。	分机	实验
az notification-hub check-availability	检查命名空间中给定通知中心的可用性。	扩展	实验
az notification-hub create	在命名空间中创建通知中心。	分机	实验
az notification-hub credential	用于管理通知中心凭据的命令。	扩展	实验
az notification-hub credential adm	管理通知中心。	扩展	实验
az notification-hub credential adm update	更新 Amazon（ADM）的凭据。	分机	实验
az notification-hub credential apns	管理通知中心。	分机	实验
az notification-hub credential apns update	更新 Apple（APNS）的凭据。	分机	实验
az notification-hub credential baidu	管理通知中心。	分机	实验
az notification-hub credential baidu update	更新百度（Andrioid China）的凭据。	扩展	实验
az notification-hub credential gcm	管理通知中心。	分机	实验
az notification-hub credential gcm update	更新 Google GCM/FCM API 密钥。	扩展	实验
az notification-hub credential list	列出与通知中心关联的 PNS 凭据。	分机	实验
az notification-hub credential mpns	管理通知中心。	分机	实验
az notification-hub credential mpns update	更新 Windows 电话（MPNS）的凭据。	扩展	实验
az notification-hub credential wns	管理通知中心。	扩展	实验
az notification-hub credential wns update	更新 Windows（WNS）的凭据。	分机	实验
az notification-hub delete	删除与命名空间关联的通知中心。	分机	实验
az notification-hub list	列出与命名空间关联的通知中心。	分机	实验
az notification-hub namespace	用于管理通知中心命名空间的命令。	分机	实验
az notification-hub namespace authorization-rule	用于管理通知中心命名空间授权规则的命令。	分机	实验
az notification-hub namespace authorization-rule create	为命名空间创建授权规则。	分机	实验
az notification-hub namespace authorization-rule delete	删除命名空间授权规则。	分机	实验
az notification-hub namespace authorization-rule list	列出命名空间的授权规则。	分机	实验
az notification-hub namespace authorization-rule list-keys	列出命名空间的主连接字符串和辅助连接字符串。	分机	实验
az notification-hub namespace authorization-rule regenerate-keys	将主密钥/辅助密钥重新生成到命名空间授权规则。	扩展	实验
az notification-hub namespace authorization-rule show	按名称获取命名空间的授权规则。	扩展	实验
az notification-hub namespace check-availability	检查所有 Azure 订阅中给定服务命名空间的可用性。 这很有用，因为域名是基于服务命名空间名称创建的。	分机	实验
az notification-hub namespace create	创建服务命名空间。 创建后，此命名空间的资源清单是不可变的。 此操作是幂等的。	扩展	实验
az notification-hub namespace delete	删除现有命名空间。 此操作还会删除命名空间下的所有关联 notificationHub。	分机	实验
az notification-hub namespace list	列出可用的命名空间。	分机	实验
az notification-hub namespace show	返回指定命名空间的说明。	分机	实验
az notification-hub namespace update	更新服务命名空间。 命名空间的资源清单是不可变的，无法修改。	分机	实验
az notification-hub namespace wait	将 CLI 置于等待状态，直到满足条件。	分机	实验
az notification-hub show	显示通知中心信息。	分机	实验
az notification-hub test-send	测试发送推送通知。	分机	实验
az notification-hub update	更新命名空间中的通知中心。	分机	实验

az notification-hub check-availability

实验

命令组“notification-hub”是试验性的，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

检查命名空间中给定通知中心的可用性。

az notification-hub check-availability --name
                                       [--ids]
                                       [--namespace-name]
                                       [--resource-group]
                                       [--subscription]

示例

检查给定通知中心名称的可用性

az notification-hub check-availability --resource-group MyResourceGroup --namespace-name "locp-newns" --name my-hub

必需参数

--name -n

资源名称。

可选参数

--ids

一个或多个资源 ID（空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--namespace-name

命名空间名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

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

全局参数

--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 notification-hub create

实验

命令组“notification-hub”是试验性的，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

在命名空间中创建通知中心。

az notification-hub create --name
                           --namespace-name
                           --resource-group
                           [--location]
                           [--registration-ttl]
                           [--tags]

示例

创建通知中心

az notification-hub create --resource-group MyResourceGroup --namespace-name my-namespace --name my-hub --location "South Central US"

必需参数

--name -n

通知中心名称。

--namespace-name

命名空间名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--location -l

未指定资源位置时，将使用资源组的位置。

--registration-ttl

创建的 NotificationHub 的 RegistrationTtl。

--tags

资源标记支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

全局参数

--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 notification-hub delete

实验

命令组“notification-hub”是试验性的，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

删除与命名空间关联的通知中心。

az notification-hub delete [--ids]
                           [--name]
                           [--namespace-name]
                           [--resource-group]
                           [--subscription]
                           [--yes]

示例

删除通知中心

az notification-hub delete --resource-group MyResourceGroup --namespace-name my-namespace --name my-hub

可选参数

--ids

一个或多个资源 ID（空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name -n

通知中心名称。

--namespace-name

命名空间名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

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

--yes -y

不提示确认。

默认值: False

全局参数

--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 notification-hub list

实验

命令组“notification-hub”是试验性的，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

列出与命名空间关联的通知中心。

az notification-hub list --namespace-name
                         --resource-group
                         [--max-items]
                         [--next-token]

示例

列出通知中心

az notification-hub list --resource-group MyResourceGroup --namespace-name my-namespace

必需参数

--namespace-name

命名空间名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--max-items

命令输出中要返回的项总数。 如果可用的项总数大于指定的值，则会在命令的输出中提供令牌。 若要恢复分页，请在后续命令的参数中 --next-token 提供令牌值。

--next-token

用于指定开始分页的位置的令牌。 这是先前截断的响应中的令牌值。

全局参数

--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 notification-hub show

实验

命令组“notification-hub”是试验性的，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

显示通知中心信息。

az notification-hub show [--ids]
                         [--name]
                         [--namespace-name]
                         [--resource-group]
                         [--subscription]

可选参数

--ids

一个或多个资源 ID（空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name -n

通知中心名称。

--namespace-name

命名空间名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

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

全局参数

--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 notification-hub test-send

实验

命令组“notification-hub”是试验性的，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

测试发送推送通知。

az notification-hub test-send --namespace-name
                              --notification-format {apple, baidu, gcm, template, windows, windowsphone}
                              --notification-hub-name
                              --resource-group
                              [--message]
                              [--payload]
                              [--tag]
                              [--title]

示例

使用消息正文测试发送通知

az notification-hub test-send --resource-group MyResourceGroup --namespace-name \
my-namespace --notification-hub-name my-hub --notification-format gcm \
--message "test notification"

测试从文件发送通知

az notification-hub test-send --resource-group MyResourceGroup --namespace-name \
my-namespace --notification-hub-name my-hub --notification-format gcm \
--payload @path/to/file

使用 json 字符串测试发送通知

az notification-hub test-send --resource-group MyResourceGroup --namespace-name \
my-namespace --notification-hub-name my-hub --notification-format gcm \
--payload "{\"data\":{\"message\":\"test notification\"}}"

必需参数

--namespace-name

命名空间名称。

--notification-format

通知消息的格式。

接受的值: apple, baidu, gcm, template, windows, windowsphone

--notification-hub-name

通知中心名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--message

要发送的消息正文。 如果不是 None，将忽略有效负载。

--payload

JSON 格式的消息的有效负载。

--tag

可以使用此选项将测试通知发送到特定注册集。 如果要将推送通知发送到所选平台上的 10 个随机注册，请将此字段留空。

--title

通知的标题。

全局参数

--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 notification-hub update

实验

命令组“notification-hub”是试验性的，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

更新命名空间中的通知中心。

az notification-hub update [--add]
                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                           [--ids]
                           [--location]
                           [--name]
                           [--namespace-name]
                           [--remove]
                           [--resource-group]
                           [--set]
                           [--subscription]
                           [--tags]

示例

更新通知中心

az notification-hub update --resource-group MyResourceGroup --namespace-name my-namespace --name "sdk-notificationHubs-8708"

可选参数

--add

通过指定路径和键值对将对象添加到对象列表。 示例：--add property.listProperty <key=value、string 或 JSON 字符串>。

--force-string

使用“set”或“add”时，保留字符串文本，而不是尝试转换为 JSON。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--ids

一个或多个资源 ID（空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--location -l

资源位置。

--name --notification-hub-name -n

通知中心名称。

--namespace-name

命名空间名称。

--remove

从列表中删除属性或元素。 示例：--remove property.list OR --remove propertyToRemove。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--set

通过指定要设置的属性路径和值来更新对象。 示例：--set property1.property2=。

--subscription

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

--tags

资源标记支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

全局参数

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