az aro

Note

このコマンド グループには、Azure CLIと少なくとも 1 つの拡張機能の両方で定義されているコマンドがあります。 各拡張機能をインストールして、拡張機能を活用します。 拡張機能の詳細については、 を参照してください。

Azure Red Hat OpenShift クラスターを管理します。

コマンド

Name 説明 型 状態
az aro create

クラスターを作成します。

Core GA
az aro create (aro 拡張機能)

クラスターを作成します。

Extension Preview
az aro delete

クラスターを削除します。

Core GA
az aro delete (aro 拡張機能)

クラスターを削除します。

Extension Preview
az aro get-admin-kubeconfig

クラスターの管理者 kubeconfig を一覧表示します。

Core GA
az aro get-admin-kubeconfig (aro 拡張機能)

クラスターの管理者 kubeconfig を一覧表示します。

Extension Preview
az aro get-versions

インストールに使用できるバージョンを一覧表示します。

Core GA
az aro get-versions (aro 拡張機能)

インストールに使用できるバージョンを一覧表示します。

Extension Preview
az aro hcp

ホストされたコントロール プレーン リソースの種類を使用してAzure Red Hat OpenShiftを管理します。

Extension Preview
az aro hcp cluster

ホストされたコントロール プレーン クラスターを使用してAzure Red Hat OpenShiftを管理します。

Extension Preview
az aro hcp cluster create

ホストされたコントロール プレーン クラスターを使用してAzure Red Hat OpenShiftを作成します。

Extension Preview
az aro hcp cluster delete

ホストされたコントロール プレーン クラスターを使用してAzure Red Hat OpenShiftを削除します。

Extension Preview
az aro hcp cluster external-auth

ホストされたコントロール プレーンの外部認証を使用してAzure Red Hat OpenShiftを管理します。

Extension Preview
az aro hcp cluster external-auth create

ホストされたコントロール プレーンの外部認証インスタンスを使用してAzure Red Hat OpenShiftを作成します。

Extension Preview
az aro hcp cluster external-auth delete

ホストされたコントロール プレーンの外部認証インスタンスを持つAzure Red Hat OpenShiftを削除します。

Extension Preview
az aro hcp cluster external-auth list

ホストされたコントロール プレーンの外部認証インスタンスを含むAzure Red Hat OpenShiftを一覧表示します。

Extension Preview
az aro hcp cluster external-auth show

ホストされたコントロール プレーンの外部認証インスタンスを使用してAzure Red Hat OpenShiftを取得します。

Extension Preview
az aro hcp cluster external-auth update

ホストされたコントロール プレーンの外部認証インスタンスを使用してAzure Red Hat OpenShiftを更新します。

Extension Preview
az aro hcp cluster external-auth wait

条件が満たされるまで CLI を待機状態にします。

Extension Preview
az aro hcp cluster list

ホストされたコントロール プレーン クラスターを含むAzure Red Hat OpenShiftを一覧表示します。

Extension Preview
az aro hcp cluster nodepool

ホストされたコントロール プレーン ノード プールを使用してAzure Red Hat OpenShiftを管理します。

Extension Preview
az aro hcp cluster nodepool create

ホストされたコントロール プレーン ノード プールを使用してAzure Red Hat OpenShiftを作成します。

Extension Preview
az aro hcp cluster nodepool delete

ホストされたコントロール プレーン ノード プールを持つAzure Red Hat OpenShiftを削除します。

Extension Preview
az aro hcp cluster nodepool list

ホストされたコントロール プレーン ノード プールを含むAzure Red Hat OpenShiftを一覧表示します。

Extension Preview
az aro hcp cluster nodepool show

ホストされたコントロール プレーン ノード プールを使用してAzure Red Hat OpenShiftを取得します。

Extension Preview
az aro hcp cluster nodepool update

ホストされたコントロール プレーン ノード プールを使用してAzure Red Hat OpenShiftを更新します。

Extension Preview
az aro hcp cluster nodepool wait

条件が満たされるまで CLI を待機状態にします。

Extension Preview
az aro hcp cluster request-credential

ホストされたコントロール プレーン クラスターを使用して、Azure Red Hat OpenShiftの一時的な資格情報を要求します。

Extension Preview
az aro hcp cluster revoke-credential

ホストされたコントロール プレーン クラスターを使用して、Azure Red Hat OpenShiftのすべての資格情報を取り消します。

Extension Preview
az aro hcp cluster show

ホストされたコントロール プレーン クラスターを使用してAzure Red Hat OpenShiftを取得します。

Extension Preview
az aro hcp cluster update

ホストされたコントロール プレーン クラスターを使用してAzure Red Hat OpenShiftを更新します。

Extension Preview
az aro hcp cluster wait

条件が満たされるまで CLI を待機状態にします。

Extension Preview
az aro hcp get-versions

ホストされているコントロール プレーンのバージョンを含むAzure Red Hat OpenShiftを一覧表示します。

Extension Preview
az aro identity

Azure Red Hat OpenShift クラスターに関連する ID を管理します。

コアと拡張機能 GA
az aro identity create-required

必要な ID を作成します。

Core GA
az aro identity create-required (aro 拡張機能)

必要な ID を作成します。

Extension Preview
az aro identity get-required

必要な ID を取得します。

Core GA
az aro identity get-required (aro 拡張機能)

必要な ID を取得します。

Extension Preview
az aro list

クラスターを一覧表示します。

Core GA
az aro list (aro 拡張機能)

クラスターを一覧表示します。

Extension Preview
az aro list-credentials

クラスターの資格情報を一覧表示します。

Core GA
az aro list-credentials (aro 拡張機能)

クラスターの資格情報を一覧表示します。

Extension Preview
az aro show

クラスターの詳細を取得します。

Core GA
az aro show (aro 拡張機能)

クラスターの詳細を取得します。

Extension Preview
az aro update

クラスターを更新します。

Core GA
az aro update (aro 拡張機能)

クラスターを更新します。

Extension Preview
az aro validate

クラスターを作成するために必要なアクセス許可を検証します。

Core GA
az aro validate (aro 拡張機能)

クラスターを作成するために必要なアクセス許可を検証します。

Extension Preview
az aro wait

クラスターが目的の状態になるまで待ちます。

Core GA
az aro wait (aro 拡張機能)

クラスターが目的の状態になるまで待ちます。

Extension Preview

az aro create

クラスターを作成します。

az aro create --master-subnet
              --name
              --resource-group
              --worker-subnet
              [--acquire-policy-token]
              [--apiserver-visibility {Private, Public}]
              [--assign-cluster-identity --mi-user-assigned]
              [--assign-platform-wi --assign-platform-workload-identity]
              [--change-reference]
              [--client-id]
              [--client-secret]
              [--cluster-resource-group]
              [--disk-encryption-set]
              [--domain]
              [--enable-managed-identity --enable-mi {false, true}]
              [--enable-preconfigured-nsg {false, true}]
              [--fips --fips-validated-modules {false, true}]
              [--ingress-visibility {Private, Public}]
              [--lb-ip-count --load-balancer-managed-outbound-ip-count]
              [--location]
              [--master-enc-host --master-encryption-at-host {false, true}]
              [--master-vm-size]
              [--no-wait]
              [--outbound-type]
              [--pod-cidr]
              [--pull-secret]
              [--service-cidr]
              [--tags]
              [--version]
              [--vnet]
              [--vnet-resource-group]
              [--worker-count]
              [--worker-enc-host --worker-encryption-at-host {false, true}]
              [--worker-vm-disk-size-gb]
              [--worker-vm-size]

例

クラスターを作成します。

az aro create --resource-group MyResourceGroup --name MyCluster --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet

サポートされている OpenShift バージョンのクラスターを作成します。

az aro create --resource-group MyResourceGroup --name MyCluster --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet --version X.Y.Z

5 つのコンピューティング ノードと Red Hat プル シークレットを含むクラスターを作成します。

az aro create --resource-group MyResourceGroup --name MyCluster --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet --worker-count 5 --pull-secret pullsecret.txt

プライベート クラスターを作成します。

az aro create --resource-group MyResourceGroup --name MyCluster --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet --apiserver-visibility Private --ingress-visibility Private

必須パラメーター

--master-subnet

マスター vnet サブネットの名前または ID。 名前を指定する場合は、 --vnet を指定する必要があります。

--name -n

クラスターの名前。

--resource-group -g

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

--worker-subnet

ワーカー vnet サブネットの名前または ID。 名前を指定する場合は、 --vnet を指定する必要があります。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--apiserver-visibility

API サーバーの可視性。 [既定値: パブリック]。

プロパティ 値
指定可能な値: Private, Public
--assign-cluster-identity --mi-user-assigned

クラスターでユーザー マネージド ID を設定します。 値は、ID 名またはリソース ID である必要があります。

プロパティ 値
パラメーター グループ: Identity Arguments
--assign-platform-wi --assign-platform-workload-identity

クラスター内で使用されるプラットフォーム ワークロード ID を割り当てます。 演算子名と、それに使用するAzure ID の名前またはリソース ID の 2 つの値が必要です。

プロパティ 値
パラメーター グループ: Identity Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--client-id

クラスター サービス プリンシパルのクライアント ID。

--client-secret

クラスター サービス プリンシパルのクライアント シークレット。

--cluster-resource-group

クラスターのリソース グループ。

--disk-encryption-set

マスター VM とワーカー VM に使用する DiskEncryptionSet の ResourceID。

--domain

クラスターのドメイン。

--enable-managed-identity --enable-mi

このクラスターのマネージド ID を有効にします。

プロパティ 値
パラメーター グループ: Identity Arguments
規定値: False
指定可能な値: false, true
--enable-preconfigured-nsg

事前構成済みの NSG を使用します。 使用できる値: false、true。 [既定値: false]。

プロパティ 値
指定可能な値: false, true
--fips --fips-validated-modules

FIPS 検証済み暗号化モジュールを使用します。 [既定値: false]。

プロパティ 値
指定可能な値: false, true
--ingress-visibility

イングレスの可視性。 [既定値: パブリック]。

プロパティ 値
指定可能な値: Private, Public
--lb-ip-count --load-balancer-managed-outbound-ip-count

クラスター パブリック ロード バランサーのAzureによって作成および管理される IPv4 送信 IP の目的の数。

--location -l

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

--master-enc-host --master-encryption-at-host

マスター VM のホスト フラグでの暗号化。 [既定値: false]。

プロパティ 値
規定値: False
指定可能な値: false, true
--master-vm-size

マスター VM のサイズ。 [既定値: Standard_D8s_v5]。

--no-wait

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

プロパティ 値
規定値: False
--outbound-type

クラスターの送信の種類。 "Loadbalancer" または "UserDefinedRouting" である必要があります。 [既定値: Loadbalancer]。

--pod-cidr

ポッド ネットワークの CIDR。 /18 以上である必要があります。 [既定値: 10.128.0.0/14]。

--pull-secret

クラスターのプル シークレット。

--service-cidr

サービス ネットワークの CIDR。 /18 以上である必要があります。 [既定値: 172.30.0.0/16]。

--tags

openShiftCluster リソースに割り当てられるタグ。 space-separated tags: key[=value] [key[=value] ...].既存のタグをクリアするには、"" を使用します。

--version

クラスターの作成に使用する OpenShift バージョン。

--vnet

vnet の名前または ID。 名前を指定する場合は、 --vnet-resource-group を指定する必要があります。

--vnet-resource-group

vnet リソース グループの名前。

--worker-count

ワーカー VM の数。 [既定値: 3]。

--worker-enc-host --worker-encryption-at-host

ワーカー VM のホスト フラグでの暗号化。 [既定値: false]。

プロパティ 値
規定値: False
指定可能な値: false, true
--worker-vm-disk-size-gb

ワーカー VM のディスク サイズ (GB 単位)。 [既定値: 128]。

--worker-vm-size

ワーカー VM のサイズ。 [既定値: Standard_D4s_v5]。

プロパティ 値
規定値: Standard_D4s_v5
グローバル パラメーター
--debug

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

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

プロパティ 値
規定値: False

az aro create (aro 拡張機能)

プレビュー

コマンド グループ 'aro' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

クラスターを作成します。

az aro create --master-subnet
              --name
              --resource-group
              --worker-subnet
              [--acquire-policy-token]
              [--apiserver-visibility {Private, Public}]
              [--assign-cluster-identity --mi-user-assigned]
              [--assign-platform-wi --assign-platform-workload-identity]
              [--change-reference]
              [--client-id]
              [--client-secret]
              [--cluster-resource-group]
              [--disk-encryption-set]
              [--domain]
              [--enable-managed-identity --enable-mi {false, true}]
              [--enable-preconfigured-nsg {false, true}]
              [--fips --fips-validated-modules {false, true}]
              [--ingress-visibility {Private, Public}]
              [--lb-ip-count --load-balancer-managed-outbound-ip-count]
              [--location]
              [--master-enc-host --master-encryption-at-host {false, true}]
              [--master-vm-size]
              [--no-wait]
              [--outbound-type]
              [--pod-cidr]
              [--pull-secret]
              [--service-cidr]
              [--tags]
              [--version]
              [--vnet]
              [--vnet-resource-group]
              [--worker-count]
              [--worker-enc-host --worker-encryption-at-host {false, true}]
              [--worker-vm-disk-size-gb]
              [--worker-vm-size]

例

クラスターを作成します。

az aro create --resource-group MyResourceGroup --name MyCluster --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet

サポートされている OpenShift バージョンのクラスターを作成します。

az aro create --resource-group MyResourceGroup --name MyCluster --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet --version X.Y.Z

5 つのコンピューティング ノードと Red Hat プル シークレットを含むクラスターを作成します。

az aro create --resource-group MyResourceGroup --name MyCluster --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet --worker-count 5 --pull-secret pullsecret.txt

プライベート クラスターを作成します。

az aro create --resource-group MyResourceGroup --name MyCluster --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet --apiserver-visibility Private --ingress-visibility Private

必須パラメーター

--master-subnet

マスター vnet サブネットの名前または ID。 名前を指定する場合は、 --vnet を指定する必要があります。

--name -n

クラスターの名前。

--resource-group -g

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

--worker-subnet

ワーカー vnet サブネットの名前または ID。 名前を指定する場合は、 --vnet を指定する必要があります。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--apiserver-visibility

API サーバーの可視性。 [既定値: パブリック]。

プロパティ 値
指定可能な値: Private, Public
--assign-cluster-identity --mi-user-assigned

クラスターでユーザー マネージド ID を設定します。 値は、ID 名またはリソース ID である必要があります。

プロパティ 値
パラメーター グループ: Identity Arguments
--assign-platform-wi --assign-platform-workload-identity

クラスター内で使用されるプラットフォーム ワークロード ID を割り当てます。 演算子名と、それに使用するAzure ID の名前またはリソース ID の 2 つの値が必要です。

プロパティ 値
パラメーター グループ: Identity Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--client-id

クラスター サービス プリンシパルのクライアント ID。

--client-secret

クラスター サービス プリンシパルのクライアント シークレット。

--cluster-resource-group

クラスターのリソース グループ。

--disk-encryption-set

マスター VM とワーカー VM に使用する DiskEncryptionSet の ResourceID。

--domain

クラスターのドメイン。

--enable-managed-identity --enable-mi

このクラスターのマネージド ID を有効にします。

プロパティ 値
パラメーター グループ: Identity Arguments
規定値: False
指定可能な値: false, true
--enable-preconfigured-nsg

事前構成済みの NSG を使用します。 使用できる値: false、true。 [既定値: false]。

プロパティ 値
指定可能な値: false, true
--fips --fips-validated-modules

FIPS 検証済み暗号化モジュールを使用します。 [既定値: false]。

プロパティ 値
指定可能な値: false, true
--ingress-visibility

イングレスの可視性。 [既定値: パブリック]。

プロパティ 値
指定可能な値: Private, Public
--lb-ip-count --load-balancer-managed-outbound-ip-count

クラスター パブリック ロード バランサーのAzureによって作成および管理される IPv4 送信 IP の目的の数。

--location -l

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

--master-enc-host --master-encryption-at-host

マスター VM のホスト フラグでの暗号化。 [既定値: false]。

プロパティ 値
規定値: False
指定可能な値: false, true
--master-vm-size

マスター VM のサイズ。 [既定値: Standard_D8s_v5]。

--no-wait

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

プロパティ 値
規定値: False
--outbound-type

クラスターの送信の種類。 "Loadbalancer" または "UserDefinedRouting" である必要があります。 [既定値: Loadbalancer]。

--pod-cidr

ポッド ネットワークの CIDR。 /18 以上である必要があります。 [既定値: 10.128.0.0/14]。

--pull-secret

クラスターのプル シークレット。

--service-cidr

サービス ネットワークの CIDR。 /18 以上である必要があります。 [既定値: 172.30.0.0/16]。

--tags

openShiftCluster リソースに割り当てられるタグ。 space-separated tags: key[=value] [key[=value] ...].既存のタグをクリアするには、"" を使用します。

--version

クラスターの作成に使用する OpenShift バージョン。

--vnet

vnet の名前または ID。 名前を指定する場合は、 --vnet-resource-group を指定する必要があります。

--vnet-resource-group

vnet リソース グループの名前。

--worker-count

ワーカー VM の数。 [既定値: 3]。

--worker-enc-host --worker-encryption-at-host

ワーカー VM のホスト フラグでの暗号化。 [既定値: false]。

プロパティ 値
規定値: False
指定可能な値: false, true
--worker-vm-disk-size-gb

ワーカー VM のディスク サイズ (GB 単位)。 [既定値: 128]。

--worker-vm-size

ワーカー VM のサイズ。 [既定値: Standard_D4s_v5]。

グローバル パラメーター
--debug

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

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

プロパティ 値
規定値: False

az aro delete

クラスターを削除します。

az aro delete --name
              --resource-group
              [--acquire-policy-token]
              [--change-reference]
              [--delete-identities {false, true}]
              [--no-wait]
              [--yes]

例

クラスターを削除します。

az aro delete --name MyCluster --resource-group MyResourceGroup

必須パラメーター

--name -n

クラスターの名前。

--resource-group -g

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

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--delete-identities

クラスターに関連付けられているマネージド ID をクラスターと共に削除します。

プロパティ 値
パラメーター グループ: Identity Arguments
指定可能な値: false, true
--no-wait

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

プロパティ 値
規定値: False
--yes -y

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

プロパティ 値
規定値: False
グローバル パラメーター
--debug

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

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

プロパティ 値
規定値: False

az aro delete (aro 拡張機能)

プレビュー

コマンド グループ 'aro' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

クラスターを削除します。

az aro delete --name
              --resource-group
              [--acquire-policy-token]
              [--change-reference]
              [--delete-identities {false, true}]
              [--no-wait]
              [--yes]

例

クラスターを削除します。

az aro delete --name MyCluster --resource-group MyResourceGroup

必須パラメーター

--name -n

クラスターの名前。

--resource-group -g

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

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--delete-identities

クラスターに関連付けられているマネージド ID をクラスターと共に削除します。

プロパティ 値
パラメーター グループ: Identity Arguments
指定可能な値: false, true
--no-wait

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

プロパティ 値
規定値: False
--yes -y

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

プロパティ 値
規定値: False
グローバル パラメーター
--debug

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

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

プロパティ 値
規定値: False

az aro get-admin-kubeconfig

クラスターの管理者 kubeconfig を一覧表示します。

az aro get-admin-kubeconfig --name
                            --resource-group
                            [--acquire-policy-token]
                            [--change-reference]
                            [--file]

例

クラスターの管理者 kubeconfig を一覧表示します。 既定値は、"kubeconfig" という名前のファイルに保存することです。

az aro get-admin-kubeconfig --name MyCluster --resource-group MyResourceGroup

必須パラメーター

--name -n

クラスターの名前。

--resource-group -g

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

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--file -f

kubeconfig を保存する必要があるファイルへのパス。 既定値: ローカル ディレクトリ内の kubeconfig。

プロパティ 値
規定値: kubeconfig
グローバル パラメーター
--debug

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

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

プロパティ 値
規定値: False

az aro get-admin-kubeconfig (aro 拡張機能)

プレビュー

コマンド グループ 'aro' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

クラスターの管理者 kubeconfig を一覧表示します。

az aro get-admin-kubeconfig --name
                            --resource-group
                            [--acquire-policy-token]
                            [--change-reference]
                            [--file]

例

クラスターの管理者 kubeconfig を一覧表示します。 既定値は、"kubeconfig" という名前のファイルに保存することです。

az aro get-admin-kubeconfig --name MyCluster --resource-group MyResourceGroup

必須パラメーター

--name -n

クラスターの名前。

--resource-group -g

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

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--file -f

kubeconfig を保存する必要があるファイルへのパス。 既定値: ローカル ディレクトリ内の kubeconfig。

プロパティ 値
規定値: kubeconfig
グローバル パラメーター
--debug

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

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

プロパティ 値
規定値: False

az aro get-versions

インストールに使用できるバージョンを一覧表示します。

az aro get-versions --location
                    [--acquire-policy-token]
                    [--change-reference]

例

米国東部リージョンで使用可能なインストール バージョンを一覧表示します。

az aro get-versions --location eastus

テーブル形式の出力を使用して、米国東部リージョンで使用できるインストール バージョンを一覧表示します。

az aro get-versions --location eastus -o table

必須パラメーター

--location -l

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

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
グローバル パラメーター
--debug

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

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

プロパティ 値
規定値: False

az aro get-versions (aro 拡張機能)

プレビュー

コマンド グループ 'aro' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

インストールに使用できるバージョンを一覧表示します。

az aro get-versions --location
                    [--acquire-policy-token]
                    [--change-reference]

例

米国東部リージョンで使用可能なインストール バージョンを一覧表示します。

az aro get-versions --location eastus

テーブル形式の出力を使用して、米国東部リージョンで使用できるインストール バージョンを一覧表示します。

az aro get-versions --location eastus -o table

必須パラメーター

--location -l

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

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
グローバル パラメーター
--debug

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

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

プロパティ 値
規定値: False

az aro list

クラスターを一覧表示します。

az aro list [--resource-group]

例

クラスターを一覧表示します。

az aro list

テーブル ビューを使用してクラスターを一覧表示します。

az aro list -o table

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--resource-group -g

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

グローバル パラメーター
--debug

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

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

プロパティ 値
規定値: False

az aro list (aro 拡張機能)

プレビュー

コマンド グループ 'aro' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

クラスターを一覧表示します。

az aro list [--resource-group]

例

クラスターを一覧表示します。

az aro list

テーブル ビューを使用してクラスターを一覧表示します。

az aro list -o table

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--resource-group -g

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

グローバル パラメーター
--debug

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

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

プロパティ 値
規定値: False

az aro list-credentials

クラスターの資格情報を一覧表示します。

az aro list-credentials --name
                        --resource-group
                        [--acquire-policy-token]
                        [--change-reference]

例

クラスターの資格情報を一覧表示します。

az aro list-credentials --name MyCluster --resource-group MyResourceGroup

必須パラメーター

--name -n

クラスターの名前。

--resource-group -g

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

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
グローバル パラメーター
--debug

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

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

プロパティ 値
規定値: False

az aro list-credentials (aro 拡張機能)

プレビュー

コマンド グループ 'aro' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

クラスターの資格情報を一覧表示します。

az aro list-credentials --name
                        --resource-group
                        [--acquire-policy-token]
                        [--change-reference]

例

クラスターの資格情報を一覧表示します。

az aro list-credentials --name MyCluster --resource-group MyResourceGroup

必須パラメーター

--name -n

クラスターの名前。

--resource-group -g

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

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
グローバル パラメーター
--debug

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

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

プロパティ 値
規定値: False

az aro show

クラスターの詳細を取得します。

az aro show --name
            --resource-group

例

クラスターの詳細を取得します。

az aro show --name MyCluster --resource-group MyResourceGroup

必須パラメーター

--name -n

クラスターの名前。

--resource-group -g

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

グローバル パラメーター
--debug

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

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

プロパティ 値
規定値: False

az aro show (aro 拡張機能)

プレビュー

コマンド グループ 'aro' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

クラスターの詳細を取得します。

az aro show --name
            --resource-group

例

クラスターの詳細を取得します。

az aro show --name MyCluster --resource-group MyResourceGroup

必須パラメーター

--name -n

クラスターの名前。

--resource-group -g

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

グローバル パラメーター
--debug

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

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

プロパティ 値
規定値: False

az aro update

クラスターを更新します。

az aro update --name
              --resource-group
              [--acquire-policy-token]
              [--assign-cluster-identity --mi-user-assigned]
              [--assign-platform-wi --assign-platform-workload-identity]
              [--change-reference]
              [--client-id]
              [--client-secret]
              [--lb-ip-count --load-balancer-managed-outbound-ip-count]
              [--no-wait]
              [--refresh-credentials {false, true}]
              [--upgradeable-to]

例

クラスターを更新します。

az aro update --name MyCluster --resource-group MyResourceGroup

必須パラメーター

--name -n

クラスターの名前。

--resource-group -g

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

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--assign-cluster-identity --mi-user-assigned

クラスターでユーザー マネージド ID を設定します。 値は、ID 名またはリソース ID である必要があります。

プロパティ 値
パラメーター グループ: Identity Arguments
--assign-platform-wi --assign-platform-workload-identity

クラスター内で使用されるプラットフォーム ワークロード ID を割り当てます。 演算子名と、それに使用するAzure ID の名前またはリソース ID の 2 つの値が必要です。

プロパティ 値
パラメーター グループ: Identity Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--client-id

クラスター サービス プリンシパルのクライアント ID。

--client-secret

クラスター サービス プリンシパルのクライアント シークレット。

--lb-ip-count --load-balancer-managed-outbound-ip-count

クラスター パブリック ロード バランサーのAzureによって作成および管理される IPv4 送信 IP の目的の数。

--no-wait

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

プロパティ 値
規定値: False
--refresh-credentials

クラスター アプリケーションの資格情報を更新します。

プロパティ 値
規定値: False
指定可能な値: false, true
--upgradeable-to

アップグレードする OpenShift バージョン。

プロパティ 値
パラメーター グループ: Identity Arguments
グローバル パラメーター
--debug

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

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

プロパティ 値
規定値: False

az aro update (aro 拡張機能)

プレビュー

コマンド グループ 'aro' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

クラスターを更新します。

az aro update --name
              --resource-group
              [--acquire-policy-token]
              [--assign-cluster-identity --mi-user-assigned]
              [--assign-platform-wi --assign-platform-workload-identity]
              [--change-reference]
              [--client-id]
              [--client-secret]
              [--lb-ip-count --load-balancer-managed-outbound-ip-count]
              [--no-wait]
              [--refresh-credentials {false, true}]
              [--upgradeable-to]

例

クラスターを更新します。

az aro update --name MyCluster --resource-group MyResourceGroup

必須パラメーター

--name -n

クラスターの名前。

--resource-group -g

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

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--assign-cluster-identity --mi-user-assigned

クラスターでユーザー マネージド ID を設定します。 値は、ID 名またはリソース ID である必要があります。

プロパティ 値
パラメーター グループ: Identity Arguments
--assign-platform-wi --assign-platform-workload-identity

クラスター内で使用されるプラットフォーム ワークロード ID を割り当てます。 演算子名と、それに使用するAzure ID の名前またはリソース ID の 2 つの値が必要です。

プロパティ 値
パラメーター グループ: Identity Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--client-id

クラスター サービス プリンシパルのクライアント ID。

--client-secret

クラスター サービス プリンシパルのクライアント シークレット。

--lb-ip-count --load-balancer-managed-outbound-ip-count

クラスター パブリック ロード バランサーのAzureによって作成および管理される IPv4 送信 IP の目的の数。

--no-wait

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

プロパティ 値
規定値: False
--refresh-credentials

クラスター アプリケーションの資格情報を更新します。

プロパティ 値
規定値: False
指定可能な値: false, true
--upgradeable-to

アップグレードする OpenShift バージョン。

プロパティ 値
パラメーター グループ: Identity Arguments
グローバル パラメーター
--debug

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

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

プロパティ 値
規定値: False

az aro validate

クラスターを作成するために必要なアクセス許可を検証します。

az aro validate --master-subnet
                --name
                --resource-group
                --worker-subnet
                [--acquire-policy-token]
                [--assign-cluster-identity --mi-user-assigned]
                [--assign-platform-wi --assign-platform-workload-identity]
                [--change-reference]
                [--client-id]
                [--client-secret]
                [--cluster-resource-group]
                [--disk-encryption-set]
                [--enable-managed-identity --enable-mi {false, true}]
                [--location]
                [--pod-cidr]
                [--service-cidr]
                [--version]
                [--vnet]
                [--vnet-resource-group]

例

アクセス許可を検証します。

az aro validate --resource-group MyGroup --name MyName --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet

アクセス許可と OpenShift バージョンを検証する

az aro validate --resource-group MyGroup --name MyName --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet --version X.Y.Z

必須パラメーター

--master-subnet

マスター vnet サブネットの名前または ID。 名前を指定する場合は、 --vnet を指定する必要があります。

--name -n

クラスターの名前。

--resource-group -g

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

--worker-subnet

ワーカー vnet サブネットの名前または ID。 名前を指定する場合は、 --vnet を指定する必要があります。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--assign-cluster-identity --mi-user-assigned

クラスターでユーザー マネージド ID を設定します。 値は、ID 名またはリソース ID である必要があります。

プロパティ 値
パラメーター グループ: Identity Arguments
--assign-platform-wi --assign-platform-workload-identity

クラスター内で使用されるプラットフォーム ワークロード ID を割り当てます。 演算子名と、それに使用するAzure ID の名前またはリソース ID の 2 つの値が必要です。

プロパティ 値
パラメーター グループ: Identity Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--client-id

クラスター サービス プリンシパルのクライアント ID。

--client-secret

クラスター サービス プリンシパルのクライアント シークレット。

--cluster-resource-group

クラスターのリソース グループ。

--disk-encryption-set

マスター VM とワーカー VM に使用する DiskEncryptionSet の ResourceID。

--enable-managed-identity --enable-mi

このクラスターのマネージド ID を有効にします。

プロパティ 値
パラメーター グループ: Identity Arguments
規定値: False
指定可能な値: false, true
--location -l

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

--pod-cidr

ポッド ネットワークの CIDR。 /18 以上である必要があります。 [既定値: 10.128.0.0/14]。

--service-cidr

サービス ネットワークの CIDR。 /18 以上である必要があります。 [既定値: 172.30.0.0/16]。

--version

クラスターの作成に使用する OpenShift バージョン。

--vnet

vnet の名前または ID。 名前を指定する場合は、 --vnet-resource-group を指定する必要があります。

--vnet-resource-group

vnet リソース グループの名前。

グローバル パラメーター
--debug

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

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

プロパティ 値
規定値: False

az aro validate (aro 拡張機能)

プレビュー

コマンド グループ 'aro' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

クラスターを作成するために必要なアクセス許可を検証します。

az aro validate --master-subnet
                --name
                --resource-group
                --worker-subnet
                [--acquire-policy-token]
                [--assign-cluster-identity --mi-user-assigned]
                [--assign-platform-wi --assign-platform-workload-identity]
                [--change-reference]
                [--client-id]
                [--client-secret]
                [--cluster-resource-group]
                [--disk-encryption-set]
                [--enable-managed-identity --enable-mi {false, true}]
                [--location]
                [--pod-cidr]
                [--service-cidr]
                [--version]
                [--vnet]
                [--vnet-resource-group]

例

アクセス許可を検証します。

az aro validate --resource-group MyGroup --name MyName --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet

アクセス許可と OpenShift バージョンを検証する

az aro validate --resource-group MyGroup --name MyName --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet --version X.Y.Z

必須パラメーター

--master-subnet

マスター vnet サブネットの名前または ID。 名前を指定する場合は、 --vnet を指定する必要があります。

--name -n

クラスターの名前。

--resource-group -g

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

--worker-subnet

ワーカー vnet サブネットの名前または ID。 名前を指定する場合は、 --vnet を指定する必要があります。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--assign-cluster-identity --mi-user-assigned

クラスターでユーザー マネージド ID を設定します。 値は、ID 名またはリソース ID である必要があります。

プロパティ 値
パラメーター グループ: Identity Arguments
--assign-platform-wi --assign-platform-workload-identity

クラスター内で使用されるプラットフォーム ワークロード ID を割り当てます。 演算子名と、それに使用するAzure ID の名前またはリソース ID の 2 つの値が必要です。

プロパティ 値
パラメーター グループ: Identity Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--client-id

クラスター サービス プリンシパルのクライアント ID。

--client-secret

クラスター サービス プリンシパルのクライアント シークレット。

--cluster-resource-group

クラスターのリソース グループ。

--disk-encryption-set

マスター VM とワーカー VM に使用する DiskEncryptionSet の ResourceID。

--enable-managed-identity --enable-mi

このクラスターのマネージド ID を有効にします。

プロパティ 値
パラメーター グループ: Identity Arguments
規定値: False
指定可能な値: false, true
--location -l

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

--pod-cidr

ポッド ネットワークの CIDR。 /18 以上である必要があります。 [既定値: 10.128.0.0/14]。

--service-cidr

サービス ネットワークの CIDR。 /18 以上である必要があります。 [既定値: 172.30.0.0/16]。

--version

クラスターの作成に使用する OpenShift バージョン。

--vnet

vnet の名前または ID。 名前を指定する場合は、 --vnet-resource-group を指定する必要があります。

--vnet-resource-group

vnet リソース グループの名前。

グローバル パラメーター
--debug

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

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

プロパティ 値
規定値: False

az aro wait

クラスターが目的の状態になるまで待ちます。

クラスターでの操作が中断されたか、 --no-waitで開始された場合は、このコマンドを使用して完了するまで待機します。

az aro wait --name
            --resource-group
            [--acquire-policy-token]
            [--change-reference]
            [--created]
            [--custom]
            [--deleted]
            [--exists]
            [--interval]
            [--timeout]
            [--updated]

必須パラメーター

--name -n

クラスターの名前。

--resource-group -g

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

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--created

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

プロパティ 値
パラメーター グループ: Wait Condition Arguments
規定値: False
--custom

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

プロパティ 値
パラメーター グループ: Wait Condition Arguments
--deleted

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

プロパティ 値
パラメーター グループ: Wait Condition Arguments
規定値: False
--exists

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

プロパティ 値
パラメーター グループ: Wait Condition Arguments
規定値: False
--interval

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

プロパティ 値
パラメーター グループ: Wait Condition Arguments
規定値: 30
--timeout

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

プロパティ 値
パラメーター グループ: Wait Condition Arguments
規定値: 3600
--updated

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

プロパティ 値
パラメーター グループ: Wait Condition Arguments
規定値: False
グローバル パラメーター
--debug

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

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

プロパティ 値
規定値: False

az aro wait (aro 拡張機能)

プレビュー

コマンド グループ 'aro' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

クラスターが目的の状態になるまで待ちます。

クラスターでの操作が中断されたか、 --no-waitで開始された場合は、このコマンドを使用して完了するまで待機します。

az aro wait --name
            --resource-group
            [--acquire-policy-token]
            [--change-reference]
            [--created]
            [--custom]
            [--deleted]
            [--exists]
            [--interval]
            [--timeout]
            [--updated]

必須パラメーター

--name -n

クラスターの名前。

--resource-group -g

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

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--created

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

プロパティ 値
パラメーター グループ: Wait Condition Arguments
規定値: False
--custom

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

プロパティ 値
パラメーター グループ: Wait Condition Arguments
--deleted

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

プロパティ 値
パラメーター グループ: Wait Condition Arguments
規定値: False
--exists

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

プロパティ 値
パラメーター グループ: Wait Condition Arguments
規定値: False
--interval

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

プロパティ 値
パラメーター グループ: Wait Condition Arguments
規定値: 30
--timeout

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

プロパティ 値
パラメーター グループ: Wait Condition Arguments
規定値: 3600
--updated

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

プロパティ 値
パラメーター グループ: Wait Condition Arguments
規定値: False
グローバル パラメーター
--debug

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

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

プロパティ 値
規定値: False