Set-​Azure​Rm​VM​Operating​System

Sets operating system properties for a virtual machine.

Syntax

Set-AzureRmVMOperatingSystem
   [-VM] <PSVirtualMachine>
   [-Linux]
   [-ComputerName] <String>
   [-Credential] <PSCredential>
   [[-CustomData] <String>]
   [-DisablePasswordAuthentication]
   [<CommonParameters>]
Set-AzureRmVMOperatingSystem
   [-VM] <PSVirtualMachine>
   [-Windows]
   [-ComputerName] <String>
   [-Credential] <PSCredential>
   [[-CustomData] <String>]
   [-ProvisionVMAgent]
   [-EnableAutoUpdate]
   [[-TimeZone] <String>]
   [-WinRMHttp]
   [<CommonParameters>]
Set-AzureRmVMOperatingSystem
   [-VM] <PSVirtualMachine>
   [-WinRMHttps]
   [-WinRMCertificateUrl] <Uri>
   [-Windows]
   [-ComputerName] <String>
   [-Credential] <PSCredential>
   [[-CustomData] <String>]
   [-ProvisionVMAgent]
   [-EnableAutoUpdate]
   [[-TimeZone] <String>]
   [-WinRMHttp]
   [<CommonParameters>]

Description

The Set-AzureRmVMOperatingSystem cmdlet sets operating system properties for a virtual machine. You can specify logon credentials, computer name, and operating system type.

Examples

Example 1: Set operating system properties for a new virtual machines

PS C:\>$SecurePassword = ConvertTo-SecureString "Password" -AsPlainText -Force
PS C:\> $Credential = New-Object System.Management.Automation.PSCredential ("FullerP", $SecurePassword); 
PS C:\> $AvailabilitySet = Get-AzureRmAvailabilitySet -ResourceGroupName "ResourceGroup11" -Name "AvailabilitySet03" 
PS C:\> $VirtualMachine = New-AzureRmVMConfig -VMName "VirtualMachine07" -VMSize "Standard_A1" -AvailabilitySetID $AvailabilitySet.Id
PS C:\> $ComputerName = "ContosoVM122"
PS C:\> $WinRMCertUrl = "http://keyVaultName.vault.azure.net/secrets/secretName/secretVersion"
PS C:\> $TimeZone = "Pacific Standard Time"
PS C:\> $CustomData = "echo 'Hello World'"
PS C:\> $VirtualMachine = Set-AzureRmVMOperatingSystem -VM $$VirtualMachine -Windows -ComputerName $ComputerName -Credential $Credential -CustomData $CustomData -WinRMHttp -WinRMHttps -WinRMCertificateUrl $WinRMCertUrl -ProvisionVMAgent -EnableAutoUpdate -TimeZone $TimeZone

The first command converts a password to a secure string, and then stores it in the $SecurePassword variable. For more information, type Get-Help ConvertTo-SecureString.

The second command creates a credential for the user FullerP and the password stored in $SecurePassword, and then stores the credential in the $Credential variable. For more information, type Get-Help New-Object.

The third command gets the availability set named AvailablitySet03 in the resource group named ResourceGroup11, and then stores that object in the $AvailabilitySet variable.

The fourth command creates a virtual machine object, and then stores it in the $VirtualMachine variable. The command assigns a name and size to the virtual machine. The virtual machine belongs to the availability set stored in $AvailabilitySet.

The next four commands assign values to variables to use in the following command. Because you could specify these strings directly in the Set-AzureRmVMOperatingSystem command, this approach is used only for readability. However, you might use an approach such as this in scripts.

The final command sets operating system properties for the virtual machine stored in $VirtualMachine. The command uses the credentials stored in $Credential. The command uses variables assigned in previous commands for some parameters.

Required Parameters

-ComputerName

Specifies the name of the computer.

Type:String
Position:3
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Credential

Specifies the user name and password for the virtual machine as a PSCredential object. To obtain a credential, use the Get-Credential cmdlet. For more information, type Get-Help Get-Credential.

Type:PSCredential
Position:4
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Linux

Indicates that the type of operating system is Linux.

Type:SwitchParameter
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-VM

Specifies the local virtual machine object on which to set operating system properties. To obtain a virtual machine object, use the Get-AzureRmVM cmdlet. Create a virtual machine object by using the New-AzureRmVMConfig cmdlet.

Type:PSVirtualMachine
Aliases:VMProfile
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName, ByValue)
Accept wildcard characters:False
-WinRMCertificateUrl

Specifies the URI of a WinRM certificate. This needs to be stored in a Key Vault.

Type:Uri
Position:11
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-WinRMHttps

Indicates that this operating system uses HTTPS WinRM.

Type:SwitchParameter
Position:10
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Windows

Indicates that the type of operating system is Windows.

Type:SwitchParameter
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-CustomData

Specifies a base-64 encoded string of custom data. This is decoded to a binary array that is saved as a file on the virtual machine. The maximum length of the binary array is 65535 bytes.

Type:String
Position:5
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-DisablePasswordAuthentication

Indicates that this cmdlet disables password authentication.

Type:SwitchParameter
Position:6
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-EnableAutoUpdate

Indicates that this cmdlet enables auto update.

Type:SwitchParameter
Position:7
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ProvisionVMAgent

Indicates that the settings require that the virtual machine agent be installed on the virtual machine.

Type:SwitchParameter
Position:6
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-TimeZone

Specifies the time zone for the virtual machine.

Type:String
Position:8
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-WinRMHttp

Indicates that this operating system uses HTTP WinRM.

Type:SwitchParameter
Position:9
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False