Partilhar via


az connectedk8s

Note

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

Comandos para gerenciar clusters kubernetes conectados.

Comandos

Name Description Tipo Status
az connectedk8s connect

Integre um cluster kubernetes conectado ao azure.

Extension disponibilidade geral
az connectedk8s delete

Exclua um cluster kubernetes conectado junto com agentes de cluster conectados.

Extension disponibilidade geral
az connectedk8s disable-features

Desabilita os recursos seletivos no cluster conectado.

Extension Preview
az connectedk8s enable-features

Habilita os recursos seletivos no cluster conectado.

Extension Preview
az connectedk8s list

Liste clusters kubernetes conectados.

Extension disponibilidade geral
az connectedk8s proxy

Obtenha acesso a um cluster kubernetes conectado.

Extension disponibilidade geral
az connectedk8s show

Mostrar detalhes de um cluster kubernetes conectado.

Extension disponibilidade geral
az connectedk8s troubleshoot

Execute verificações de diagnóstico em um cluster Kubernetes habilitado para Arc.

Extension Preview
az connectedk8s update

Atualize as propriedades do cluster kubernetes integrado ao arc.

Extension disponibilidade geral
az connectedk8s upgrade

Atualize atomicamente os agentes integrados para a versão específica ou padrão para a versão mais recente.

Extension disponibilidade geral

az connectedk8s connect

Integre um cluster kubernetes conectado ao azure.

O cluster do Kubernetes a ser integrado como um cluster conectado deve ser o cluster padrão no kubeconfig. Execute kubectl config get-contexts para confirmar o nome do contexto de destino. Em seguida, defina o contexto padrão para o cluster certo executando kubectl config use-context target-cluster-name.

az connectedk8s connect --name
                        --resource-group
                        [--azure-hybrid-benefit {False, NotApplicable, True}]
                        [--config --configuration-settings]
                        [--config-protected --config-protected-settings]
                        [--container-log-path]
                        [--correlation-id]
                        [--custom-ca-cert --proxy-cert]
                        [--custom-locations-oid]
                        [--disable-auto-upgrade]
                        [--distribution {aks, aks_edge_k3s, aks_edge_k8s, aks_engine, aks_management, aks_workload, canonical, capz, eks, generic, gke, k3s, karbon, kind, minikube, openshift, rancher_rke, tkg}]
                        [--distribution-version]
                        [--enable-oidc-issuer {false, true}]
                        [--enable-private-link {false, true}]
                        [--enable-wi --enable-workload-identity {false, true}]
                        [--gateway-resource-id]
                        [--infrastructure {LTSCWindows 10 Enterprise LTSC, Windows 10 Enterprise, Windows 10 Enterprise LTSC 2019, Windows 10 Enterprise LTSC 2021, Windows 10 Enterprise N, Windows 10 Enterprise N LTSC 2019, Windows 10 Enterprise N LTSC 2021, Windows 10 IoT Enterprise, Windows 10 IoT Enterprise LTSC 2019, Windows 10 IoT Enterprise LTSC 2021, Windows 10 Pro, Windows 11 Enterprise, Windows 11 Enterprise N, Windows 11 IoT Enterprise, Windows 11 Pro, Windows Server 2019, Windows Server 2019 Datacenter, Windows Server 2019 Standard, Windows Server 2022, Windows Server 2022 Datacenter, Windows Server 2022 Standard, aws, azure, azure_stack_edge, azure_stack_hci, azure_stack_hub, gcp, generic, vsphere, windows_server}]
                        [--kube-config]
                        [--kube-context]
                        [--location]
                        [--no-wait]
                        [--onboarding-timeout]
                        [--pls-arm-id --private-link-scope-resource-id]
                        [--proxy-http]
                        [--proxy-https]
                        [--proxy-skip-range]
                        [--self-hosted-issuer]
                        [--skip-ssl-verification]
                        [--tags]
                        [--yes]

Exemplos

Integre um cluster kubernetes conectado com configuração kube padrão e contexto kube.

az connectedk8s connect -g resourceGroupName -n connectedClusterName

Integre um cluster kubernetes conectado com configuração kube padrão e contexto kube e desative a atualização automática de agentes arc.

az connectedk8s connect -g resourceGroupName -n connectedClusterName --disable-auto-upgrade

Integre um cluster kubernetes conectado especificando kubeconfig e kubecontext.

az connectedk8s connect -g resourceGroupName -n connectedClusterName --kube-config /path/to/kubeconfig --kube-context kubeContextName

Integre um cluster kubernetes conectado especificando o proxy https, proxy http, sem configurações de proxy.

az connectedk8s connect -g resourceGroupName -n connectedClusterName --proxy-https https://proxy-url --proxy-http http://proxy-url --proxy-skip-range excludedIP,excludedCIDR,exampleCIDRfollowed,10.0.0.0/24

Integre um cluster kubernetes conectado especificando o proxy https, proxy http, nenhum proxy com configurações cert.

az connectedk8s connect -g resourceGroupName -n connectedClusterName --proxy-cert /path/to/crt --proxy-https https://proxy-url --proxy-http http://proxy-url --proxy-skip-range excludedIP,excludedCIDR,exampleCIDRfollowed,10.0.0.0/24

Integre um cluster kubernetes conectado com o recurso de link privado habilitado especificando parâmetros de link privado.

az connectedk8s connect -g resourceGroupName -n connectedClusterName --enable-private-link true --private-link-scope-resource-id pls/resource/arm/id

Integre um cluster kubernetes conectado com tempo limite de integração personalizado.

az connectedk8s connect -g resourceGroupName -n connectedClusterName --onboarding-timeout 600

Integre um cluster kubernetes conectado com o emissor oidc e o webhook de identidade da carga de trabalho habilitado.

az connectedk8s connect -g resourceGroupName -n connectedClusterName --enable-oidc-issuer --enable-workload-identity

Integre um cluster kubernetes conectado com o emissor oidc habilitado usando uma url de emissor auto-hospedada para cluster de nuvem pública.

az connectedk8s connect -g resourceGroupName -n connectedClusterName --enable-oidc-issuer --self-hosted-issuer aksissuerurl

Integre um cluster kubernetes conectado com o recurso azure gateway habilitado.

az connectedk8s connect -g resourceGroupName -n connectedClusterName --gateway-resource-id gatewayResourceId

Parâmetros Obrigatórios

--name -n

O nome do cluster conectado.

--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 tornar-se necessários para que o comando seja executado com êxito.

--azure-hybrid-benefit

Sinalizar para habilitar/desabilitar o recurso Benefício Híbrido do Azure.

Propriedade Valor
Valores aceites: False, NotApplicable, True
--config --configuration-settings
Pré-visualizar

Definições de configuração como par chave=valor. Repita o parâmetro para cada configuração. Não use isso para segredos, pois esse valor é retornado em resposta.

--config-protected --config-protected-settings
Pré-visualizar

Configurações protegidas como par chave=valor. Repita o parâmetro para cada configuração. Somente a chave é retornada em resposta, o valor não é.

--container-log-path

Substitua o caminho de log de contêiner padrão para habilitar o log de bits fluentes.

--correlation-id

Um guid que é usado para rastrear internamente a origem da integração do cluster. Por favor, não o modifique, a menos que seja aconselhado.

--custom-ca-cert --proxy-cert

Caminho para o arquivo de certificado para proxy ou Autoridade de Certificação personalizada.

Propriedade Valor
Grupo de parâmetros: Proxy Arguments
--custom-locations-oid

OID do aplicativo 'custom-locations'.

--disable-auto-upgrade

Sinalizador para desativar a atualização automática de agentes de arco.

Propriedade Valor
Default value: False
--distribution

A distribuição do Kubernetes que será executada neste cluster conectado.

Propriedade Valor
Default value: generic
Valores aceites: aks, aks_edge_k3s, aks_edge_k8s, aks_engine, aks_management, aks_workload, canonical, capz, eks, generic, gke, k3s, karbon, kind, minikube, openshift, rancher_rke, tkg
--distribution-version

A versão de distribuição do Kubernetes do cluster conectado.

--enable-oidc-issuer
Pré-visualizar

Habilite a criação da URL do emissor OIDC usada para a federação de identidades da carga de trabalho.

Propriedade Valor
Grupo de parâmetros: Workload Identity Arguments
Default value: False
Valores aceites: false, true
--enable-private-link
Pré-visualizar

Sinalizador para ativar/desativar o suporte a links privados em um recurso de cluster conectado. Valores permitidos: false, true.

Propriedade Valor
Grupo de parâmetros: PrivateLink Arguments
Valores aceites: false, true
--enable-wi --enable-workload-identity
Pré-visualizar

Habilite o webhook de identidade da carga de trabalho.

Propriedade Valor
Grupo de parâmetros: Workload Identity Arguments
Default value: False
Valores aceites: false, true
--gateway-resource-id
Pré-visualizar

ArmID do recurso Arc Gateway.

Propriedade Valor
Grupo de parâmetros: Gateway Arguments
--infrastructure

A infraestrutura na qual o cluster do Kubernetes representado por esse cluster conectado será executado.

Propriedade Valor
Default value: generic
Valores aceites: LTSCWindows 10 Enterprise LTSC, Windows 10 Enterprise, Windows 10 Enterprise LTSC 2019, Windows 10 Enterprise LTSC 2021, Windows 10 Enterprise N, Windows 10 Enterprise N LTSC 2019, Windows 10 Enterprise N LTSC 2021, Windows 10 IoT Enterprise, Windows 10 IoT Enterprise LTSC 2019, Windows 10 IoT Enterprise LTSC 2021, Windows 10 Pro, Windows 11 Enterprise, Windows 11 Enterprise N, Windows 11 IoT Enterprise, Windows 11 Pro, Windows Server 2019, Windows Server 2019 Datacenter, Windows Server 2019 Standard, Windows Server 2022, Windows Server 2022 Datacenter, Windows Server 2022 Standard, aws, azure, azure_stack_edge, azure_stack_hci, azure_stack_hub, gcp, generic, vsphere, windows_server
--kube-config

Caminho para o arquivo de configuração kube.

--kube-context

Contexto Kubconfig da máquina atual.

--location -l

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

--no-wait

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

Propriedade Valor
Grupo de parâmetros: Timeout Arguments
Default value: False
--onboarding-timeout

Tempo necessário (em segundos) para que os pods do arc-agent sejam instalados no cluster kubernetes. Substitua esse valor se as restrições de hardware/rede em seu cluster exigirem mais tempo para instalar os pods do arc-agent.

Propriedade Valor
Grupo de parâmetros: Timeout Arguments
Default value: 1200
--pls-arm-id --private-link-scope-resource-id
Pré-visualizar

ID do recurso ARM do recurso de escopo de link privado ao qual esse cluster conectado está associado.

Propriedade Valor
Grupo de parâmetros: PrivateLink Arguments
--proxy-http

URL do proxy http a ser usado.

Propriedade Valor
Grupo de parâmetros: Proxy Arguments
--proxy-https

URL do proxy Https a ser usado.

Propriedade Valor
Grupo de parâmetros: Proxy Arguments
--proxy-skip-range

Lista de URLs/CIDRs para os quais o proxy não deve ser usado.

Propriedade Valor
Grupo de parâmetros: Proxy Arguments
--self-hosted-issuer
Pré-visualizar

URL do emissor auto-hospedado para clusters de nuvem pública - AKS, GKE, EKS.

Propriedade Valor
Grupo de parâmetros: Workload Identity Arguments
--skip-ssl-verification

Ignore a verificação SSL para qualquer conexão de cluster.

Propriedade Valor
Default value: False
--tags

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

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

Formato de saída.

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

Exclua um cluster kubernetes conectado junto com agentes de cluster conectados.

az connectedk8s delete [--force]
                       [--ids]
                       [--kube-config]
                       [--kube-context]
                       [--name]
                       [--no-wait]
                       [--resource-group]
                       [--skip-ssl-verification]
                       [--subscription]
                       [--yes]

Exemplos

Exclua um cluster kubernetes conectado e agentes de cluster conectados com kubeconfig e kubecontext padrão.

az connectedk8s delete -g resourceGroupName -n connectedClusterName

Exclua um cluster kubernetes conectado especificando kubeconfig e kubecontext para exclusão de agentes de cluster conectados.

az connectedk8s delete -g resourceGroupName -n connectedClusterName --kube-config /path/to/kubeconfig --kube-context kubeContextName

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--force

Forçar exclusão para remover todos os recursos azure-arc do cluster.

Propriedade Valor
Default value: False
--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo que contenha todas as informações dos argumentos do 'ID de recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--kube-config

Caminho para o arquivo de configuração kube.

--kube-context

Contexto Kubconfig da máquina atual.

--name -n

O nome do cluster conectado.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--no-wait

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

Propriedade Valor
Default value: False
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--skip-ssl-verification

Ignore a verificação SSL para qualquer conexão de cluster.

Propriedade Valor
Default value: False
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--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

Formato de saída.

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.

--verbose

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

Propriedade Valor
Default value: False

az connectedk8s disable-features

Pré-visualizar

Este comando está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Desabilita os recursos seletivos no cluster conectado.

az connectedk8s disable-features --features {azure-rbac, cluster-connect, custom-locations}
                                 [--ids]
                                 [--kube-config]
                                 [--kube-context]
                                 [--name]
                                 [--resource-group]
                                 [--skip-ssl-verification]
                                 [--subscription]
                                 [--yes]

Exemplos

Desativa o recurso azure-rbac.

az connectedk8s disable-features -n clusterName -g resourceGroupName --features azure-rbac

Desative vários recursos.

az connectedk8s disable-features -n clusterName -g resourceGroupName --features custom-locations azure-rbac

Parâmetros Obrigatórios

--features

Lista separada por espaço de recursos que você deseja desativar.

Propriedade Valor
Valores aceites: azure-rbac, cluster-connect, custom-locations

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo que contenha todas as informações dos argumentos do 'ID de recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--kube-config

Caminho para o arquivo de configuração kube.

--kube-context

Contexto Kubconfig da máquina atual.

--name -n

O nome do cluster conectado.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--skip-ssl-verification

Ignore a verificação SSL para qualquer conexão de cluster.

Propriedade Valor
Default value: False
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--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

Formato de saída.

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.

--verbose

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

Propriedade Valor
Default value: False

az connectedk8s enable-features

Pré-visualizar

Este comando está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Habilita os recursos seletivos no cluster conectado.

az connectedk8s enable-features --features {azure-rbac, cluster-connect, custom-locations}
                                [--custom-locations-oid]
                                [--ids]
                                [--kube-config]
                                [--kube-context]
                                [--name]
                                [--resource-group]
                                [--skip-azure-rbac-list]
                                [--skip-ssl-verification]
                                [--subscription]

Exemplos

Habilita o recurso Cluster-Connect.

az connectedk8s enable-features -n clusterName -g resourceGroupName --features cluster-connect

Habilite o recurso RBAC do Azure.

az connectedk8s enable-features -n clusterName -g resourceGroupName --features azure-rbac --skip-azure-rbac-list "user1@domain.com,spn_oid"

Habilite vários recursos.

az connectedk8s enable-features -n clusterName -g resourceGroupName --features cluster-connect custom-locations

Parâmetros Obrigatórios

--features

Lista separada por espaço dos recursos que você deseja ativar.

Propriedade Valor
Valores aceites: azure-rbac, cluster-connect, custom-locations

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--custom-locations-oid

OID do aplicativo 'custom-locations'.

--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo que contenha todas as informações dos argumentos do 'ID de recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--kube-config

Caminho para o arquivo de configuração kube.

--kube-context

Contexto Kubconfig da máquina atual.

--name -n

O nome do cluster conectado.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--skip-azure-rbac-list

Lista separada por vírgulas de nomes de usuário/e-mail/oid. O RBAC do Azure será ignorado para esses usuários. Especifique ao habilitar azure-rbac.

Propriedade Valor
Grupo de parâmetros: Azure RBAC Arguments
--skip-ssl-verification

Ignore a verificação SSL para qualquer conexão de cluster.

Propriedade Valor
Default value: False
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
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

Formato de saída.

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.

--verbose

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

Propriedade Valor
Default value: False

az connectedk8s list

Liste clusters kubernetes conectados.

az connectedk8s list [--resource-group]

Exemplos

Liste todos os clusters kubernetes conectados em um grupo de recursos.

az connectedk8s list -g resourceGroupName --subscription subscriptionName

Liste todos os clusters kubernetes conectados em uma assinatura.

az connectedk8s list --subscription subscriptionName

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

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

Formato de saída.

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

Obtenha acesso a um cluster kubernetes conectado.

az connectedk8s proxy [--file]
                      [--ids]
                      [--kube-context]
                      [--name]
                      [--port]
                      [--resource-group]
                      [--subscription]
                      [--token]

Exemplos

Obtenha acesso a um cluster kubernetes conectado.

az connectedk8s proxy -n clusterName -g resourceGroupName

Obter acesso a um cluster kubernetes conectado com porta personalizada

az connectedk8s proxy -n clusterName -g resourceGroupName --port portValue

Obter acesso a um cluster kubernetes conectado com token de conta de serviço

az connectedk8s proxy -n clusterName -g resourceGroupName --token tokenValue

Obtenha acesso a um cluster kubernetes conectado especificando o local kubeconfig personalizado

az connectedk8s proxy -n clusterName -g resourceGroupName -f path/to/kubeconfig

Obter acesso a um cluster kubernetes conectado especificando contexto personalizado

az connectedk8s proxy -n clusterName -g resourceGroupName --kube-context contextName

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--file -f

Arquivo de configuração do Kubernetes a ser atualizado. Se não for fornecido, atualiza o arquivo '~/.kube/config'. Em vez disso, use '-' para imprimir YAML para stdout.

Propriedade Valor
Default value: ~\.kube\config
--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo que contenha todas as informações dos argumentos do 'ID de recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--kube-context

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

--name -n

O nome do cluster conectado.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--port

Porta usada para acessar o cluster conectado.

Propriedade Valor
Default value: 47011
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--token

Token de conta de serviço a ser usado para autenticar no cluster kubernetes.

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

Formato de saída.

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.

--verbose

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

Propriedade Valor
Default value: False

az connectedk8s show

Mostrar detalhes de um cluster kubernetes conectado.

az connectedk8s show [--ids]
                     [--name]
                     [--resource-group]
                     [--subscription]

Exemplos

Mostrar os detalhes de um cluster kubernetes conectado

az connectedk8s show -g resourceGroupName -n connectedClusterName

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo que contenha todas as informações dos argumentos do 'ID de recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--name -n

O nome do cluster conectado.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
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

Formato de saída.

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.

--verbose

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

Propriedade Valor
Default value: False

az connectedk8s troubleshoot

Pré-visualizar

Este comando está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Execute verificações de diagnóstico em um cluster Kubernetes habilitado para Arc.

az connectedk8s troubleshoot --name
                             --resource-group
                             [--kube-config]
                             [--kube-context]
                             [--skip-ssl-verification]
                             [--tags]

Exemplos

Execute verificações de diagnóstico em um cluster Kubernetes habilitado para Arc.

az connectedk8s troubleshoot -n clusterName -g resourceGroupName

Parâmetros Obrigatórios

--name -n

O nome do cluster conectado.

--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 tornar-se necessários para que o comando seja executado com êxito.

--kube-config

Caminho para o arquivo de configuração kube.

--kube-context

Contexto Kubeconfig da máquina atual.

--skip-ssl-verification

Ignore a verificação SSL para qualquer conexão de cluster.

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

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

Formato de saída.

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

Atualize as propriedades do cluster kubernetes integrado ao arc.

az connectedk8s update [--auto-upgrade {false, true}]
                       [--azure-hybrid-benefit {False, NotApplicable, True}]
                       [--config --configuration-settings]
                       [--config-protected --config-protected-settings]
                       [--container-log-path]
                       [--custom-ca-cert --proxy-cert]
                       [--disable-gateway {false, true}]
                       [--disable-proxy]
                       [--disable-wi --disable-workload-identity {false, true}]
                       [--distribution {aks, aks_edge_k3s, aks_edge_k8s, aks_engine, aks_management, aks_workload, canonical, capz, eks, generic, gke, k3s, karbon, kind, minikube, openshift, rancher_rke, tkg}]
                       [--distribution-version]
                       [--enable-oidc-issuer {false, true}]
                       [--enable-wi --enable-workload-identity {false, true}]
                       [--gateway-resource-id]
                       [--ids]
                       [--kube-config]
                       [--kube-context]
                       [--name]
                       [--proxy-http]
                       [--proxy-https]
                       [--proxy-skip-range]
                       [--resource-group]
                       [--self-hosted-issuer]
                       [--skip-ssl-verification]
                       [--subscription]
                       [--tags]
                       [--yes]

Exemplos

Atualizar valores de proxy para os agentes

az connectedk8s update -g resourceGroupName -n connectedClusterName  --proxy-cert /path/to/crt --proxy-https https://proxy-url --proxy-http http://proxy-url --proxy-skip-range excludedIP,excludedCIDR,exampleCIDRfollowed,10.0.0.0/24

Desabilitar configurações de proxy para agentes

az connectedk8s update -g resourceGroupName -n connectedClusterName --disable-proxy

Desativar a atualização automática de agentes

az connectedk8s update -g resourceGroupName -n connectedClusterName --auto-upgrade false

Atualize um cluster kubernetes conectado com o emissor oidc e o webhook de identidade da carga de trabalho habilitado.

az connectedk8s update -g resourceGroupName -n connectedClusterName --enable-oidc-issuer --enable-workload-identity

Atualize um cluster kubernetes conectado com o emissor oidc habilitado usando uma URL de emissor auto-hospedada para cluster de nuvem pública.

az connectedk8s update -g resourceGroupName -n connectedClusterName --enable-oidc-issuer --self-hosted-issuer aksissuerurl

Desative o webhook de identidade da carga de trabalho em um cluster kubernetes conectado.

az connectedk8s update -g resourceGroupName -n connectedClusterName --disable-workload-identity

Atualize um cluster kubernetes conectado com o recurso azure gateway habilitado.

az connectedk8s update -g resourceGroupName -n connectedClusterName --gateway-resource-id gatewayResourceId

Desative o recurso azure gateway em um cluster kubernetes conectado.

az connectedk8s update -g resourceGroupName -n connectedClusterName --disable-gateway

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--auto-upgrade

Sinalizar para ativar/desativar a atualização automática de agentes de arco. Por padrão, a atualização automática de agentes está habilitada.

Propriedade Valor
Valores aceites: false, true
--azure-hybrid-benefit

Sinalizar para habilitar/desabilitar o recurso Benefício Híbrido do Azure.

Propriedade Valor
Valores aceites: False, NotApplicable, True
--config --configuration-settings
Pré-visualizar

Definições de configuração como par chave=valor. Repita o parâmetro para cada configuração. Não use isso para segredos, pois esse valor é retornado em resposta.

--config-protected --config-protected-settings
Pré-visualizar

Configurações protegidas como par chave=valor. Repita o parâmetro para cada configuração. Somente a chave é retornada em resposta, o valor não é.

--container-log-path

Substitua o caminho de log de contêiner padrão para habilitar o log de bits fluentes.

--custom-ca-cert --proxy-cert

Caminho para o arquivo de certificado para proxy ou Autoridade de Certificação personalizada.

Propriedade Valor
Grupo de parâmetros: Proxy Arguments
--disable-gateway
Pré-visualizar

Sinalizador para desativar o Arc Gateway.

Propriedade Valor
Grupo de parâmetros: Gateway Arguments
Default value: False
Valores aceites: false, true
--disable-proxy

Desabilita as configurações de proxy para agentes.

Propriedade Valor
Grupo de parâmetros: Proxy Arguments
Default value: False
--disable-wi --disable-workload-identity
Pré-visualizar

Desative o webhook de identidade da carga de trabalho.

Propriedade Valor
Grupo de parâmetros: Workload Identity Arguments
Valores aceites: false, true
--distribution

A distribuição do Kubernetes que será executada neste cluster conectado.

Propriedade Valor
Valores aceites: aks, aks_edge_k3s, aks_edge_k8s, aks_engine, aks_management, aks_workload, canonical, capz, eks, generic, gke, k3s, karbon, kind, minikube, openshift, rancher_rke, tkg
--distribution-version

A versão de distribuição do Kubernetes do cluster conectado.

--enable-oidc-issuer
Pré-visualizar

Habilite a criação da URL do emissor OIDC usada para a federação de identidades da carga de trabalho.

Propriedade Valor
Grupo de parâmetros: Workload Identity Arguments
Valores aceites: false, true
--enable-wi --enable-workload-identity
Pré-visualizar

Habilite o webhook de identidade da carga de trabalho.

Propriedade Valor
Grupo de parâmetros: Workload Identity Arguments
Valores aceites: false, true
--gateway-resource-id
Pré-visualizar

ArmID do recurso Arc Gateway.

Propriedade Valor
Grupo de parâmetros: Gateway Arguments
--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo que contenha todas as informações dos argumentos do 'ID de recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--kube-config

Caminho para o arquivo de configuração kube.

--kube-context

Contexto Kubconfig da máquina atual.

--name -n

O nome do cluster conectado.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--proxy-http

URL do proxy http a ser usado.

Propriedade Valor
Grupo de parâmetros: Proxy Arguments
--proxy-https

URL do proxy Https a ser usado.

Propriedade Valor
Grupo de parâmetros: Proxy Arguments
--proxy-skip-range

Lista de URLs/CIDRs para os quais o proxy não deve ser usado.

Propriedade Valor
Grupo de parâmetros: Proxy Arguments
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--self-hosted-issuer
Pré-visualizar

URL do emissor auto-hospedado para clusters de nuvem pública - AKS, GKE, EKS.

Propriedade Valor
Grupo de parâmetros: Workload Identity Arguments
--skip-ssl-verification

Ignore a verificação SSL para qualquer conexão de cluster.

Propriedade Valor
Default value: False
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--tags

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

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

Formato de saída.

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.

--verbose

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

Propriedade Valor
Default value: False

az connectedk8s upgrade

Atualize atomicamente os agentes integrados para a versão específica ou padrão para a versão mais recente.

az connectedk8s upgrade [--agent-version]
                        [--ids]
                        [--kube-config]
                        [--kube-context]
                        [--name]
                        [--resource-group]
                        [--skip-ssl-verification]
                        [--subscription]
                        [--upgrade-timeout]

Exemplos

Atualize os agentes para a versão mais recente

az connectedk8s upgrade -g resourceGroupName -n connectedClusterName

Atualizar os agentes para uma versão específica

az connectedk8s upgrade -g resourceGroupName -n connectedClusterName --agent-version 0.2.62

Atualize os agentes com tempo limite de atualização personalizado.

az connectedk8s upgrade -g resourceGroupName -n connectedClusterName --upgrade-timeout 600

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--agent-version

Versão do agente para atualizar os gráficos de leme.

--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo que contenha todas as informações dos argumentos do 'ID de recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--kube-config

Caminho para o arquivo de configuração kube.

--kube-context

Contexto Kubconfig da máquina atual.

--name -n

O nome do cluster conectado.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--skip-ssl-verification

Ignore a verificação SSL para qualquer conexão de cluster.

Propriedade Valor
Default value: False
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--upgrade-timeout

Tempo necessário (em segundos) para que os pods do arc-agent sejam atualizados no cluster kubernetes. Substitua esse valor se as restrições de hardware/rede em seu cluster exigirem mais tempo para atualizar os pods do arc-agent.

Propriedade Valor
Default value: 600
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

Formato de saída.

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.

--verbose

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

Propriedade Valor
Default value: False