Compartilhar via

az aksarc

  • Referência

Observação

Essa referência faz parte da extensão aksarc para a CLI do Azure (versão 2.32.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az aksarc . Saiba mais sobre extensões.

Gerencie clusters provisionados.

Comandos

Nome Description Tipo Status
az aksarc create

Cria o cluster provisionado.

 Extensão GA
az aksarc delete

Exclui o cluster provisionado.

 Extensão GA
az aksarc get-credentials

Obtenha kubeconfig local do cluster provisionado.

 Extensão GA
az aksarc get-upgrades

Obtenha as versões de atualização disponíveis para o cluster provisionado.

 Extensão GA
az aksarc get-versions

Liste as versões do Kubernetes com suporte no local personalizado especificado.

 Extensão GA
az aksarc list

Lista os clusters provisionados em um grupo de recursos ou em uma assinatura.

 Extensão GA
az aksarc logs

Coletar logs de clusters provisionados.

 Extensão GA
az aksarc logs hci

Coletar logs de clusters provisionados no ambiente HCI.

 Extensão GA
az aksarc nodepool

Gerencie pools de nós em um cluster provisionado.

 Extensão GA
az aksarc nodepool add

Adiciona um pool de nós no cluster provisionado.

 Extensão GA
az aksarc nodepool delete

Exclui o pool de nós no cluster provisionado.

 Extensão GA
az aksarc nodepool list

Lista todos os pools de nós no cluster provisionado.

 Extensão GA
az aksarc nodepool scale

Dimensiona o pool de nós no cluster provisionado.

 Extensão GA
az aksarc nodepool show

Obtém o pool de nós no cluster provisionado.

 Extensão GA
az aksarc nodepool update

Atualize um pool de nós no cluster provisionado.

 Extensão GA
az aksarc notice

Saída do arquivo NOTICE para o caminho do arquivo especificado pelo usuário.

 Extensão GA
az aksarc release

Gerencie imagens VHD para clusters provisionados.

 Extensão Visualizar
az aksarc release download

Baixa as imagens VHD de uma versão.

 Extensão Visualizar
az aksarc release save

Provisiona as imagens VHD baixadas para a ponte de recursos do arc.

 Extensão Visualizar
az aksarc show

Obtém o cluster provisionado.

 Extensão GA
az aksarc update

Atualiza o cluster provisionado.

 Extensão GA
az aksarc upgrade

Atualiza o cluster provisionado.

 Extensão GA
az aksarc vmsize

Gerencie SKUs de máquina virtual para clusters provisionados.

 Extensão GA
az aksarc vmsize list

Lista os tamanhos de máquina virtual com suporte no local personalizado especificado.

 Extensão GA
az aksarc vnet

Gerenciar redes virtuais para clusters provisionados.

 Extensão GA
az aksarc vnet create

Cria a rede virtual.

 Extensão GA
az aksarc vnet delete

Excluir a rede virtual.

 Extensão GA
az aksarc vnet list

Lista as redes virtuais por grupo de recursos ou assinatura.

 Extensão GA
az aksarc vnet show

Obtém a rede virtual.

 Extensão GA

az aksarc create

Cria o cluster provisionado.

az aksarc create --custom-location
                 --name
                 --resource-group
                 --vnet-id
                 [--aad-admin-group-object-ids]
                 [--ca-profile]
                 [--control-plane-count]
                 [--control-plane-ip]
                 [--control-plane-vm-size]
                 [--disable-nfs-driver]
                 [--disable-smb-driver]
                 [--enable-ahub]
                 [--enable-azure-rbac]
                 [--enable-cluster-autoscaler]
                 [--enable-oidc-issuer]
                 [--enable-wi]
                 [--gateway-id]
                 [--generate-ssh-keys]
                 [--kubernetes-version]
                 [--load-balancer-count]
                 [--location]
                 [--max-count]
                 [--max-pods]
                 [--min-count]
                 [--no-wait]
                 [--node-count]
                 [--node-vm-size]
                 [--nodepool-labels]
                 [--nodepool-taints]
                 [--pod-cidr]
                 [--ssh-auth-ips]
                 [--ssh-key-value]
                 [--tags]

Exemplos

PutProvisionedCluster

az aksarc create --resource-group sample-rg --custom-location sample-cl --name sample-aksarccluster --vnet-ids "vnet-arm-id"

Parâmetros Exigidos

--custom-location

Nome ou ID do local personalizado a ser usado para o cluster provisionado.

--name -n

Nome do cluster provisionado.

--resource-group -g

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

--vnet-id --vnet-ids

ID do recurso ARM da rede virtual aksarc ou da rede lógica do Azure Stack HCI.

Parâmetros Opcionais

--aad-admin-group-object-ids -i

Lista separada por vírgulas de IDs de objeto de grupo do aad que serão definidas como administrador de cluster no cluster provisionado.

--ca-profile --cluster-autoscaler-profile

Lista separada por espaços de pares chave=valor para configurar o dimensionador automático de cluster. Passe uma string vazia para limpar o perfil.

--control-plane-count --control-plane-node-count

Número de nós do plano de controle.

--control-plane-ip

Kubernetes APIServer IPAddress. O endereço IP deve ser roteável do Dispositivo de Ponte de Recursos do Azure VM.It deve fazer parte da sub-rede de rede que está sendo referenciada. A criação do cluster pode falhar ou atingir o tempo limite se um IPAddress não roteável for passado.

--control-plane-vm-size

Tamanho da VM do plano de controle.

--disable-nfs-driver

Desabilite o driver NFS para o cluster provisionado.

Valor padrão: False
--disable-smb-driver

Desabilite o driver SMB para o cluster provisionado.

Valor padrão: False
--enable-ahub

Habilite os AHUB (Benefícios do Usuário Híbrido do Azure) para o cluster provisionado.

Valor padrão: False
--enable-azure-rbac

Habilite o RBAC do Azure para controlar as verificações de autorização no cluster.

Valor padrão: False
--enable-cluster-autoscaler -e

Habilite o dimensionador automático de cluster para o cluster provisionado.

Valor padrão: False
--enable-oidc-issuer

Habilite o emissor do OIDC.

Valor padrão: False
--enable-wi --enable-workload-identity

Habilite o complemento de identidade da carga de trabalho.

Valor padrão: False
--gateway-id

ID do Arm do Gateway do cluster provisionado.

--generate-ssh-keys

Gere o par de chaves ssh se não estiver presente.

Valor padrão: False
--kubernetes-version -k

A versão do kubernetes do cluster provisionado.

--load-balancer-count

Número de nós do balanceador de carga.

--location -l

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

--max-count

O número máximo de nós para dimensionamento automático.

--max-pods -m

Número máximo de pods que podem ser executados em um nó.

--min-count

O número mínimo de nós para dimensionamento automático.

--no-wait

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

Valor padrão: False
--node-count -c

Número de nós a serem criados no pool de nós.

Valor padrão: 1
--node-vm-size

Tamanho da VM dos nós no pool de nós.

--nodepool-labels

Rótulos separados por espaço: chave[=valor] [chave[=valor] ...].

--nodepool-taints

Lista separada por vírgulas de taints do pool de nós.

--pod-cidr

O IP de notação CIDR varia a partir do qual atribuir IPs de pod.

--ssh-auth-ips --ssh-authorized-ip-ranges

Lista separada por vírgulas de endereços IP ou CIDR que têm permissão para ssh para a VM do cluster.

--ssh-key-value

Caminho para a chave pública ssh a ser injetada no plano de controle.

Valor padrão: ~\.ssh\id_rsa.pub
--tags

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

Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az aksarc delete

Exclui o cluster provisionado.

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

Exemplos

ExcluirProvisionedCluster

az aksarc delete --name "sample-aksarccluster" --resource-group "sample-rg"

Parâmetros Exigidos

--name -n

Nome do cluster provisionado.

--resource-group -g

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 aguarde a conclusão da operação de execução longa.

Valor padrão: False
--yes -y

Não solicite confirmação.

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

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az aksarc get-credentials

Obtenha kubeconfig local do cluster provisionado.

az aksarc get-credentials --name
                          --resource-group
                          [--admin]
                          [--context]
                          [--file]
                          [--overwrite-existing]

Exemplos

Obter Credencial de Administração

az aksarc get-credentials --name "sample-aksarccluster" --resource-group "sample-rg" --admin

Obter AADUserCredential

az aksarc get-credentials --name "sample-aksarccluster" --resource-group "sample-rg"

Parâmetros Exigidos

--name -n

Nome do cluster provisionado.

--resource-group -g

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

Parâmetros Opcionais

--admin -a

Obtenha credenciais de administrador de cluster.

Valor padrão: False
--context

Se especificado, substitua o nome do contexto padrão.

--file -f

Arquivo de configuração do Kubernetes a ser atualizado. Se não for fornecido, atualiza o arquivo '~/.kube/config'.

Valor padrão: ~\.kube\config
--overwrite-existing

Substitua qualquer entrada de cluster existente com o mesmo nome.

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

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az aksarc get-upgrades

Obtenha as versões de atualização disponíveis para o cluster provisionado.

az aksarc get-upgrades --name
                       --resource-group

Exemplos

Obter as versões de atualização disponíveis para o cluster provisionado do AKS Híbrido

az aksarc get-upgrades --name "samplecluster" --resource-group "sample-rg"

Parâmetros Exigidos

--name -n

Nome do cluster provisionado.

--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 o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az aksarc get-versions

Liste as versões do Kubernetes com suporte no local personalizado especificado.

az aksarc get-versions --custom-location
                       [--resource-group]

Exemplos

VMListSkus

az aksarc get-versions -g sample-rg --custom-location sample-cl

Parâmetros Exigidos

--custom-location

Nome do local personalizado a ser usado para exibir as versões do k8s com suporte.

Parâmetros Opcionais

--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 o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az aksarc list

Lista os clusters provisionados em um grupo de recursos ou em uma assinatura.

az aksarc list [--resource-group]

Exemplos

ListProvisionedClusterByResourceGroup

az aksarc list --resource-group "sample-rg"

ListProvisionedClusterBySubscription

az aksarc list

Parâmetros Opcionais

--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 o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az aksarc notice

Saída do arquivo NOTICE para o caminho do arquivo especificado pelo usuário.

az aksarc notice --output-filepath

Exemplos

Arquivo GetNoticeFile

az aksarc notice --output-filepath "./Notice"

Parâmetros Exigidos

--output-filepath

Caminho do arquivo de saída para o arquivo NOTICE.

Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az aksarc show

Obtém o cluster provisionado.

az aksarc show --name
               --resource-group

Exemplos

GetProvisionedCluster

az aksarc show --name "sample-aksarccluster" --resource-group "sample-rg"

Parâmetros Exigidos

--name -n

Nome do cluster provisionado.

--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 o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az aksarc update

Atualiza o cluster provisionado.

az aksarc update --name
                 --resource-group
                 [--aad-admin-group-object-ids]
                 [--ca-profile]
                 [--control-plane-count]
                 [--disable-ahub]
                 [--disable-cluster-autoscaler]
                 [--disable-gateway]
                 [--disable-nfs-driver]
                 [--disable-smb-driver]
                 [--enable-ahub]
                 [--enable-cluster-autoscaler]
                 [--enable-nfs-driver]
                 [--enable-smb-driver]
                 [--gateway-id]
                 [--max-count]
                 [--min-count]
                 [--tags]
                 [--update-cluster-autoscaler]

Exemplos

UpdateProvisionedCluster

az aksarc update --tags additionalProperties="sample" --name "sample-aksarccluster" --resource-group "sample-rg"

Habilite o recurso Benefícios do Usuário Híbrido do Azure para um cluster provisionado.

az aksarc update --name "sample-aksarccluster" --resource-group "sample-rg" --enable-ahub

Desabilite o recurso Benefícios do Usuário Híbrido do Azure para um cluster provisionado.

az aksarc update --name "sample-aksarccluster" --resource-group "sample-rg"--disable-ahub

Escalar verticalmente os nós do plano de controle.

az aksarc update --name "sample-aksarccluster" --resource-group "sample-rg" --control-plane-node-count 5

Parâmetros Exigidos

--name -n

Nome do cluster provisionado.

--resource-group -g

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

Parâmetros Opcionais

--aad-admin-group-object-ids -i

Lista separada por vírgulas de IDs de objeto de grupo do aad que serão definidas como administrador de cluster no cluster provisionado.

--ca-profile --cluster-autoscaler-profile

Lista separada por espaços de pares chave=valor para configurar o dimensionador automático de cluster. Passe uma string vazia para limpar o perfil.

--control-plane-count --control-plane-node-count

Número de nós para dimensionar o plano de controle.

--disable-ahub

Desabilite os AHUB (Benefícios do Usuário Híbrido do Azure) para o cluster provisionado.

Valor padrão: False
--disable-cluster-autoscaler -d

Desabilite o dimensionador automático de cluster para o cluster provisionado.

Valor padrão: False
--disable-gateway

Desative o gateway para o cluster provisionado.

Valor padrão: False
--disable-nfs-driver

Desabilite o driver NFS para o cluster provisionado.

Valor padrão: False
--disable-smb-driver

Desabilite o driver SMB para o cluster provisionado.

Valor padrão: False
--enable-ahub

Habilite os AHUB (Benefícios do Usuário Híbrido do Azure) para o cluster provisionado.

Valor padrão: False
--enable-cluster-autoscaler -e

Habilite o dimensionador automático de cluster para o cluster provisionado.

Valor padrão: False
--enable-nfs-driver

Habilite o driver NFS para o cluster provisionado.

Valor padrão: False
--enable-smb-driver

Habilite o driver SMB para o cluster provisionado.

Valor padrão: False
--gateway-id

ID do Arm do Gateway do cluster provisionado.

--max-count

O número máximo de nós para dimensionamento automático.

--min-count

O número mínimo de nós para dimensionamento automático.

--tags

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

--update-cluster-autoscaler -u

Atualize o escalonador automático de cluster para o cluster provisionado.

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

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az aksarc upgrade

Atualiza o cluster provisionado.

az aksarc upgrade --name
                  --resource-group
                  [--kubernetes-version]
                  [--no-wait]
                  [--yes]

Exemplos

UpgradeProvisionedCluster

az aksarc upgrade --name "sample-aksarccluster" --resource-group "sample-rg" --kubernetes-version "1.22.2"

Parâmetros Exigidos

--name -n

Nome do cluster provisionado.

--resource-group -g

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

Parâmetros Opcionais

--kubernetes-version -k

A versão do kubernetes do cluster provisionado.

--no-wait

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

Valor padrão: False
--yes

Sinalize para desativar os prompts de confirmação.

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

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.