az eventhubs eventhub

Azure EventHubs eventhub と authorization-rule を管理します。

コマンド

名前	説明	型	状態
az eventhubs eventhub authorization-rule	Eventhub 承認規則。	コア	GA
az eventhubs eventhub authorization-rule create	指定したイベント ハブの AuthorizationRule を作成します。 AuthorizationRule の作成/更新が有効になるには数秒かかります。	コア	GA
az eventhubs eventhub authorization-rule delete	イベント ハブ AuthorizationRule を削除します。	コア	GA
az eventhubs eventhub authorization-rule keys	承認規則キー。	コア	GA
az eventhubs eventhub authorization-rule keys list	イベント ハブの ACS 接続文字列と SAS 接続文字列を取得します。	コア	GA
az eventhubs eventhub authorization-rule keys renew	イベント ハブの ACS 接続文字列と SAS 接続文字列を再生成します。	コア	GA
az eventhubs eventhub authorization-rule list	イベント ハブの承認規則を一覧表示します。	コア	GA
az eventhubs eventhub authorization-rule show	ルール名でイベント ハブの AuthorizationRule を取得します。	コア	GA
az eventhubs eventhub authorization-rule update	指定したイベント ハブの AuthorizationRule を更新します。 AuthorizationRule の作成/更新が有効になるには数秒かかります。	コア	GA
az eventhubs eventhub consumer-group	Azure Event Hubs コンシューマー グループを管理します。	コア	GA
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 create	EventHubs Eventhub を作成します。	コア	GA
az eventhubs eventhub delete	指定した名前空間とリソース グループからイベント ハブを削除します。	コア	GA
az eventhubs eventhub list	名前空間内のすべての Event Hubs を一覧表示します。	コア	GA
az eventhubs eventhub show	指定したイベント ハブの Event Hubs の説明を取得します。	コア	GA
az eventhubs eventhub update	名前空間内の入れ子になったリソースとして新しいイベント ハブを更新します。	コア	GA

az eventhubs eventhub create

EventHubs Eventhub を作成します。

az eventhubs eventhub create --name
                             --namespace-name
                             --resource-group
                             [--archive-name-format]
                             [--blob-container]
                             [--capture-interval]
                             [--capture-size-limit]
                             [--cleanup-policy {Compact, Delete, DeleteOrCompact}]
                             [--destination-name]
                             [--enable-capture {false, true}]
                             [--mi-system-assigned {false, true}]
                             [--mi-user-assigned]
                             [--min-compaction-lag-in-mins]
                             [--partition-count]
                             [--retention-time]
                             [--skip-empty-archives {false, true}]
                             [--status {Active, Disabled, SendDisabled}]
                             [--storage-account]
                             [--timestamp-type {Create, LogAppend}]
                             [--tombstone-retention-time-in-hours]
                             [--user-metadata]

例

新しい Eventhub を作成します。

az eventhubs eventhub create --resource-group myresourcegroup --namespace-name mynamespace --name myeventhub --cleanup-policy Delete --partition-count 15

必須のパラメーター

--name -n

Eventhub の名前。

--namespace-name

名前空間の名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

省略可能のパラメーター

--archive-name-format

アーカイブの BLOB 名前付け規則 ({Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second} など)。 ここでは、順序に関係なく、すべてのパラメーター (Namespace、EventHub など) が必須です。

--blob-container

BLOB コンテナー名。

--capture-interval

Azure BLOB へのキャプチャの頻度を設定できます。値は 60 ~ 900 秒です。

--capture-size-limit

キャプチャ操作の前にイベント ハブに構築されるデータの量を定義します。値は10485760から524288000 バイトの間にする必要があります。

--cleanup-policy

クリーンアップ ポリシーに使用できる値を列挙します。

指定可能な値: Compact, Delete, DeleteOrCompact

--destination-name

キャプチャ先の名前。EventHubArchive.AzureBlockBlob にする必要があります。

--enable-capture

キャプチャが有効かどうかを示すブール値。

指定可能な値: false, true

--mi-system-assigned

システム割り当て ID を有効にします。

指定可能な値: false, true

規定値: False

--mi-user-assigned

ユーザー割り当て ID の一覧。

--min-compaction-lag-in-mins --min-lag

メッセージがログに圧縮されない最小時間。 この値は、cleanupPolicy が Compact または DeleteOrCompact の場合に使用されます。

--partition-count

イベント ハブ用に作成されたパーティションの数。 既定では、使用できる値は 2 ~ 32 です。 Kafka 対応の名前空間では、1 の小さい値がサポートされています。 カスタム クォータが存在する場合、上限はクォータの上限と一致します。

--retention-time --retention-time-in-hours

このイベント ハブのイベントを保持する時間数。 この値は、cleanupPolicy が Delete の場合にのみ使用されます。 cleanupPolicy が Compaction の場合、このプロパティの戻り値は Long.MaxValue です。

--skip-empty-archives

空をスキップするかどうかを示すブール値。

指定可能な値: false, true

--status

Eventhub の状態。

指定可能な値: Active, Disabled, SendDisabled

--storage-account

BLOB の作成に使用するストレージ アカウントの名前 (クラシック ストレージの種類ではなく、同じリソース グループ内にある場合) または ARM ID。

--timestamp-type

メッセージが保持するタイムスタンプの種類を示します。

指定可能な値: Create, LogAppend

--tombstone-retention-time-in-hours --tombstone-time

圧縮されたイベント ハブの廃棄石マーカーを保持する時間数。 この値は、cleanupPolicy が圧縮されている場合にのみ使用されます。 コンシューマーは、圧縮されたイベント ハブ内の廃棄石マーカーによって記述された特定のキーの有効なスナップショットを取得するために、オフセットの開始から開始する場合、この指定された時間内に廃棄石マーカーの読み取りを完了する必要があります。

--user-metadata

ユーザーのメタデータを取得および設定します。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

--output -o

出力フォーマット。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

az eventhubs eventhub delete

指定した名前空間とリソース グループからイベント ハブを削除します。

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

省略可能のパラメーター

--event-hub-name --name -n

イベント ハブ名。

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--namespace-name

名前空間の名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 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

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

az eventhubs eventhub list

名前空間内のすべての Event Hubs を一覧表示します。

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

必須のパラメーター

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

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

az eventhubs eventhub show

指定したイベント ハブの Event Hubs の説明を取得します。

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

省略可能のパラメーター

--event-hub-name --name -n

イベント ハブ名。

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--namespace-name

名前空間の名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 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

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

az eventhubs eventhub update

名前空間内の入れ子になったリソースとして新しいイベント ハブを更新します。

az eventhubs eventhub update [--add]
                             [--archive-name-format]
                             [--blob-container]
                             [--capture-interval]
                             [--capture-size-limit]
                             [--cleanup-policy {Compact, Delete, DeleteOrCompact}]
                             [--destination-name]
                             [--enable-capture {0, 1, f, false, n, no, t, true, y, yes}]
                             [--encoding {Avro, AvroDeflate}]
                             [--event-hub-name]
                             [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                             [--identity]
                             [--ids]
                             [--min-compaction-lag-in-mins]
                             [--namespace-name]
                             [--partition-count]
                             [--remove]
                             [--resource-group]
                             [--retention-time]
                             [--set]
                             [--skip-empty-archives {0, 1, f, false, n, no, t, true, y, yes}]
                             [--status {Active, Creating, Deleting, Disabled, ReceiveDisabled, Renaming, Restoring, SendDisabled, Unknown}]
                             [--storage-account]
                             [--subscription]
                             [--timestamp-type {Create, LogAppend}]
                             [--tombstone-retention-time-in-hours]
                             [--user-metadata]

省略可能のパラメーター

--add

パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value, string or JSON string>。

--archive-name-format

アーカイブの BLOB 名前付け規則 ({Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second} など)。 ここでは、順序に関係なく、すべてのパラメーター (Namespace、EventHub など) が必須です。

--blob-container

BLOB コンテナー名。

--capture-interval

時間枠では、Azure BLOB へのキャプチャの頻度を設定できます。値は 60 ~ 900 秒です。

--capture-size-limit

サイズ ウィンドウは、キャプチャ操作の前にイベント ハブに構築されたデータの量を定義します。値は10485760から524288000 バイトの間である必要があります。

--cleanup-policy

クリーンアップ ポリシーに使用できる値を列挙します。

指定可能な値: Compact, Delete, DeleteOrCompact

--destination-name

キャプチャ先の名前。

--enable-capture

キャプチャの説明が有効かどうかを示す値。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--encoding

キャプチャの説明のエンコード形式に使用できる値を列挙します。 注: "AvroDeflate" は、新しい API バージョンでは非推奨になります。

指定可能な値: Avro, AvroDeflate

--event-hub-name --name -n

イベント ハブ名。

--force-string

'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--identity

キャプチャの説明が有効かどうかを示す値。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--min-compaction-lag-in-mins --min-lag

メッセージがログに圧縮されない最小時間。 この値は、cleanupPolicy が Compact または DeleteOrCompact の場合に使用されます。

--namespace-name

名前空間の名前。

--partition-count

イベント ハブ用に作成されたパーティションの数。使用できる値は 1 から 32 個のパーティションです。

--remove

リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove> OR --remove propertyToRemove。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--retention-time --retention-time-in-hours

このイベント ハブのイベントを保持する時間数。 この値は、cleanupPolicy が Delete の場合にのみ使用されます。 cleanupPolicy が Compaction の場合、このプロパティの戻り値は Long.MaxValue です。

--set

設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>。

--skip-empty-archives

空のアーカイブをスキップするかどうかを示す値。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--status

イベント ハブの状態に使用できる値を列挙します。

指定可能な値: Active, Creating, Deleting, Disabled, ReceiveDisabled, Renaming, Restoring, SendDisabled, Unknown

--storage-account

BLOB の作成に使用するストレージ アカウントのリソース ID。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--timestamp-type

メッセージが保持するタイムスタンプの種類を示します。タイムスタンプ型は、"AppendTime" と "CreateTime" の 2 種類です。 AppendTime は、メッセージがブローカー ログ内に追加された時刻を指します。 CreateTime は、メッセージがソース側で生成された時刻を指し、プロデューサーはメッセージの送信中にこのタイムスタンプを設定できます。 既定値は AppendTime です。 AMQP プロトコルを使用している場合、CreateTime は AppendTime と等しく、動作は変わりません。

指定可能な値: Create, LogAppend

--tombstone-retention-time-in-hours -t

圧縮されたイベント ハブの廃棄石マーカーを保持する時間数。 この値は、cleanupPolicy が圧縮されている場合にのみ使用されます。 コンシューマーは、圧縮されたイベント ハブ内の廃棄石マーカーによって記述された特定のキーの有効なスナップショットを取得するために、オフセットの開始から開始する場合、この指定された時間内に廃棄石マーカーの読み取りを完了する必要があります。

--user-metadata

ユーザーのメタデータを取得および設定します。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

--output -o

出力フォーマット。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。