az webpubsub service group

注意

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

管理 Webpubsub 服務群組的命令。

命令

名稱	Description	類型	狀態
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 group add-connection

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

az webpubsub service group add-connection --connection-id
                                          --group-name
                                          --hub-name
                                          [--ids]
                                          [--name]
                                          [--resource-group]
                                          [--subscription]

必要參數

--connection-id

連接識別碼。

--group-name

組名。

--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 service group add-user

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

az webpubsub service group add-user --group-name
                                    --hub-name
                                    --user-id
                                    [--ids]
                                    [--name]
                                    [--resource-group]
                                    [--subscription]

必要參數

--group-name

組名。

--hub-name

要管理的中樞。

--user-id

使用者識別碼。

選擇性參數

--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 service group remove-connection

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

az webpubsub service group remove-connection --connection-id
                                             --group-name
                                             --hub-name
                                             [--ids]
                                             [--name]
                                             [--resource-group]
                                             [--subscription]

必要參數

--connection-id

連接識別碼。

--group-name

組名。

--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 service group remove-user

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

az webpubsub service group remove-user --hub-name
                                       --user-id
                                       [--group-name]
                                       [--ids]
                                       [--name]
                                       [--resource-group]
                                       [--subscription]

必要參數

--hub-name

要管理的中樞。

--user-id

使用者識別碼。

選擇性參數

--group-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 service group send

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

az webpubsub service group send --group-name
                                --hub-name
                                --payload
                                [--ids]
                                [--name]
                                [--resource-group]
                                [--subscription]

必要參數

--group-name

組名。

--hub-name

要管理的中樞。

--payload

要傳送的字串承載。

選擇性參數

--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 來取得完整偵錯記錄。