Edit

Share via

Get-AzLabServicesUserVM

  • Reference
Module:
Az.LabServices

API to get the assigned vm for the user.

Syntax

Get-AzLabServicesUserVM
   [-SubscriptionId <String[]>]
   -ResourceId <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzLabServicesUserVM
   -ResourceGroupName <String>
   -LabName <String>
   -Email <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzLabServicesUserVM
   -Email <String>
   [-SubscriptionId <String[]>]
   -Lab <Lab>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzLabServicesUserVM
   [-SubscriptionId <String[]>]
   -User <User>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

API to get the assigned vm for the user.

Examples

Example 1: Get the Virtual machine assigned to a specific user.

Get-AzLabServicesUserVM -ResourceGroupName "Group Name" -LabName "Lab Name" -Email 'user@contoso.com'

Name
----
0

Returns the specific machine that is assigned to the user in the lab.

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

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

-Email

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

-LabName

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

-ResourceGroupName

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

-ResourceId

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

-User

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

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

Inputs

User

Outputs

IVirtualMachine