az vm extension

Gerenciar extensões em VMs.

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

Comandos

Nome	Description	Tipo	Status
az vm extension delete	Excluir a operação para excluir a extensão.	Core	GA
az vm extension image	Localize as extensões de VM disponíveis para uma assinatura e uma região.	Core	GA
az vm extension image list	Liste as informações sobre extensões disponíveis.	Core	GA
az vm extension image list-names	Liste os nomes das extensões disponíveis.	Core	GA
az vm extension image list-versions	Liste as versões para extensões disponíveis.	Core	GA
az vm extension image show	Exibir informações de uma extensão.	Core	GA
az vm extension list	Liste as extensões anexadas a uma VM.	Core	GA
az vm extension set	Defina extensões para uma VM.	Core	GA
az vm extension show	Exibir informações sobre extensões anexadas a uma VM.	Core	GA
az vm extension wait	Coloque a CLI em um estado de espera até que uma condição seja atendida.	Core	GA

az vm extension delete

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

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

Exemplos

Use um nome de VM e uma extensão 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 contêm 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

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 --vm-extension-name -n

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

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

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

--vm-name

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

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

Liste 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

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

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

--vm-name

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

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

Defina extensões para uma VM.

Obter detalhes da extensão de 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 do 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 VMs especificadas 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.

Propriedade	Valor
Valor de:	az vm extension image list

--publisher

O nome do editor de extensão.

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.

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

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

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

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

--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 escolherá ou atualizará automaticamente para a versão secundária mais recente, mesmo que a extensão seja reimplantada.

Propriedade	Valor
Valor padrão:	False
Valores aceitos:	false, true

--no-auto-upgrade-minor-version

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

Propriedade	Valor
Valor padrão:	False
Valores aceitos:	false, true

--no-wait

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

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

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

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

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

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

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

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

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

--instance-view

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

Propriedade	Valor
Valor padrão:	False

--name -n

Nome da extensão.

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

--vm-name

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

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

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

az vm extension wait [--created]
                     [--custom]
                     [--deleted]
                     [--exists]
                     [--expand]
                     [--ids]
                     [--interval]
                     [--name --vm-extension-name]
                     [--resource-group]
                     [--subscription]
                     [--timeout]
                     [--updated]
                     [--vm-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.

--created

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

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments
Valor padrão:	False

--custom

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

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments

--deleted

Aguarde até ser excluído.

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments
Valor padrão:	False

--exists

Aguarde até que o recurso exista.

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments
Valor padrão:	False

--expand

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

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

--interval

Intervalo de sondagem em segundos.

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments
Valor padrão:	30

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

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

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

--timeout

Espera máxima em segundos.

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments
Valor padrão:	3600

--updated

Aguarde até que seja atualizado com provisioningState em 'Succeeded'.

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments
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 .

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