az webpubsub

注意

此參考是 Azure CLI 的 Webpubsub 擴充功能的一部分（2.39.0 版或更高版本）。 擴充功能會在您第一次執行 az webpubsub 命令時自動安裝。 深入了解擴充功能。

管理 Webpubsub 的命令。

命令

名稱	Description	類型	狀態
az webpubsub client	管理客戶端連線的命令。	副檔名	GA
az webpubsub client start	啟動互動式用戶端連線。	副檔名	GA
az webpubsub create	建立 Webpubsub。	副檔名	GA
az webpubsub delete	刪除 Webpubsub。	副檔名	GA
az webpubsub hub	管理 Webpubsub 中樞設定的命令。	副檔名	GA
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 key	管理 Webpubsub 金鑰的命令。	副檔名	GA
az webpubsub key regenerate	重新產生 WebPubSub 服務的金鑰。	副檔名	GA
az webpubsub key show	顯示 WebPubSub 服務的串連字串和索引鍵。	副檔名	GA
az webpubsub list	列出 Webpubsub。	副檔名	GA
az webpubsub list-skus	列出資源的所有可用 SKU。	副檔名	GA
az webpubsub list-usage	依位置列出資源使用量配額。	副檔名	GA
az webpubsub network-rule	管理 Webpubsub 網路規則的命令。	副檔名	GA
az webpubsub network-rule show	取得 WebPubSub Service 的網路存取控制。	副檔名	GA
az webpubsub network-rule update	更新 WebPubSub Service 的網路存取控制。	副檔名	GA
az webpubsub replica	管理複本設定。	副檔名	GA
az webpubsub replica create	建立 Webpubsub 服務的複本。	副檔名	GA
az webpubsub replica delete	刪除 WebPubSub 服務的複本。	副檔名	GA
az webpubsub replica list	列出 Webpubsub 服務的複本。	副檔名	GA
az webpubsub replica show	顯示複本的詳細數據。	副檔名	GA
az webpubsub restart	重新啟動 Webpubsub。	副檔名	GA
az webpubsub service	管理 Webpubsub 服務的命令。	副檔名	GA
az webpubsub service broadcast	將訊息廣播至中樞。 如果作業失敗，就會擲回錯誤。	副檔名	GA
az webpubsub service connection	管理 Webpubsub 服務連線的命令。	副檔名	GA
az webpubsub service connection close	關閉特定的用戶端連線。 如果作業失敗，就會擲回錯誤。	副檔名	GA
az webpubsub service connection exist	檢查客戶端連線是否存在。	副檔名	GA
az webpubsub service connection send	將訊息傳送至連線。 如果作業失敗，就會擲回錯誤。	副檔名	GA
az webpubsub service group	管理 Webpubsub 服務群組的命令。	副檔名	GA
az webpubsub service group add-connection	將連線新增至群組。 如果作業失敗，就會擲回錯誤。	副檔名	GA
az webpubsub service group add-user	將使用者新增至群組。 如果作業失敗，就會擲回錯誤。	副檔名	GA
az webpubsub service group remove-connection	從群組移除連線。 如果作業失敗，就會擲回錯誤。	副檔名	GA
az webpubsub service group remove-user	從群組中移除使用者。 如果作業失敗，就會擲回錯誤。	副檔名	GA
az webpubsub service group send	將訊息傳送至群組。 如果作業失敗，就會擲回錯誤。	副檔名	GA
az webpubsub service permission	管理 Webpubsub 服務許可權的命令。	副檔名	GA
az webpubsub service permission check	檢查連接是否具有指定群組的許可權。	副檔名	GA
az webpubsub service permission grant	將群組許可權授與連線。 如果作業失敗，就會擲回錯誤。	副檔名	GA
az webpubsub service permission revoke	撤銷線上的群組許可權。 如果作業失敗，就會擲回錯誤。	副檔名	GA
az webpubsub service user	管理 Webpubsub 服務使用者的命令。	副檔名	GA
az webpubsub service user exist	檢查指定使用者是否有任何客戶端連線。	副檔名	GA
az webpubsub service user send	傳送訊息給使用者。 如果作業失敗，就會擲回錯誤。	副檔名	GA
az webpubsub show	顯示 Webpubsub 的詳細數據。	副檔名	GA
az webpubsub update	更新 Webpubsub。	副檔名	GA

az webpubsub create

建立 Webpubsub。

az webpubsub create --name
                    --resource-group
                    --sku
                    [--kind]
                    [--location]
                    [--tags]
                    [--unit-count]

範例

使用標準 SKU 和單元 2 建立 WebPubSub 服務。

az webpubsub create -n MyWebPubSub -g MyResourceGroup --sku Standard_S1 --unit-count 2

使用 進階版 SKU 和單元 1 建立適用於 Socket.IO 的 Web PubSub。

az webpubsub create -n MyWebPubSub -g MyResourceGroup --sku Premium_P1 --unit-count 1 --kind SocketIO

必要參數

--name -n

Webpubsub 的名稱。

--resource-group -g

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

--sku

webpubsub 服務的 SKU 名稱。 允許的值：Free_F1、Standard_S1、進階版_P1。

選擇性參數

--kind

webpubsub 服務的種類。 允許的值：WebPubSub、SocketIO。

--location -l

位置。​​ 來自的值： az account list-locations。 您可以使用 az configure --defaults location=<location> 設定預設位置。

--tags

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

--unit-count

webpubsub 服務單位計數。

預設值: 1

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az webpubsub delete

刪除 Webpubsub。

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

選擇性參數

--ids

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

--name -n

Webpubsub 的名稱。

--resource-group -g

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

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 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

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az webpubsub list

列出 Webpubsub。

az webpubsub list [--resource-group]

選擇性參數

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

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az webpubsub list-skus

列出資源的所有可用 SKU。

az webpubsub list-skus [--ids]
                       [--name]
                       [--resource-group]
                       [--subscription]

選擇性參數

--ids

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

--name -n

Webpubsub 的名稱。

--resource-group -g

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

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 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

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az webpubsub list-usage

依位置列出資源使用量配額。

az webpubsub list-usage --location

必要參數

--location -l

位置。​​ 來自的值： az account list-locations。 您可以使用 az configure --defaults location=<location> 設定預設位置。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az webpubsub restart

重新啟動 Webpubsub。

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

選擇性參數

--ids

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

--name -n

Webpubsub 的名稱。

--resource-group -g

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

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 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

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az webpubsub show

顯示 Webpubsub 的詳細數據。

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

選擇性參數

--ids

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

--name -n

Webpubsub 的名稱。

--resource-group -g

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

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 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

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az webpubsub update

更新 Webpubsub。

az webpubsub update [--add]
                    [--force-string]
                    [--ids]
                    [--name]
                    [--remove]
                    [--resource-group]
                    [--set]
                    [--sku]
                    [--subscription]
                    [--tags]
                    [--unit-count]

範例

將 WebPubSub 服務更新為單位 10。

az webpubsub update -n MyWebPubSub -g MyResourceGroup --sku Standard_S1 --unit-count 10

選擇性參數

--add

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

預設值: []

--force-string

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

預設值: False

--ids

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

--name -n

Webpubsub 的名稱。

--remove

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

預設值: []

--resource-group -g

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

--set

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

預設值: []

--sku

webpubsub 服務的 SKU 名稱。 允許的值：Free_F1、Standard_S1、進階版_P1。

--subscription

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

--tags

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

--unit-count

webpubsub 服務單位計數。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。