az connectedmachine extension

  • Referência

Observação

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

Gerencie uma extensão de VM em um servidor habilitado para Azure Arc.

Comandos

Nome Description Tipo Status
az connectedmachine extension create

Criar uma extensão.

 Extensão GA
az connectedmachine extension delete

Exclua uma extensão.

 Extensão GA
az connectedmachine extension image

Gerencie metadados de extensão de VM disponíveis para servidores habilitados para Azure Arc.

 Extensão GA
az connectedmachine extension image list

Liste todas as versões de extensão com base no local, editor, extensionType.

 Extensão GA
az connectedmachine extension image show

Obtenha metadados de extensão com base no local, editor, extensionType e versão.

 Extensão GA
az connectedmachine extension list

Obtenha todas as extensões de um computador que não seja do Azure.

 Extensão GA
az connectedmachine extension show

Mostrar uma extensão de um computador que não é do Azure.

 Extensão GA
az connectedmachine extension update

Atualize uma extensão.

 Extensão GA
az connectedmachine extension wait

Coloque a CLI em um estado de espera até que uma condição seja atendida.

 Extensão GA

az connectedmachine extension create

Criar uma extensão.

az connectedmachine extension create --extension-name
                                     --machine-name
                                     --resource-group
                                     [--auto-upgrade-min {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--enable-auto-upgrade {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--force-update-tag]
                                     [--instance-view]
                                     [--location]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--protected-settings]
                                     [--publisher]
                                     [--settings]
                                     [--tags]
                                     [--type]
                                     [--type-handler-version]

Exemplos

Comando de exemplo para criação de extensão

az connectedmachine extension create --name CustomScriptExtension --location eastus2euap --type CustomScriptExtension --publisher Microsoft.Compute --type-handler-version 1.10 --machine-name myMachine --resource-group myResourceGroup

Parâmetros Exigidos

--extension-name --name -n

O nome da extensão do computador.

--machine-name

O nome do computador em que a extensão deve ser criada ou atualizada.

--resource-group -g

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

Parâmetros Opcionais

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

Indica se a extensão deve usar uma versão secundária mais recente, se houver uma disponível no momento da implantação. Após a implantação, no entanto, a extensão não atualizará as versões secundárias, a menos que seja reimplantada, mesmo com essa propriedade definida como verdadeira.

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--enable-auto-upgrade --enable-automatic-upgrade

Indica se a extensão deve ser atualizada automaticamente pela plataforma se houver uma versão mais recente disponível.

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--force-update-tag

Como o manipulador de extensão deve ser forçado a atualizar mesmo que a configuração da extensão não tenha sido alterada.

--instance-view

A exibição de instância de extensão de máquina. Suporte a sintaxe abreviada, json-file e yaml-file. Tente "??" para mostrar mais.

--location -l

A localização geográfica onde o recurso reside Quando não especificado, o local do grupo de recursos será usado.

--no-wait

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

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--protected-settings

A extensão pode conter protectedSettings ou protectedSettingsFromKeyVault ou nenhuma configuração protegida. Suporte json-file e yaml-file.

--publisher

O nome do editor do manipulador de extensão.

--settings

Configurações públicas formatadas em Json para a extensão. Suporte json-file e yaml-file.

--tags

Tags de recursos. Suporte a sintaxe abreviada, json-file e yaml-file. Tente "??" para mostrar mais.

--type

Especifica o tipo da extensão; um exemplo é "CustomScriptExtension".

--type-handler-version

Especifica a versão do manipulador de script.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

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

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

--subscription

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

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az connectedmachine extension delete

Exclua uma extensão.

az connectedmachine extension delete [--extension-name]
                                     [--ids]
                                     [--machine-name]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--resource-group]
                                     [--subscription]
                                     [--yes]

Exemplos

Exemplo de comando para exclusão de extensão

az connectedmachine extension delete --name myName --machine-name myMachine --resource-group myResourceGroup

Parâmetros Opcionais

--extension-name --name -n

O nome da extensão do computador.

--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 do recurso".

--machine-name

O nome do computador em que a extensão deve ser excluída.

--no-wait

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

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

--subscription

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

--yes -y

Não solicite confirmação.

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

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

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

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

--subscription

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

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az connectedmachine extension list

Obtenha todas as extensões de um computador que não seja do Azure.

az connectedmachine extension list --machine-name
                                   --resource-group
                                   [--expand]
                                   [--max-items]
                                   [--next-token]

Exemplos

Exemplo de comando para lista de extensões

az connectedmachine extension list --machine-name myMachine --resource-group myResourceGroup

Parâmetros Exigidos

--machine-name

O nome da máquina que contém a 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

--expand

A expressão de expansão a ser aplicada na operação.

--max-items

Número total de itens a serem retornados na saída do comando. Se o número total de itens disponíveis for maior que o valor especificado, um token será fornecido na saída do comando. Para retomar a paginação, forneça o valor do token no --next-token argumento de um comando subsequente.

--next-token

Token para especificar por onde começar a paginar. Esse é o valor do token de uma resposta truncada anteriormente.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

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

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

--subscription

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

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az connectedmachine extension show

Mostrar uma extensão de um computador que não é do Azure.

az connectedmachine extension show [--extension-name]
                                   [--ids]
                                   [--machine-name]
                                   [--resource-group]
                                   [--subscription]

Exemplos

Exemplo de comando para a extensão show

az connectedmachine extension show --name CustomScriptExtension --machine-name myMachine --resource-group myResourceGroup

Parâmetros Opcionais

--extension-name --name -n

O nome da extensão do computador.

--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 do recurso".

--machine-name

O nome da máquina que contém a extensão.

--resource-group -g

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

--subscription

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

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

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

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

--subscription

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

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az connectedmachine extension update

Atualize uma extensão.

az connectedmachine extension update [--add]
                                     [--auto-upgrade-min {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--enable-auto-upgrade {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--extension-name]
                                     [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--force-update-tag]
                                     [--ids]
                                     [--instance-view]
                                     [--machine-name]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--protected-settings]
                                     [--publisher]
                                     [--remove]
                                     [--resource-group]
                                     [--set]
                                     [--settings]
                                     [--subscription]
                                     [--tags]
                                     [--type]
                                     [--type-handler-version]

Exemplos

Exemplo de comando para atualização de extensão

az connectedmachine extension update --name CustomScriptExtension --type CustomScriptExtension --publisher Microsoft.Compute --type-handler-version 1.10 --machine-name myMachine --resource-group myResourceGroup

Parâmetros Opcionais

--add

Adicione um objeto a uma lista de objetos especificando um par de caminho e um valor-chave. Exemplo: --add property.listProperty <key=value, string ou string> JSON.

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

Indica se a extensão deve usar uma versão secundária mais recente, se houver uma disponível no momento da implantação. Após a implantação, no entanto, a extensão não atualizará as versões secundárias, a menos que seja reimplantada, mesmo com essa propriedade definida como verdadeira.

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--enable-auto-upgrade --enable-automatic-upgrade

Indica se a extensão deve ser atualizada automaticamente pela plataforma se houver uma versão mais recente disponível.

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--extension-name --name -n

O nome da extensão do computador.

--force-string

Ao usar 'set' ou 'add', preserve os literais de string em vez de tentar converter em JSON.

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--force-update-tag

Como o manipulador de extensão deve ser forçado a atualizar mesmo que a configuração da extensão não tenha sido alterada.

--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 do recurso".

--instance-view

A exibição de instância de extensão de máquina. Suporte a sintaxe abreviada, json-file e yaml-file. Tente "??" para mostrar mais.

--machine-name

O nome da máquina que contém a extensão.

--no-wait

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

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--protected-settings

A extensão pode conter protectedSettings ou protectedSettingsFromKeyVault ou nenhuma configuração protegida. Suporte json-file e yaml-file.

--publisher

O nome do editor do manipulador de extensão.

--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list OR --remove propertyToRemove.

--resource-group -g

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

--set

Atualize um objeto especificando um caminho de propriedade e um valor a ser definido. Exemplo: --set property1.property2=.

--settings

Configurações públicas formatadas em Json para a extensão. Suporte json-file e yaml-file.

--subscription

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

--tags

Tags de recursos. Suporte a sintaxe abreviada, json-file e yaml-file. Tente "??" para mostrar mais.

--type

Especifica o tipo da extensão; um exemplo é "CustomScriptExtension".

--type-handler-version

Especifica a versão do manipulador de script.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

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

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

--subscription

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

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az connectedmachine extension wait

Coloque a CLI em um estado de espera até que uma condição seja atendida.

az connectedmachine extension wait [--created]
                                   [--custom]
                                   [--deleted]
                                   [--exists]
                                   [--extension-name]
                                   [--ids]
                                   [--interval]
                                   [--machine-name]
                                   [--resource-group]
                                   [--subscription]
                                   [--timeout]
                                   [--updated]

Parâmetros Opcionais

--created

Aguarde até ser criado com 'provisioningState' em 'Succeeded'.

Valor padrão: False
--custom

Aguarde até que a condição satisfaça uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Aguarde até ser excluído.

Valor padrão: False
--exists

Aguarde até que o recurso exista.

Valor padrão: False
--extension-name --name -n

O nome da extensão do computador.

--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 do recurso".

--interval

Intervalo de sondagem em segundos.

Valor padrão: 30
--machine-name

O nome da máquina que contém a extensão.

--resource-group -g

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

--subscription

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

--timeout

Espera máxima em segundos.

Valor padrão: 3600
--updated

Aguarde até ser atualizado com provisioningState em 'Succeeded'.

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

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

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

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

--subscription

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

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.