v3

latestSwagger 2.0raw.githubusercontent.com2019-08-0676156747.2 KB
ComputeNodes

Gets the settings required for remote login to a Compute Node.

Before you can remotely login to a Compute Node using the remote login settings, you must create a user Account on the Compute Node. This API can be invoked only on Pools created with the virtual machine configuration property. For Pools created with a cloud service configuration, see the GetRemoteDesktop API.

get/pools/{poolId}/nodes/{nodeId}/remoteloginsettings

Path parameters

poolIdstring required

The ID of the Pool that contains the Compute Node.

nodeIdstring required

The ID of the Compute Node for which to obtain the remote login settings.

Query parameters

timeoutinteger

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.

api-versionstring required

Client API Version.

Headers

client-request-idstring uuid

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return-client-request-idboolean

Whether the server should return the client-request-id in the response.

ocp-datestring date-time-rfc1123

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Response

A response containing the login settings.

remoteLoginIPAddressstring required
remoteLoginPortinteger required