remote_connections

Creates, updates, deletes, gets or lists a remote_connections resource.

Overview

Name	remote_connections
Type	Resource
Id	azure.developer_devcenter.remote_connections

Fields

The following fields are returned by SELECT queries:

get_remote_connection

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_remote_connection	select	project_name, user_id, dev_box_name, endpoint		Gets RDP Connection info.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
dev_box_name	string	The name of a Dev Box. Required.
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
project_name	string	The DevCenter Project upon which to execute operations. Required.
user_id	string	The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. Required.

SELECT examples

get_remote_connection

Gets RDP Connection info.

SELECT
rdpConnectionUrl,
webUrl
FROM azure.developer_devcenter.remote_connections
WHERE project_name = '{{ project_name }}' -- required
AND user_id = '{{ user_id }}' -- required
AND dev_box_name = '{{ dev_box_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;