Partilhar via

az aro

  • Referência

Gerencie clusters do Azure Red Hat OpenShift.

Comandos

Name Description Tipo Estado
az aro create

Crie um cluster.

 Principal GA
az aro delete

Excluir um cluster.

 Principal GA
az aro get-admin-kubeconfig

Listar kubeconfig admin de um cluster.

 Principal GA
az aro get-versions

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

 Principal GA
az aro list

Listar clusters.

 Principal GA
az aro list-credentials

Listar credenciais de um cluster.

 Principal GA
az aro show

Obtenha os detalhes de um cluster.

 Principal GA
az aro update

Atualizar um cluster.

 Principal GA
az aro validate

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

 Principal GA
az aro wait

Aguarde até que um cluster atinja o estado desejado.

 Principal GA

az aro create

Editar

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

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

o 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

--apiserver-visibility

Visibilidade do servidor de API.

valores aceites: Private, Public
valor predefinido: 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. Padrão: False.

valores aceites: false, true
valor predefinido: False
--fips --fips-validated-modules

Use módulos de criptografia validados pelo FIPS. Padrão: False.

valores aceites: false, true
valor predefinido: False
--ingress-visibility

Visibilidade de ingresso.

valores aceites: Private, Public
valor predefinido: Public
--location -l

Localização. 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. Padrão: False.

valores aceites: false, true
valor predefinido: False
--master-vm-size

Tamanho das VMs mestras.

valor predefinido: Standard_D8s_v3
--no-wait

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

valor predefinido: False
--outbound-type

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

valor predefinido: Loadbalancer
--pod-cidr

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

valor predefinido: 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.

valor predefinido: 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.

valor predefinido: 3
--worker-enc-host --worker-encryption-at-host

Criptografia no sinalizador de host para VMs de trabalho. Padrão: False.

valores aceites: false, true
valor predefinido: False
--worker-vm-disk-size-gb

Tamanho do disco em GB de VMs de trabalho.

valor predefinido: 128
--worker-vm-size

Tamanho das VMs de trabalho.

valor predefinido: Standard_D4s_v3
Parâmetros de Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

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

--verbose

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

az aro delete

Editar

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

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

Parâmetros Opcionais

--no-wait

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

valor predefinido: False
--yes -y

Não solicite confirmação.

valor predefinido: False
Parâmetros de Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

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

--verbose

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

az aro get-admin-kubeconfig

Editar

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

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

Parâmetros Opcionais

--file -f

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

valor predefinido: kubeconfig
Parâmetros de Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

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

--verbose

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

az aro get-versions

Editar

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

Localização. 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.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

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

--verbose

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

az aro list

Editar

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

--resource-group -g

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

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

--verbose

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

az aro list-credentials

Editar

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

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

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

--verbose

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

az aro show

Editar

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

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

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

--verbose

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

az aro update

Editar

Atualizar um cluster.

az aro update --name
              --resource-group
              [--client-id]
              [--client-secret]
              [--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

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

Parâmetros Opcionais

--client-id

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

--client-secret

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

--no-wait

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

valor predefinido: False
--refresh-credentials

Atualize as credenciais do aplicativo de cluster.

valores aceites: false, true
valor predefinido: False
Parâmetros de Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

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

--verbose

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

az aro validate

Editar

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

Valide permissões.

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

o 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

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

Localização. 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.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

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

--verbose

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

az aro wait

Editar

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

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

Parâmetros Opcionais

--created

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

valor predefinido: False
--custom

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

--deleted

Aguarde até ser excluído.

valor predefinido: False
--exists

Aguarde até que o recurso exista.

valor predefinido: False
--interval

Intervalo de sondagem em segundos.

valor predefinido: 30
--timeout

Espera máxima em segundos.

valor predefinido: 3600
--updated

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

valor predefinido: False
Parâmetros de Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

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

--verbose

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