az aro
Azure Red Hat OpenShift クラスターを管理します。
コマンド
| 名前 | 説明 | 型 | 状態 |
|---|---|---|---|
| az aro create |
クラスターを作成します。 |
Core | GA |
| az aro delete |
クラスターを削除します。 |
Core | GA |
| az aro get-admin-kubeconfig |
クラスターの管理者 kubeconfig を一覧表示します。 |
Core | GA |
| az aro get-versions |
インストールに使用できるバージョンを一覧表示します。 |
Core | GA |
| az aro list |
クラスターを一覧表示します。 |
Core | GA |
| az aro list-credentials |
クラスターの資格情報を一覧表示します。 |
Core | GA |
| az aro show |
クラスターの詳細を取得します。 |
Core | GA |
| az aro update |
クラスターを更新します。 |
Core | GA |
| az aro validate |
クラスターを作成するために必要なアクセス許可を検証します。 |
Core | GA |
| az aro wait |
クラスターが目的の状態になるまで待ちます。 |
Core | GA |
az aro create
クラスターを作成します。
az aro create --master-subnet
--name
--resource-group
--worker-subnet
[--apiserver-visibility {Private, Public}]
[--assign-cluster-identity --mi-user-assigned]
[--assign-platform-wi --assign-platform-workload-identity]
[--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
必須のパラメーター
マスター vnet サブネットの名前または ID。 名前を指定する場合は、 を指定する必要があります。
クラスターの名前。
リソース グループの名前。 を使用して既定のグループを構成できます。
ワーカー vnet サブネットの名前または ID。 名前を指定する場合は、 を指定する必要があります。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
API サーバーの可視性。 [既定値: パブリック]。
| プロパティ | 値 |
|---|---|
| 指定可能な値: | Private, Public |
クラスターでユーザー マネージド ID を設定します。 値は、ID 名またはリソース ID である必要があります。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Identity Arguments |
クラスター内で使用されるプラットフォーム ワークロード ID を割り当てます。 演算子名と、それに使用するAzure ID の名前またはリソース ID の 2 つの値が必要です。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Identity Arguments |
クラスター サービス プリンシパルのクライアント ID。
クラスター サービス プリンシパルのクライアント シークレット。
クラスターのリソース グループ。
マスター VM とワーカー VM に使用する DiskEncryptionSet の ResourceID。
クラスターのドメイン。
このクラスターのマネージド ID を有効にします。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Identity Arguments |
| 規定値: | False |
| 指定可能な値: | false, true |
事前構成済みの NSG を使用します。 使用できる値: false、true。 [既定値: false]。
| プロパティ | 値 |
|---|---|
| 指定可能な値: | false, true |
FIPS 検証済み暗号化モジュールを使用します。 [既定値: false]。
| プロパティ | 値 |
|---|---|
| 指定可能な値: | false, true |
イングレスの可視性。 [既定値: パブリック]。
| プロパティ | 値 |
|---|---|
| 指定可能な値: | Private, Public |
クラスター パブリック ロード バランサーのAzureによって作成および管理される IPv4 送信 IP の目的の数。
Location. 値のソース: を使用して、既定の場所を構成できます。
マスター VM のホスト フラグでの暗号化。 [既定値: false]。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
| 指定可能な値: | false, true |
マスター VM のサイズ。 [既定値: Standard_D8s_v5]。
実行時間の長い操作が完了するまで待つ必要はありません。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
クラスターの送信の種類。 "Loadbalancer" または "UserDefinedRouting" である必要があります。 [既定値: Loadbalancer]。
ポッド ネットワークの CIDR。 /18 以上である必要があります。 [既定値: 10.128.0.0/14]。
クラスターのプル シークレット。
サービス ネットワークの CIDR。 /18 以上である必要があります。 [既定値: 172.30.0.0/16]。
スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。
クラスターの作成に使用する OpenShift バージョン。
vnet の名前または ID。 名前を指定する場合は、 を指定する必要があります。
vnet リソース グループの名前。
ワーカー VM の数。 [既定値: 3]。
ワーカー VM のホスト フラグでの暗号化。 [既定値: false]。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
| 指定可能な値: | false, true |
ワーカー VM のディスク サイズ (GB 単位)。 [既定値: 128]。
ワーカー VM のサイズ。 [既定値: Standard_D4s_v5]。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、 を参照してください。
サブスクリプションの名前または ID。 を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az aro delete
クラスターを削除します。
az aro delete --name
--resource-group
[--delete-identities {false, true}]
[--no-wait]
[--yes]
例
クラスターを削除します。
az aro delete --name MyCluster --resource-group MyResourceGroup
必須のパラメーター
クラスターの名前。
リソース グループの名前。 を使用して既定のグループを構成できます。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
クラスターに関連付けられているマネージド ID をクラスターと共に削除します。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Identity Arguments |
| 指定可能な値: | false, true |
実行時間の長い操作が完了するまで待つ必要はありません。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
確認を求めないでください。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、 を参照してください。
サブスクリプションの名前または ID。 を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az aro get-admin-kubeconfig
クラスターの管理者 kubeconfig を一覧表示します。
az aro get-admin-kubeconfig --name
--resource-group
[--file]
例
クラスターの管理者 kubeconfig を一覧表示します。 既定値は、"kubeconfig" という名前のファイルに保存することです。
az aro get-admin-kubeconfig --name MyCluster --resource-group MyResourceGroup
必須のパラメーター
クラスターの名前。
リソース グループの名前。 を使用して既定のグループを構成できます。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
kubeconfig を保存する必要があるファイルへのパス。 既定値: ローカル ディレクトリ内の kubeconfig。
| プロパティ | 値 |
|---|---|
| 規定値: | kubeconfig |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、 を参照してください。
サブスクリプションの名前または ID。 を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az aro get-versions
インストールに使用できるバージョンを一覧表示します。
az aro get-versions --location
例
米国東部リージョンで使用可能なインストール バージョンを一覧表示します。
az aro get-versions --location eastus
テーブル形式の出力を使用して、米国東部リージョンで使用できるインストール バージョンを一覧表示します。
az aro get-versions --location eastus -o table
必須のパラメーター
Location. 値のソース: を使用して、既定の場所を構成できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、 を参照してください。
サブスクリプションの名前または ID。 を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az aro list
クラスターを一覧表示します。
az aro list [--resource-group]
例
クラスターを一覧表示します。
az aro list
テーブル ビューを使用してクラスターを一覧表示します。
az aro list -o table
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
リソース グループの名前。 を使用して既定のグループを構成できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、 を参照してください。
サブスクリプションの名前または ID。 を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az aro list-credentials
クラスターの資格情報を一覧表示します。
az aro list-credentials --name
--resource-group
例
クラスターの資格情報を一覧表示します。
az aro list-credentials --name MyCluster --resource-group MyResourceGroup
必須のパラメーター
クラスターの名前。
リソース グループの名前。 を使用して既定のグループを構成できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、 を参照してください。
サブスクリプションの名前または ID。 を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az aro show
クラスターの詳細を取得します。
az aro show --name
--resource-group
例
クラスターの詳細を取得します。
az aro show --name MyCluster --resource-group MyResourceGroup
必須のパラメーター
クラスターの名前。
リソース グループの名前。 を使用して既定のグループを構成できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、 を参照してください。
サブスクリプションの名前または ID。 を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az aro update
クラスターを更新します。
az aro update --name
--resource-group
[--assign-cluster-identity --mi-user-assigned]
[--assign-platform-wi --assign-platform-workload-identity]
[--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
必須のパラメーター
クラスターの名前。
リソース グループの名前。 を使用して既定のグループを構成できます。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
クラスターでユーザー マネージド ID を設定します。 値は、ID 名またはリソース ID である必要があります。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Identity Arguments |
クラスター内で使用されるプラットフォーム ワークロード ID を割り当てます。 演算子名と、それに使用するAzure ID の名前またはリソース ID の 2 つの値が必要です。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Identity Arguments |
クラスター サービス プリンシパルのクライアント ID。
クラスター サービス プリンシパルのクライアント シークレット。
クラスター パブリック ロード バランサーのAzureによって作成および管理される IPv4 送信 IP の目的の数。
実行時間の長い操作が完了するまで待つ必要はありません。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
クラスター アプリケーションの資格情報を更新します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
| 指定可能な値: | false, true |
アップグレードする OpenShift バージョン。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Identity Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、 を参照してください。
サブスクリプションの名前または ID。 を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az aro validate
クラスターを作成するために必要なアクセス許可を検証します。
az aro validate --master-subnet
--name
--resource-group
--worker-subnet
[--assign-cluster-identity --mi-user-assigned]
[--assign-platform-wi --assign-platform-workload-identity]
[--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
必須のパラメーター
マスター vnet サブネットの名前または ID。 名前を指定する場合は、 を指定する必要があります。
クラスターの名前。
リソース グループの名前。 を使用して既定のグループを構成できます。
ワーカー vnet サブネットの名前または ID。 名前を指定する場合は、 を指定する必要があります。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
クラスターでユーザー マネージド ID を設定します。 値は、ID 名またはリソース ID である必要があります。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Identity Arguments |
クラスター内で使用されるプラットフォーム ワークロード ID を割り当てます。 演算子名と、それに使用するAzure ID の名前またはリソース ID の 2 つの値が必要です。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Identity Arguments |
クラスター サービス プリンシパルのクライアント ID。
クラスター サービス プリンシパルのクライアント シークレット。
クラスターのリソース グループ。
マスター VM とワーカー VM に使用する DiskEncryptionSet の ResourceID。
このクラスターのマネージド ID を有効にします。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Identity Arguments |
| 規定値: | False |
| 指定可能な値: | false, true |
Location. 値のソース: を使用して、既定の場所を構成できます。
ポッド ネットワークの CIDR。 /18 以上である必要があります。 [既定値: 10.128.0.0/14]。
サービス ネットワークの CIDR。 /18 以上である必要があります。 [既定値: 172.30.0.0/16]。
クラスターの作成に使用する OpenShift バージョン。
vnet の名前または ID。 名前を指定する場合は、 を指定する必要があります。
vnet リソース グループの名前。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、 を参照してください。
サブスクリプションの名前または ID。 を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az aro wait
クラスターが目的の状態になるまで待ちます。
クラスターでの操作が中断されたか、 で開始された場合は、このコマンドを使用して完了するまで待機します。
az aro wait --name
--resource-group
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--timeout]
[--updated]
必須のパラメーター
クラスターの名前。
リソース グループの名前。 を使用して既定のグループを構成できます。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
'provisioningState' が 'Succeeded' で作成されるまで待ちます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | False |
条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
削除されるまで待ちます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | False |
リソースが存在するまで待ちます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | False |
ポーリング間隔 (秒単位)。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | 30 |
最大待機時間 (秒単位)。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | 3600 |
provisioningState が 'Succeeded' で更新されるまで待ちます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | False |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、 を参照してください。
サブスクリプションの名前または ID。 を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |