az eventhubs namespace
Eventhub 名前空間。
コマンド
az eventhubs namespace create
EventHubs 名前空間を作成します。
az eventhubs namespace create --name
--resource-group
[--alternate-name]
[--capacity]
[--cluster-arm-id]
[--disable-local-auth {false, true}]
[--enable-auto-inflate {false, true}]
[--enable-kafka {false, true}]
[--encryption-config]
[--infra-encryption {false, true}]
[--location]
[--maximum-throughput-units]
[--mi-system-assigned {false, true}]
[--mi-user-assigned]
[--min-tls {1.0, 1.1, 1.2}]
[--public-network {Disabled, Enabled}]
[--sku {Basic, Premium, Standard}]
[--tags]
[--zone-redundant {false, true}]
例
新しい名前空間を作成します。
az eventhubs namespace create --resource-group myresourcegroup --name mynamespace --location westus --tags tag1=value1 tag2=value2 --sku Standard --enable-auto-inflate --maximum-throughput-units 20
ID と暗号化が有効になっている新しい名前空間を作成します。
az eventhubs namespace create --resource-group myresourcegroup --name mynamespace --location westus --sku Premium --mi-user-assigned /subscriptions/{subscriptionId}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName --encryption-config key-name=key1 key-vault-uri=https://mykeyvault.vault.azure.net/ user-assigned-identity=/subscriptions/{subscriptionId}}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName --encryption-config key-name=key1 key-vault-uri=https://mykeyvault.vault.azure.net/ user-assigned-identity=/subscriptions/{subscriptionId}}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName
必須のパラメーター
名前空間の名前。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
省略可能のパラメーター
別名と名前空間名が同じ場合に指定される代替名。
SKU の容量。
名前空間のクラスター ARM ID。
Event Hubs で SAS 認証が有効または無効になっているかどうかを示すブール値。
Eventhub 名前空間に対して AutoInflate が有効かどうかを示すブール値。
Kafka が eventhub 名前空間に対して有効になっているかどうかを示すブール値。
KeyVaultProperties オブジェクトの一覧。
Infrastructure Encryption (Double Encryption) が有効または無効かどうかを示すブール値。
Location。 値のソース: az account list-locations
az configure --defaults location=<location>
を使用して、既定の場所を構成できます。
AutoInflate が有効な場合のスループット ユニットの上限は、0 ~ 20 スループット ユニット以内にする必要があります。 (AutoInflateEnabled = true の場合は 0)。
システム割り当て ID を有効にします。
ユーザー割り当て ID の一覧。
サポートするクラスターの最小 TLS バージョン (例: 1.2)。
これにより、パブリック ネットワーク経由でトラフィックが許可されるかどうかが決まります。 既定では有効になっています。 値が SecuredByPerimeter の場合、受信と送信の通信は、ネットワーク セキュリティ境界とプロファイルのアクセス規則によって制御されます。
名前空間 SKU。
スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。
このプロパティを有効にすると、サポートされている可用性ゾーンのリージョンに Standard EventHubs 名前空間が作成されます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az eventhubs namespace delete
既存の名前空間を削除します。 この操作により、名前空間に関連付けられているすべてのリソースも削除されます。
az eventhubs namespace delete [--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
例
名前空間を削除する
az eventhubs namespace delete --resource-group myresourcegroup --name mynamespace
省略可能のパラメーター
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 namespace exists
名前空間名の指定の可用性を確認します。
az eventhubs namespace exists --name
必須のパラメーター
名前空間名の可用性をチェックする名前。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az eventhubs namespace list
リソース グループに関係なく、サブスクリプション内で使用可能なすべての名前空間を一覧表示します。
az eventhubs namespace list [--max-items]
[--next-token]
[--resource-group]
例
リソース グループ別に Event Hubs 名前空間を一覧表示します。
az eventhubs namespace list --resource-group myresourcegroup
サブスクリプション別の名前空間を取得します。
az eventhubs namespace list
省略可能のパラメーター
コマンドの出力で返される項目の合計数。 使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。 改ページ位置の変更を再開するには、後続のコマンドの引数に --next-token
トークン値を指定します。
ページ分割を開始する場所を指定するトークン。 これは、以前に切り捨てられた応答からのトークン値です。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az eventhubs namespace show
指定した名前空間の説明を取得します。
az eventhubs namespace show [--ids]
[--name]
[--resource-group]
[--subscription]
例
には、名前空間の詳細が表示されます。
az eventhubs namespace show --resource-group myresourcegroup --name mynamespace
省略可能のパラメーター
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 namespace update
名前空間を更新します。 作成されると、この名前空間のリソース マニフェストは変更できません。 この操作はべき等です。
az eventhubs namespace update [--add]
[--alternate-name]
[--capacity]
[--cluster-arm-id]
[--disable-local-auth {0, 1, f, false, n, no, t, true, y, yes}]
[--enable-auto-inflate {0, 1, f, false, n, no, t, true, y, yes}]
[--encryption]
[--endpoint-connections]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--identity]
[--ids]
[--kafka-enabled {0, 1, f, false, n, no, t, true, y, yes}]
[--maximum-throughput-units]
[--minimum-tls-version {1.0, 1.1, 1.2}]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--public-network-access {Disabled, Enabled, SecuredByPerimeter}]
[--remove]
[--resource-group]
[--set]
[--sku {Basic, Premium, Standard}]
[--subscription]
[--tags]
[--tier {Basic, Premium, Standard}]
[--zone-redundant {0, 1, f, false, n, no, t, true, y, yes}]
例
新しい名前空間を更新します。
az eventhubs namespace update --resource-group myresourcegroup --name mynamespace --tags tag=value --enable-auto-inflate True
省略可能のパラメーター
パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value、string、または JSON 文字列>。
別名と名前空間名が同じ場合に指定される代替名。
Basic レベルまたは Standard レベルの Event Hubs スループット ユニット。値は 0 から 20 のスループット ユニットである必要があります。 プレミアム レベルの Event Hubs Premium ユニット。値は 0 から 10 の Premium ユニットである必要があります。
名前空間のクラスター ARM ID。
このプロパティは、Event Hubs 名前空間の SAS 認証を無効にします。
Eventhub 名前空間に対して AutoInflate が有効かどうかを示す値。
BYOK 暗号化の説明のプロパティは、短縮構文、json ファイル、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
プライベート エンドポイント接続の一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。
BYOK ID の説明のプロパティは、短縮構文、json ファイル、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
Kafka が eventhub 名前空間に対して有効になっているかどうかを示す値。
AutoInflate が有効な場合のスループット ユニットの上限。値は 0 ~ 20 スループット ユニット以内にする必要があります。 ( AutoInflateEnabled = true の場合は '0' )。
サポートするクラスターの最小 TLS バージョン (例: '1.2')。
名前空間の名前。
実行時間の長い操作の終了を待機しません。
これにより、パブリック ネットワーク経由でトラフィックが許可されるかどうかが決まります。 既定では有効になっています。
リストからプロパティまたは要素を削除します。 例: --remove property.list OR --remove propertyToRemove。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=。
この SKU の名前。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
リソース タグ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
この特定の SKU の課金レベル。
このプロパティを有効にすると、サポートされている可用性ゾーンのリージョンに Standard Event Hubs 名前空間が作成されます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az eventhubs namespace wait
条件が満たされるまで CLI を待機状態にします。
az eventhubs namespace wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
省略可能のパラメーター
'provisioningState' が 'Succeeded' で作成されるまで待ちます。
条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。
削除されるまで待ちます。
リソースが存在するまで待ちます。
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
ポーリング間隔 (秒単位)。
名前空間の名前。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
最大待機時間 (秒単位)。
provisioningState が 'Succeeded' で更新されるまで待ちます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
Azure CLI