PoolOperations.GetRemoteLoginSettings Method

Definition

Namespace:

Microsoft.Azure.Batch

Assembly:

Microsoft.Azure.Batch.dll

Package:

Microsoft.Azure.Batch v16.2.0

Source:

PoolOperations.cs

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

public Microsoft.Azure.Batch.RemoteLoginSettings GetRemoteLoginSettings (string poolId, string computeNodeId, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);

member this.GetRemoteLoginSettings : string * string * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> Microsoft.Azure.Batch.RemoteLoginSettings

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

Returns

RemoteLoginSettings

Remarks

This is a blocking operation. For a non-blocking equivalent, see GetRemoteLoginSettingsAsync(String, String, IEnumerable<BatchClientBehavior>, CancellationToken).

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.