az confluent organization

注

このリファレンスは、Azure CLI (バージョン 2.56.0 以降) の confluent 拡張機能の一部です。 拡張機能は、az confluent organization コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細については、 を参照してください。

confluent 組織に対してアクションを実行するコマンド。

コマンド

名前	説明	型	状態
az confluent organization api-key	クラスター API キーを管理します。	拡張	GA
az confluent organization api-key delete	kafka またはスキーマ レジストリ クラスターの API キーを削除します。	拡張	GA
az confluent organization create	組織のリソースを作成します。	拡張	GA
az confluent organization create-role-binding	組織の役割のバインド。	拡張	GA
az confluent organization create-user	組織にユーザーを招待します。	拡張	GA
az confluent organization delete	組織のリソースを削除します。	拡張	GA
az confluent organization environment	組織内の confluent 環境を取得するコマンド。	拡張	GA
az confluent organization environment cluster	環境内の confluent クラスターの詳細を取得するコマンド。	拡張	GA
az confluent organization environment cluster create-api-key	環境内のスキーマ レジストリ クラスター ID または Kafka クラスター ID の API キーを作成します。	拡張	GA
az confluent organization environment cluster list	環境内のすべてのクラスターの一覧。	拡張	GA
az confluent organization environment cluster show	ID でクラスターを取得します。	拡張	GA
az confluent organization environment list	組織内のすべての環境の一覧。	拡張	GA
az confluent organization environment schema-registry-cluster	環境内のスキーマ レジストリ クラスターの詳細を取得するコマンド。	拡張	GA
az confluent organization environment schema-registry-cluster list	スキーマ レジストリ クラスターを一覧表示します。	拡張	GA
az confluent organization environment schema-registry-cluster show	ID でスキーマ レジストリ クラスターを取得します。	拡張	GA
az confluent organization list	指定したリソース グループのすべての組織を一覧表示します。 指定したサブスクリプションのすべての組織を一覧表示します。	拡張	GA
az confluent organization list-role-binding	組織の役割のバインド。	拡張	GA
az confluent organization list-service-accounts	組織のサービス アカウントの詳細。	拡張	GA
az confluent organization list-users	組織のユーザーの詳細。	拡張	GA
az confluent organization role-binding	ロール バインドを管理します。	拡張	GA
az confluent organization role-binding delete	ロール バインドを削除します。	拡張	GA
az confluent organization show	特定の組織リソースのプロパティを取得します。	拡張	GA
az confluent organization update	組織のリソースを更新します。	拡張	GA
az confluent organization wait	コンフルエント組織の条件が満たされるまで、CLI を待機状態にします。	拡張	GA

az confluent organization create

組織のリソースを作成します。

az confluent organization create --name
                                 --plan-id
                                 --plan-name
                                 --resource-group
                                 --term-unit
                                 [--location]
                                 [--no-wait]
                                 [--offer-id]
                                 [--publisher-id]
                                 [--tags]

例

組織を作成する

az confluent organization create --location "West US" --tags Environment="Dev" --name "myOrganization" --resource-group "myResourceGroup" --offer-id "confluent-cloud-azure-prod" --plan-id "confluent-cloud-azure-payg-prod" --plan-name "Confluent Cloud - Pay as you Go" --publisher-id "confluentinc" --term-unit "P1M"

必須のパラメーター

--name --organization-name -n

組織のリソース名。

--plan-id

プラン ID。

--plan-name

プラン名。

--resource-group -g

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

--term-unit

プランプランの期間単位。

省略可能のパラメーター

--location -l

場所。 値のソース: az account list-locations az configure --defaults location=<location>を使用して、既定の場所を構成できます。

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

規定値: False

--offer-id

オファー ID。

規定値: confluent-cloud-azure-prod

--publisher-id

パブリッシャー ID。

規定値: confluentinc

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

グローバル パラメーター

--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 confluent organization create-role-binding

組織の役割のバインド。

az confluent organization create-role-binding [--crn-pattern]
                                              [--ids]
                                              [--organization-name]
                                              [--principal]
                                              [--resource-group]
                                              [--role-name]
                                              [--subscription]

省略可能のパラメーター

--crn-pattern

ロールのバインドに必要なスコープとリソース パターンを指定する CRN。

--ids

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

--organization-name

組織のリソース名。

--principal

ロールをバインドするプリンシパル ユーザーまたはグループ。

--resource-group

リソース グループ名。

--role-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 confluent organization create-user

組織にユーザーを招待します。

az confluent organization create-user [--auth-type]
                                      [--email]
                                      [--ids]
                                      [--invited-email]
                                      [--organization-id]
                                      [--organization-name]
                                      [--resource-group]
                                      [--subscription]
                                      [--upn]

省略可能のパラメーター

--auth-type

ユーザーの認証の種類。

--email

ログインしているユーザーの電子メール。

--ids

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

--invited-email

招待されているユーザーの UPN/電子メール。

--organization-id

組織の ID。

--organization-name

組織のリソース名。

--resource-group -g

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

--subscription

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

--upn

ログインしているユーザーの Upn。

グローバル パラメーター

--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 confluent organization delete

組織のリソースを削除します。

az confluent organization delete [--ids]
                                 [--name]
                                 [--no-wait]
                                 [--resource-group]
                                 [--subscription]
                                 [--yes]

例

組織の削除

az confluent organization delete --name "myOrganization" --resource-group "myResourceGroup"

ID を使用して組織を削除する

az confluent organization delete --ids "/subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Confluent/organizations/{myOrganization}"

省略可能のパラメーター

--ids

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

--name --organization-name -n

組織のリソース名。

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

規定値: False

--resource-group -g

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

--subscription

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

--yes -y

確認を求めないでください。

グローバル パラメーター

--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 confluent organization list

指定したリソース グループのすべての組織を一覧表示します。 指定したサブスクリプションのすべての組織を一覧表示します。

az confluent organization list [--resource-group]

例

Organization_ListByResourceGroup

az confluent organization list --resource-group "myResourceGroup"

Organization_ListBySubscription

az confluent organization list

省略可能のパラメーター

--resource-group -g

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

グローバル パラメーター

--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 confluent organization list-role-binding

組織の役割のバインド。

az confluent organization list-role-binding [--ids]
                                            [--organization-name]
                                            [--resource-group]
                                            [--search-filters]
                                            [--subscription]

省略可能のパラメーター

--ids

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

--organization-name

組織のリソース名。

--resource-group

リソース グループ名。

--search-filters

要求の検索フィルターは、短縮構文、json ファイル、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--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 confluent organization list-service-accounts

組織のサービス アカウントの詳細。

az confluent organization list-service-accounts [--ids]
                                                [--organization-name]
                                                [--resource-group]
                                                [--search-filters]
                                                [--subscription]

省略可能のパラメーター

--ids

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

--organization-name

組織のリソース名。

--resource-group

リソース グループ名。

--search-filters

要求の検索フィルターは、短縮構文、json ファイル、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--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 confluent organization list-users

組織のユーザーの詳細。

az confluent organization list-users [--ids]
                                     [--organization-name]
                                     [--resource-group]
                                     [--search-filters]
                                     [--subscription]

省略可能のパラメーター

--ids

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

--organization-name

組織のリソース名。

--resource-group

リソース グループ名。

--search-filters

要求の検索フィルターは、短縮構文、json ファイル、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--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 confluent organization show

特定の組織リソースのプロパティを取得します。

az confluent organization show [--ids]
                               [--name]
                               [--resource-group]
                               [--subscription]

例

組織を表示する

az confluent organization show --name "myOrganization" --resource-group "myResourceGroup"

ID を使用して組織を表示する

az confluent organization show --ids "/subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Confluent/organizations/{myOrganization}"

省略可能のパラメーター

--ids

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

--name --organization-name -n

組織のリソース名。

--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 confluent organization update

組織のリソースを更新します。

az confluent organization update [--ids]
                                 [--name]
                                 [--resource-group]
                                 [--subscription]
                                 [--tags]

例

Confluent_Update

az confluent organization update --tags client="dev-client" env="dev" --name "myOrganization" --resource-group "myResourceGroup"

省略可能のパラメーター

--ids

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

--name --organization-name -n

組織のリソース名。

--resource-group -g

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

--subscription

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

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

グローバル パラメーター

--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 confluent organization wait

コンフルエント組織の条件が満たされるまで、CLI を待機状態にします。

az confluent organization wait [--created]
                               [--custom]
                               [--deleted]
                               [--exists]
                               [--ids]
                               [--interval]
                               [--name]
                               [--resource-group]
                               [--subscription]
                               [--timeout]
                               [--updated]

例

confluent 組織が正常に作成されるまで、CLI スクリプトの次の行の実行を一時停止します。

az confluent organization wait --name "myOrganization" --resource-group "myResourceGroup" --created

confluent 組織が正常に削除されるまで、CLI スクリプトの次の行の実行を一時停止します。

az confluent organization wait --name "myOrganization" --resource-group "myResourceGroup" --deleted

省略可能のパラメーター

--created

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

規定値: False

--custom

条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。

--deleted

削除されるまで待ちます。

規定値: False

--exists

リソースが存在するまで待ちます。

規定値: False

--ids

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

--interval

ポーリング間隔 (秒単位)。

規定値: 30

--name --organization-name -n

組織のリソース名。

--resource-group -g

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

--subscription

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

--timeout

最大待機時間 (秒単位)。

規定値: 3600

--updated

provisioningState が 'Succeeded' で更新されるまで待ちます。

規定値: False

グローバル パラメーター

--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 を使用します。