az eventhubs eventhub consumer-group

管理 Azure 事件中樞 取用者群組。

命令

名稱	Description	類型	狀態
az eventhubs eventhub consumer-group create	建立事件中樞取用者群組作為命名空間內的巢狀資源。	核心	GA
az eventhubs eventhub consumer-group delete	從指定的事件中樞和資源群組中刪除取用者群組。	核心	GA
az eventhubs eventhub consumer-group list	列出命名空間中的所有取用者群組。 如果命名空間中沒有任何取用者群組存在，則會傳回空白摘要。	核心	GA
az eventhubs eventhub consumer-group show	取得指定取用者群組的描述。	核心	GA
az eventhubs eventhub consumer-group update	將事件中樞取用者群組更新為命名空間內的巢狀資源。	核心	GA

az eventhubs eventhub consumer-group create

建立事件中樞取用者群組作為命名空間內的巢狀資源。

az eventhubs eventhub consumer-group create --consumer-group-name
                                            --eventhub-name
                                            --namespace-name
                                            --resource-group
                                            [--user-metadata]

必要參數

--consumer-group-name --name -n

取用者組名。

--eventhub-name

事件中樞名稱。

--namespace-name

命名空間名稱。

--resource-group -g

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

選擇性參數

--user-metadata

用戶元數據是一個佔位元，用來儲存長度上限為1024的使用者定義字串數據。 例如，它可以用來儲存描述性數據，例如小組清單及其連絡資訊，也可以儲存使用者定義的組態設定。

全域參數

--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 eventhubs eventhub consumer-group delete

從指定的事件中樞和資源群組中刪除取用者群組。

az eventhubs eventhub consumer-group delete [--consumer-group-name]
                                            [--eventhub-name]
                                            [--ids]
                                            [--namespace-name]
                                            [--resource-group]
                                            [--subscription]

選擇性參數

--consumer-group-name --name -n

取用者組名。

--eventhub-name

事件中樞名稱。

--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 eventhubs eventhub consumer-group list

列出命名空間中的所有取用者群組。 如果命名空間中沒有任何取用者群組存在，則會傳回空白摘要。

az eventhubs eventhub consumer-group list --eventhub-name
                                          --namespace-name
                                          --resource-group
                                          [--max-items]
                                          [--next-token]
                                          [--skip]
                                          [--top]

必要參數

--eventhub-name

事件中樞名稱。

--namespace-name

命名空間名稱。

--resource-group -g

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

選擇性參數

--max-items

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

--next-token

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

--skip

只有在先前的作業傳回部分結果時，才會使用Skip。 如果先前的回應包含 nextLink 元素，則 nextLink 元素的值會包含 skip 參數，指定要用於後續呼叫的起點。

--top

可用來將結果數目限制為最新的 N usageDetails。

全域參數

--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 eventhubs eventhub consumer-group show

取得指定取用者群組的描述。

az eventhubs eventhub consumer-group show [--consumer-group-name]
                                          [--eventhub-name]
                                          [--ids]
                                          [--namespace-name]
                                          [--resource-group]
                                          [--subscription]

選擇性參數

--consumer-group-name --name -n

取用者組名。

--eventhub-name

事件中樞名稱。

--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 eventhubs eventhub consumer-group update

將事件中樞取用者群組更新為命名空間內的巢狀資源。

az eventhubs eventhub consumer-group update [--add]
                                            [--consumer-group-name]
                                            [--eventhub-name]
                                            [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--ids]
                                            [--namespace-name]
                                            [--remove]
                                            [--resource-group]
                                            [--set]
                                            [--subscription]
                                            [--user-metadata]

選擇性參數

--add

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

--consumer-group-name --name -n

取用者組名。

--eventhub-name

事件中樞名稱。

--force-string

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

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

--ids

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

--namespace-name

命名空間名稱。

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

--user-metadata

用戶元數據是一個佔位元，用來儲存長度上限為1024的使用者定義字串數據。 例如，它可以用來儲存描述性數據，例如小組清單及其連絡資訊，也可以儲存使用者定義的組態設定。

全域參數

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