node_remote_login_settings

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

Overview

Name	node_remote_login_settings
Type	Resource
Id	azure.batch_dataplane.node_remote_login_settings

Fields

The following fields are returned by SELECT queries:

get_node_remote_login_settings

Name	Datatype	Description
ipv6RemoteLoginIPAddress	string	The IPv6 address used for remote login to the Compute Node.
ipv6RemoteLoginPort	integer	The port used for remote login to the Compute Node.
remoteLoginIPAddress	string	The IP address used for remote login to the Compute Node. Required.
remoteLoginPort	integer	The port used for remote login to the Compute Node. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_node_remote_login_settings	select	pool_id, node_id, endpoint	timeOut, ocp-date	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 _.

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
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
node_id	string	The ID of the Compute Node for which to obtain the remote login settings. Required.
pool_id	string	The ID of the Pool that contains the Compute Node. Required.
ocp-date	string	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. Default value is None.
timeOut	integer	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.". Default value is None.

SELECT examples

get_node_remote_login_settings

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

SELECT
ipv6RemoteLoginIPAddress,
ipv6RemoteLoginPort,
remoteLoginIPAddress,
remoteLoginPort
FROM azure.batch_dataplane.node_remote_login_settings
WHERE pool_id = '{{ pool_id }}' -- required
AND node_id = '{{ node_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND timeOut = '{{ timeOut }}'
AND ocp-date = '{{ ocp-date }}'
;