Dev Boxes - Get Remote Connection

Service:

Dev Center

API Version:

2024-02-01

Gets RDP Connection info.

GET {endpoint}/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/remoteConnection?api-version=2024-02-01

URI Parameters

Name	In	Required	Type	Description
devBoxName	path	True	string	The name of a Dev Box. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$
endpoint	path	True	string uri	The DevCenter-specific URI to operate on.
projectName	path	True	string	The DevCenter Project upon which to execute operations. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$
userId	path	True	string	The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. Regex pattern: ^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	RemoteConnection	The request has succeeded.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	An unexpected error response. Headers x-ms-error-code: string

Security

OAuth2Auth

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
https://devcenter.azure.com/.default

Examples

Gets RDP Connection info.

Sample request

HTTP

GET https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/me/devboxes/MyDevBox/remoteConnection?api-version=2024-02-01

Sample response

Status code:

200

{
  "webUrl": "https://connectionUrl"
}

Definitions

Name	Description
Azure.Core.Foundations.Error	The error object.
Azure.Core.Foundations.ErrorResponse	A response containing error details.
Azure.Core.Foundations.InnerError	An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
RemoteConnection	Provides remote connection information for a Dev Box.

Azure.Core.Foundations.Error

Object

The error object.

Name	Type	Description
code	string	One of a server-defined set of error codes.
details	Azure.Core.Foundations.Error[]	An array of details about specific errors that led to this reported error.
innererror	Azure.Core.Foundations.InnerError	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.
target	string	The target of the error.

Azure.Core.Foundations.ErrorResponse

Object

A response containing error details.

Name	Type	Description
error	Azure.Core.Foundations.Error	The error object.

Azure.Core.Foundations.InnerError

Object

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	string	One of a server-defined set of error codes.
innererror	Azure.Core.Foundations.InnerError	Inner error.

RemoteConnection

Object

Provides remote connection information for a Dev Box.

Name	Type	Description
rdpConnectionUrl	string	Link to open a Remote Desktop session.
webUrl	string	URL to open a browser based RDP session.