az webpubsub

Note

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

管理 Webpubsub 的命令。

命令

名稱	Description	類型	狀態
az webpubsub client	管理客戶端連線的命令。	Extension	GA
az webpubsub client start	啟動互動式用戶端連線。	Extension	GA
az webpubsub create	建立 Webpubsub。	Extension	GA
az webpubsub custom-certificate	管理 WebPubSub 自定義憑證。	Extension	GA
az webpubsub custom-certificate create	建立 WebPubSub 服務的自定義憑證。	Extension	GA
az webpubsub custom-certificate delete	刪除 WebPubSub 服務的自定義憑證。	Extension	GA
az webpubsub custom-certificate list	列出 WebPubSub 服務的自定義憑證。	Extension	GA
az webpubsub custom-certificate show	顯示 WebPubSub 服務的自定義憑證詳細數據。	Extension	GA
az webpubsub custom-domain	管理自訂網域設定。	Extension	GA
az webpubsub custom-domain create	建立 WebPubSub 服務的自定義網域。	Extension	GA
az webpubsub custom-domain delete	刪除 WebPubSub 服務的自定義網域。	Extension	GA
az webpubsub custom-domain list	列出 WebPubSub 服務的自訂網域。	Extension	GA
az webpubsub custom-domain show	顯示 WebPubSub Service 自訂網域的詳細數據。	Extension	GA
az webpubsub delete	刪除 Webpubsub。	Extension	GA
az webpubsub hub	管理 Webpubsub 中樞設定的命令。	Extension	GA
az webpubsub hub create	在無伺服器模式中建立 WebPubSub 服務或 Web PubSub 的中樞設定，以用於 Socket.IO。	Extension	GA
az webpubsub hub delete	刪除 WebPubSub 服務的中樞設定。	Extension	GA
az webpubsub hub list	列出 WebPubSub 服務的所有中樞設定。	Extension	GA
az webpubsub hub show	顯示 WebPubSub 服務的中樞設定。	Extension	GA
az webpubsub hub update	在無伺服器模式中更新 WebPubSub Service 或 Web PubSub for Socket.IO 的中樞設定。	Extension	GA
az webpubsub identity	管理受控識別設定。	Extension	GA
az webpubsub identity assign	指派 WebPubSub 服務的受控識別。	Extension	GA
az webpubsub identity remove	拿掉 WebPubSub 服務的受控識別。	Extension	GA
az webpubsub identity show	顯示 WebPubSub 服務的受控識別。	Extension	GA
az webpubsub key	管理 Webpubsub 金鑰的命令。	Extension	GA
az webpubsub key regenerate	重新產生 WebPubSub 服務的金鑰。	Extension	GA
az webpubsub key show	顯示 WebPubSub 服務的串連字串和索引鍵。	Extension	GA
az webpubsub list	列出 Webpubsub。	Extension	GA
az webpubsub list-skus	列出資源的所有可用 SKU。	Extension	GA
az webpubsub list-usage	依位置列出資源使用量配額。	Extension	GA
az webpubsub network-rule	管理 Webpubsub 網路規則的命令。	Extension	GA
az webpubsub network-rule ip-rule	管理 WebPubSub 服務 IP 規則。	Extension	GA
az webpubsub network-rule ip-rule add	將IP規則新增至 WebPubSub 服務。	Extension	GA
az webpubsub network-rule ip-rule remove	從 WebPubSub 服務移除 IP 規則。	Extension	GA
az webpubsub network-rule show	取得 WebPubSub Service 的網路存取控制。	Extension	GA
az webpubsub network-rule update	更新 WebPubSub Service 的網路存取控制。	Extension	GA
az webpubsub replica	管理複本設定。	Extension	GA
az webpubsub replica create	建立 Webpubsub 服務的複本。	Extension	GA
az webpubsub replica delete	刪除 WebPubSub 服務的複本。	Extension	GA
az webpubsub replica list	列出 Webpubsub 服務的複本。	Extension	GA
az webpubsub replica restart	重新啟動 WebPubSub 服務的複本。	Extension	GA
az webpubsub replica show	顯示複本的詳細數據。	Extension	GA
az webpubsub replica start	啟動 WebPubSub 服務的複本。	Extension	GA
az webpubsub replica stop	停止 WebPubSub 服務的複本。	Extension	GA
az webpubsub replica update	更新 Webpubsub 服務的複本。	Extension	GA
az webpubsub restart	重新啟動 Webpubsub。	Extension	GA
az webpubsub service	管理 Webpubsub 服務的命令。	Extension	GA
az webpubsub service broadcast	將訊息廣播至中樞。如果作業失敗，就會擲回錯誤。	Extension	GA
az webpubsub service connection	管理 Webpubsub 服務連線的命令。	Extension	GA
az webpubsub service connection close	關閉特定的用戶端連線。如果作業失敗，就會擲回錯誤。	Extension	GA
az webpubsub service connection exist	檢查客戶端連線是否存在。	Extension	GA
az webpubsub service connection send	將訊息傳送至連線。如果作業失敗，就會擲回錯誤。	Extension	GA
az webpubsub service group	管理 Webpubsub 服務群組的命令。	Extension	GA
az webpubsub service group add-connection	將連線新增至群組。如果作業失敗，就會擲回錯誤。	Extension	GA
az webpubsub service group add-user	將使用者新增至群組。如果作業失敗，就會擲回錯誤。	Extension	GA
az webpubsub service group remove-connection	從群組移除連線。如果作業失敗，就會擲回錯誤。	Extension	GA
az webpubsub service group remove-user	從群組中移除使用者。如果作業失敗，就會擲回錯誤。	Extension	GA
az webpubsub service group send	將訊息傳送至群組。如果作業失敗，就會擲回錯誤。	Extension	GA
az webpubsub service permission	管理 Webpubsub 服務許可權的命令。	Extension	GA
az webpubsub service permission check	檢查連接是否具有指定群組的許可權。	Extension	GA
az webpubsub service permission grant	將群組許可權授與連線。如果作業失敗，就會擲回錯誤。	Extension	GA
az webpubsub service permission revoke	撤銷線上的群組許可權。如果作業失敗，就會擲回錯誤。	Extension	GA
az webpubsub service user	管理 Webpubsub 服務使用者的命令。	Extension	GA
az webpubsub service user exist	檢查指定使用者是否有任何客戶端連線。	Extension	GA
az webpubsub service user send	傳送訊息給使用者。如果作業失敗，就會擲回錯誤。	Extension	GA
az webpubsub show	顯示 Webpubsub 的詳細數據。	Extension	GA
az webpubsub start	啟動 Webpubsub。	Extension	GA
az webpubsub stop	停止 Webpubsub。	Extension	GA
az webpubsub update	更新 Webpubsub。	Extension	GA

az webpubsub create

建立 Webpubsub。

az webpubsub create --name
                    --resource-group
                    --sku
                    [--kind]
                    [--location]
                    [--service-mode]
                    [--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

使用進階 SKU 和單元 1，在無伺服器模式中建立 Socket.IO 的 Web PubSub

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

必要參數

--name -n

webpubsub 的名稱。

--resource-group -g

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

--sku

webpubsub 服務的 SKU 名稱。允許的值：Free_F1、Standard_S1、Premium_P1。

選擇性參數

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

--kind

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

--location -l

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

--service-mode

在種類中使用的模式：SocketIO。允許的值：預設值、無伺服器值。

--tags

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

--unit-count

webpubsub 服務單位計數。

屬性	值
預設值:	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 webpubsub delete

刪除 Webpubsub。

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

選擇性參數

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

--ids

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

屬性	值
參數群組:	Resource Id Arguments

--name -n

webpubsub 的名稱。

屬性	值
參數群組:	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 webpubsub list

列出 Webpubsub。

az webpubsub list [--resource-group]

選擇性參數

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

--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 webpubsub list-skus

列出資源的所有可用 SKU。

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

選擇性參數

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

--ids

屬性	值
參數群組:	Resource Id Arguments

--name -n

webpubsub 的名稱。

屬性	值
參數群組:	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 webpubsub list-usage

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

az webpubsub list-usage --location

必要參數

--location -l

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

全域參數

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

重新啟動 Webpubsub。

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

選擇性參數

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

--ids

屬性	值
參數群組:	Resource Id Arguments

--name -n

webpubsub 的名稱。

屬性	值
參數群組:	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 webpubsub show

顯示 Webpubsub 的詳細數據。

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

選擇性參數

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

--ids

屬性	值
參數群組:	Resource Id Arguments

--name -n

webpubsub 的名稱。

屬性	值
參數群組:	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 webpubsub start

啟動 Webpubsub。

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

選擇性參數

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

--ids

屬性	值
參數群組:	Resource Id Arguments

--name -n

webpubsub 的名稱。

屬性	值
參數群組:	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 webpubsub stop

停止 Webpubsub。

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

選擇性參數

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

--ids

屬性	值
參數群組:	Resource Id Arguments

--name -n

webpubsub 的名稱。

屬性	值
參數群組:	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 webpubsub update

更新 Webpubsub。

az webpubsub update [--add]
                    [--client-cert-enabled {false, true}]
                    [--disable-local-auth {false, true}]
                    [--force-string]
                    [--ids]
                    [--name]
                    [--region-endpoint-enabled {false, true}]
                    [--remove]
                    [--resource-group]
                    [--service-mode]
                    [--set]
                    [--sku]
                    [--subscription]
                    [--tags]
                    [--unit-count]

範例

將 WebPubSub 服務更新為單位 10。

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

將 web PubSub 更新為無伺服器模式 Socket.IO。

az webpubsub update -n MyWebPubSub -g MyResourceGroup --service-mode Serverless

啟用或停用 WebPubSub 服務的客戶端憑證驗證

az webpubsub update -n MyWebPubSub -g MyResourceGroup --client-cert-enabled true

啟用或停用 WebPubSub 服務的本機驗證

az webpubsub update -n MyWebPubSub -g MyResourceGroup --disable-local-auth true

啟用或停用 WebPubSub 服務的區域端點

az webpubsub update -n MyWebPubSub -g MyResourceGroup --region-endpoint-enabled true

選擇性參數

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

--add

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

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

--client-cert-enabled

啟用或停用 WebPubSub 服務的客戶端憑證驗證。

屬性	值
接受的值:	false, true

--disable-local-auth

啟用或停用 WebPubSub 服務的本機驗證。

屬性	值
接受的值:	false, true

--force-string

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

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

--ids

屬性	值
參數群組:	Resource Id Arguments

--name -n

webpubsub 的名稱。

屬性	值
參數群組:	Resource Id Arguments

--region-endpoint-enabled

啟用或停用 WebPubSub 服務的區域端點。

屬性	值
接受的值:	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

在種類中使用的模式：SocketIO。允許的值：預設值、無伺服器值。

--set

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

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

--sku

webpubsub 服務的 SKU 名稱。允許的值：Free_F1、Standard_S1、Premium_P1。

--subscription

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

屬性	值
參數群組:	Resource Id Arguments

--tags

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

--unit-count

webpubsub 服務單位計數。

全域參數

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

命令

az webpubsub create

範例

必要參數

選擇性參數

az webpubsub delete

選擇性參數

az webpubsub list

選擇性參數

az webpubsub list-skus

選擇性參數

az webpubsub list-usage

必要參數

az webpubsub restart

選擇性參數

az webpubsub show

選擇性參數

az webpubsub start

選擇性參數

az webpubsub stop

選擇性參數

az webpubsub update

範例

選擇性參數

意見反應