BatchClient.GetNodeRemoteLoginSettings Method

Definition

Namespace:

Azure.Compute.Batch

Assembly:

Azure.Compute.Batch.dll

Package:

Azure.Compute.Batch v1.0.0-beta.1

Overloads

GetNodeRemoteLoginSettings(String, String, Nullable<Int32>, Nullable<DateTimeOffset>, RequestContext)	[Protocol Method] Gets the settings required for remote login to a Compute Node. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetNodeRemoteLoginSettings(String, String, Nullable<Int32>, Nullable<DateTimeOffset>, CancellationToken) convenience overload with strongly typed models first.
GetNodeRemoteLoginSettings(String, String, Nullable<Int32>, Nullable<DateTimeOffset>, CancellationToken)	Gets the settings required for remote login to a Compute Node.

GetNodeRemoteLoginSettings(String, String, Nullable<Int32>, Nullable<DateTimeOffset>, RequestContext)

Source:

BatchClient.cs

[Protocol Method] Gets the settings required for remote login to a Compute Node.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
• Please try the simpler GetNodeRemoteLoginSettings(String, String, Nullable<Int32>, Nullable<DateTimeOffset>, CancellationToken) convenience overload with strongly typed models first.

public virtual Azure.Response GetNodeRemoteLoginSettings (string poolId, string nodeId, int? timeOutInSeconds, DateTimeOffset? ocpdate, Azure.RequestContext context);

abstract member GetNodeRemoteLoginSettings : string * string * Nullable<int> * Nullable<DateTimeOffset> * Azure.RequestContext -> Azure.Response
override this.GetNodeRemoteLoginSettings : string * string * Nullable<int> * Nullable<DateTimeOffset> * Azure.RequestContext -> Azure.Response

Public Overridable Function GetNodeRemoteLoginSettings (poolId As String, nodeId As String, timeOutInSeconds As Nullable(Of Integer), ocpdate As Nullable(Of DateTimeOffset), context As RequestContext) As Response

Parameters

poolId

String

The ID of the Pool that contains the Compute Node.

nodeId

String

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

timeOutInSeconds

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

ocpdate

Nullable<DateTimeOffset>

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.

context

RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Response

The response returned from the service.

Exceptions

ArgumentNullException

poolId or nodeId is null.

ArgumentException

poolId or nodeId is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call GetNodeRemoteLoginSettings and parse the result.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
BatchClient client = new BatchClient(endpoint, credential);

Response response = client.GetNodeRemoteLoginSettings("<poolId>", "<nodeId>", null, null, null);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("remoteLoginIPAddress").ToString());
Console.WriteLine(result.GetProperty("remoteLoginPort").ToString());

This sample shows how to call GetNodeRemoteLoginSettings with all parameters and parse the result.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
BatchClient client = new BatchClient(endpoint, credential);

Response response = client.GetNodeRemoteLoginSettings("<poolId>", "<nodeId>", 1234, DateTimeOffset.Parse("Tue, 10 May 2022 18:57:31 GMT"), null);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("remoteLoginIPAddress").ToString());
Console.WriteLine(result.GetProperty("remoteLoginPort").ToString());

GetNodeRemoteLoginSettings(String, String, Nullable<Int32>, Nullable<DateTimeOffset>, CancellationToken)

Source:

BatchClient.cs

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

public virtual Azure.Response<Azure.Compute.Batch.BatchNodeRemoteLoginSettings> GetNodeRemoteLoginSettings (string poolId, string nodeId, int? timeOutInSeconds = default, DateTimeOffset? ocpdate = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetNodeRemoteLoginSettings : string * string * Nullable<int> * Nullable<DateTimeOffset> * System.Threading.CancellationToken -> Azure.Response<Azure.Compute.Batch.BatchNodeRemoteLoginSettings>
override this.GetNodeRemoteLoginSettings : string * string * Nullable<int> * Nullable<DateTimeOffset> * System.Threading.CancellationToken -> Azure.Response<Azure.Compute.Batch.BatchNodeRemoteLoginSettings>

Public Overridable Function GetNodeRemoteLoginSettings (poolId As String, nodeId As String, Optional timeOutInSeconds As Nullable(Of Integer) = Nothing, Optional ocpdate As Nullable(Of DateTimeOffset) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of BatchNodeRemoteLoginSettings)

Parameters

poolId

String

The ID of the Pool that contains the Compute Node.

nodeId

String

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

timeOutInSeconds

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

ocpdate

Nullable<DateTimeOffset>

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.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<BatchNodeRemoteLoginSettings>

Exceptions

ArgumentNullException

poolId or nodeId is null.

ArgumentException

poolId or nodeId is an empty string, and was expected to be non-empty.

Examples

This sample shows how to call GetNodeRemoteLoginSettings.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
BatchClient client = new BatchClient(endpoint, credential);

Response<BatchNodeRemoteLoginSettings> response = client.GetNodeRemoteLoginSettings("<poolId>", "<nodeId>");

This sample shows how to call GetNodeRemoteLoginSettings with all parameters.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
BatchClient client = new BatchClient(endpoint, credential);

Response<BatchNodeRemoteLoginSettings> response = client.GetNodeRemoteLoginSettings("<poolId>", "<nodeId>", timeOutInSeconds: 1234, ocpdate: DateTimeOffset.Parse("Tue, 10 May 2022 18:57:31 GMT"));

Remarks

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.