az aro

參考

管理 Azure Red Hat OpenShift 叢集。

命令

名稱	Description	類型	狀態
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 子網的名稱或標識碼。如果提供名稱， --vnet 則必須提供。

--name -n

叢集的名稱。

--resource-group -g

資源組名。您可以使用來設定預設群組 az configure --defaults group=<name>。

--worker-subnet

背景工作角色 vnet 子網的名稱或標識碼。如果提供名稱， --vnet 則必須提供。

選擇性參數

--apiserver-visibility

API 伺服器可見度。

接受的值: Private, Public

預設值: Public

--client-id

叢集服務主體的用戶端標識碼。

--client-secret

叢集服務主體的客戶端密碼。

--cluster-resource-group

叢集的資源群組。

--disk-encryption-set

要用於主要和背景工作 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

位置。來自的值： 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

Pod 網路的 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 的名稱或標識碼。如果提供名稱， --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

以 GB 為單位的背景工作 VM 磁碟大小。

預設值: 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

訂用帳戶的名稱或標識碼。您可以使用來設定預設訂用 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

訂用帳戶的名稱或標識碼。您可以使用來設定預設訂用 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

訂用帳戶的名稱或標識碼。您可以使用來設定預設訂用 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

位置。來自的值： 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

訂用帳戶的名稱或標識碼。您可以使用來設定預設訂用 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

訂用帳戶的名稱或標識碼。您可以使用來設定預設訂用 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

訂用帳戶的名稱或標識碼。您可以使用來設定預設訂用 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

訂用帳戶的名稱或標識碼。您可以使用來設定預設訂用 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

叢集服務主體的用戶端標識碼。

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

訂用帳戶的名稱或標識碼。您可以使用來設定預設訂用 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 子網的名稱或標識碼。如果提供名稱， --vnet 則必須提供。

--name -n

叢集的名稱。

--resource-group -g

資源組名。您可以使用來設定預設群組 az configure --defaults group=<name>。

--worker-subnet

背景工作角色 vnet 子網的名稱或標識碼。如果提供名稱， --vnet 則必須提供。

選擇性參數

--client-id

叢集服務主體的用戶端標識碼。

--client-secret

叢集服務主體的客戶端密碼。

--cluster-resource-group

叢集的資源群組。

--disk-encryption-set

要用於主要和背景工作 VM 的 DiskEncryptionSet ResourceID。

--location -l

位置。來自的值： az account list-locations。您可以使用 az configure --defaults location=<location> 設定預設位置。

--pod-cidr

Pod 網路的 CIDR。必須至少為 /18 或更大。

--service-cidr

服務網路的 CIDR。必須至少為 /18 或更大。

--version

要用於建立叢集的 OpenShift 版本。

--vnet

vnet 的名稱或標識碼。如果提供名稱， --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

訂用帳戶的名稱或標識碼。您可以使用來設定預設訂用 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

請等候在 'Succeeded' 使用 'provisioningState' 建立。

預設值: 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

訂用帳戶的名稱或標識碼。您可以使用來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。使用 --debug 來取得完整偵錯記錄。

共用方式為

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

必要參數

選擇性參數

其他資源