Share via

Nodes - Get Node Remote Login Settings

Service:
Batch Service
API Version:
2025-06-01

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 {endpoint}/pools/{poolId}/nodes/{nodeId}/remoteloginsettings?api-version=2025-06-01
With optional parameters: 
GET {endpoint}/pools/{poolId}/nodes/{nodeId}/remoteloginsettings?api-version=2025-06-01&timeOut={timeOut}

URI Parameters

Name In Required Type Description
endpoint
 path True

string (uri)

Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com).
nodeId
 path True

string

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

string

The ID of the Pool that contains the Compute Node.
api-version
 query True

string

minLength: 1

The API version to use for this operation.
timeOut
 query

integer (int32)

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.".

Request Header

Name Required Type Description
client-request-id

string

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

boolean

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

string (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.

Responses

Name Type Description
200 OK

BatchNodeRemoteLoginSettings

The request has succeeded.

Headers

  • ETag: string
  • Last-Modified: string
  • client-request-id: string
  • request-id: string
Other Status Codes

BatchError

An unexpected error response.

Security

OAuth2Auth

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

Scopes

Name Description
https://batch.core.windows.net//.default

Examples

Get batch node Dual Stack Networking Remote
Node get remote login settings

Get batch node Dual Stack Networking Remote

Sample request

GET {endpoint}/pools/dualstackpool/nodes/tvmps_5d8adec89961dcc011329b38df999a841f6cc815a5710678b741f04b33556ed2_d/remoteloginsettings?api-version=2025-06-01

Sample response

Status code:
200 
{
  "remoteLoginIPAddress": "１.1.1.1",
  "remoteLoginPort": 40000,
  "ipv6RemoteLoginIPAddress": "fd00::1",
  "ipv6RemoteLoginPort": 40000
}

Node get remote login settings

Sample request

GET {endpoint}/pools/poolId/nodes/tvm-1695681911_1-20161121t182739z/remoteloginsettings?api-version=2025-06-01

Sample response

Status code:
200 
{
  "remoteLoginIPAddress": "1.1.1.1",
  "remoteLoginPort": 50000
}

Definitions

Name Description
BatchError

An error response received from the Azure Batch service.
BatchErrorDetail

An item of additional information included in an Azure Batch error response.
BatchErrorMessage

An error message received in an Azure Batch error response.
BatchNodeRemoteLoginSettings

The remote login settings for a Compute Node.

BatchError

Object

An error response received from the Azure Batch service.

Name Type Description
code

string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
message

BatchErrorMessage

A message describing the error, intended to be suitable for display in a user interface.
values

BatchErrorDetail[]

A collection of key-value pairs containing additional details about the error.

BatchErrorDetail

Object

An item of additional information included in an Azure Batch error response.

Name Type Description
key

string

An identifier specifying the meaning of the Value property.
value

string

The additional information included with the error response.

BatchErrorMessage

Object

An error message received in an Azure Batch error response.

Name Type Description
lang

string

The language code of the error message.
value

string

The text of the message.

BatchNodeRemoteLoginSettings

Object

The remote login settings for a Compute Node.

Name Type Description
ipv6RemoteLoginIPAddress

string

The IPv6 address used for remote login to the Compute Node.
ipv6RemoteLoginPort

integer (int32)

The port used for remote login to the Compute Node.
remoteLoginIPAddress

string

The IP address used for remote login to the Compute Node.
remoteLoginPort

integer (int32)

The port used for remote login to the Compute Node.