Get-AzureDataDisk
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
Get-AzureDataDisk
Gets a Windows Azure data disk object.
Parameter Set: Default
Get-AzureDataDisk [[-Lun] <Int32> ] -VM <IPersistentVM> [ <CommonParameters>]
This topic describes the cmdlet in the .6.19 version of the Windows Azure PowerShell module. To find out the version of the module you're using, from the Windows Azure PowerShell console, type (get-module azure).version.
The Get-AzureDataDisk cmdlet gets an object that represents the Windows Azure data disks on the specified virtual machine. To get a specific data disk object, specify the disk's LUN.
-Lun<Int32>
Specifies the LUN where the data disk resides.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VM<IPersistentVM>
Specifies the virtual machine object from which to get data disk objects.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
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.
Example 1
This command gets the "MyVM" virtual machine running on the "myservice" cloud service, and then gets a list of the data disks mounted on the virtual machine.
C:\PS>Get-AzureVM "myservice" –Name "MyVM" | Get-AzureDataDisk
Example 2
This command gets a data disk object, $dDisk, that represents the data disk mounted at LUN 2 on the Database virtual machine running on the Windows Azure service "myservice".
C:\PS>$dDisk = ( Get-AzureVM "myservice" -Name "MyVM" `
| Get-AzureDataDisk -LUN 2 )
Example 3
This command removes the data disk at LUN 1 on the "MyVM" virtual machine running on the Windows Azure service "MyService".
C:\PS>Get-AzureVM "MyService" –Name "MyVM" | Get-AzureDataDisk –LUN 1