az signalr

Manage Azure SignalR Service.

命令

名稱 Description 類型 狀態
az signalr cors

Manage CORS for Azure SignalR Service.

Core GA
az signalr cors add

將允許的起點加入 SignalR Service。

Core GA
az signalr cors list

List 允許 SignalR Service 的起源。

Core GA
az signalr cors remove

移除 SignalR Service 中允許的起點。

Core GA
az signalr cors update

更新允許 SignalR Service 的起點。

Core GA
az signalr create

建立一個 SignalR Service。

Core GA
az signalr custom-certificate

管理自定義憑證設定。

Core GA
az signalr custom-certificate create

建立 SignalR Service 的自訂憑證。

Core GA
az signalr custom-certificate delete

刪除 SignalR Service 的自訂憑證。

Core GA
az signalr custom-certificate list

列出 SignalR Service 的自訂憑證。

Core GA
az signalr custom-certificate show

展示 SignalR Service 自訂證書的詳細資料。

Core GA
az signalr custom-certificate update

更新 SignalR Service 的自訂憑證。

Core GA
az signalr custom-domain

管理自訂網域設定。

Core GA
az signalr custom-domain create

建立一個 SignalR Service 的自訂網域。

Core GA
az signalr custom-domain delete

刪除 SignalR Service 的自訂網域。

Core GA
az signalr custom-domain list

列出 SignalR Service 的自訂網域。

Core GA
az signalr custom-domain show

展示 SignalR Service 自訂網域的詳細資料。

Core GA
az signalr custom-domain update

更新 SignalR Service 的自訂網域。

Core GA
az signalr delete

刪除一個 SignalR Service。

Core GA
az signalr identity

管理受控識別設定。

Core GA
az signalr identity assign

為 SignalR Service 指派管理身份。

Core GA
az signalr identity remove

移除 SignalR Service 的管理身份。

Core GA
az signalr identity show

顯示 SignalR Service 的管理身份。

Core GA
az signalr key

Manage keys for Azure SignalR Service.

Core GA
az signalr key list

列出 SignalR Service 的存取金鑰。

Core GA
az signalr key renew

重新產生 SignalR Service 的存取金鑰。

Core GA
az signalr list

列出目前訂閱下的所有 SignalR Service。

Core GA
az signalr network-rule

管理網路規則。

Core GA
az signalr network-rule ip-rule

管理 SignalR Service IP 規則。

Core GA
az signalr network-rule ip-rule add

在 SignalR Service 中新增 IP 規則。

Core GA
az signalr network-rule ip-rule remove

移除 SignalR Service 的 IP 規則。

Core GA
az signalr network-rule list

取得 SignalR Service 的網路存取控制。

Core GA
az signalr network-rule update

更新 SignalR Service 的網路存取控制。

Core GA
az signalr replica

管理複本設定。

Core GA
az signalr replica create

建立一個 SignalR Service 的複製品。

Core GA
az signalr replica delete

刪除 SignalR Service 的副本。

Core GA
az signalr replica list

列出 SignalR Service 的複製品。

Core GA
az signalr replica restart

重新啟動 SignalR Service 的副本。

Core GA
az signalr replica show

顯示複本的詳細數據。

Core GA
az signalr replica start

啟動一個 SignalR Service 的複製品。

Core GA
az signalr replica stop

停止一個 SignalR Service 的複製品。

Core GA
az signalr replica update

更新 SignalR Service 的副本。

Core GA
az signalr restart

重新啟動現有的 SignalR Service。

Core GA
az signalr show

取得 SignalR Service 的詳細資訊。

Core GA
az signalr start

啟動現有的 SignalR Service。

Core GA
az signalr stop

停止現有的 SignalR Service。

Core GA
az signalr update

更新現有的 SignalR Service。

Core GA
az signalr upstream

管理上游設定。

Core GA
az signalr upstream clear

清除現有 SignalR Service 的上游設定。

Core GA
az signalr upstream list

列出現有 SignalR Service 的上游設定。

Core GA
az signalr upstream update

更新現有 SignalR Service 的敏感上行設定。

Core GA

az signalr create

建立一個 SignalR Service。

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

範例

建立一個使用 Premium SKU 和預設模式的 SignalR Service

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

建立一個包含高級 SKU 和無伺服器模式的 SignalR Service,並啟用訊息日誌。

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。

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性
參數群組: Global Policy Arguments
--allowed-origins -a

應允許的空間分隔原點進行跨原始來源呼叫(例如:http://example.com:12345)。 若要允許所有專案,請使用 “*”。

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性
參數群組: Global Policy Arguments
--default-action

未符合規則時要套用的預設動作。

屬性
參數群組: Network Rule Arguments
預設值: Allow
接受的值: Allow, Deny
--enable-message-logs

傳訊記錄的交換器,信號器服務將產生或不會產生。

屬性
預設值: False
接受的值: false, true
--location -l

Location. 值的來源:az account list-locations。 您可以使用 az configure --defaults location=<location>來設定預設位置。

--service-mode

信號器服務將處理的服務模式。

屬性
預設值: Default
接受的值: Classic, Default, Serverless
--tags

以空格分隔的標記:key[=value] [key[=value] ...]。使用 「清除現有的標記」。

--unit-count

signalr 服務單位計數的數目。

屬性
預設值: 1
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

屬性
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False

az signalr delete

刪除一個 SignalR Service。

az signalr delete [--acquire-policy-token]
                  [--change-reference]
                  [--ids]
                  [--name]
                  [--resource-group]
                  [--subscription]

範例

刪除一個 SignalR Service。

az signalr delete -n MySignalR -g MyResourceGroup

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性
參數群組: Global Policy Arguments
--ids

一或多個資源識別碼(以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性
參數群組: Resource Id Arguments
--name -n

signalr 服務的名稱。

屬性
參數群組: Resource Id Arguments
--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性
參數群組: Resource Id Arguments
--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性
參數群組: Resource Id Arguments
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

屬性
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False

az signalr list

列出目前訂閱下的所有 SignalR Service。

az signalr list [--resource-group]

範例

列出 SignalR Service,並以表格顯示結果。

az signalr list -o table

將 SignalR Service 列入資源群組,並以表格顯示結果。

az signalr list -g MySignalR -o table

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

屬性
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False

az signalr restart

重新啟動現有的 SignalR Service。

az signalr restart [--acquire-policy-token]
                   [--change-reference]
                   [--ids]
                   [--name]
                   [--resource-group]
                   [--subscription]

範例

重新啟動 SignalR Service 實例。

az signalr restart -n MySignalR -g MyResourceGroup

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性
參數群組: Global Policy Arguments
--ids

一或多個資源識別碼(以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性
參數群組: Resource Id Arguments
--name -n

signalr 服務的名稱。

屬性
參數群組: Resource Id Arguments
--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性
參數群組: Resource Id Arguments
--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性
參數群組: Resource Id Arguments
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

屬性
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False

az signalr show

取得 SignalR Service 的詳細資訊。

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

範例

取得 SignalR Service 的 SKU。

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

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--ids

一或多個資源識別碼(以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性
參數群組: Resource Id Arguments
--name -n

signalr 服務的名稱。

屬性
參數群組: Resource Id Arguments
--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性
參數群組: Resource Id Arguments
--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性
參數群組: Resource Id Arguments
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

屬性
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False

az signalr start

啟動現有的 SignalR Service。

az signalr start [--acquire-policy-token]
                 [--change-reference]
                 [--ids]
                 [--name]
                 [--resource-group]
                 [--subscription]

範例

啟動一個 SignalR Service 實例。

az signalr start -n MySignalR -g MyResourceGroup

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性
參數群組: Global Policy Arguments
--ids

一或多個資源識別碼(以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性
參數群組: Resource Id Arguments
--name -n

signalr 服務的名稱。

屬性
參數群組: Resource Id Arguments
--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性
參數群組: Resource Id Arguments
--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性
參數群組: Resource Id Arguments
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

屬性
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False

az signalr stop

停止現有的 SignalR Service。

az signalr stop [--acquire-policy-token]
                [--change-reference]
                [--ids]
                [--name]
                [--resource-group]
                [--subscription]

範例

停止一個 SignalR Service 實例。

az signalr stop -n MySignalR -g MyResourceGroup

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性
參數群組: Global Policy Arguments
--ids

一或多個資源識別碼(以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性
參數群組: Resource Id Arguments
--name -n

signalr 服務的名稱。

屬性
參數群組: Resource Id Arguments
--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性
參數群組: Resource Id Arguments
--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性
參數群組: Resource Id Arguments
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

屬性
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False

az signalr update

更新現有的 SignalR Service。

az signalr update [--acquire-policy-token]
                  [--add]
                  [--allowed-origins]
                  [--change-reference]
                  [--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 Service 的用戶端憑證認證

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

啟用或停用 SignalR Service 的本地認證

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

啟用或停用 SignalR Service 的區域端點

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

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性
參數群組: Global Policy Arguments
--add

藉由指定路徑和索引鍵值組,將物件加入物件清單。 範例: --add property.listProperty <key=value, string or JSON string>.

屬性
參數群組: Generic Update Arguments
預設值: []
--allowed-origins -a

應允許的空間分隔原點進行跨原始來源呼叫(例如:http://example.com:12345)。 若要允許所有專案,請使用 “*”。

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性
參數群組: Global Policy Arguments
--client-cert-enabled

啟用或停用 SignalR Service 的用戶端憑證驗證。

屬性
接受的值: false, true
--default-action

未符合規則時要套用的預設動作。

屬性
參數群組: Network Rule Arguments
接受的值: Allow, Deny
--disable-local-auth

啟用或停用 SignalR Service 的本地認證。

屬性
接受的值: false, true
--enable-message-logs

傳訊記錄的交換器,信號器服務將產生或不會產生。

屬性
接受的值: false, true
--force-string

使用 'set' 或 'add' 時,請保留字串常值,而不是嘗試轉換成 JSON。

屬性
參數群組: Generic Update Arguments
預設值: False
--ids

一或多個資源識別碼(以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性
參數群組: Resource Id Arguments
--name -n

signalr 服務的名稱。

屬性
參數群組: Resource Id Arguments
--region-endpoint-enabled

啟用或停用 SignalR Service 的區域端點。

屬性
接受的值: false, true
--remove

從清單中移除屬性或專案。 範例: --remove property.list <indexToRemove>--remove propertyToRemove

屬性
參數群組: Generic Update Arguments
預設值: []
--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性
參數群組: Resource Id Arguments
--service-mode

信號器服務將處理的服務模式。

屬性
接受的值: Classic, Default, Serverless
--set

指定要設定的屬性路徑和值,以更新物件。 範例: --set property1.property2=<value>.

屬性
參數群組: Generic Update Arguments
預設值: []
--sku

signalr 服務的 SKU 名稱。 例如Standard_S1。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性
參數群組: Resource Id Arguments
--tags

以空格分隔的標記:key[=value] [key[=value] ...]。使用 「清除現有的標記」。

--unit-count

signalr 服務單位計數的數目。

屬性
預設值: 1
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

屬性
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False