az eventgrid namespace client-group

注意

此參考是 Azure CLI 的 eventgrid 延伸模組的一部分 （2.51.0 版或更高版本）。 擴充功能會在您第一次執行 az eventgrid 命名空間 client-group 命令時自動安裝。 深入了解擴充功能。

命令群組 'az eventgrid' 處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

管理 eventgrid 命名空間 client-group。

命令

名稱	Description	類型	狀態
az eventgrid namespace client-group create	建立用戶端群組。	副檔名	預覽版
az eventgrid namespace client-group delete	刪除現有的用戶端群組。	副檔名	預覽版
az eventgrid namespace client-group list	列出命名空間下的所有用戶端群組。	副檔名	預覽版
az eventgrid namespace client-group show	顯示用戶端群組。	副檔名	預覽版
az eventgrid namespace client-group update	更新用戶端群組。	副檔名	預覽版
az eventgrid namespace client-group wait	將 CLI 置於等候狀態，直到符合條件為止。	副檔名	預覽版

az eventgrid namespace client-group create

預覽

命令群組 'az eventgrid namespace client-group' 處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

建立用戶端群組。

az eventgrid namespace client-group create --client-group-name
                                           --namespace-name
                                           --resource-group
                                           [--description]
                                           [--group-query]
                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

範例

建立用戶端群組

az eventgrid namespace client-group create -g rg --namespace-name name -n client-group --group-query "attributes.floor=6"

必要參數

--client-group-name --name -n

用戶端組名。

--namespace-name

命名空間的名稱。

--resource-group -g

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

選擇性參數

--description

用戶端群組資源的描述。

--group-query

用戶端的群組查詢。

--no-wait

請勿等候長時間執行的作業完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

全域參數

--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 eventgrid namespace client-group delete

預覽

命令群組 'az eventgrid namespace client-group' 處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

刪除現有的用戶端群組。

az eventgrid namespace client-group delete [--client-group-name]
                                           [--ids]
                                           [--namespace-name]
                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--resource-group]
                                           [--subscription]
                                           [--yes]

範例

刪除用戶端群組

az eventgrid namespace client-group delete -g rg --namespace-name name -n client-group

選擇性參數

--client-group-name --name -n

用戶端群組的名稱。

--ids

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

--namespace-name

命名空間的名稱。

--no-wait

請勿等候長時間執行的作業完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

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

--subscription

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

--yes -y

不提示確認。

預設值: False

全域參數

--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 eventgrid namespace client-group list

預覽

命令群組 'az eventgrid namespace client-group' 處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

列出命名空間下的所有用戶端群組。

az eventgrid namespace client-group list --namespace-name
                                         --resource-group
                                         [--filter]
                                         [--max-items]
                                         [--next-token]
                                         [--top]

範例

列出用戶端群組

az eventgrid namespace client-group list -g rg --namespace-name name

必要參數

--namespace-name

命名空間的名稱。

--resource-group -g

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

選擇性參數

--filter

用來使用 OData 語法篩選搜尋結果的查詢。 只允許篩選 'name' 屬性，且 OData 作業數目有限。 這些作業包括：'contains' 函式以及下列邏輯作業：not、 和， 或 eq （針對 equal）， 和 ne （for not equal） 。 不支援算數運算。 以下是有效的篩選範例：$filter=contains（namE，'PATTERN'） 和名稱 ne 'PATTERN-1'。 下列不是有效的篩選範例：$filter=location eq 'westus'。

--max-items

命令輸出中要傳回的專案總數。 如果可用的專案總數超過指定的值，則會在命令的輸出中提供權杖。 若要繼續分頁，請在後續命令的引數中 --next-token 提供權杖值。

--next-token

標記，指定要開始分頁的位置。 這是先前截斷回應中的權杖值。

--top

要針對清單作業傳回每個頁面的結果數目。 top 參數的有效範圍是 1 到 100。 如果未指定，每個頁面要傳回的預設結果數目為 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 eventgrid namespace client-group show

預覽

命令群組 'az eventgrid namespace client-group' 處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

顯示用戶端群組。

az eventgrid namespace client-group show [--client-group-name]
                                         [--ids]
                                         [--namespace-name]
                                         [--resource-group]
                                         [--subscription]

範例

顯示用戶端群組

az eventgrid namespace client-group show -g rg --namespace-name name -n client-group

選擇性參數

--client-group-name --name -n

用戶端群組的名稱。

--ids

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

--namespace-name

命名空間的名稱。

--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 eventgrid namespace client-group update

預覽

命令群組 'az eventgrid namespace client-group' 處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

更新用戶端群組。

az eventgrid namespace client-group update [--add]
                                           [--client-group-name]
                                           [--description]
                                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--group-query]
                                           [--ids]
                                           [--namespace-name]
                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--remove]
                                           [--resource-group]
                                           [--set]
                                           [--subscription]

範例

更新用戶端群組

az eventgrid namespace client-group update -g rg --namespace-name name -n client-group --description test

選擇性參數

--add

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

--client-group-name --name -n

用戶端群組的名稱。

--description

用戶端群組資源的描述。

--force-string

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

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--group-query

用戶端的群組查詢。

--ids

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

--namespace-name

命名空間的名稱。

--no-wait

請勿等候長時間執行的作業完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--remove

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

--resource-group -g

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

--set

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

--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 eventgrid namespace client-group wait

預覽

命令群組 'az eventgrid namespace client-group' 處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

將 CLI 置於等候狀態，直到符合條件為止。

az eventgrid namespace client-group wait [--client-group-name]
                                         [--created]
                                         [--custom]
                                         [--deleted]
                                         [--exists]
                                         [--ids]
                                         [--interval]
                                         [--namespace-name]
                                         [--resource-group]
                                         [--subscription]
                                         [--timeout]
                                         [--updated]

選擇性參數

--client-group-name --name -n

用戶端群組的名稱。

--created

請等候在 'Succeeded' 使用 'provisioningState' 建立。

預設值: False

--custom

等到條件符合自訂 JMESPath 查詢為止。 例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

--deleted

等到刪除為止。

預設值: False

--exists

等候資源存在。

預設值: False

--ids

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

--interval

輪詢間隔以秒為單位。

預設值: 30

--namespace-name

命名空間的名稱。

--resource-group -g

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

--subscription

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

--timeout

以秒為單位的等候上限。

預設值: 3600

--updated

等到 provisioningState 更新為 'Succeeded'。

預設值: False

全域參數

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