Edit

Remove-AzVmssDataDisk

  • Reference
Module:
Az.Compute

Removes a data disk from the VMSS.

Syntax

Remove-AzVmssDataDisk
      [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet>
      [-Name] <String>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzVmssDataDisk
      [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet>
      [-Lun] <Int32>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-AzVmssDataDisk cmdlet removes a data disk from the Virtual Machine Scale Set (VMSS) instance.

Examples

Example 1

Remove-AzVmssDataDisk -VirtualMachineScaleSet $vmss -Name 'DataDisk1'

This command removes the data disk named 'DataDisk1' from the VMSS object.

Example 2

Remove-AzVmssDataDisk -VirtualMachineScaleSet $vmss -Lun 0

This command removes the data disk of LUN 0 from the VMSS object.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Lun

Specifies the logical unit number of the disk.

Type:Nullable<T>[Int32]
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Specifies the name of the disk.

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

-VirtualMachineScaleSet

Specify the VMSS object.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

PSVirtualMachineScaleSet

String

Nullable<T>[[System.Int32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Outputs

PSVirtualMachineScaleSet