PoolOperations.GetRemoteLoginSettingsAsync(String, String, IEnumerable<BatchClientBehavior>, CancellationToken) Method

Definition

Gets the settings required for remote login to a compute node.

public System.Threading.Tasks.Task<Microsoft.Azure.Batch.RemoteLoginSettings> GetRemoteLoginSettingsAsync (string poolId, string computeNodeId, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);
member this.GetRemoteLoginSettingsAsync : string * string * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Batch.RemoteLoginSettings>

Parameters

poolId
String

The id of the pool that contains the compute node.

computeNodeId
String

The id of the compute node for which to get a Remote Desktop file.

additionalBehaviors
IEnumerable<BatchClientBehavior>

A collection of BatchClientBehavior instances that are applied to the Batch service request after the CustomBehaviors.

cancellationToken
CancellationToken

A CancellationToken for controlling the lifetime of the asynchronous operation.

Returns

A Task that represents the asynchronous operation.

Remarks

The get remote login settings operation runs asynchronously.

This method can be invoked only if the pool is created with a VirtualMachineConfiguration property. If this method is invoked on pools created with CloudServiceConfiguration, then Batch service returns 409 (Conflict). For pools with a CloudServiceConfiguration property, one of the GetRDPFileAsync/GetRDPFile methods must be used.

Applies to