az webpubsub hub

備註

此參考是 Azure CLI 的 webpubsub 延伸模組的一部分（2.56.0 版或更高版本）。 當您第一次執行 az webpubsub hub 命令時，擴充功能會自動安裝。 深入瞭解擴充功能。

管理 Webpubsub 中樞設定的命令。

命令

名稱	Description	類型	狀態
az webpubsub hub create	在無伺服器模式中建立 WebPubSub 服務或 Web PubSub 的中樞設定，以用於 Socket.IO。	擴充套件	GA
az webpubsub hub delete	刪除 WebPubSub 服務的中樞設定。	擴充套件	GA
az webpubsub hub list	列出 WebPubSub 服務的所有中樞設定。	擴充套件	GA
az webpubsub hub show	顯示 WebPubSub 服務的中樞設定。	擴充套件	GA
az webpubsub hub update	在無伺服器模式中更新 WebPubSub Service 或 Web PubSub for Socket.IO 的中樞設定。	擴充套件	GA

az webpubsub hub create

在無伺服器模式中建立 WebPubSub 服務或 Web PubSub 的中樞設定，以用於 Socket.IO。

az webpubsub hub create --hub-name
                        --name
                        --resource-group
                        [--allow-anonymous {false, true}]
                        [--event-handler]
                        [--websocket-keepalive]

範例

使用兩個事件處理程式設定建立中樞設定

az webpubsub hub create -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --event-handler url-template="http://host.com" user-event-pattern="MyEvent" --event-handler url-template="http://host2.com" system-event="connected" system-event="disconnected" auth-type="ManagedIdentity" auth-resource="uri://myUri"

建立允許匿名連線的中樞設定

az webpubsub hub create -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --allow-anonymous true

必要參數

--hub-name

要管理的中樞。

--name -n

webpubsub 的名稱。

--resource-group -g

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

選擇性參數

--allow-anonymous

設定此中樞是否允許匿名連線。 True 表示 allow 和 False 表示 deny。

接受的值: false, true

預設值: False

--event-handler

事件處理程式設定的範本專案。 使用key=value模式來設定屬性。 支援的密鑰包括 “url-template”、“user-event-pattern”、“system-event”、“auth-type” 和 “auth-resource”。 設定多個 「system-event」 會導致陣列和其他屬性使用，只有最後一個集合才會作用中。

--websocket-keepalive

中樞內所有用戶端的 WebSocket 保持運作間隔以秒為單位。 有效範圍：1 到 120。 預設為20秒。

預設值: 20

全域參數

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

刪除 WebPubSub 服務的中樞設定。

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

選擇性參數

--hub-name

中樞的名稱。

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

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

az webpubsub hub list --name
                      --resource-group

必要參數

--name -n

webpubsub 的名稱。

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

顯示 WebPubSub 服務的中樞設定。

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

選擇性參數

--hub-name

中樞的名稱。

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

在無伺服器模式中更新 WebPubSub Service 或 Web PubSub for Socket.IO 的中樞設定。

az webpubsub hub update --hub-name
                        [--add]
                        [--allow-anonymous {false, true}]
                        [--event-handler]
                        [--force-string]
                        [--ids]
                        [--name]
                        [--remove]
                        [--resource-group]
                        [--set]
                        [--subscription]
                        [--websocket-keepalive]

範例

更新中樞的事件處理程序設定

az webpubsub hub update -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --event-handler url-template="http://host.com" user-event-pattern="MyEvent" --event-handler url-template="http://host2.com" system-event="connected" system-event="disconnected" auth-type="ManagedIdentity" auth-resource="uri://myUri"

更新以允許匿名連線

az webpubsub hub update -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --allow-anonymous true

更新至 Web 套接字以秒為單位保持運作間隔 （預設值為 20 秒，最小值為 1，最大值為 120）

az webpubsub hub update -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --websocket-keepalive 30

必要參數

--hub-name

要管理的中樞。

選擇性參數

--add

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

預設值: []

--allow-anonymous

設定此中樞是否允許匿名連線。 True 表示 allow 和 False 表示 deny。

接受的值: false, true

--event-handler

事件處理程式設定的範本專案。 使用key=value模式來設定屬性。 支援的密鑰包括 “url-template”、“user-event-pattern”、“system-event”、“auth-type” 和 “auth-resource”。 設定多個 「system-event」 會導致陣列和其他屬性使用，只有最後一個集合才會作用中。

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

預設值: []

--subscription

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

--websocket-keepalive

中樞內所有用戶端的 WebSocket 保持運作間隔以秒為單位。 有效範圍：1 到 120。 預設為20秒。

全域參數

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