Partilhar via

az aksarc

  • Referência

Nota

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

Name 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 suportadas do Kubernetes 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

Colete logs de clusters provisionados.

 Extensão GA
az aksarc logs hci

Colete 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 nodepools 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 de arquivo especificado pelo usuário.

 Extensão GA
az aksarc release

Gerencie imagens VHD para clusters provisionados.

 Extensão Pré-visualizar
az aksarc release download

Baixa as imagens VHD de uma versão.

 Extensão Pré-visualizar
az aksarc release save

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

 Extensão Pré-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áquinas virtuais para clusters provisionados.

 Extensão GA
az aksarc vmsize list

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

 Extensão GA
az aksarc vnet

Gerencie redes virtuais para clusters provisionados.

 Extensão GA
az aksarc vnet create

Cria a rede virtual.

 Extensão GA
az aksarc vnet delete

Exclui 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 Obrigatórios

--custom-location

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

--name -n

Nome do cluster provisionado.

--resource-group -g

o 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 HCI do Azure Stack.

Parâmetros Opcionais

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

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

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

Lista separada por espaço de pares key=value para configurar o autoscaler de cluster. Passe uma cadeia de caracteres vazia para limpar o perfil.

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

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

--control-plane-ip

Kubernetes APIServer IPAddress. O endereço IPAddress deve ser roteável a partir do Azure Resource Bridge Appliance VM.It deve fazer parte da sub-rede Rede que está sendo referenciada. A criação do cluster pode falhar ou atingir o tempo limite se um endereço IPAddress não roteável for passado.

--control-plane-vm-size

VM Tamanho do plano de controle.

--disable-nfs-driver

Desative o driver NFS para o cluster provisionado.

Default value: False
--disable-smb-driver

Desative o driver SMB para o cluster provisionado.

Default value: False
--enable-ahub

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

Default value: False
--enable-azure-rbac

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

Default value: False
--enable-cluster-autoscaler -e

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

Default value: False
--enable-oidc-issuer

Habilite o emissor OIDC.

Default value: False
--enable-wi --enable-workload-identity

Habilite o addon de identidade da carga de trabalho.

Default value: False
--gateway-id

ID do braço do gateway do cluster provisionado.

--generate-ssh-keys

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

Default value: False
--kubernetes-version -k

A versão kubernetes do cluster provisionado.

--load-balancer-count

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

--location -l

Localização. 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 espere que a operação de longa duração termine.

Default value: False
--node-count -c

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

Default value: 1
--node-vm-size

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

--nodepool-labels

Etiquetas separadas por espaço: key[=value] [key[=value] ...].

--nodepool-taints

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

--pod-cidr

O IP de notação CIDR varia a partir do qual atribuir IPs 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.

Default value: ~\.ssh\id_rsa.pub
--tags

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

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
Default value: 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 aksarc delete

Exclui o cluster provisionado.

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

Exemplos

DeleteProvisionedCluster

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

Parâmetros Obrigatórios

--name -n

Nome do cluster provisionado.

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

Default value: False
--yes -y

Não solicite confirmação.

Default value: 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
Default value: 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 aksarc get-credentials

Obtenha kubeconfig local do cluster provisionado.

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

Exemplos

GetAdminCredential

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

GetAADUserCredential

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

Parâmetros Obrigatórios

--name -n

Nome do cluster provisionado.

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

--admin -a

Obtenha credenciais de administrador de cluster.

Default value: False
--context

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

--file -f

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

Default value: ~\.kube\config
--overwrite-existing

Substitua qualquer entrada de cluster existente com o mesmo nome.

Default value: 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
Default value: 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 aksarc get-upgrades

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

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

Exemplos

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

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

Parâmetros Obrigatórios

--name -n

Nome do cluster provisionado.

--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
Default value: 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 aksarc get-versions

Liste as versões suportadas do Kubernetes 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 Obrigatórios

--custom-location

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

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
Default value: 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 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

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
Default value: 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 aksarc notice

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

az aksarc notice --output-filepath

Exemplos

GetNoticeFile

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

Parâmetros Obrigatórios

--output-filepath

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

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
Default value: 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 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 Obrigatórios

--name -n

Nome do cluster provisionado.

--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
Default value: 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 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

Aumente a escala dos nós do plano de controle.

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

Parâmetros Obrigatórios

--name -n

Nome do cluster provisionado.

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

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

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

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

Lista separada por espaço de pares key=value para configurar o autoscaler de cluster. Passe uma cadeia de caracteres vazia para limpar o perfil.

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

Número de nós para o qual dimensionar o Plano de Controle.

--disable-ahub

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

Default value: False
--disable-cluster-autoscaler -d

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

Default value: False
--disable-gateway

Desative o gateway para o cluster provisionado.

Default value: False
--disable-nfs-driver

Desative o driver NFS para o cluster provisionado.

Default value: False
--disable-smb-driver

Desative o driver SMB para o cluster provisionado.

Default value: False
--enable-ahub

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

Default value: False
--enable-cluster-autoscaler -e

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

Default value: False
--enable-nfs-driver

Habilite o driver NFS para o cluster provisionado.

Default value: False
--enable-smb-driver

Habilite o driver SMB para o cluster provisionado.

Default value: False
--gateway-id

ID do braço 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 tags existentes.

--update-cluster-autoscaler -u

Atualize o dimensionador automático do cluster para o cluster provisionado.

Default value: 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
Default value: 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 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 Obrigatórios

--name -n

Nome do cluster provisionado.

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

--kubernetes-version -k

A versão kubernetes do cluster provisionado.

--no-wait

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

Default value: False
--yes

Sinalize para desativar os prompts de confirmação.

Default value: 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
Default value: 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.