Edit

Share via

Get-AzureDisk

  • Reference
Module:
Azure

Gets information about disks 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

Get-AzureDisk
   [[-DiskName] <String>]
   [-Profile <AzureSMProfile>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]

Description

The Get-AzureDisk cmdlet gets information about the disks that are stored in the Azure disk repository for the current subscription. This cmdlet returns a list of information for all disks in the repository. To view information for a specific disk, specify the name of the disk.

Examples

Example 1: Get information about a disk

PS C:\> Get-AzureDisk -DiskName "ContosoDataDisk"

This command gets information data about the disk named ContosoDataDisk from the disk repository.

Example 2: Get information about all disks

PS C:\> Get-AzureDisk

This command gets information about all the disks in the disk repository.

Example 3: Get information about a disk

PS C:\> Get-AzureDisk | Where-Object {$_.AttachedTo -eq $Null } | Format-Table -AutoSize -Property "DiskName","DiskSizeInGB","MediaLink"

This command gets data for all of the disks in the disk repository that are not currently attached to a virtual machine. The command gets information about all of the disks, and passes each object to the Where-Object cmdlet. That cmdlet drops any disk that does not have a value of $Null for the AttachedTo property. The command formats the list as a table by using the Format-Table cmdlet.

Parameters

-DiskName

Specifies the name of the disk in the disk repository about which this cmdlet gets information.

Type:String
Position:0
Default value:None
Required:False
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

-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