az webpubsub

注意

此參考是 Azure CLI (2.22.0 版或更高版本) 的 Webpubsub 延伸模組的一部分。 當您第一次執行 az webpubsub 命令時,擴充功能會自動安裝。 深入了解延伸模組。

用來管理 Webpubsub 的命令。

命令

az webpubsub client

用來管理用戶端連線的命令。

az webpubsub client start

啟動互動式用戶端連線。

az webpubsub create

建立 Webpubsub。

az webpubsub delete

刪除 Webpubsub。

az webpubsub hub

用來管理 Webpubsub 中樞設定的命令。

az webpubsub hub create

建立 WebPubSub 服務的中樞設定。

az webpubsub hub delete

刪除 WebPubSub 服務的中樞設定。

az webpubsub hub list

列出 WebPubSub 服務的所有中樞設定。

az webpubsub hub show

顯示 WebPubSub 服務的中樞設定。

az webpubsub hub update

更新 WebPubSub 服務的中樞設定。

az webpubsub key

用來管理 Webpubsub 金鑰的命令。

az webpubsub key regenerate

重新產生 WebPubSub 服務的金鑰。

az webpubsub key show

顯示 WebPubSub 服務的串連字號串和索引鍵。

az webpubsub list

列出 Webpubsub。

az webpubsub list-skus

列出資源的所有可用 SKU。

az webpubsub list-usage

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

az webpubsub network-rule

用來管理 Webpubsub 網路規則的命令。

az webpubsub network-rule show

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

az webpubsub network-rule update

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

az webpubsub restart

重新開機 Webpubsub。

az webpubsub service

用來管理 Webpubsub 服務的命令。

az webpubsub service broadcast

將訊息廣播至中樞。 如果作業失敗,就會擲回錯誤。

az webpubsub service connection

用來管理 Webpubsub 服務連線的命令。

az webpubsub service connection close

關閉特定的用戶端連線。 如果作業失敗,就會擲回錯誤。

az webpubsub service connection exist

檢查用戶端連線是否存在。

az webpubsub service connection send

將訊息傳送至連線。 如果作業失敗,就會擲回錯誤。

az webpubsub service group

管理 Webpubsub 服務群組的命令。

az webpubsub service group add-connection

將連線新增至群組。 如果作業失敗,就會擲回錯誤。

az webpubsub service group add-user

將使用者新增至群組。 如果作業失敗,就會擲回錯誤。

az webpubsub service group remove-connection

從群組中移除連線。 如果作業失敗,就會擲回錯誤。

az webpubsub service group remove-user

從群組中移除使用者。 如果作業失敗,就會擲回錯誤。

az webpubsub service group send

將訊息傳送至群組。 如果作業失敗,就會擲回錯誤。

az webpubsub service permission

管理 Webpubsub 服務許可權的命令。

az webpubsub service permission check

檢查連接是否具有指定群組的許可權。

az webpubsub service permission grant

將群組許可權授與連線。 如果作業失敗,就會擲回錯誤。

az webpubsub service permission revoke

撤銷連線的群組許可權。 如果作業失敗,就會擲回錯誤。

az webpubsub service user

管理 Webpubsub 服務使用者的命令。

az webpubsub service user exist

檢查指定的使用者是否有任何連線的用戶端連線。

az webpubsub service user send

傳送訊息給使用者。 如果作業失敗,就會擲回錯誤。

az webpubsub show

顯示 Webpubsub 的詳細資料。

az webpubsub update

更新 Webpubsub。

az webpubsub create

建立 Webpubsub。

az webpubsub create --name
                    --resource-group
                    --sku {Free_F1, Standard_S1}
                    [--location]
                    [--tags]
                    [--unit-count]

範例

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

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

必要參數

--name -n

Webpubsub 的名稱。

--resource-group -g

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

--sku

signalr 服務的 SKU 名稱。

接受的值: Free_F1, Standard_S1

選擇性參數

--location -l

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

--tags

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

--unit-count

signalr 服務單位元數目。

預設值: 1

az webpubsub delete

刪除 Webpubsub。

az webpubsub delete --name
                    --resource-group

必要參數

--name -n

Webpubsub 的名稱。

--resource-group -g

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

az webpubsub list

列出 Webpubsub。

az webpubsub list [--resource-group]

選擇性參數

--resource-group -g

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

az webpubsub list-skus

列出資源的所有可用 SKU。

az webpubsub list-skus --name
                       --resource-group

必要參數

--name -n

Webpubsub 的名稱。

--resource-group -g

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

az webpubsub list-usage

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

az webpubsub list-usage --location

必要參數

--location -l

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

az webpubsub restart

重新開機 Webpubsub。

az webpubsub restart --name
                     --resource-group

必要參數

--name -n

Webpubsub 的名稱。

--resource-group -g

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

az webpubsub show

顯示 Webpubsub 的詳細資料。

az webpubsub show --name
                  --resource-group

必要參數

--name -n

Webpubsub 的名稱。

--resource-group -g

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

az webpubsub update

更新 Webpubsub。

az webpubsub update --name
                    --resource-group
                    [--add]
                    [--force-string]
                    [--remove]
                    [--set]
                    [--sku {Free_F1, Standard_S1}]
                    [--tags]
                    [--unit-count]

範例

將 WebPubSub 服務更新為單位 10。

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

必要參數

--name -n

Webpubsub 的名稱。

--resource-group -g

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

選擇性參數

--add

藉由指定路徑和索引鍵值組,將 物件新增至物件清單。 範例:--add property.listProperty < key=value、string 或 JSON 字串 > 。

--force-string

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

--remove

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

--set

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

--sku

signalr 服務的 SKU 名稱。

接受的值: Free_F1, Standard_S1
--tags

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

--unit-count

signalr 服務單位元數目。