Update-AzureDisk

Changes the label of a disk in the Azure disk repository.

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

Update-AzureDisk
      [-DiskName] <String>
      [[-Label] <String>]
      [-ResizedSizeInGB] <Int32>
      [-Profile <AzureSMProfile>]
      [-InformationAction <ActionPreference>]
      [-InformationVariable <String>]
      [<CommonParameters>]
Update-AzureDisk
      [-DiskName] <String>
      [-Label] <String>
      [-Profile <AzureSMProfile>]
      [-InformationAction <ActionPreference>]
      [-InformationVariable <String>]
      [<CommonParameters>]

Description

The Update-AzureDisk cmdlet changes the label that is associated with a disk in the disk repository of the current Azure subscription.

Examples

Example 1: Change the label of a disk

PS C:\> Update-AzureDisk ?DiskName "ContosoOSDisk" -Label "DoNotUse"

This command changes the label of the disk named ContosoOSDisk to DoNotUse.

Parameters

-DiskName

Specifies the name of the disk that this cmdlet modifies.

Type:String
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

-Label

Specifies the new label for the disk.

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

-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

Type:AzureSMProfile
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResizedSizeInGB

Specifies the new size, in gigabytes, for the disk.

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

Outputs

DiskContext