Set-AzVMDataDisk
Modifies properties of a virtual machine data disk.
Syntax
Set-AzVMDataDisk
[-VM] <PSVirtualMachine>
[-Name] <String>
[[-Caching] <CachingTypes>]
[[-DiskSizeInGB] <Int32>]
[-StorageAccountType <StorageAccountTypes>]
[-WriteAccelerator]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Set-AzVMDataDisk
[-VM] <PSVirtualMachine>
[-Lun] <Int32>
[[-Caching] <CachingTypes>]
[[-DiskSizeInGB] <Int32>]
[-StorageAccountType <StorageAccountTypes>]
[-WriteAccelerator]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
The Set-AzVMDataDisk cmdlet modifies properties of a virtual machine data disk.
Examples
Example 1: Modify the caching mode of a data disk
PS C:\> $VM = Get-AzVM -ResourceGroupName "ResourceGroup11" -VMName "ContosoVM07"
PS C:\> Set-AzVMDataDisk -VM $VM -Name "DataDisk01" -Caching ReadWrite | Update-AzVMThe first command gets the virtual machine named ContosoVM07 by using Get-AzVM. The command stores it in the $VM variable.
The second command modifies the caching mode for the data disk named DataDisk01 on the virtual machine in $VM. The command passes the result to the Update-AzVM cmdlet, which implements your changes. A change to the cashing mode causes the virtual machine to restart.
Parameters
-Caching
Specifies the caching mode of the disk. The acceptable values for this parameter are:
- ReadOnly
- ReadWrite
The default value is ReadWrite. Changing this value causes the virtual machine to restart.
This setting affects the consistency and performance of the disk.
| Type: | CachingTypes |
| Accepted values: | None, ReadOnly, ReadWrite |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
| Type: | IAzureContextContainer |
| Aliases: | AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DiskSizeInGB
Specifies the size, in gigabytes, for the data disk.
| Type: | Int32 |
| Position: | 3 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Lun
Specifies the logical unit number (LUN) of the data disk that this cmdlet modifies.
| Type: | Int32 |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
Specifies the name of the data disk that this cmdlet modifies.
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-StorageAccountType
The virtual machine managed disk's account type.
| Type: | StorageAccountTypes |
| Accepted values: | StandardLRS, PremiumLRS |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-VM
Specifies the virtual machine for which this cmdlet modifies a data disk. To obtain a virtual machine object, use the Get-AzVM cmdlet.
| Type: | PSVirtualMachine |
| Aliases: | VMProfile |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WriteAccelerator
Specifies whether WriteAccelerator should be enabled or disabled on the data disk.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
PSVirtualMachine
Parameter 'VM' accepts value of type 'PSVirtualMachine' from the pipeline