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	List clusters.	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}]
              [--client-id]
              [--client-secret]
              [--cluster-resource-group]
              [--disk-encryption-set]
              [--domain]
              [--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 を指定する必要があります。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--apiserver-visibility

API サーバーの可視性。

プロパティ	値
規定値:	Public
指定可能な値:	Private, Public

--client-id

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

--client-secret

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

--cluster-resource-group

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

--disk-encryption-set

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

--domain

クラスターのドメイン。

--enable-preconfigured-nsg

事前構成済みの NSG を使用します。

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

--fips --fips-validated-modules

FIPS 検証済み暗号化モジュールを使用します。

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

--ingress-visibility

Ingress visibility.

プロパティ	値
規定値:	Public
指定可能な値:	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, 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

スペース区切りのタグ: 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, 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

Output format.

プロパティ	値
規定値:	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
              [--no-wait]
              [--yes]

例

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

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

必須のパラメーター

--name -n

クラスターの名前。

--resource-group -g

リソースグループの名前。 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.

--no-wait

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

プロパティ	値
規定値:	False

--yes -y

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

プロパティ	値
規定値:	False

グローバルパラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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
                            [--file]

例

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

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

必須のパラメーター

--name -n

クラスターの名前。

--resource-group -g

リソースグループの名前。 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.

--file -f

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

プロパティ	値
規定値:	kubeconfig

グローバルパラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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

例

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

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>を使用して、既定の場所を構成できます。

グローバルパラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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

編集

List clusters.

az aro list [--resource-group]

例

List clusters.

az aro list

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

az aro list -o table

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

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

グローバルパラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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

例

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

az aro list-credentials --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

Output format.

プロパティ	値
規定値:	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

Output format.

プロパティ	値
規定値:	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
              [--client-id]
              [--client-secret]
              [--lb-ip-count --load-balancer-managed-outbound-ip-count]
              [--no-wait]
              [--refresh-credentials {false, true}]

例

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

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

必須のパラメーター

--name -n

クラスターの名前。

--resource-group -g

リソースグループの名前。 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.

--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

グローバルパラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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
                [--client-id]
                [--client-secret]
                [--cluster-resource-group]
                [--disk-encryption-set]
                [--location]
                [--pod-cidr]
                [--service-cidr]
                [--version]
                [--vnet]
                [--vnet-resource-group]

例

Validate permissions.

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 を指定する必要があります。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--client-id

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

--client-secret

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

--cluster-resource-group

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

--disk-encryption-set

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

--location -l

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

--pod-cidr

ポッドネットワークの CIDR。 /18 以上である必要があります。

--service-cidr

サービスネットワークの CIDR。 /18 以上である必要があります。

--version

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

--vnet

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

--vnet-resource-group

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

グローバルパラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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
            [--created]
            [--custom]
            [--deleted]
            [--exists]
            [--interval]
            [--timeout]
            [--updated]

必須のパラメーター

--name -n

クラスターの名前。

--resource-group -g

リソースグループの名前。 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.

--created

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

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	False

--custom

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

プロパティ	値
Parameter group:	Wait Condition Arguments

--deleted

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

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	False

--exists

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

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	False

--interval

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

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	30

--timeout

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

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	3600

--updated

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

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	False

グローバルパラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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

コマンド

az aro create

例

必須のパラメーター

省略可能のパラメーター

az aro delete

例

必須のパラメーター

省略可能のパラメーター

az aro get-admin-kubeconfig

例

必須のパラメーター

省略可能のパラメーター

az aro get-versions

例

必須のパラメーター

az aro list

例

省略可能のパラメーター

az aro list-credentials

例

必須のパラメーター

az aro show

例

必須のパラメーター

az aro update

例

必須のパラメーター

省略可能のパラメーター

az aro validate

例

必須のパラメーター

省略可能のパラメーター

az aro wait

必須のパラメーター

省略可能のパラメーター

フィードバック