Set-AzureDataDisk
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
Set-AzureDataDisk
Sets the host-cache mode on an existing data disk object.
Syntax
Parameter Set: Default
Set-AzureDataDisk [-HostCaching] <String> [-LUN] <Int32> -VM <IPersistentVM> [ <CommonParameters>]
Detailed Description
This topic describes the cmdlet in the 0.8.10 version of the Microsoft Azure PowerShell module. To get the version of the module you're using, in the Azure PowerShell console, type (Get-Module -Name Azure).Version.
The Set-AzureDataDisk cmdlet updates the cache attributes of an existing data disk object on an Azure virtual machine. The possible host caching values are: None, ReadOnly, and ReadWrite. You specify which data disk to update by specifying its logical unit number (LUN).
Parameters
-HostCaching<String>
Sets the host level caching settings of the disk. Possible values are: None, ReadOnly and ReadWrite.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-LUN<Int32>
Numerical value that defines the slot where the data drive is mounted in the virtual machine.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VM<IPersistentVM>
The virtual machine where the data disk is mounted.
Aliases |
InputObject |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
-------------- Example 1 --------------
This command gets the "MyVM" virtual machine running on the "myservice" cloud service, and then sets the data disk at LUN 2 of the virtual machine to use ReadOnly host caching.
C:\PS>Get-AzureVM "myservice" -name "MyVM" | Set-AzureDataDisk -LUN 2 -HostCaching ReadOnly | Update-AzureVM