Get-AzLabServicesVM

Reference

Module:: Az.LabServices

Returns the properties for a lab virtual machine.

Syntax

Get-AzLabServicesVM
   -LabName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-Filter <String>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzLabServicesVM
   -LabName <String>
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzLabServicesVM
   [-Name <String>]
   [-SubscriptionId <String[]>]
   -Lab <Lab>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Returns the properties for a lab virtual machine.

Examples

Example 1: Gets all the Virtual machines in the lab.

Get-AzLabServicesVM -LabName "Lab Name" -ResourceGroupName "Group Name"

Name
----
0
1
2

Returns all the VMs.

Example 2: Gets the specific VM in the lab.

Get-AzLabServicesVM -LabName "Lab Name" -ResourceGroupName "Group Name" -Name 2

Name
----
2

Returns the specific VM.

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

-Filter

The filter to apply to the operation.

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

-Lab

To construct, see NOTES section for LAB properties and create a hash table.

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

-LabName

The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

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

-Name

The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.

Type:	String
Aliases:	VirtualMachineName
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.

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

Inputs

Lab

Outputs

IVirtualMachine

Share via