Get-AzureDisk
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
Get-AzureDisk
Gets an object with information on disks in the Azure disk repository.
Syntax
Parameter Set: Default
Get-AzureDisk [[-DiskName] <String> ] [ <CommonParameters>]
Detailed Description
This topic describes the cmdlet in the 0.8.10 version of the Microsoft Azure PowerShell module. To get the version of the module you're using, in the Azure PowerShell console, type (Get-Module -Name Azure).Version.
The Get-AzureDisk cmdlet retrieves an object with information about the disks stored in the Azure disk repository for the current subscription. It returns a list object with information for all disks in the repository, or with information on a specific disk if its disk name is specified.
Parameters
-DiskName<String>
Specifies the name of the disk in the disk repository to return information about.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1
This command retrieves data about the "MyDataDisk" disk from the disk repository.
C:\PS>Get-AzureDisk -DiskName MyDataDisk
Example 2
This command retrieves data for all the disks in the disk repository.
C:\PS>Get-AzureDisk
Example 3
This command gets data for all of the disks in the disk repository that are not currently attached to a virtual machine and then formats the list as a table.
C:\PS>Get-AzureDisk | Where-Object {$_.AttachedTo –eq $null } `
| Format-Table –auto "DiskName","DiskSizeInGB","MediaLink"