Compartilhar via


az aro

Gerencie clusters do Red Hat OpenShift no Azure.

Comandos

Nome Description Tipo Status
az aro create

Criar um cluster.

Core GA
az aro delete

Excluir um cluster.

Core GA
az aro get-admin-kubeconfig

Listar kubeconfig do administrador de um cluster.

Core GA
az aro get-versions

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

Core GA
az aro list

Listar clusters.

Core GA
az aro list-credentials

Listar credenciais de um cluster.

Core GA
az aro show

Obtenha os detalhes de um cluster.

Core GA
az aro update

Atualize um cluster.

Core GA
az aro validate

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

Core GA
az aro wait

Aguarde até que um cluster atinja um estado desejado.

Core GA

az aro create

Criar 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

Criar 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 do OpenShift com suporte.

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 segredo de pull do 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 Exigidos

--master-subnet

Nome ou ID da sub-rede de vnet mestre. 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 da rede virtual de trabalho. Se o nome for fornecido, --vnet deve ser fornecido.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--apiserver-visibility

Visibilidade do servidor de API.

Propriedade Valor
Valor padrão: Public
Valores aceitos: Private, Public
--client-id

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

--client-secret

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

--cluster-resource-group

Grupo de recursos do cluster.

--disk-encryption-set

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

--domain

Domínio do cluster.

--enable-preconfigured-nsg

Use NSGs pré-configurados.

Propriedade Valor
Valor padrão: False
Valores aceitos: false, true
--fips --fips-validated-modules

Use módulos de criptografia validados por FIPS.

Propriedade Valor
Valor padrão: False
Valores aceitos: false, true
--ingress-visibility

Visibilidade da entrada.

Propriedade Valor
Valor padrão: Public
Valores aceitos: 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 mestras.

Propriedade Valor
Valor padrão: False
Valores aceitos: false, true
--master-vm-size

Tamanho das VMs mestras.

Propriedade Valor
Valor padrão: Standard_D8s_v5
--no-wait

Não aguarde a conclusão da operação de execução prolongada.

Propriedade Valor
Valor padrão: False
--outbound-type

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

Propriedade Valor
Valor padrão: Loadbalancer
--pod-cidr

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

Propriedade Valor
Valor padrão: 10.128.0.0/14
--pull-secret

Efetuar pull do segredo do cluster.

--service-cidr

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

Propriedade Valor
Valor padrão: 172.30.0.0/16
--tags

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

--version

Versão do OpenShift a ser usada para criação de cluster.

--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 da vnet.

--worker-count

Contagem de VMs de trabalho.

Propriedade Valor
Valor padrão: 3
--worker-enc-host --worker-encryption-at-host

Criptografia no sinalizador de host para VMs de trabalho.

Propriedade Valor
Valor padrão: False
Valores aceitos: false, true
--worker-vm-disk-size-gb

Tamanho do disco em GB de VMs de trabalho.

Propriedade Valor
Valor padrão: 128
--worker-vm-size

Tamanho das VMs de trabalho.

Propriedade Valor
Valor padrão: Standard_D4s_v5
Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: 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 Exigidos

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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--no-wait

Não aguarde a conclusão da operação de execução prolongada.

Propriedade Valor
Valor padrão: False
--yes -y

Não solicite confirmação.

Propriedade Valor
Valor padrão: False
Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False

az aro get-admin-kubeconfig

Listar kubeconfig do administrador de um cluster.

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

Exemplos

Listar kubeconfig do administrador 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 Exigidos

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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--file -f

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

Propriedade Valor
Valor padrão: kubeconfig
Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: 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

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

--location -l

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

Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False

az aro list

Listar clusters.

az aro list [--resource-group]

Exemplos

Listar clusters.

az aro list

Listar clusters com exibição de tabela.

az aro list -o table

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--resource-group -g

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

Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: 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 Exigidos

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

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: 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 Exigidos

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

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False

az aro update

Atualize 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

Atualize um cluster.

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

Parâmetros Exigidos

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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--client-id

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

--client-secret

Segredo do cliente da entidade de serviço do 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 aguarde a conclusão da operação de execução prolongada.

Propriedade Valor
Valor padrão: False
--refresh-credentials

Atualize as credenciais do aplicativo de cluster.

Propriedade Valor
Valor padrão: False
Valores aceitos: false, true
Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: 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

Validar permissões.

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

Validar permissões e a 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 Exigidos

--master-subnet

Nome ou ID da sub-rede de vnet mestre. 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 da rede virtual de trabalho. Se o nome for fornecido, --vnet deve ser fornecido.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--client-id

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

--client-secret

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

--cluster-resource-group

Grupo de recursos do cluster.

--disk-encryption-set

ResourceID do DiskEncryptionSet a ser usado para VMs mestras 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 de pod. Deve ser um mínimo de /18 ou maior.

--service-cidr

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

--version

Versão do OpenShift a ser usada para criação de cluster.

--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 da vnet.

Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False

az aro wait

Aguarde até que um cluster atinja um estado desejado.

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

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

Parâmetros Exigidos

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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--created

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

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor padrão: False
--custom

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

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
--deleted

Aguarde até ser excluído.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor padrão: False
--exists

Aguarde até que o recurso exista.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor padrão: False
--interval

Intervalo de sondagem em segundos.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor padrão: 30
--timeout

Espera máxima em segundos.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor padrão: 3600
--updated

Aguarde até que seja atualizado com provisioningState em 'Succeeded'.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor padrão: False
Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False