Get-AzVMwareVirtualMachine

Module:

Az.VMware

Get a VirtualMachine

Syntax

Get-AzVMwareVirtualMachine
   -ClusterName <String>
   -PrivateCloudName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzVMwareVirtualMachine
   -ClusterName <String>
   -Id <String>
   -PrivateCloudInputObject <IVMwareIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzVMwareVirtualMachine
   -ClusterName <String>
   -Id <String>
   -PrivateCloudName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzVMwareVirtualMachine
   -Id <String>
   -ClusterInputObject <IVMwareIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzVMwareVirtualMachine
   -InputObject <IVMwareIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Get a VirtualMachine

Examples

Example 1: List virtual machine in a private cloud cluster

Get-AzVMwareVirtualMachine -ClusterName cluster1 -PrivateCloudName cloud1 -ResourceGroupName group1

Name   ResourceGroupName
----   -----------------
vm-209 group1
vm-128 group1

List virtual machine in a private cloud cluster

Example 2: Get a virtual machine by id in a private cloud cluster

Get-AzVMwareVirtualMachine -Id vm-209 -ClusterName cluster1 -PrivateCloudName cloud1 -ResourceGroupName group1

Name   ResourceGroupName
----   -----------------
vm-209 group1

Get a virtual machine by id in a private cloud cluster

Parameters

-ClusterInputObject

Identity Parameter

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

-ClusterName

Name of the cluster

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

-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

-Id

ID of the virtual machine.

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

-InputObject

Identity Parameter

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

-PrivateCloudInputObject

Identity Parameter

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

-PrivateCloudName

Name of the private cloud

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

-SubscriptionId

The ID of the target subscription. The value must be an UUID.

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

Inputs

IVMwareIdentity

Outputs

IVirtualMachine