ComputeNode.GetRemoteLoginSettingsAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.Batch

Assembly:: Microsoft.Azure.Batch.dll

Package:: Microsoft.Azure.Batch v16.2.0

Source:: ComputeNode.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

Task<RemoteLoginSettings>

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