az eventhubs eventhub
Azure EventHubs eventhub と authorization-rule を管理します。
コマンド
名前 | 説明 | 型 | 状態 |
---|---|---|---|
az eventhubs eventhub authorization-rule |
Eventhub 承認規則。 |
Core | GA |
az eventhubs eventhub authorization-rule create |
指定したイベント ハブの AuthorizationRule を作成します。 AuthorizationRule の作成/更新が有効になるには数秒かかります。 |
Core | GA |
az eventhubs eventhub authorization-rule delete |
イベント ハブ AuthorizationRule を削除します。 |
Core | GA |
az eventhubs eventhub authorization-rule keys |
Authorization-rule keys. |
Core | GA |
az eventhubs eventhub authorization-rule keys list |
イベント ハブの ACS 接続文字列と SAS 接続文字列を取得します。 |
Core | GA |
az eventhubs eventhub authorization-rule keys renew |
イベント ハブの ACS 接続文字列と SAS 接続文字列を再生成します。 |
Core | GA |
az eventhubs eventhub authorization-rule list |
イベント ハブの承認規則を一覧表示します。 |
Core | GA |
az eventhubs eventhub authorization-rule show |
ルール名でイベント ハブの AuthorizationRule を取得します。 |
Core | GA |
az eventhubs eventhub authorization-rule update |
指定したイベント ハブの AuthorizationRule を更新します。 AuthorizationRule の作成/更新が有効になるには数秒かかります。 |
Core | GA |
az eventhubs eventhub consumer-group |
Azure Event Hubs コンシューマー グループを管理します。 |
Core | GA |
az eventhubs eventhub consumer-group create |
名前空間内に入れ子になったリソースとして Event Hubs コンシューマー グループを作成します。 |
Core | GA |
az eventhubs eventhub consumer-group delete |
指定したイベント ハブとリソース グループからコンシューマー グループを削除します。 |
Core | GA |
az eventhubs eventhub consumer-group list |
名前空間内のすべてのコンシューマー グループを一覧表示します。 名前空間にコンシューマー グループが存在しない場合は、空のフィードが返されます。 |
Core | GA |
az eventhubs eventhub consumer-group show |
指定したコンシューマー グループの説明を取得します。 |
Core | GA |
az eventhubs eventhub consumer-group update |
Event Hubs コンシューマー グループを名前空間内の入れ子になったリソースとして更新します。 |
Core | GA |
az eventhubs eventhub create |
EventHubs Eventhub を作成します。 |
Core | GA |
az eventhubs eventhub delete |
指定した名前空間とリソース グループからイベント ハブを削除します。 |
Core | GA |
az eventhubs eventhub list |
名前空間内のすべての Event Hubs を一覧表示します。 |
Core | GA |
az eventhubs eventhub show |
指定したイベント ハブの Event Hubs の説明を取得します。 |
Core | GA |
az eventhubs eventhub update |
名前空間内の入れ子になったリソースとして新しいイベント ハブを更新します。 |
Core | 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 --min-lag]
[--partition-count]
[--retention-time --retention-time-in-hours]
[--skip-empty-archives {false, true}]
[--status {Active, Disabled, SendDisabled}]
[--storage-account]
[--timestamp-type {Create, LogAppend}]
[--tombstone-retention-time-in-hours --tombstone-time]
[--user-metadata]
例
新しい Eventhub を作成します。
az eventhubs eventhub create --resource-group myresourcegroup --namespace-name mynamespace --name myeventhub --cleanup-policy Delete --partition-count 15
必須のパラメーター
Eventhub の名前。
名前空間の名前。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
アーカイブの BLOB 名前付け規則 ({Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second} など)。 ここでは、順序に関係なく、すべてのパラメーター (Namespace、EventHub など) が必須です。
プロパティ | 値 |
---|---|
Parameter group: | Capture-Destination Arguments |
BLOB コンテナー名。
プロパティ | 値 |
---|---|
Parameter group: | Capture-Destination Arguments |
Azure BLOB へのキャプチャの頻度を設定できます。値は 60 ~ 900 秒です。
プロパティ | 値 |
---|---|
Parameter group: | Capture Arguments |
キャプチャ操作の前にイベント ハブに構築されるデータの量を定義します。値は10485760から524288000 バイトの間にする必要があります。
プロパティ | 値 |
---|---|
Parameter group: | Capture Arguments |
クリーンアップ ポリシーに使用できる値を列挙します。
プロパティ | 値 |
---|---|
Parameter group: | Retention-Description Arguments |
指定可能な値: | Compact, Delete, DeleteOrCompact |
キャプチャ先の名前。EventHubArchive.AzureBlockBlob にする必要があります。
プロパティ | 値 |
---|---|
Parameter group: | Capture-Destination Arguments |
キャプチャが有効かどうかを示すブール値。
プロパティ | 値 |
---|---|
Parameter group: | Capture Arguments |
指定可能な値: | false, true |
システム割り当て ID を有効にします。
プロパティ | 値 |
---|---|
Parameter group: | Capture-Destination Arguments |
規定値: | False |
指定可能な値: | false, true |
ユーザー割り当て ID の一覧。
プロパティ | 値 |
---|---|
Parameter group: | Capture-Destination Arguments |
メッセージがログに圧縮されない最小時間。 この値は、cleanupPolicy が Compact または DeleteOrCompact の場合に使用されます。
プロパティ | 値 |
---|---|
Parameter group: | Retention-Description Arguments |
イベント ハブ用に作成されたパーティションの数。 既定では、使用できる値は 2 ~ 32 です。 Kafka 対応の名前空間では、1 の小さい値がサポートされています。 カスタム クォータが存在する場合、上限はクォータの上限と一致します。
このイベント ハブのイベントを保持する時間数。 この値は、cleanupPolicy が Delete の場合にのみ使用されます。 cleanupPolicy が Compaction の場合、このプロパティの戻り値は Long.MaxValue です。
プロパティ | 値 |
---|---|
Parameter group: | Retention-Description Arguments |
空をスキップするかどうかを示すブール値。
プロパティ | 値 |
---|---|
指定可能な値: | false, true |
Eventhub の状態。
プロパティ | 値 |
---|---|
指定可能な値: | Active, Disabled, SendDisabled |
BLOB の作成に使用するストレージ アカウントの名前 (クラシック ストレージの種類ではなく、同じリソース グループ内にある場合) または ARM ID。
プロパティ | 値 |
---|---|
Parameter group: | Capture-Destination Arguments |
メッセージが保持するタイムスタンプの種類を示します。
プロパティ | 値 |
---|---|
指定可能な値: | Create, LogAppend |
圧縮されたイベント ハブの廃棄石マーカーを保持する時間数。 この値は、cleanupPolicy が圧縮されている場合にのみ使用されます。 コンシューマーは、圧縮されたイベント ハブ内の廃棄石マーカーによって記述された特定のキーの有効なスナップショットを取得するために、オフセットの開始から開始する場合、この指定された時間内に廃棄石マーカーの読み取りを完了する必要があります。
プロパティ | 値 |
---|---|
Parameter group: | Retention-Description Arguments |
ユーザーのメタデータを取得および設定します。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az eventhubs eventhub delete
指定した名前空間とリソース グループからイベント ハブを削除します。
az eventhubs eventhub delete [--event-hub-name --name]
[--ids]
[--namespace-name]
[--resource-group]
[--subscription]
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
イベント ハブ名。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
名前空間の名前。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az eventhubs eventhub list
名前空間内のすべての Event Hubs を一覧表示します。
az eventhubs eventhub list --namespace-name
--resource-group
[--max-items]
[--next-token]
[--skip]
[--top]
必須のパラメーター
名前空間の名前。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
コマンドの出力で返される項目の合計数。 使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。 改ページ位置の変更を再開するには、後続のコマンドの引数 --next-token
トークン値を指定します。
プロパティ | 値 |
---|---|
Parameter group: | Pagination Arguments |
ページ分割を開始する場所を指定するトークン。 これは、以前に切り捨てられた応答からのトークン値です。
プロパティ | 値 |
---|---|
Parameter group: | Pagination Arguments |
Skip は、前の操作で部分的な結果が返された場合にのみ使用されます。 前の応答に nextLink 要素が含まれている場合、nextLink 要素の値には、後続の呼び出しに使用する開始点を指定する skip パラメーターが含まれます。
結果の数を最新の N usageDetails に制限するために使用できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az eventhubs eventhub show
指定したイベント ハブの Event Hubs の説明を取得します。
az eventhubs eventhub show [--event-hub-name --name]
[--ids]
[--namespace-name]
[--resource-group]
[--subscription]
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
イベント ハブ名。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
名前空間の名前。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
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 --name]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--identity]
[--ids]
[--min-compaction-lag-in-mins --min-lag]
[--namespace-name]
[--partition-count]
[--remove]
[--resource-group]
[--retention-time --retention-time-in-hours]
[--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]
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value, string or JSON string>
。
プロパティ | 値 |
---|---|
Parameter group: | Generic Update Arguments |
アーカイブの BLOB 名前付け規則 ({Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second} など)。 ここでは、順序に関係なく、すべてのパラメーター (Namespace、EventHub など) が必須です。
プロパティ | 値 |
---|---|
Parameter group: | CaptureDescription Arguments |
BLOB コンテナー名。
プロパティ | 値 |
---|---|
Parameter group: | CaptureDescription Arguments |
時間枠では、Azure BLOB へのキャプチャの頻度を設定できます。値は 60 ~ 900 秒です。
プロパティ | 値 |
---|---|
Parameter group: | CaptureDescription Arguments |
サイズ ウィンドウは、キャプチャ操作の前にイベント ハブに構築されたデータの量を定義します。値は10485760から524288000 バイトの間である必要があります。
プロパティ | 値 |
---|---|
Parameter group: | CaptureDescription Arguments |
クリーンアップ ポリシーに使用できる値を列挙します。
プロパティ | 値 |
---|---|
Parameter group: | RetentionDescription Arguments |
指定可能な値: | Compact, Delete, DeleteOrCompact |
キャプチャ先の名前。
プロパティ | 値 |
---|---|
Parameter group: | CaptureDescription Arguments |
キャプチャの説明が有効かどうかを示す値。
プロパティ | 値 |
---|---|
Parameter group: | CaptureDescription Arguments |
指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
キャプチャの説明のエンコード形式に使用できる値を列挙します。 注: "AvroDeflate" は、新しい API バージョンでは非推奨になります。
プロパティ | 値 |
---|---|
Parameter group: | CaptureDescription Arguments |
指定可能な値: | Avro, AvroDeflate |
イベント ハブ名。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。
プロパティ | 値 |
---|---|
Parameter group: | Generic Update Arguments |
指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
キャプチャの説明が有効かどうかを示す値。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
プロパティ | 値 |
---|---|
Parameter group: | Destination Arguments |
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
メッセージがログに圧縮されない最小時間。 この値は、cleanupPolicy が Compact または DeleteOrCompact の場合に使用されます。
プロパティ | 値 |
---|---|
Parameter group: | RetentionDescription Arguments |
名前空間の名前。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
イベント ハブ用に作成されたパーティションの数。使用できる値は 1 から 32 個のパーティションです。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove>
OR --remove propertyToRemove
。
プロパティ | 値 |
---|---|
Parameter group: | Generic Update Arguments |
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
このイベント ハブのイベントを保持する時間数。 この値は、cleanupPolicy が Delete の場合にのみ使用されます。 cleanupPolicy が Compaction の場合、このプロパティの戻り値は Long.MaxValue です。
プロパティ | 値 |
---|---|
Parameter group: | RetentionDescription Arguments |
設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>
。
プロパティ | 値 |
---|---|
Parameter group: | Generic Update Arguments |
空のアーカイブをスキップするかどうかを示す値。
プロパティ | 値 |
---|---|
Parameter group: | CaptureDescription Arguments |
指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
イベント ハブの状態に使用できる値を列挙します。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
指定可能な値: | Active, Creating, Deleting, Disabled, ReceiveDisabled, Renaming, Restoring, SendDisabled, Unknown |
BLOB の作成に使用するストレージ アカウントのリソース ID。
プロパティ | 値 |
---|---|
Parameter group: | CaptureDescription Arguments |
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
メッセージが保持するタイムスタンプの種類を示します。タイムスタンプ型は、"AppendTime" と "CreateTime" の 2 種類です。 AppendTime は、メッセージがブローカー ログ内に追加された時刻を指します。 CreateTime は、メッセージがソース側で生成された時刻を指し、プロデューサーはメッセージの送信中にこのタイムスタンプを設定できます。 既定値は AppendTime です。 AMQP プロトコルを使用している場合、CreateTime は AppendTime と等しく、動作は変わりません。
プロパティ | 値 |
---|---|
Parameter group: | MessageTimestampDescription Arguments |
指定可能な値: | Create, LogAppend |
圧縮されたイベント ハブの廃棄石マーカーを保持する時間数。 この値は、cleanupPolicy が圧縮されている場合にのみ使用されます。 コンシューマーは、圧縮されたイベント ハブ内の廃棄石マーカーによって記述された特定のキーの有効なスナップショットを取得するために、オフセットの開始から開始する場合、この指定された時間内に廃棄石マーカーの読み取りを完了する必要があります。
プロパティ | 値 |
---|---|
Parameter group: | RetentionDescription Arguments |
ユーザーのメタデータを取得および設定します。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |