Set-AzureOSDisk
Modifies the host cache mode of an Azure virtual machine.
Note
The cmdlets referenced in this documentation are for managing legacy Azure resources that use Service Management APIs. See the Az PowerShell module for cmdlets to manage Azure Resource Manager resources.
Syntax
Set-AzureOSDisk
[-HostCaching] <String>
-VM <IPersistentVM>
[-Profile <AzureSMProfile>]
[-InformationAction <ActionPreference>]
[-InformationVariable <String>]
[<CommonParameters>] 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.
Examples
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:\> $VM = Get-AzureVM -ServiceName "ContosoService" -Name "VirtualMachine02"
PS C:\> Set-AzureOSDisk "ReadWrite" -VM $myVM2The first command gets the virtual machine named VirtualMachine02 in the service named ContosoService, and then stores it in the variable.
The second command sets the host cache mode of the operating system disk of that virtual machine to be ReadWrite.
Parameters
-HostCaching
Specifies the host cache attribute for the operating system disk. Valid values are:
- ReadOnly
- ReadWrite
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InformationAction
Specifies how this cmdlet responds to an information event.
The acceptable values for this parameter are:
- Continue
- Ignore
- Inquire
- SilentlyContinue
- Stop
- Suspend
| Type: | ActionPreference |
| Aliases: | infa |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InformationVariable
Specifies an information variable.
| Type: | String |
| Aliases: | iv |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Profile
Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.
| Type: | AzureSMProfile |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResizedSizeInGB
Specifies a new size, in gigabytes, for the operating system disk. The size must be larger than the current size.
| Type: | Int32 |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VM
Specifies the virtual machine for which this cmdlet modifies the operating system disk. To obtain a virtual machine object, use the Get-AzureVM cmdlet.
| Type: | IPersistentVM |
| Aliases: | InputObject |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |