你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
az webpubsub hub
注意
此参考是 Azure CLI(版本 2.39.0 或更高版本)的 Webpubsub 扩展的一部分。 该扩展将在首次运行 az webpubsub hub 命令时自动安装。 详细了解扩展。
用于管理 Webpubsub 中心设置的命令。
命令
名称 | 说明 | 类型 | 状态 |
---|---|---|---|
az webpubsub hub create |
创建 WebPubSub 服务的中心设置。 |
扩展 | GA |
az webpubsub hub delete |
删除 WebPubSub 服务的中心设置。 |
扩展 | GA |
az webpubsub hub list |
列出 WebPubSub 服务的所有中心设置。 |
扩展 | GA |
az webpubsub hub show |
显示 WebPubSub 服务的中心设置。 |
扩展 | GA |
az webpubsub hub update |
更新 WebPubSub 服务的中心设置。 |
扩展 | GA |
az webpubsub hub create
创建 WebPubSub 服务的中心设置。
az webpubsub hub create --hub-name
--name
--resource-group
[--allow-anonymous {false, true}]
[--event-handler]
示例
使用两个事件处理程序设置创建中心设置
az webpubsub hub create -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --event-handler url-template="http://host.com" user-event-pattern="MyEvent" --event-handler url-template="http://host2.com" system-event="connected" system-event="disconnected" auth-type="ManagedIdentity" auth-resource="uri://myUri"
创建允许匿名连接的中心设置
az webpubsub hub create -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --allow-anonymous true
必需参数
要管理的中心。
Webpubsub 的名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
可选参数
设置是否允许此中心的匿名连接。 True 表示 allow 和 False 表示 deny。
事件处理程序设置的模板项。 使用 key=value 模式设置属性。 支持的密钥包括“url-template”、“user-event-pattern”、“system-event”、“auth-type”和“auth-resource”。 设置多个“system-event”会导致数组和其他属性,只有最后一个集处于活动状态。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az webpubsub hub delete
删除 WebPubSub 服务的中心设置。
az webpubsub hub delete [--hub-name]
[--ids]
[--name]
[--resource-group]
[--subscription]
可选参数
中心的名称。
一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
Webpubsub 的名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az webpubsub hub list
列出 WebPubSub 服务的所有中心设置。
az webpubsub hub list --name
--resource-group
必需参数
Webpubsub 的名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az webpubsub hub show
显示 WebPubSub 服务的中心设置。
az webpubsub hub show [--hub-name]
[--ids]
[--name]
[--resource-group]
[--subscription]
可选参数
中心的名称。
一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
Webpubsub 的名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az webpubsub hub update
更新 WebPubSub 服务的中心设置。
az webpubsub hub update --hub-name
[--add]
[--allow-anonymous {false, true}]
[--event-handler]
[--force-string]
[--ids]
[--name]
[--remove]
[--resource-group]
[--set]
[--subscription]
示例
更新中心的事件处理程序设置
az webpubsub hub update -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --event-handler url-template="http://host.com" user-event-pattern="MyEvent" --event-handler url-template="http://host2.com" system-event="connected" system-event="disconnected" auth-type="ManagedIdentity" auth-resource="uri://myUri"
更新以允许匿名连接
az webpubsub hub update -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --allow-anonymous true
必需参数
要管理的中心。
可选参数
通过指定路径和键值对将对象添加到对象列表。 示例:--add property.listProperty <key=value, string or JSON string>
。
设置是否允许此中心的匿名连接。 True 表示 allow 和 False 表示 deny。
事件处理程序设置的模板项。 使用 key=value 模式设置属性。 支持的密钥包括“url-template”、“user-event-pattern”、“system-event”、“auth-type”和“auth-resource”。 设置多个“system-event”会导致数组和其他属性,只有最后一个集处于活动状态。
使用“set”或“add”时,保留字符串文本,而不是尝试转换为 JSON。
一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
Webpubsub 的名称。
从列表中删除属性或元素。 示例: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
通过指定要设置的属性路径和值来更新对象。 示例:--set property1.property2=<value>
。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。