Edit

Share via


Get-AzStackHCIVMVirtualHardDisk

Gets a virtual hard disk

Syntax

Get-AzStackHCIVMVirtualHardDisk
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzStackHCIVMVirtualHardDisk
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzStackHCIVMVirtualHardDisk
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzStackHCIVMVirtualHardDisk
   [-ResourceId <String>]
   [-DefaultProfile <PSObject>]
   [-NoWait]
   [<CommonParameters>]

Description

Gets a virtual hard disk

Examples

Example 1: Get a Virtual Hard Disk

Get-AzStackHCIVMVirtualHardDisk -Name  "testVhd" -ResourceGroupName "test-rg"

Name            ResourceGroupName
----            -----------------
testVhd       test-rg

This command gets a specific virtual hard disk in the specified resource group.

Example 2: List all Virtual Hard Disks in a Resource Group

Get-AzStackHCIVMVirtualHardDisk -ResourceGroupName "test-rg"

Name            ResourceGroupName
----            -----------------
testVhd       test-rg

This command lists all virtual hard disks in the specified resource group.

Parameters

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Name of the virtual hard disk

Type:String
Aliases:VirtualHardDiskName
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-NoWait

Run the command asynchronously

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

-ResourceGroupName

The name of the resource group. The name is case insensitive.

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

-ResourceId

The ARM ID of the virtual hard disk.

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

-SubscriptionId

The ID of the target subscription.

Type:String[]
Position:Named
Default value:(Get-AzContext).Subscription.Id
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

IVirtualHardDisks