az eventhubs eventhub consumer-group
Azure Event Hubs コンシューマー グループを管理します。
コマンド
名前 | 説明 | 型 | 状態 |
---|---|---|---|
az eventhubs eventhub consumer-group create |
名前空間内に入れ子になったリソースとして Event Hubs コンシューマー グループを作成します。 |
コア | 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 |
Event Hubs コンシューマー グループを名前空間内の入れ子になったリソースとして更新します。 |
コア | GA |
az eventhubs eventhub consumer-group create
名前空間内に入れ子になったリソースとして Event Hubs コンシューマー グループを作成します。
az eventhubs eventhub consumer-group create --consumer-group-name
--eventhub-name
--namespace-name
--resource-group
[--user-metadata]
必須のパラメーター
コンシューマー グループ名。
イベント ハブ名。
名前空間の名前。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
省略可能のパラメーター
ユーザー メタデータは、最大長 1024 のユーザー定義文字列データを格納するためのプレースホルダーです。 たとえば、チームのリストや連絡先情報などの説明データを格納するために使用でき、ユーザー定義の構成設定も格納できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az eventhubs eventhub consumer-group delete
指定したイベント ハブとリソース グループからコンシューマー グループを削除します。
az eventhubs eventhub consumer-group delete [--consumer-group-name]
[--eventhub-name]
[--ids]
[--namespace-name]
[--resource-group]
[--subscription]
省略可能のパラメーター
コンシューマー グループ名。
イベント ハブ名。
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
名前空間の名前。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --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]
必須のパラメーター
イベント ハブ名。
名前空間の名前。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
省略可能のパラメーター
コマンドの出力で返される項目の合計数。 使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。 改ページ位置の変更を再開するには、後続のコマンドの引数に --next-token
トークン値を指定します。
ページ分割を開始する場所を指定するトークン。 これは、以前に切り捨てられた応答からのトークン値です。
Skip は、前の操作で部分的な結果が返された場合にのみ使用されます。 前の応答に nextLink 要素が含まれている場合、nextLink 要素の値には、後続の呼び出しに使用する開始点を指定する skip パラメーターが含まれます。
結果の数を最新の N usageDetails に制限するために使用できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az eventhubs eventhub consumer-group show
指定したコンシューマー グループの説明を取得します。
az eventhubs eventhub consumer-group show [--consumer-group-name]
[--eventhub-name]
[--ids]
[--namespace-name]
[--resource-group]
[--subscription]
省略可能のパラメーター
コンシューマー グループ名。
イベント ハブ名。
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
名前空間の名前。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az eventhubs eventhub consumer-group update
Event Hubs コンシューマー グループを名前空間内の入れ子になったリソースとして更新します。
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 property.listProperty <key=value、string、または JSON 文字列>。
コンシューマー グループ名。
イベント ハブ名。
'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
名前空間の名前。
リストからプロパティまたは要素を削除します。 例: --remove property.list OR --remove propertyToRemove。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ユーザー メタデータは、最大長 1024 のユーザー定義文字列データを格納するためのプレースホルダーです。 たとえば、チームのリストや連絡先情報などの説明データを格納するために使用でき、ユーザー定義の構成設定も格納できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
Azure CLI