v22

latestSwagger 2.02026-07-1372236814.0 KB

Nodes

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 and configure access ports for SSH and RDP. For more information, see https://learn.microsoft.com/azure/batch/pool-endpoint-configuration

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

api-versionstring required

The API version to use for this operation.

timeOutinteger

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".

Headers

client-request-idstring

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-rfc7231

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

The request has succeeded.

ipv6RemoteLoginIPAddressstring

Represent an IP V6 address serialized as a string.

It is formatted as eight hex decimal values(16-bit) between 0 and FFFF separated by colon. (i.e. y:y:y:y:y:y:y:y)

ipv6RemoteLoginPortinteger

The port used for remote login to the Compute Node.

remoteLoginIPAddressstring required

Represent an IP V4 address serialized as a string.

It is formatted as four 8-bit fields separated by periods.

remoteLoginPortinteger required

The port used for remote login to the Compute Node.