Set-AzureOSDisk

NAME Set-AzureOSDisk



SYNOPSIS

Modifies the host cache mode of an Azure virtual machine.





SYNTAX

Set-AzureOSDisk [-HostCaching] <String> [-ResizedSizeInGB] <Int32> -VM <IPersistentVM> [-Profile <AzureSMProfile>] [-InformationAction

<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]





DESCRIPTION

The Set-AzureOSDisk cmdlet modifies the host cache mode of the operating system disk of an Azure virtual machine. The supported host cache modes are

ReadOnly and ReadWrite. If you run this cmdlet on a virtual machine that is running, that virtual machine restarts.





PARAMETERS

-HostCaching <String>

Specifies the host cache attribute for the operating system disk. Valid values are:



-- ReadOnly



-- ReadWrite



Required? true

Position? 0

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-VM <IPersistentVM>

Specifies the virtual machine for which this cmdlet modifies the operating system disk. To obtain a virtual machine object, use the Get-AzureVM

cmdlet.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByValue, ByPropertyName)

Accept wildcard characters? false



-Profile <AzureSMProfile>

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InformationAction <ActionPreference>





Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InformationVariable <String>





Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ResizedSizeInGB <Int32>

Specifies a new size, in gigabytes, for the operating system disk. The size must be larger than the current size.



Required? true

Position? 1

Default value None

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



NOTES









-------------------------- Example 1: Set the host cache mode to ReadOnly by using the pipeline --------------------------



PS C:\\>Get-AzureVM -ServiceName "ContosoService" -Name "VirtualMachine02" | Set-AzureOSDisk -HostCaching "ReadOnly"



This command gets the virtual machine named VirtualMachine02 in the service named ContosoService by using the Get-AzureVM cmdlet. The command passes the

virtual machine to the current cmdlet by using the pipeline operator. The current cmdlet sets the host cache mode of the operating system disk of that

virtual machine to be ReadOnly.

-------------------------- Example 2: Set the host cache mode to ReadWrite --------------------------



PS C:\\>$myVM2 = Get-AzureVM -ServiceName "ContosoService" -Name "VirtualMachine02"

PS C:\\> Set-AzureOSDisk "ReadWrite" -VM $myVM2



The first command gets the virtual machine named VirtualMachine02 in the service named ContosoService, and then stores it in the variable.



RELATED LINKS

Add-AzureVMImage

Get-AzureOSDisk

Get-AzureVM

Get-AzureVMImage

Set-AzureDataDisk

Update-AzureVM