az vm extension

  • Referência

Gerenciar extensões em VMs.

As extensões são pequenos aplicativos que fornecem tarefas de configuração e automação pós-implantação em máquinas virtuais do Azure. Por exemplo, se uma máquina virtual exigir a instalação de software, proteção antivírus ou a configuração do Docker, uma extensão da VM poderá ser usada para concluir essas tarefas. Extensões podem ser agrupadas com uma nova implantação de máquina virtual ou executar qualquer sistema existente.

Comandos

Nome Description Tipo Status
az vm extension delete

Exclua a operação para excluir a extensão.

 Núcleo GA
az vm extension image

Encontre as extensões de VM disponíveis para uma assinatura e região.

 Núcleo GA
az vm extension image list

Liste as informações sobre as extensões disponíveis.

 Núcleo GA
az vm extension image list-names

Liste os nomes das extensões disponíveis.

 Núcleo GA
az vm extension image list-versions

Liste as versões para extensões disponíveis.

 Núcleo GA
az vm extension image show

Exibir informações de uma extensão.

 Núcleo GA
az vm extension list

Listar as extensões anexadas a uma VM.

 Núcleo GA
az vm extension set

Defina extensões para uma VM.

 Núcleo GA
az vm extension show

Exibir informações sobre extensões anexadas a uma VM.

 Núcleo GA
az vm extension wait

Coloque a CLI em um estado de espera até que uma condição de uma extensão de máquina virtual seja atendida.

 Núcleo GA

az vm extension delete

Editar

Exclua a operação para excluir a extensão.

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

Exemplos

Use um nome e uma extensão de VM para excluir uma extensão de uma VM.

az vm extension delete -g MyResourceGroup --vm-name MyVm -n MyExtensionName

Exclua extensões com IDs que contenham a cadeia de caracteres "MyExtension" de uma VM.

az vm extension delete --ids $(az resource list --query "[?contains(name, 'MyExtension')].id" -o tsv)

Parâmetros Opcionais

--ids

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

--name --vm-extension-name -n

O nome da extensão da máquina virtual.

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

--vm-name

O nome da Máquina Virtual. Você pode configurar o padrão usando az configure --defaults vm=<name>o .

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

Editar

Listar as extensões anexadas a uma VM.

az vm extension list [--ids]
                     [--resource-group]
                     [--subscription]
                     [--vm-name]

Exemplos

Listar extensões anexadas a uma VM nomeada.

az vm extension list -g MyResourceGroup --vm-name MyVm

Parâmetros Opcionais

--ids

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

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

--vm-name

O nome da Máquina Virtual. Você pode configurar o padrão usando az configure --defaults vm=<name>o .

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 vm extension set

Editar

Defina extensões para uma VM.

Obtenha detalhes da extensão em az vm extension image list.

az vm extension set --name
                    --publisher
                    [--enable-auto-upgrade {false, true}]
                    [--extension-instance-name]
                    [--force-update]
                    [--ids]
                    [--no-auto-upgrade {false, true}]
                    [--no-auto-upgrade-minor-version {false, true}]
                    [--no-wait]
                    [--protected-settings]
                    [--resource-group]
                    [--settings]
                    [--subscription]
                    [--version]
                    [--vm-name]

Exemplos

Adicione uma conta de usuário a uma VM Linux.

az vm extension set -n VMAccessForLinux --publisher Microsoft.OSTCExtensions --version 1.4 \
    --vm-name MyVm --resource-group MyResourceGroup \
    --protected-settings '{"username":"user1", "ssh_key":"ssh_rsa ..."}'

Adicione uma extensão customScript à(s) VM(s) especificada(s) por --ids.

az vm extension set -n customScript --publisher Microsoft.Azure.Extensions --ids {vm_id}

Adicione uma extensão e habilite a atualização automática pela plataforma se houver uma versão mais recente da extensão disponível.

az vm extension set -n extName --publisher publisher --vm-name MyVM -g MyResourceGroup \
--enable-auto-upgrade true

Parâmetros Exigidos

--name -n

Nome da extensão.

Valor de: az vm extension image list
--publisher

O nome do editor da extensão.

Parâmetros Opcionais

--enable-auto-upgrade

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

Valores aceitos: false, true
--extension-instance-name

Nome da instância de extensão, que pode ser personalizada. Padrão: nome da extensão.

--force-update

Força a atualização mesmo que a configuração da extensão não tenha sido alterada.

Valor padrão: False
--ids

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

--no-auto-upgrade
Preterido

A opção '--no-auto-upgrade' foi preterida e será removida em uma versão futura. Em vez disso, use '--no-auto-upgrade-minor-version'.

Se definido, o serviço de extensão não selecionará ou atualizará automaticamente para a versão secundária mais recente, mesmo se a extensão for reimplantada.

Valores aceitos: false, true
Valor padrão: False
--no-auto-upgrade-minor-version

Se definido, o serviço de extensão não selecionará ou atualizará automaticamente para a versão secundária mais recente, mesmo se a extensão for reimplantada.

Valores aceitos: false, true
Valor padrão: False
--no-wait

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

Valor padrão: False
--protected-settings

Configurações protegidas no formato JSON para informações confidenciais, como credenciais. Um caminho de arquivo JSON também é aceito.

--resource-group -g

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

--settings

Configurações de extensão no formato JSON. Um caminho de arquivo JSON também é aceito.

--subscription

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

--version

A versão da extensão. Para fixar a versão da extensão a esse valor, especifique --no-auto-upgrade-minor-version.

--vm-name

O nome da Máquina Virtual. Você pode configurar o padrão usando az configure --defaults vm=<name>o .

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

Editar

Exibir informações sobre extensões anexadas a uma VM.

az vm extension show [--ids]
                     [--instance-view]
                     [--name]
                     [--resource-group]
                     [--subscription]
                     [--vm-name]

Exemplos

Use o nome da VM e o nome da extensão para mostrar as extensões anexadas a uma VM.

az vm extension show -g MyResourceGroup --vm-name MyVm -n extension_name

Parâmetros Opcionais

--ids

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

--instance-view

O modo de exibição de instância de uma extensão de máquina virtual.

Valor padrão: False
--name -n

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

--vm-name

O nome da Máquina Virtual. Você pode configurar o padrão usando az configure --defaults vm=<name>o .

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 vm extension wait

Editar

Coloque a CLI em um estado de espera até que uma condição de uma extensão de máquina virtual seja atendida.

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

Exemplos

Coloque a CLI em um estado de espera até que uma condição de uma extensão de máquina virtual seja atendida. (gerado automaticamente)

az vm extension wait --created --name MyExtension --resource-group MyResourceGroup --vm-name MyVm

Coloque a CLI em um estado de espera até que uma condição de uma extensão de máquina virtual seja atendida. (gerado automaticamente)

az vm extension wait --exists --name MyExtension --resource-group MyResourceGroup --vm-name MyVm

Coloque a CLI em um estado de espera até que uma condição de uma extensão de máquina virtual seja atendida. (gerado automaticamente)

az vm extension wait --ids @- --name MyExtension --subscription MySubscription --updated --vm-name MyVm

Parâmetros Opcionais

--created

Aguarde até criar 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
--ids

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

--interval

Intervalo de sondagem em segundos.

Valor padrão: 30
--name -n

Nome da 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é que seja atualizado com provisioningState em 'Succeeded'.

Valor padrão: False
--vm-name

O nome da Máquina Virtual. Você pode configurar o padrão usando az configure --defaults vm=<name>o .

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.