PoolOperations.GetRemoteLoginSettingsAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.Batch

Assembly:: Microsoft.Azure.Batch.dll

Package:: Microsoft.Azure.Batch v16.3.1

Source:: PoolOperations.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 (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>

Public Function GetRemoteLoginSettingsAsync (poolId As String, computeNodeId As String, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of 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

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.

Applies to

Share via