Edit

Share via

Remove-AzureVMImageDataDiskConfig

  • Reference
Module:
Azure

Removes the data disk configuration from the DiskConfigSet object.

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

Remove-AzureVMImageDataDiskConfig
      [-DiskConfig] <VirtualMachineImageDiskConfigSet>
      [-DataDiskName] <String>
      [-InformationAction <ActionPreference>]
      [-InformationVariable <String>]
      [<CommonParameters>]
Remove-AzureVMImageDataDiskConfig
      [-DiskConfig] <VirtualMachineImageDiskConfigSet>
      [-Lun] <Int32>
      [-InformationAction <ActionPreference>]
      [-InformationVariable <String>]
      [<CommonParameters>]

Description

The Remove-AzureVMImageDataDiskConfig cmdlet removes the data disk configuration from the DiskConfigSet object.

Examples

Example 1: Remove the data disk configuration from the DiskConfigSet object

PS C:\> $Disk = New-AzureDiskConfigSet
PS C:\> $Disk = Set-AzureDataDiskConfig -DiskConfig $Disk -HostCaching ReadWrite
PS C:\> Remove-AzureVMImageDataDiskConfig -DiskConfig $Disk

This example creates a DiskConfigSet, configures it, then removes the data disk.

Parameters

-DataDiskName

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

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

-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:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Outputs

Microsoft.WindowsAzure.Commands.ServiceManagement.Model.VirtualMachineImageDiskConfigSet