az k8s-extension

Note

This reference is part of the k8s-extension extension for the Azure CLI (version 2.51.0 or higher). The extension will automatically install the first time you run an az k8s-extension command. Learn more about extensions.

Comandos para gerenciar extensões do Kubernetes.

Comandos

Name	Description	Tipo	Status
az k8s-extension create	Crie uma Extensão de Cluster do Kubernetes, incluindo a compra de uma Oferta de extensão do Azure Marketplace (apenas AKS). Consulte o exemplo no final para ver como criar uma extensão ou comprar uma oferta de extensão.	Extension	disponibilidade geral
az k8s-extension delete	Exclua uma extensão do Kubernetes.	Extension	disponibilidade geral
az k8s-extension extension-types	Comandos para descobrir tipos de extensão do Kubernetes.	Extension	Preview
az k8s-extension extension-types list-by-cluster	Liste os Tipos de Extensão de Cluster disponíveis para um cluster existente. As propriedades usadas para filtragem incluem tipo de cluster (gerenciado, conectado, etc), versão do kubernetes, localização do cluster.	Extension	Preview
az k8s-extension extension-types list-by-location	Liste os Tipos de Extensão de Cluster disponíveis em uma região.	Extension	Preview
az k8s-extension extension-types list-versions-by-cluster	Liste as versões disponíveis para um Tipo de Extensão de Cluster para um determinado cluster. As propriedades usadas para filtragem incluem tipo de cluster (gerenciado, conectado, etc), versão do kubernetes, localização do cluster.	Extension	Preview
az k8s-extension extension-types list-versions-by-location	Liste as versões disponíveis para um Tipo de Extensão de Cluster em uma região.	Extension	Preview
az k8s-extension extension-types show-by-cluster	Mostrar propriedades de um Tipo de Extensão de Cluster para um cluster existente. As propriedades usadas para filtragem incluem tipo de cluster (gerenciado, conectado, etc), versão do kubernetes, localização do cluster.	Extension	Preview
az k8s-extension extension-types show-by-location	Mostrar propriedades para um Tipo de Extensão de Cluster em uma região.	Extension	Preview
az k8s-extension extension-types show-version-by-cluster	Mostrar propriedades associadas a uma versão do Tipo de Extensão de Cluster para um cluster existente. As propriedades usadas para filtragem incluem tipo de cluster (gerenciado, conectado, etc), versão do kubernetes, localização do cluster.	Extension	Preview
az k8s-extension extension-types show-version-by-location	Mostrar propriedades associadas a uma versão do Tipo de Extensão de Cluster em uma região.	Extension	Preview
az k8s-extension list	Listar extensões do Kubernetes.	Extension	disponibilidade geral
az k8s-extension show	Mostrar uma extensão do Kubernetes.	Extension	disponibilidade geral
az k8s-extension update	Atualize as propriedades mutáveis de uma extensão do Kubernetes.	Extension	disponibilidade geral

az k8s-extension create

Crie uma Extensão de Cluster do Kubernetes, incluindo a compra de uma Oferta de extensão do Azure Marketplace (apenas AKS). Consulte o exemplo no final para ver como criar uma extensão ou comprar uma oferta de extensão.

Crie uma extensão do Kubernetes. A saída inclui segredos que você deve proteger. Certifique-se de não incluir esses segredos no controle do código-fonte. Verifique também se nenhum segredo está presente nos logs do seu comando ou script. Para obter informações adicionais, consulte http://aka.ms/clisecrets.

az k8s-extension create --cluster-name
                        --cluster-type {appliances, connectedClusters, managedClusters, provisionedClusters}
                        --extension-type
                        --name
                        --resource-group
                        [--auto-upgrade --auto-upgrade-minor-version {false, true}]
                        [--cluster-resource-provider --cluster-rp]
                        [--config --configuration-settings]
                        [--config-file --config-settings-file]
                        [--config-protected --config-protected-settings]
                        [--config-protected-file --config-protected-settings-file]
                        [--config-settings]
                        [--configuration-protected-settings]
                        [--configuration-protected-settings-file]
                        [--configuration-settings-file]
                        [--no-wait]
                        [--plan-name]
                        [--plan-product]
                        [--plan-publisher]
                        [--release-namespace]
                        [--release-train]
                        [--scope {cluster, namespace}]
                        [--target-namespace]
                        [--version]

Exemplos

Criar uma extensão do Kubernetes

az k8s-extension create --resource-group my-resource-group --cluster-name mycluster --cluster-type connectedClusters --name myextension --extension-type microsoft.openservicemesh --scope cluster --release-train stable

Criar uma extensão do Kubernetes Marketplace

az k8s-extension create --resource-group my-resource-group --cluster-name mycluster --cluster-type managedClusters --name myextension --extension-type Contoso.AzureVoteKubernetesAppTest --scope cluster --release-train stable --plan-name testplan --plan-product kubernetest_apps_demo_offer --plan-publisher test_test_mix3pptest0011614206850774

Parâmetros Obrigatórios

--cluster-name -c

Nome do cluster Kubernetes.

--cluster-type -t

Especifique clusters Arc ou clusters gerenciados AKS ou dispositivos Arc ou provisionedClusters.

Propriedade	Valor
Valores aceites:	appliances, connectedClusters, managedClusters, provisionedClusters

--extension-type

Nome do tipo de extensão.

--name -n

Nome da instância de extensão.

--resource-group -g

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

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--auto-upgrade --auto-upgrade-minor-version

Atualize automaticamente a versão secundária da instância de extensão.

Propriedade	Valor
Parameter group:	Version Arguments
Valores aceites:	false, true

--cluster-resource-provider --cluster-rp

Nome do Provedor de Recursos de Cluster para este clusterType (Necessário para provisionedClusters).

--config --configuration-settings

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.

Propriedade	Valor
Parameter group:	Configuration Arguments

--config-file --config-settings-file

Caminho do arquivo JSON para definições de configuração.

Propriedade	Valor
Parameter group:	Configuration Arguments

--config-protected --config-protected-settings

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

Propriedade	Valor
Parameter group:	Configuration Arguments

--config-protected-file --config-protected-settings-file

Caminho do arquivo JSON para configurações protegidas.

Propriedade	Valor
Parameter group:	Configuration Arguments

--config-settings

Preterido

A opção '--config-settings' foi preterida e será removida em uma versão futura. Em vez disso, use '--configuration-settings'.

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.

Propriedade	Valor
Parameter group:	Configuration Arguments

--configuration-protected-settings

Preterido

A opção '--configuration-protected-settings' foi preterida e será removida em uma versão futura. Use '--config-protected-settings' em vez disso.

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

Propriedade	Valor
Parameter group:	Configuration Arguments

--configuration-protected-settings-file

Preterido

A opção '--configuration-protected-settings-file' foi preterida e será removida em uma versão futura. Use '--config-protected-file' em vez disso.

Caminho do arquivo JSON para configurações protegidas.

Propriedade	Valor
Parameter group:	Configuration Arguments

--configuration-settings-file

Preterido

A opção '--configuration-settings-file' foi preterida e será removida em uma versão futura. Use '--config-settings-file' em vez disso.

Caminho do arquivo JSON para definições de configuração.

Propriedade	Valor
Parameter group:	Configuration Arguments

--no-wait

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

Propriedade	Valor
Default value:	False

--plan-name

O nome do plano está se referindo à ID do plano da extensão que está sendo retirada do portal do Marketplace em Informações de uso + suporte.

Propriedade	Valor
Parameter group:	Marketplace Arguments

--plan-product

O produto do plano está se referindo à ID do Produto da extensão que está sendo retirada do portal do Marketplace em Informações de Uso + Suporte. Um exemplo disso é o nome da oferta de ISV usada.

Propriedade	Valor
Parameter group:	Marketplace Arguments

--plan-publisher

O editor do plano está se referindo à ID do editor da extensão que está sendo retirada do portal do Marketplace em Informações de uso + suporte.

Propriedade	Valor
Parameter group:	Marketplace Arguments

--release-namespace

Especifique o namespace para instalar a versão da extensão.

--release-train

Especifique o trem de liberação para o tipo de extensão.

Propriedade	Valor
Parameter group:	Version Arguments

--scope

Especifique o escopo da extensão.

Propriedade	Valor
Valores aceites:	cluster, namespace

--target-namespace

Especifique o namespace de destino no qual instalar para a instância de extensão. Este parâmetro é necessário se o escopo da extensão estiver definido como 'namespace'.

--version

Especifique a versão a ser instalada para a instância de extensão se --auto-upgrade-minor-version não estiver habilitado.

Propriedade	Valor
Parameter group:	Version 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

Output format.

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 k8s-extension delete

Exclua uma extensão do Kubernetes.

az k8s-extension delete --cluster-name
                        --cluster-type {appliances, connectedClusters, managedClusters, provisionedClusters}
                        --name
                        --resource-group
                        [--cluster-resource-provider --cluster-rp]
                        [--force]
                        [--no-wait]
                        [--yes]

Exemplos

Excluir uma extensão existente do Kubernetes

az k8s-extension delete --resource-group my-resource-group --cluster-name mycluster --cluster-type connectedClusters --name myextension

Parâmetros Obrigatórios

--cluster-name -c

Nome do cluster Kubernetes.

--cluster-type -t

Especifique clusters Arc ou clusters gerenciados AKS ou dispositivos Arc ou provisionedClusters.

Propriedade	Valor
Valores aceites:	appliances, connectedClusters, managedClusters, provisionedClusters

--name -n

Nome da instância de extensão.

--resource-group -g

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

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-resource-provider --cluster-rp

Nome do Provedor de Recursos de Cluster para este clusterType (Necessário para provisionedClusters).

--force

Especifique se a exclusão da extensão do cluster deve ser forçada.

Propriedade	Valor
Default value:	False

--no-wait

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

Propriedade	Valor
Default value:	False

--yes -y

Ignore os prompts de 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

Output format.

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 k8s-extension list

Listar extensões do Kubernetes.

Liste todas as extensões do Kubernetes em um cluster, incluindo suas propriedades. A saída inclui segredos que você deve proteger. Certifique-se de não incluir esses segredos no controle do código-fonte. Verifique também se nenhum segredo está presente nos logs do seu comando ou script. Para obter informações adicionais, consulte http://aka.ms/clisecrets.

az k8s-extension list --cluster-name
                      --cluster-type {appliances, connectedClusters, managedClusters, provisionedClusters}
                      --resource-group
                      [--cluster-resource-provider --cluster-rp]

Exemplos

Listar todas as extensões do Kubernetes em um cluster

az k8s-extension list --resource-group my-resource-group --cluster-name mycluster --cluster-type connectedClusters

Parâmetros Obrigatórios

--cluster-name -c

Nome do cluster Kubernetes.

--cluster-type -t

Especifique clusters Arc ou clusters gerenciados AKS ou dispositivos Arc ou provisionedClusters.

Propriedade	Valor
Valores aceites:	appliances, connectedClusters, managedClusters, provisionedClusters

--resource-group -g

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

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-resource-provider --cluster-rp

Nome do Provedor de Recursos de Cluster para este clusterType (Necessário para provisionedClusters).

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

Output format.

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 k8s-extension show

Mostrar uma extensão do Kubernetes.

Mostrar uma extensão do Kubernetes incluindo suas propriedades. A saída inclui segredos que você deve proteger. Certifique-se de não incluir esses segredos no controle do código-fonte. Verifique também se nenhum segredo está presente nos logs do seu comando ou script. Para obter informações adicionais, consulte http://aka.ms/clisecrets.

az k8s-extension show --cluster-name
                      --cluster-type {appliances, connectedClusters, managedClusters, provisionedClusters}
                      --name
                      --resource-group
                      [--cluster-resource-provider --cluster-rp]

Exemplos

Mostrar detalhes de uma extensão do Kubernetes

az k8s-extension show --resource-group my-resource-group --cluster-name mycluster --cluster-type connectedClusters --name myextension

Parâmetros Obrigatórios

--cluster-name -c

Nome do cluster Kubernetes.

--cluster-type -t

Especifique clusters Arc ou clusters gerenciados AKS ou dispositivos Arc ou provisionedClusters.

Propriedade	Valor
Valores aceites:	appliances, connectedClusters, managedClusters, provisionedClusters

--name -n

Nome da instância de extensão.

--resource-group -g

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

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-resource-provider --cluster-rp

Nome do Provedor de Recursos de Cluster para este clusterType (Necessário para provisionedClusters).

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

Output format.

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 k8s-extension update

Atualize as propriedades mutáveis de uma extensão do Kubernetes.

Para atualizar ConfigSettings e ConfigProtectedSettings, consulte a documentação do serviço de extensão de cluster para verificar se há suporte para a atualização dessas propriedades antes de atualizá-las. A saída inclui segredos que você deve proteger. Certifique-se de não incluir esses segredos no controle do código-fonte. Verifique também se nenhum segredo está presente nos logs do seu comando ou script. Para obter informações adicionais, consulte http://aka.ms/clisecrets.

az k8s-extension update --cluster-name
                        --cluster-type {appliances, connectedClusters, managedClusters, provisionedClusters}
                        --name
                        --resource-group
                        [--auto-upgrade --auto-upgrade-minor-version {false, true}]
                        [--cluster-resource-provider --cluster-rp]
                        [--config --configuration-settings]
                        [--config-file --config-settings-file]
                        [--config-protected --config-protected-settings]
                        [--config-protected-file --config-protected-settings-file]
                        [--config-settings]
                        [--configuration-protected-settings]
                        [--configuration-protected-settings-file]
                        [--configuration-settings-file]
                        [--no-wait]
                        [--release-train]
                        [--version]
                        [--yes]

Exemplos

Atualizar uma extensão do Kubernetes

az k8s-extension update --resource-group my-resource-group --cluster-name mycluster --cluster-type connectedClusters --name myextension --auto-upgrade true/false --version extension-version --release-train stable --configuration-settings settings-key=settings-value --config-protected-settings protected-settings-key=protected-value --config-settings-file=config-settings-file --config-protected-file=protected-settings-file

Parâmetros Obrigatórios

--cluster-name -c

Nome do cluster Kubernetes.

--cluster-type -t

Especifique clusters Arc ou clusters gerenciados AKS ou dispositivos Arc ou provisionedClusters.

Propriedade	Valor
Valores aceites:	appliances, connectedClusters, managedClusters, provisionedClusters

--name -n

Nome da instância de extensão.

--resource-group -g

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

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--auto-upgrade --auto-upgrade-minor-version

Atualize automaticamente a versão secundária da instância de extensão.

Propriedade	Valor
Parameter group:	Version Arguments
Valores aceites:	false, true

--cluster-resource-provider --cluster-rp

Nome do Provedor de Recursos de Cluster para este clusterType (Necessário para provisionedClusters).

--config --configuration-settings

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.

Propriedade	Valor
Parameter group:	Configuration Arguments

--config-file --config-settings-file

Caminho do arquivo JSON para definições de configuração.

Propriedade	Valor
Parameter group:	Configuration Arguments

--config-protected --config-protected-settings

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

Propriedade	Valor
Parameter group:	Configuration Arguments

--config-protected-file --config-protected-settings-file

Caminho do arquivo JSON para configurações protegidas.

Propriedade	Valor
Parameter group:	Configuration Arguments

--config-settings

Preterido

A opção '--config-settings' foi preterida e será removida em uma versão futura. Em vez disso, use '--configuration-settings'.

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.

Propriedade	Valor
Parameter group:	Configuration Arguments

--configuration-protected-settings

Preterido

A opção '--configuration-protected-settings' foi preterida e será removida em uma versão futura. Use '--config-protected-settings' em vez disso.

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

Propriedade	Valor
Parameter group:	Configuration Arguments

--configuration-protected-settings-file

Preterido

A opção '--configuration-protected-settings-file' foi preterida e será removida em uma versão futura. Use '--config-protected-file' em vez disso.

Caminho do arquivo JSON para configurações protegidas.

Propriedade	Valor
Parameter group:	Configuration Arguments

--configuration-settings-file

Preterido

A opção '--configuration-settings-file' foi preterida e será removida em uma versão futura. Use '--config-settings-file' em vez disso.

Caminho do arquivo JSON para definições de configuração.

Propriedade	Valor
Parameter group:	Configuration Arguments

--no-wait

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

Propriedade	Valor
Default value:	False

--release-train

Especifique o trem de liberação para o tipo de extensão.

Propriedade	Valor
Parameter group:	Version Arguments

--version

Especifique a versão a ser instalada para a instância de extensão se --auto-upgrade-minor-version não estiver habilitado.

Propriedade	Valor
Parameter group:	Version Arguments

--yes -y

Ignore os prompts de 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

Output format.

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

Partilhar via

az k8s-extension

Comandos

az k8s-extension create

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az k8s-extension delete

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az k8s-extension list

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az k8s-extension show

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az k8s-extension update

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

Comentários