az signalr

参考

管理Azure SignalR 服务。

命令

名称	说明	类型	Status
az signalr cors	管理 Azure SignalR 服务的 CORS。	核心	GA
az signalr cors add	将允许的源添加到 SignalR 服务。	核心	GA
az signalr cors list	列出 SignalR 服务的允许源。	核心	GA
az signalr cors remove	从 SignalR 服务中删除允许的源。	核心	GA
az signalr cors update	将允许的源更新到 SignalR 服务。	核心	GA
az signalr create	创建 SignalR 服务。	核心	GA
az signalr custom-certificate	管理自定义证书设置。	核心	GA
az signalr custom-certificate create	创建自定义 SignalR 服务的证书。	核心	GA
az signalr custom-certificate delete	删除 SignalR 服务的自定义证书。	核心	GA
az signalr custom-certificate list	列出 SignalR 服务的自定义证书。	核心	GA
az signalr custom-certificate show	显示 SignalR 服务的自定义证书的详细信息。	核心	GA
az signalr custom-certificate update	更新 SignalR 服务的自定义证书。	核心	GA
az signalr custom-___domain	管理自定义域设置。	核心	GA
az signalr custom-___domain create	创建自定义 SignalR 服务的域。	核心	GA
az signalr custom-___domain delete	删除 SignalR 服务的自定义域。	核心	GA
az signalr custom-___domain list	列出 SignalR 服务的自定义域。	核心	GA
az signalr custom-___domain show	显示 SignalR 服务的自定义域的详细信息。	核心	GA
az signalr custom-___domain update	更新 SignalR 服务的自定义域。	核心	GA
az signalr delete	删除 SignalR 服务。	核心	GA
az signalr identity	管理托管标识设置。	核心	GA
az signalr identity assign	为 SignalR 服务分配托管标识。	核心	GA
az signalr identity remove	删除 SignalR 服务的托管标识。	核心	GA
az signalr identity show	显示 SignalR 服务的托管标识。	核心	GA
az signalr key	管理 Azure SignalR 服务的密钥。	核心	GA
az signalr key list	列出 SignalR 服务的访问密钥。	核心	GA
az signalr key renew	重新生成 SignalR 服务的访问密钥。	核心	GA
az signalr list	列出当前订阅下的所有 SignalR 服务。	核心	GA
az signalr network-rule	管理网络规则。	核心	GA
az signalr network-rule ip-rule	管理 SignalR 服务 IP 规则。	核心	GA
az signalr network-rule ip-rule add	将 IP 规则添加到 SignalR 服务。	核心	GA
az signalr network-rule ip-rule remove	从 SignalR 服务中删除 IP 规则。	核心	GA
az signalr network-rule list	获取 SignalR 服务的网络访问控制。	核心	GA
az signalr network-rule update	更新 SignalR 服务的网络访问控制。	核心	GA
az signalr replica	管理副本设置。	核心	GA
az signalr replica create	创建 SignalR 服务的副本。	核心	GA
az signalr replica delete	删除 SignalR 服务的副本。	核心	GA
az signalr replica list	列出 SignalR 服务的副本。	核心	GA
az signalr replica restart	重启 SignalR 服务的副本。	核心	GA
az signalr replica show	显示副本的详细信息。	核心	GA
az signalr replica start	启动 SignalR 服务的副本。	核心	GA
az signalr replica stop	停止 SignalR 服务的副本。	核心	GA
az signalr replica update	更新 SignalR 服务的副本。	核心	GA
az signalr restart	重启现有的 SignalR 服务。	核心	GA
az signalr show	获取 SignalR 服务的详细信息。	核心	GA
az signalr start	启动现有的 SignalR 服务。	核心	GA
az signalr stop	停止现有的 SignalR 服务。	核心	GA
az signalr update	更新现有的 SignalR 服务。	核心	GA
az signalr upstream	管理上游设置。	核心	GA
az signalr upstream clear	清除现有 SignalR 服务的上游设置。	核心	GA
az signalr upstream list	列出现有 SignalR 服务的上游设置。	核心	GA
az signalr upstream update	更新现有 SignalR 服务的敏感上游设置。	核心	GA

az signalr create

编辑

创建 SignalR 服务。

az signalr create --name
                  --resource-group
                  --sku
                  [--allowed-origins]
                  [--default-action {Allow, Deny}]
                  [--enable-message-logs {false, true}]
                  [--___location]
                  [--service-mode {Classic, Default, Serverless}]
                  [--tags]
                  [--unit-count]

示例

使用高级 SKU 和默认模式创建 SignalR 服务

az signalr create -n MySignalR -g MyResourceGroup --sku Premium_P1

使用高级 SKU 和无服务器模式创建 SignalR 服务并启用消息传送日志。

az signalr create -n MySignalR -g MyResourceGroup --sku Premium_P1 --unit-count 1 --service-mode Serverless --enable-message-logs True

必需参数

--name -n

signalr 服务的名称。

--resource-group -g

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

--sku

signalr 服务的 SKU 名称。允许的值：Premium_P1、Standard_S1、Free_F1。

可选参数

--allowed-origins -a

应允许空间分隔的源进行跨域调用（例如：http://example.com:12345）。若要允许所有，请使用“*”。

--default-action

如果未匹配规则，则应用的默认操作。

接受的值: Allow, Deny

默认值: Allow

--enable-message-logs

信号器服务将生成或不生成的消息传送日志的开关。

接受的值: false, true

默认值: False

--___location -l

Location。 az account list-locations 中的值。可以使用 az configure --defaults ___location=<___location> 配置默认位置。

--service-mode

信号器服务将处理的服务模式。

接受的值: Classic, Default, Serverless

默认值: Default

--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

--unit-count

信号器服务单位计数。

默认值: 1

全局参数

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

编辑

删除 SignalR 服务。

az signalr delete [--ids]
                  [--name]
                  [--resource-group]
                  [--subscription]

示例

删除 SignalR 服务。

az signalr delete -n MySignalR -g MyResourceGroup

可选参数

--ids

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

--name -n

signalr 服务的名称。

--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 signalr list

编辑

列出当前订阅下的所有 SignalR 服务。

az signalr list [--resource-group]

示例

列出 SignalR 服务并在表中显示结果。

az signalr list -o table

列出资源组中的 SignalR 服务，并在表中显示结果。

az signalr list -g MySignalR -o table

可选参数

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<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 signalr restart

编辑

重启现有的 SignalR 服务。

az signalr restart [--ids]
                   [--name]
                   [--resource-group]
                   [--subscription]

示例

重启 SignalR 服务实例。

az signalr restart -n MySignalR -g MyResourceGroup

可选参数

--ids

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

--name -n

signalr 服务的名称。

--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 signalr show

编辑

获取 SignalR 服务的详细信息。

az signalr show [--ids]
                [--name]
                [--resource-group]
                [--subscription]

示例

获取 SignalR 服务的 SKU。

az signalr show -n MySignalR -g MyResourceGroup --query sku

可选参数

--ids

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

--name -n

signalr 服务的名称。

--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 signalr start

编辑

启动现有的 SignalR 服务。

az signalr start [--ids]
                 [--name]
                 [--resource-group]
                 [--subscription]

示例

启动 SignalR 服务实例。

az signalr start -n MySignalR -g MyResourceGroup

可选参数

--ids

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

--name -n

signalr 服务的名称。

--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 signalr stop

编辑

停止现有的 SignalR 服务。

az signalr stop [--ids]
                [--name]
                [--resource-group]
                [--subscription]

示例

停止 SignalR 服务实例。

az signalr stop -n MySignalR -g MyResourceGroup

可选参数

--ids

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

--name -n

signalr 服务的名称。

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

编辑

更新现有的 SignalR 服务。

az signalr update [--add]
                  [--allowed-origins]
                  [--client-cert-enabled {false, true}]
                  [--default-action {Allow, Deny}]
                  [--disable-local-auth {false, true}]
                  [--enable-message-logs {false, true}]
                  [--force-string]
                  [--ids]
                  [--name]
                  [--region-endpoint-enabled {false, true}]
                  [--remove]
                  [--resource-group]
                  [--service-mode {Classic, Default, Serverless}]
                  [--set]
                  [--sku]
                  [--subscription]
                  [--tags]
                  [--unit-count]

示例

更新单位计数以缩放服务。

az signalr update -n MySignalR -g MyResourceGroup --sku Standard_S1 --unit-count 50

更新服务模式。

az signalr update -n MySignalR -g MyResourceGroup --service-mode Serverless

更新以在服务中启用消息传送日志。

az signalr update -n MySignalR -g MyResourceGroup --enable-message-logs True

启用或禁用 SignalR 服务的客户端证书身份验证

az signalr update -n MySignalR -g MyResourceGroup --client-cert-enabled False

启用或禁用 SignalR 服务的本地身份验证

az signalr update -n MySignalR -g MyResourceGroup --disable-local-auth True

启用或禁用 SignalR 服务的区域终结点

az signalr update -n MySignalR -g MyResourceGroup --region-endpoint-enabled False

可选参数

--add

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

默认值: []

--allowed-origins -a

应允许空间分隔的源进行跨域调用（例如：http://example.com:12345）。若要允许所有，请使用“*”。

--client-cert-enabled

启用或禁用 SignalR 服务的客户端证书身份验证。

接受的值: false, true

--default-action

如果未匹配规则，则应用的默认操作。

接受的值: Allow, Deny

--disable-local-auth

启用或禁用 SignalR 服务的本地身份验证。

接受的值: false, true

--enable-message-logs

信号器服务将生成或不生成的消息传送日志的开关。

接受的值: false, true

--force-string

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

默认值: False

--ids

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

--name -n

signalr 服务的名称。

--region-endpoint-enabled

启用或禁用 SignalR 服务的区域终结点。

接受的值: false, true

--remove

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

默认值: []

--resource-group -g

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

--service-mode

信号器服务将处理的服务模式。

接受的值: Classic, Default, Serverless

--set

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

默认值: []

--sku

signalr 服务的 SKU 名称。例如Standard_S1。

--subscription

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

--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

--unit-count

信号器服务单位计数。

默认值: 1

全局参数

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