Compartilhar 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 instalará automaticamente na primeira vez que você executar um comando az connectedk8s . Saiba mais sobre extensões.

Comandos para gerenciar clusters do Kubernetes conectados.

Comandos

Nome Description Tipo Status
az connectedk8s connect

Integrar um cluster do Kubernetes conectado ao Azure.

Extension GA
az connectedk8s delete

Exclua um cluster do Kubernetes conectado junto com os agentes de cluster conectados.

Extension GA
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 de kubernetes conectados.

Extension GA
az connectedk8s proxy

Obtenha acesso a um cluster do Kubernetes conectado.

Extension GA
az connectedk8s show

Mostrar detalhes de um cluster do Kubernetes conectado.

Extension GA
az connectedk8s troubleshoot

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

Extension Preview
az connectedk8s update

Atualize as propriedades do cluster do Kubernetes integrado ao Arc.

Extension GA
az connectedk8s upgrade

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

Extension GA

az connectedk8s connect

Integrar um cluster do Kubernetes conectado ao Azure.

O cluster kubernetes a ser integrado como um cluster conectado deve ser o cluster padrão no kubeconfig. Execute os contextos de obtenção de configuração do kubectl 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 do Kubernetes conectado com a configuração padrão do kube e o contexto do kube.

az connectedk8s connect -g resourceGroupName -n connectedClusterName

Integre um cluster do Kubernetes conectado com a configuração padrão do kube e o contexto do kube e desabilite a atualização automática dos agentes do arc.

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

Integre um cluster do Kubernetes conectado especificando o kubeconfig e o kubecontext.

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

Integre um cluster do Kubernetes conectado especificando as configurações de proxy https, proxy http, sem 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 do Kubernetes conectado especificando o proxy https, o proxy http, no proxy com configurações de certificado.

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 do 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 do 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 de carga de trabalho ativado.

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

Integre um cluster do 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

Integrar um cluster do Kubernetes conectado com o recurso de gateway do Azure habilitado.

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

Parâmetros Exigidos

--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 se tornar obrigatórios para que o comando seja executado com sucesso.

--azure-hybrid-benefit

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

Propriedade Valor
Valores aceitos: False, NotApplicable, True
--config --configuration-settings
Versão Prévia

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
Versão Prévia

Configurações protegidas de configuração 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 usado para acompanhar 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 desabilitar a atualização automática de agentes do arc.

Propriedade Valor
Valor padrão: False
--distribution

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

Propriedade Valor
Valor padrão: generic
Valores aceitos: 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
Versão Prévia

Habilite a criação do URL do emissor do OIDC usado para federação de identidade de carga de trabalho.

Propriedade Valor
Grupo de parâmetros: Workload Identity Arguments
Valor padrão: False
Valores aceitos: false, true
--enable-private-link
Versão Prévia

Sinalizador para habilitar/desabilitar o suporte ao link privado em um recurso de cluster conectado. Valores permitidos: false, true.

Propriedade Valor
Grupo de parâmetros: PrivateLink Arguments
Valores aceitos: false, true
--enable-wi --enable-workload-identity
Versão Prévia

Ative o webhook de identidade da carga de trabalho.

Propriedade Valor
Grupo de parâmetros: Workload Identity Arguments
Valor padrão: False
Valores aceitos: false, true
--gateway-resource-id
Versão Prévia

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
Valor padrão: generic
Valores aceitos: 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

Kubconfig do computador 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 aguarde a conclusão da operação de execução prolongada.

Propriedade Valor
Grupo de parâmetros: Timeout Arguments
Valor padrão: False
--onboarding-timeout

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

Propriedade Valor
Grupo de parâmetros: Timeout Arguments
Valor padrão: 1200
--pls-arm-id --private-link-scope-resource-id
Versão Prévia

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
Versão Prévia

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

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

--yes -y

Não solicite confirmação.

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

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

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

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

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

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Propriedade Valor
Valor padrão: False

az connectedk8s delete

Exclua um cluster do Kubernetes conectado junto com os 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 do Kubernetes conectado e agentes de cluster conectados com kubeconfig e kubecontext padrão.

az connectedk8s delete -g resourceGroupName -n connectedClusterName

Exclua um cluster do Kubernetes conectado especificando o kubeconfig e o kubecontext para a 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 se tornar obrigatórios para que o comando seja executado com sucesso.

--force

Force delete para remover todos os recursos do azure-arc do cluster.

Propriedade Valor
Valor padrão: False
--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

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

Caminho para o arquivo de configuração kube.

--kube-context

Kubconfig do computador atual.

--name -n

O nome do cluster conectado.

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

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

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

Nome ou ID da assinatura. 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
Valor padrão: False
Parâmetros Globais
--debug

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

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

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

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

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Propriedade Valor
Valor padrão: False

az connectedk8s disable-features

Versão Prévia

Esse comando está em versão prévia e em desenvolvimento. Níveis de referência e suporte: 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

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

--features

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

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

Parâmetros Opcionais

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

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

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

Caminho para o arquivo de configuração kube.

--kube-context

Kubconfig do computador 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
Valor padrão: False
--subscription

Nome ou ID da assinatura. 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
Valor padrão: False
Parâmetros Globais
--debug

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

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

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

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

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Propriedade Valor
Valor padrão: False

az connectedk8s enable-features

Versão Prévia

Esse comando está em versão prévia e em desenvolvimento. Níveis de referência e suporte: 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 Exigidos

--features

Lista separada por espaços de recursos que você deseja habilitar.

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

Parâmetros Opcionais

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

--custom-locations-oid

OID do aplicativo 'custom-locations'.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

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

Caminho para o arquivo de configuração kube.

--kube-context

Kubconfig do computador 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 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
Valor padrão: False
--subscription

Nome ou ID da assinatura. 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 Globais
--debug

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

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

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

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

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Propriedade Valor
Valor padrão: False

az connectedk8s list

Liste clusters de kubernetes conectados.

az connectedk8s list [--resource-group]

Exemplos

Liste todos os clusters do Kubernetes conectados em um grupo de recursos.

az connectedk8s list -g resourceGroupName --subscription subscriptionName

Liste todos os clusters do 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 se tornar obrigatórios para que o comando seja executado com sucesso.

--resource-group -g

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

Parâmetros Globais
--debug

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

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

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

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

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Propriedade Valor
Valor padrão: False

az connectedk8s proxy

Obtenha acesso a um cluster do Kubernetes conectado.

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

Exemplos

Obtenha acesso a um cluster do Kubernetes conectado.

az connectedk8s proxy -n clusterName -g resourceGroupName

Obtenha acesso a um cluster do Kubernetes conectado com porta personalizada

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

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

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

Obtenha acesso a um cluster do Kubernetes conectado especificando o local personalizado do kubeconfig

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

Obtenha acesso a um cluster do Kubernetes conectado especificando o 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 se tornar obrigatórios para que o comando seja executado com sucesso.

--file -f

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

Propriedade Valor
Valor padrão: ~\.kube\config
--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

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
Valor padrão: 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 assinatura. 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 do Kubernetes.

Parâmetros Globais
--debug

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

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

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

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

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Propriedade Valor
Valor padrão: False

az connectedk8s show

Mostrar detalhes de um cluster do Kubernetes conectado.

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

Exemplos

Mostrar os detalhes de um cluster do 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 se tornar obrigatórios para que o comando seja executado com sucesso.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

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

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

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

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

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

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Propriedade Valor
Valor padrão: False

az connectedk8s troubleshoot

Versão Prévia

Esse comando está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Execute verificações de diagnóstico em um cluster do 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 do Kubernetes habilitado para Arc.

az connectedk8s troubleshoot -n clusterName -g resourceGroupName

Parâmetros Exigidos

--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 se tornar obrigatórios para que o comando seja executado com sucesso.

--kube-config

Caminho para o arquivo de configuração kube.

--kube-context

Kubeconfig da máquina atual.

--skip-ssl-verification

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

Propriedade Valor
Valor padrão: False
--tags

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

Parâmetros Globais
--debug

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

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

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

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

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Propriedade Valor
Valor padrão: False

az connectedk8s update

Atualize as propriedades do cluster do 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

Desativar configurações de proxy para agentes

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

Desativar atualização automática de agentes

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

Atualize um cluster do Kubernetes conectado com o emissor oidc e o webhook de identidade da carga de trabalho ativado.

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

Atualize um cluster do 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 de carga de trabalho em um cluster do Kubernetes conectado.

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

Atualize um cluster do Kubernetes conectado com o recurso de gateway do Azure habilitado.

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

Desabilite o recurso de gateway do Azure em um cluster do 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 se tornar obrigatórios para que o comando seja executado com sucesso.

--auto-upgrade

Sinalizador para ativar/desativar a atualização automática de agentes do Arc. Por padrão, a atualização automática de agentes está ativada.

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

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

Propriedade Valor
Valores aceitos: False, NotApplicable, True
--config --configuration-settings
Versão Prévia

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
Versão Prévia

Configurações protegidas de configuração 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
Versão Prévia

Sinalize para desativar o Arc Gateway.

Propriedade Valor
Grupo de parâmetros: Gateway Arguments
Valor padrão: False
Valores aceitos: false, true
--disable-proxy

Desativa as configurações de proxy para agentes.

Propriedade Valor
Grupo de parâmetros: Proxy Arguments
Valor padrão: False
--disable-wi --disable-workload-identity
Versão Prévia

Desative o webhook de identidade da carga de trabalho.

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

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

Propriedade Valor
Valores aceitos: 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
Versão Prévia

Habilite a criação do URL do emissor do OIDC usado para federação de identidade de carga de trabalho.

Propriedade Valor
Grupo de parâmetros: Workload Identity Arguments
Valores aceitos: false, true
--enable-wi --enable-workload-identity
Versão Prévia

Ative o webhook de identidade da carga de trabalho.

Propriedade Valor
Grupo de parâmetros: Workload Identity Arguments
Valores aceitos: false, true
--gateway-resource-id
Versão Prévia

ArmID do recurso Arc Gateway.

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

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

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

Caminho para o arquivo de configuração kube.

--kube-context

Kubconfig do computador 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
Versão Prévia

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

Nome ou ID da assinatura. 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

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

--yes -y

Não solicite confirmação.

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

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

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

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

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

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Propriedade Valor
Valor padrão: False

az connectedk8s upgrade

Atualize atomicamente os agentes integrados para a versão específica ou o 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

Atualizar 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 se tornar obrigatórios para que o comando seja executado com sucesso.

--agent-version

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

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

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

Caminho para o arquivo de configuração kube.

--kube-context

Kubconfig do computador 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
Valor padrão: False
--subscription

Nome ou ID da assinatura. 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 agente arc sejam atualizados no cluster do kubernetes. Substitua esse valor se as restrições de hardware/rede no cluster exigirem mais tempo para atualizar os pods do arc-agent.

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

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

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

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

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

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Propriedade Valor
Valor padrão: False