Set-AzVMExtension
Atualiza as propriedades da extensão ou adiciona uma extensão a uma máquina virtual.
Sintaxe
Settings (Padrão)
Set-AzVMExtension
[-ResourceGroupName] <String>
[-VMName] <String>
-Publisher <String>
-ExtensionType <String>
-Name <String>
[-Settings <Hashtable>]
[-ProtectedSettings <Hashtable>]
[-EnableAutomaticUpgrade <Boolean>]
[-AsJob]
[-TypeHandlerVersion <String>]
[-Location <String>]
[-DisableAutoUpgradeMinorVersion]
[-ForceRerun <String>]
[-NoWait]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SettingString
Set-AzVMExtension
[-ResourceGroupName] <String>
[-VMName] <String>
-Publisher <String>
-ExtensionType <String>
-Name <String>
[-SettingString <String>]
[-ProtectedSettingString <String>]
[-EnableAutomaticUpgrade <Boolean>]
[-AsJob]
[-TypeHandlerVersion <String>]
[-Location <String>]
[-DisableAutoUpgradeMinorVersion]
[-ForceRerun <String>]
[-NoWait]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
O cmdlet Set-AzVMExtension atualiza as propriedades das Extensões de Máquina Virtual existentes ou adiciona uma extensão a uma máquina virtual.
Exemplos
Exemplo 1: modificar configurações usando tabelas de hash
$Settings = @{"fileUris" = "[]"; "commandToExecute" = ""};
$ProtectedSettings = @{"storageAccountName" = $stoname; "storageAccountKey" = $stokey};
Set-AzVMExtension -ResourceGroupName "ResourceGroup11" -Location "West US" -VMName "VirtualMachine22" -Name "ContosoTest" -Publisher "Contoso.Compute" -ExtensionType "CustomScriptExtension" -TypeHandlerVersion "1.1" -Settings $Settings -ProtectedSettings $ProtectedSettings;
Os dois primeiros comandos usam a sintaxe padrão do Windows PowerShell para criar tabelas de hash e, em seguida, armazenam essas tabelas de hash nas variáveis $Settings e $ProtectedSettings.
Para obter mais informações, digite Get-Help about_Hash_Tables.
O segundo comando inclui dois valores criados e armazenados anteriormente em variáveis.
O comando final modifica uma extensão da máquina virtual chamada VirtualMachine22 em ResourceGroup11 de acordo com o conteúdo de $Settings e $ProtectedSettings.
O comando especifica outras informações necessárias que incluem o editor e o tipo de extensão.
Exemplo 2: Modificar configurações usando cadeias de caracteres
$SettingsString = '{"fileUris":[],"commandToExecute":""}';
$ProtectedSettingsString = '{"storageAccountName":"' + $stoname + '","storageAccountKey":"' + $stokey + '"}';
Set-AzVMExtension -ResourceGroupName "ResourceGroup11" -Location "West US" -VMName "VirtualMachine22" -Name "CustomScriptExtension" -Publisher "Contoso.Compute" -ExtensionType "CustomScriptExtension" -TypeHandlerVersion "1.1" -SettingString $SettingsString -ProtectedSettingString $ProtectedSettingsString ;
Os dois primeiros comandos criam cadeias de caracteres que contêm configurações e, em seguida, as armazenam nas variáveis $SettingsString e $ProtectedSettingsString.
O comando final modifica uma extensão da máquina virtual chamada VirtualMachine22 em ResourceGroup11 de acordo com o conteúdo de $SettingsString e $ProtectedSettingsString.
O comando especifica outras informações necessárias que incluem o editor e o tipo de extensão.
Parâmetros
-AsJob
Executar cmdlet em segundo plano
Propriedades do parâmetro
Tipo: SwitchParameter
Valor padrão: None Dá suporte a curingas: False DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
-Confirm
Solicita sua confirmação antes de executar o cmdlet.
Propriedades do parâmetro
Tipo: SwitchParameter
Valor padrão: False Dá suporte a curingas: False DontShow: False Aliases: cf
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
-DefaultProfile
As credenciais, a conta, o locatário e a assinatura usados para comunicação com o Azure.
Propriedades do parâmetro
Tipo: IAzureContextContainer
Valor padrão: None Dá suporte a curingas: False DontShow: False Aliases: AzContext, AzureRmContext, AzureCredential
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
-DisableAutoUpgradeMinorVersion
Indica que esse cmdlet impede que o agente convidado do Azure atualize automaticamente as extensões para uma versão secundária mais recente.
Por padrão, esse cmdlet permite que o agente convidado atualize as extensões.
Propriedades do parâmetro
Tipo: SwitchParameter
Valor padrão: None Dá suporte a curingas: False DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: True Valor dos argumentos restantes: False
-EnableAutomaticUpgrade
Indica se a extensão deve ser atualizada automaticamente pela plataforma se houver uma versão mais recente da extensão disponível.
Propriedades do parâmetro
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
-ExtensionType
Especifica o tipo de extensão.
Propriedades do parâmetro
Tipo: String
Valor padrão: None Dá suporte a curingas: False DontShow: False Aliases: Tipo
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: True Valor do pipeline: False Valor do pipeline pelo nome da propriedade: True Valor dos argumentos restantes: False
-ForceRerun
Indica que esse cmdlet força uma nova execução da mesma configuração de extensão na máquina virtual sem desinstalar e reinstalar a extensão.
O valor pode ser qualquer cadeia de caracteres diferente do valor atual.
Se forceUpdateTag não for alterado, as atualizações nas configurações públicas ou protegidas ainda serão aplicadas pelo manipulador.
Propriedades do parâmetro
Tipo: String
Valor padrão: None Dá suporte a curingas: False DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: True Valor dos argumentos restantes: False
-Location
Especifica o local da máquina virtual.
Propriedades do parâmetro
Tipo: String
Valor padrão: None Dá suporte a curingas: False DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: True Valor dos argumentos restantes: False
-Name
Especifica o nome de uma extensão.
Propriedades do parâmetro
Tipo: String
Valor padrão: None Dá suporte a curingas: False DontShow: False Aliases: ExtensionName
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: True Valor do pipeline: False Valor do pipeline pelo nome da propriedade: True Valor dos argumentos restantes: False
-NoWait
Inicia a operação e retorna imediatamente, antes que a operação seja concluída. Para determinar se a operação foi concluída com êxito, use algum outro mecanismo.
Propriedades do parâmetro
Tipo: SwitchParameter
Valor padrão: None Dá suporte a curingas: False DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
-ProtectedSettings
Especifica a configuração privada para a extensão, como uma tabela de hash.
Esse cmdlet criptografa a configuração privada.
Propriedades do parâmetro
Tipo: Hashtable
Valor padrão: None Dá suporte a curingas: False DontShow: False
Conjuntos de parâmetros
Settings
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: True Valor dos argumentos restantes: False
-ProtectedSettingString
Especifica a configuração privada para a extensão, como uma cadeia de caracteres.
Esse cmdlet criptografa a configuração privada.
Propriedades do parâmetro
Tipo: String
Valor padrão: None Dá suporte a curingas: False DontShow: False
Conjuntos de parâmetros
SettingString
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: True Valor dos argumentos restantes: False
-Publisher
Especifica o nome do editor da extensão.
O editor fornece um nome quando registra uma extensão.
Propriedades do parâmetro
Tipo: String
Valor padrão: None Dá suporte a curingas: False DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: True Valor do pipeline: False Valor do pipeline pelo nome da propriedade: True Valor dos argumentos restantes: False
-ResourceGroupName
Especifica o nome do grupo de recursos da máquina virtual.
Propriedades do parâmetro
Tipo: String
Valor padrão: None Dá suporte a curingas: False DontShow: False
Conjuntos de parâmetros
(All)
Cargo: 0 Obrigatório: True Valor do pipeline: False Valor do pipeline pelo nome da propriedade: True Valor dos argumentos restantes: False
-Settings
Especifica a configuração pública para a extensão, como uma tabela de hash.
Esse cmdlet não criptografa a configuração pública.
Propriedades do parâmetro
Tipo: Hashtable
Valor padrão: None Dá suporte a curingas: False DontShow: False
Conjuntos de parâmetros
Settings
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: True Valor dos argumentos restantes: False
-SettingString
Especifica a configuração pública para a extensão, como uma cadeia de caracteres.
Esse cmdlet não criptografa a configuração pública.
Propriedades do parâmetro
Tipo: String
Valor padrão: None Dá suporte a curingas: False DontShow: False
Conjuntos de parâmetros
SettingString
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: True Valor dos argumentos restantes: False
-TypeHandlerVersion
Especifica a versão da extensão a ser usada para esta máquina virtual.
Propriedades do parâmetro
Tipo: String
Valor padrão: None Dá suporte a curingas: False DontShow: False Aliases: HandlerVersion, Versão
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: True Valor dos argumentos restantes: False
-VMName
Especifica o nome de uma máquina virtual.
Esse cmdlet modifica as extensões para a máquina virtual especificada por esse parâmetro.
Propriedades do parâmetro
Tipo: String
Valor padrão: None Dá suporte a curingas: False DontShow: False Aliases: NomeDoRecurso
Conjuntos de parâmetros
(All)
Cargo: 1 Obrigatório: True Valor do pipeline: False Valor do pipeline pelo nome da propriedade: True Valor dos argumentos restantes: False
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado.
O cmdlet não é executado.
Propriedades do parâmetro
Tipo: SwitchParameter
Valor padrão: False Dá suporte a curingas: False DontShow: False Aliases: wi
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters .
Saídas
