Partilhar via


az aro

Gerencie clusters do Azure Red Hat OpenShift.

Comandos

Name Description Tipo Status
az aro create

Crie um cluster.

Core disponibilidade geral
az aro delete

Excluir um cluster.

Core disponibilidade geral
az aro get-admin-kubeconfig

Listar kubeconfig admin de um cluster.

Core disponibilidade geral
az aro get-versions

Listar versões disponíveis para instalação.

Core disponibilidade geral
az aro list

List clusters.

Core disponibilidade geral
az aro list-credentials

Listar credenciais de um cluster.

Core disponibilidade geral
az aro show

Obtenha os detalhes de um cluster.

Core disponibilidade geral
az aro update

Atualizar um cluster.

Core disponibilidade geral
az aro validate

Valide as permissões necessárias para criar um cluster.

Core disponibilidade geral
az aro wait

Aguarde até que um cluster atinja o estado desejado.

Core disponibilidade geral

az aro create

Crie um cluster.

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]

Exemplos

Crie um cluster.

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

Crie um cluster com uma versão OpenShift suportada.

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

Crie um cluster com 5 nós de computação e o segredo de pull da 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

Crie um cluster privado.

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

Parâmetros Obrigatórios

--master-subnet

Nome ou ID da sub-rede vnet master. Se o nome for fornecido, --vnet deve ser fornecido.

--name -n

Nome do cluster.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--worker-subnet

Nome ou ID da sub-rede vnet do trabalhador. Se o nome for fornecido, --vnet deve ser fornecido.

Parâmetros Opcionais

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

--apiserver-visibility

Visibilidade do servidor de API.

Propriedade Valor
Default value: Public
Valores aceites: Private, Public
--client-id

ID do cliente da entidade de serviço de cluster.

--client-secret

Segredo do cliente da entidade de serviço de cluster.

--cluster-resource-group

Grupo de recursos do cluster.

--disk-encryption-set

ResourceID do DiskEncryptionSet a ser usado para VMs mestre e de trabalho.

--domain

Domínio do cluster.

--enable-preconfigured-nsg

Use NSGs pré-configurados.

Propriedade Valor
Default value: False
Valores aceites: false, true
--fips --fips-validated-modules

Use módulos de criptografia validados pelo FIPS.

Propriedade Valor
Default value: False
Valores aceites: false, true
--ingress-visibility

Ingress visibility.

Propriedade Valor
Default value: Public
Valores aceites: Private, Public
--lb-ip-count --load-balancer-managed-outbound-ip-count

O número desejado de IPs de saída IPv4 criados e gerenciados pelo Azure para o balanceador de carga público do cluster.

--location -l

Location. Valores de: az account list-locations. Você pode configurar o local padrão usando az configure --defaults location=<location>.

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

Criptografia no sinalizador de host para VMs mestres.

Propriedade Valor
Default value: False
Valores aceites: false, true
--master-vm-size

Tamanho das VMs mestras.

Propriedade Valor
Default value: Standard_D8s_v5
--no-wait

Não espere que a operação de longa duração termine.

Propriedade Valor
Default value: False
--outbound-type

Tipo de cluster de saída. Deve ser "Loadbalancer" ou "UserDefinedRouting".

Propriedade Valor
Default value: Loadbalancer
--pod-cidr

CIDR da rede pod. Deve ser um mínimo de /18 ou maior.

Propriedade Valor
Default value: 10.128.0.0/14
--pull-secret

Puxe o segredo do cluster.

--service-cidr

CIDR da rede de serviços. Deve ser um mínimo de /18 ou maior.

Propriedade Valor
Default value: 172.30.0.0/16
--tags

Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar tags existentes.

--version

Versão do OpenShift para usar na criação de clusters.

--vnet

Nome ou ID da vnet. Se o nome for fornecido, --vnet-resource-group deve ser fornecido.

--vnet-resource-group

Nome do grupo de recursos vnet.

--worker-count

Contagem de VMs de trabalho.

Propriedade Valor
Default value: 3
--worker-enc-host --worker-encryption-at-host

Criptografia no sinalizador de host para VMs de trabalho.

Propriedade Valor
Default value: False
Valores aceites: false, true
--worker-vm-disk-size-gb

Tamanho do disco em GB de VMs de trabalho.

Propriedade Valor
Default value: 128
--worker-vm-size

Tamanho das VMs de trabalho.

Propriedade Valor
Default value: Standard_D4s_v5
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Output format.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az aro delete

Excluir um cluster.

az aro delete --name
              --resource-group
              [--no-wait]
              [--yes]

Exemplos

Excluir um cluster.

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

Parâmetros Obrigatórios

--name -n

Nome do cluster.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

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

--no-wait

Não espere que a operação de longa duração termine.

Propriedade Valor
Default value: False
--yes -y

Não solicite confirmação.

Propriedade Valor
Default value: False
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Output format.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az aro get-admin-kubeconfig

Listar kubeconfig admin de um cluster.

az aro get-admin-kubeconfig --name
                            --resource-group
                            [--file]

Exemplos

Listar kubeconfig admin de um cluster. O padrão é salvá-lo em um arquivo chamado "kubeconfig".

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

Parâmetros Obrigatórios

--name -n

Nome do cluster.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

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

--file -f

Caminho para o arquivo onde kubeconfig deve ser salvo. Padrão: kubeconfig no diretório local.

Propriedade Valor
Default value: kubeconfig
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Output format.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az aro get-versions

Listar versões disponíveis para instalação.

az aro get-versions --location

Exemplos

Listar versões de instalação disponíveis para a região Leste dos EUA.

az aro get-versions --location eastus

Liste as versões de instalação disponíveis para a região Leste dos EUA com saída formatada em tabela.

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

Parâmetros Obrigatórios

--location -l

Location. Valores de: az account list-locations. Você pode configurar o local padrão usando az configure --defaults location=<location>.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Output format.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az aro list

List clusters.

az aro list [--resource-group]

Exemplos

List clusters.

az aro list

Listar clusters com exibição de tabela.

az aro list -o table

Parâmetros Opcionais

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

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Output format.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az aro list-credentials

Listar credenciais de um cluster.

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

Exemplos

Listar credenciais de um cluster.

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

Parâmetros Obrigatórios

--name -n

Nome do cluster.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Output format.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az aro show

Obtenha os detalhes de um cluster.

az aro show --name
            --resource-group

Exemplos

Obtenha os detalhes de um cluster.

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

Parâmetros Obrigatórios

--name -n

Nome do cluster.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Output format.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az aro update

Atualizar um cluster.

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

Exemplos

Atualizar um cluster.

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

Parâmetros Obrigatórios

--name -n

Nome do cluster.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

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 do cliente da entidade de serviço de cluster.

--client-secret

Segredo do cliente da entidade de serviço de cluster.

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

O número desejado de IPs de saída IPv4 criados e gerenciados pelo Azure para o balanceador de carga público do cluster.

--no-wait

Não espere que a operação de longa duração termine.

Propriedade Valor
Default value: False
--refresh-credentials

Atualize as credenciais do aplicativo de cluster.

Propriedade Valor
Default value: False
Valores aceites: false, true
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Output format.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az aro validate

Valide as permissões necessárias para criar um cluster.

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]

Exemplos

Validate permissions.

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

Validar permissões e versão do OpenShift

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

Parâmetros Obrigatórios

--master-subnet

Nome ou ID da sub-rede vnet master. Se o nome for fornecido, --vnet deve ser fornecido.

--name -n

Nome do cluster.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--worker-subnet

Nome ou ID da sub-rede vnet do trabalhador. Se o nome for fornecido, --vnet deve ser fornecido.

Parâmetros Opcionais

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 do cliente da entidade de serviço de cluster.

--client-secret

Segredo do cliente da entidade de serviço de cluster.

--cluster-resource-group

Grupo de recursos do cluster.

--disk-encryption-set

ResourceID do DiskEncryptionSet a ser usado para VMs mestre e de trabalho.

--location -l

Location. Valores de: az account list-locations. Você pode configurar o local padrão usando az configure --defaults location=<location>.

--pod-cidr

CIDR da rede pod. Deve ser um mínimo de /18 ou maior.

--service-cidr

CIDR da rede de serviços. Deve ser um mínimo de /18 ou maior.

--version

Versão do OpenShift para usar na criação de clusters.

--vnet

Nome ou ID da vnet. Se o nome for fornecido, --vnet-resource-group deve ser fornecido.

--vnet-resource-group

Nome do grupo de recursos vnet.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Output format.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az aro wait

Aguarde até que um cluster atinja o estado desejado.

Se uma operação em um cluster foi interrompida ou iniciada com --no-wait, use este comando para aguardar a conclusão.

az aro wait --name
            --resource-group
            [--created]
            [--custom]
            [--deleted]
            [--exists]
            [--interval]
            [--timeout]
            [--updated]

Parâmetros Obrigatórios

--name -n

Nome do cluster.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

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

--created

Aguarde até ser criado com 'provisioningState' em 'Succeeded'.

Propriedade Valor
Parameter group: Wait Condition Arguments
Default value: False
--custom

Aguarde até que a condição satisfaça uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Propriedade Valor
Parameter group: Wait Condition Arguments
--deleted

Aguarde até ser excluído.

Propriedade Valor
Parameter group: Wait Condition Arguments
Default value: False
--exists

Aguarde até que o recurso exista.

Propriedade Valor
Parameter group: Wait Condition Arguments
Default value: False
--interval

Intervalo de sondagem em segundos.

Propriedade Valor
Parameter group: Wait Condition Arguments
Default value: 30
--timeout

Espera máxima em segundos.

Propriedade Valor
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Aguarde até ser atualizado com provisioningState em 'Succeeded'.

Propriedade Valor
Parameter group: Wait Condition Arguments
Default value: False
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Output format.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False