az azurestackhci virtualmachine extension

  • Experimental
  • Referência

Nota

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

O grupo de comando 'azurestackhci' é experimental e está em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Gerencie a extensão virtualmachine com azurestackhci.

Comandos

Name Description Tipo Estado
az azurestackhci virtualmachine extension create

Crie uma extensão de máquina virtual.

 Extensão Experimental
az azurestackhci virtualmachine extension delete

Exclua uma extensão de máquina virtual.

 Extensão Experimental
az azurestackhci virtualmachine extension list

Liste todas as extensões para uma máquina virtual.

 Extensão Experimental
az azurestackhci virtualmachine extension show

Obtenha os detalhes de uma extensão virtualmachine.

 Extensão Experimental
az azurestackhci virtualmachine extension update

Atualize uma extensão de máquina virtual.

 Extensão Experimental
az azurestackhci virtualmachine extension wait

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

 Extensão Experimental

az azurestackhci virtualmachine extension create

Experimental

O grupo de comando 'azurestackhci' é experimental e está em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Crie uma extensão de máquina virtual.

az azurestackhci virtualmachine extension create --name
                                                 --resource-group
                                                 --virtualmachine-name
                                                 [--auto-upgrade-minor {false, true}]
                                                 [--enable-auto-upgrade {false, true}]
                                                 [--extension-type]
                                                 [--force-update-tag]
                                                 [--inst-handler-version]
                                                 [--instance-view-type]
                                                 [--location]
                                                 [--protected-settings]
                                                 [--publisher]
                                                 [--settings]
                                                 [--status]
                                                 [--tags]
                                                 [--type-handler-version]

Exemplos

PutExtension

az azurestackhci virtualmachine extension create --resource-group "test-rg" --location "West US2" --name "test-extension" --extension-type "CustomScriptExtension" --publisher "Microsoft.Compute" --settings '{"commandToExecute":"hostname"}' --type-handler-version "1.10" --virtualmachine-name "test-virtualmachine"

Parâmetros Obrigatórios

--name

O nome da extensão.

--resource-group -g

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

--virtualmachine-name

O nome da máquina virtual onde a extensão deve ser criada ou atualizada.

Parâmetros Opcionais

--auto-upgrade-minor

Indique se a extensão deve usar uma versão secundária mais recente, se houver uma disponível no momento da implantação. Uma vez implantada, no entanto, a extensão não atualizará versões secundárias, a menos que seja reimplantada, mesmo com essa propriedade definida como true.

valores aceites: false, true
--enable-auto-upgrade

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

valores aceites: false, true
--extension-type

Especifique o tipo da extensão virtualmachine; um exemplo é CustomScriptExtension.

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

--inst-handler-version

Especifique a versão do manipulador de script.

--instance-view-type

Especifique o tipo de extensão; um exemplo é "CustomScriptExtension".

--location -l

Localização. Valores de: az account list-locations. Você pode configurar o local padrão usando az configure --defaults location=<location>.

--protected-settings

A extensão pode conter protectedSettings ou protectedSettingsFromKeyVault ou nenhuma configuração protegida. Valor esperado: json-string/json-file/@json-file.

--publisher

O nome do editor do manipulador de extensão virtualmachine.

--settings

Json formatou configurações públicas para a extensão virtualmachine.

--status

Status da exibição da instância.

--tags

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

--type-handler-version

Especifique a versão do manipulador de script.

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az azurestackhci virtualmachine extension delete

Experimental

O grupo de comando 'azurestackhci' é experimental e está em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Exclua uma extensão de máquina virtual.

az azurestackhci virtualmachine extension delete [--ids]
                                                 [--name]
                                                 [--resource-group]
                                                 [--subscription]
                                                 [--virtualmachine-name]
                                                 [--yes]

Exemplos

DeleteExtension

az azurestackhci virtualmachine extension delete --name "test-extension" --virtualmachine-name "test-virtualmachine" --resource-group "test-rg"

Parâmetros Opcionais

--ids

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

--name

O nome da extensão da máquina.

--resource-group -g

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--virtualmachine-name

O nome da máquina virtual da qual a extensão deve ser excluída.

--yes -y

Não solicite confirmação.

valor predefinido: False
Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az azurestackhci virtualmachine extension list

Experimental

O grupo de comando 'azurestackhci' é experimental e está em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Liste todas as extensões para uma máquina virtual.

az azurestackhci virtualmachine extension list --resource-group
                                               --virtualmachine-name

Exemplos

ListExtensions

az azurestackhci virtualmachine extension list --virtualmachine-name "test-virtualmachine" --resource-group "test-rg"

Parâmetros Obrigatórios

--resource-group -g

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

--virtualmachine-name

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

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az azurestackhci virtualmachine extension show

Experimental

O grupo de comando 'azurestackhci' é experimental e está em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Obtenha os detalhes de uma extensão virtualmachine.

az azurestackhci virtualmachine extension show [--ids]
                                               [--name]
                                               [--resource-group]
                                               [--subscription]
                                               [--virtualmachine-name]

Exemplos

GetExtension

az azurestackhci virtualmachine extension show --name "test-extension" --virtualmachine-name "test-virtualmachine" --resource-group "test-rg"

Parâmetros Opcionais

--ids

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

--name

O nome da extensão da máquina.

--resource-group -g

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--virtualmachine-name

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

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az azurestackhci virtualmachine extension update

Experimental

O grupo de comando 'azurestackhci' é experimental e está em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Atualize uma extensão de máquina virtual.

az azurestackhci virtualmachine extension update --name
                                                 [--auto-upgrade-minor {false, true}]
                                                 [--enable-auto-upgrade {false, true}]
                                                 [--extension-type]
                                                 [--force-update-tag]
                                                 [--ids]
                                                 [--protected-settings]
                                                 [--publisher]
                                                 [--resource-group]
                                                 [--settings]
                                                 [--subscription]
                                                 [--tags]
                                                 [--type-handler-version]
                                                 [--virtualmachine-name]

Exemplos

UpdateExtension

az azurestackhci virtualmachine extension update --resource-group "test-rg" --name "test-extension" --extension-type "CustomScriptExtension" --virtualmachine-name "test-virtualmachine" --publisher "Microsoft.Compute" --settings '{"commandToExecute":"hostname"}' --type-handler-version "1.10"

Parâmetros Obrigatórios

--name

O nome da extensão.

Parâmetros Opcionais

--auto-upgrade-minor

Indique se a extensão deve usar uma versão secundária mais recente, se houver uma disponível no momento da implantação. Uma vez implantada, no entanto, a extensão não atualizará versões secundárias, a menos que seja reimplantada, mesmo com essa propriedade definida como true.

valores aceites: false, true
--enable-auto-upgrade

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

valores aceites: false, true
--extension-type

Especifique o tipo de extensão; um exemplo é "CustomScriptExtension".

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

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

--protected-settings

A extensão pode conter protectedSettings ou protectedSettingsFromKeyVault ou nenhuma configuração protegida. Valor esperado: json-string/json-file/@json-file.

--publisher

O nome do editor do manipulador de extensão.

--resource-group -g

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

--settings

Json formatou configurações públicas para a extensão. Valor esperado: json-string/json-file/@json-file.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--tags

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

--type-handler-version

Especifique a versão do manipulador de script.

--virtualmachine-name

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

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az azurestackhci virtualmachine extension wait

Experimental

O grupo de comando 'azurestackhci' é experimental e está em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

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

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

Exemplos

Pause a execução da próxima linha do script CLI até que a extensão virtualmachine seja criada com êxito.

az azurestackhci virtualmachine extension wait --name "test-extension" --virtualmachine-name "test-virtualmachine" --resource-group "test-rg" --created

Pause a execução da próxima linha do script CLI até que a extensão virtualmachine seja atualizada com êxito.

az azurestackhci virtualmachine extension wait --name "test-extension" --virtualmachine-name "test-virtualmachine" --resource-group "test-rg" --updated

Pause a execução da próxima linha do script CLI até que a extensão virtualmachine seja excluída com êxito.

az azurestackhci virtualmachine extension wait --name "test-extension" --virtualmachine-name "test-virtualmachine" --resource-group "test-rg" --deleted

Parâmetros Opcionais

--created

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

valor predefinido: 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 predefinido: False
--exists

Aguarde até que o recurso exista.

valor predefinido: False
--ids

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

--interval

Intervalo de sondagem em segundos.

valor predefinido: 30
--name

O nome da extensão da máquina.

--resource-group -g

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--timeout

Espera máxima em segundos.

valor predefinido: 3600
--updated

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

valor predefinido: False
--virtualmachine-name

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

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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