Edit

Share via

Set-AzureVMImageDataDiskConfig

  • Reference
Module:
Azure

Sets the Data Disk properties on the virtual machine image.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.

The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.

Syntax

Set-AzureVMImageDataDiskConfig
   [-DiskConfig] <VirtualMachineImageDiskConfigSet>
   [-DataDiskName] <String>
   [-Lun] <Int32>
   [-HostCaching] <String>
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]
Set-AzureVMImageDataDiskConfig
   [-DiskConfig] <VirtualMachineImageDiskConfigSet>
   [-Lun] <Int32>
   [-HostCaching] <String>
   [-MediaLink] <Uri>
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]

Description

The Set-AzureVMImageDataDiskConfig cmdlet sets the Data Disk properties on the virtual machine image.

Examples

Example 1: Set Data Disk properties on a virtual machine image

PS C:\> $Disk = New-AzureDiskConfigSet
PS C:\> $Disk = Set-AzureOSDiskConfig -DiskConfig $Disk -HostCaching ReadWrite
PS C:\> $Disk = Set-AzureDataDiskConfig -DiskConfig $Disk -Name "Test" -HostCaching "ReadWrite" -LUN 0
PS C:\> Update-AzureVMImage -ImageName "Image2" -Label "Test1" -Description "Test1" -DiskConfigSet $Disk;

This command sets data disk properties on a virtual machine then updates the virtual machine image.

Parameters

-DataDiskName

Specifies the name of the data disk that this cmdlet configures.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DiskConfig

Specifies the disk configuration object that encapsulates the operating system disk and Data Disk objects.

Type:VirtualMachineImageDiskConfigSet
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-HostCaching

Specifies the host cache attribute for the operating system disk.

Valid values are:

--ReadOnly --ReadWrite

Type:String
Position:3
Default value:None
Required:True
Accept pipeline input:True
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

-Lun

Specifies the slot where the data drive is mounted in the virtual machine.

Type:Int32
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-MediaLink

Specifies the URI of the location where the new virtual hard drive is created when the new data disk is added.

Type:Uri
Position:3
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Outputs

Microsoft.WindowsAzure.Commands.ServiceManagement.Model.VirtualMachineImageDiskConfigSet