ComputeNode.GetRemoteLoginSettings 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 Microsoft.Azure.Batch.RemoteLoginSettings GetRemoteLoginSettings (System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);

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

Public Function GetRemoteLoginSettings (Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing) As RemoteLoginSettings

Parameters

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(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.

Applies to