az aro

  • リファレンス

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

コマンド

名前 説明 型 Status
az aro create

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

 コア GA
az aro delete

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

 コア GA
az aro get-admin-kubeconfig

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

 コア GA
az aro get-versions

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

 コア GA
az aro list

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

 コア GA
az aro list-credentials

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

 コア GA
az aro show

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

 コア GA
az aro update

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

 コア GA
az aro validate

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

 コア GA
az aro wait

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

 コア 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 {false, true}]
              [--ingress-visibility {Private, Public}]
              [--location]
              [--master-enc-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 {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 指定する必要があります。

省略可能のパラメーター

--apiserver-visibility

API サーバーの可視性。

承認された値: Private, Public
既定値: Public
--client-id

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

--client-secret

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

--cluster-resource-group

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

--disk-encryption-set

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

--domain

クラスターの実行メイン。

--enable-preconfigured-nsg

事前構成済みの NSG を使用します。 既定値は False です。

承認された値: false, true
既定値: False
--fips --fips-validated-modules

FIPS 検証済み暗号化モジュールを使用します。 既定値は False です。

承認された値: false, true
既定値: False
--ingress-visibility

イングレスの可視性。

承認された値: Private, Public
既定値: Public
--location -l

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

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

マスター VM のホスト フラグでの暗号化。 既定値は False です。

承認された値: false, true
既定値: False
--master-vm-size

マスター VM のサイズ。

既定値: Standard_D8s_v3
--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
既定値: False
--worker-vm-disk-size-gb

ワーカー VM のディスク サイズ (GB 単位)。

既定値: 128
--worker-vm-size

ワーカー VM のサイズ。

既定値: Standard_D4s_v3
グローバル パラメーター
--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 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> を使用して、既定のグループを構成できます。

省略可能のパラメーター

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False
--yes -y

確認のダイアログを表示しません。

既定値: 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 を使います。

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

省略可能のパラメーター

--file -f

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

既定値: kubeconfig
グローバル パラメーター
--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 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

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

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

編集

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

az aro list [--resource-group]

例

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

az aro list

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

az aro list -o table

省略可能のパラメーター

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

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

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

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

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

編集

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

az aro update --name
              --resource-group
              [--client-id]
              [--client-secret]
              [--no-wait]
              [--refresh-credentials {false, true}]

例

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

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

必須のパラメーター

--name -n

クラスターの名前。

--resource-group -g

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

省略可能のパラメーター

--client-id

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

--client-secret

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

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False
--refresh-credentials

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

承認された値: false, true
既定値: 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 を使います。

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]

例

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

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

省略可能のパラメーター

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

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

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

省略可能のパラメーター

--created

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

既定値: False
--custom

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

--deleted

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

既定値: False
--exists

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

既定値: False
--interval

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

既定値: 30
--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 を使います。