Set-AzVMExtension

Module:

Az.Compute Module

Updates extension properties or adds an extension to a virtual machine.

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

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

The Set-AzVMExtension cmdlet updates properties for existing Virtual Machine Extensions or adds an extension to a virtual machine.

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

The first two commands use standard Windows PowerShell syntax to create hash tables, and then stores those hash tables in the $Settings and $ProtectedSettings variables. For more information, type Get-Help about_Hash_Tables. The second command includes two values previously created and stored in variables. The final command modifies an extension of the virtual machine named VirtualMachine22 in ResourceGroup11 according to the contents of $Settings and $ProtectedSettings. The command specifies other required information that includes the publisher and the extension type.

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

The first two commands create strings that contain settings, and then stores them in the $SettingsString and $ProtectedSettingsString variables. The final command modifies an extension of the virtual machine named VirtualMachine22 in ResourceGroup11 according to the contents of $SettingsString and $ProtectedSettingsString. The command specifies other required information that includes the publisher and the extension type.

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.