Delen via


ComputeNode.GetRemoteLoginSettingsAsync Method

Definition

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

public System.Threading.Tasks.Task<Microsoft.Azure.Batch.RemoteLoginSettings> GetRemoteLoginSettingsAsync (System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);
member this.GetRemoteLoginSettingsAsync : seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Batch.RemoteLoginSettings>
Public Function GetRemoteLoginSettingsAsync (Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of RemoteLoginSettings)

Parameters

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.

Applies to