Get-AzDevCenterUserDevBoxRemoteConnection

  • Reference
Module:
Az.DevCenter

Gets RDP Connection info

Syntax

Get-AzDevCenterUserDevBoxRemoteConnection
   -Endpoint <String>
   -DevBoxName <String>
   -ProjectName <String>
   [-UserId <String>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzDevCenterUserDevBoxRemoteConnection
   -Endpoint <String>
   -InputObject <IDevCenterdataIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzDevCenterUserDevBoxRemoteConnection
   -DevCenterName <String>
   -InputObject <IDevCenterdataIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzDevCenterUserDevBoxRemoteConnection
   -DevCenterName <String>
   -DevBoxName <String>
   -ProjectName <String>
   [-UserId <String>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Gets RDP Connection info

Examples

Example 1: Get the remote connection on the dev box by endpoint

Get-AzDevCenterUserDevBoxRemoteConnection -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -DevBoxName myDevBox -ProjectName DevProject

This commands gets the remote connection for the dev box "myDevBox".

Example 2: Get the remote connection on the dev box by dev center

Get-AzDevCenterUserDevBoxRemoteConnection -DevCenterName Contoso -DevBoxName myDevBox -ProjectName DevProject

This commands gets the remote connection for the dev box "myDevBox".

Example 3: Get the remote connection on the dev box by endpoint and InputObject

$devBoxInput = @{"DevBoxName" = "myDevBox"; "UserId" = "me"; "ProjectName" = "DevProject" }
Get-AzDevCenterUserDevBoxRemoteConnection -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -InputObject $devBoxInput

This commands gets the remote connection for the dev box "myDevBox".

Example 4: Get the remote connection on the dev box by dev center and InputObject

$devBoxInput = @{"DevBoxName" = "myDevBox"; "UserId" = "me"; "ProjectName" = "DevProject" }
Get-AzDevCenterUserDevBoxRemoteConnection -DevCenterName Contoso -InputObject $devBoxInput

This commands gets the remote connection for the dev box "myDevBox".

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

-DevBoxName

The name of a Dev Box.

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

-DevCenterName

The DevCenter upon which to execute operations.

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

-Endpoint

The DevCenter-specific URI to operate on.

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

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

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

-ProjectName

The DevCenter Project upon which to execute operations.

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

-UserId

The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.

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

Inputs

IDevCenterdataIdentity

Outputs

IRemoteConnection