ComputeNodeOperationsExtensions.GetRemoteLoginSettingsAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.Batch.Protocol

Assembly:: Microsoft.Azure.Batch.dll

Package:: Microsoft.Azure.Batch v16.2.0

Source:: ComputeNodeOperationsExtensions.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 static System.Threading.Tasks.Task<Microsoft.Azure.Batch.Protocol.Models.ComputeNodeGetRemoteLoginSettingsResult> GetRemoteLoginSettingsAsync (this Microsoft.Azure.Batch.Protocol.IComputeNodeOperations operations, string poolId, string nodeId, Microsoft.Azure.Batch.Protocol.Models.ComputeNodeGetRemoteLoginSettingsOptions computeNodeGetRemoteLoginSettingsOptions = default, System.Threading.CancellationToken cancellationToken = default);

static member GetRemoteLoginSettingsAsync : Microsoft.Azure.Batch.Protocol.IComputeNodeOperations * string * string * Microsoft.Azure.Batch.Protocol.Models.ComputeNodeGetRemoteLoginSettingsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Batch.Protocol.Models.ComputeNodeGetRemoteLoginSettingsResult>

<Extension()>
Public Function GetRemoteLoginSettingsAsync (operations As IComputeNodeOperations, poolId As String, nodeId As String, Optional computeNodeGetRemoteLoginSettingsOptions As ComputeNodeGetRemoteLoginSettingsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ComputeNodeGetRemoteLoginSettingsResult)

Parameters

operations: IComputeNodeOperations

The operations group for this extension method.

poolId: String

The ID of the Pool that contains the Compute Node.

nodeId: String

The ID of the Compute Node for which to obtain the remote login settings.

computeNodeGetRemoteLoginSettingsOptions: ComputeNodeGetRemoteLoginSettingsOptions

Additional parameters for the operation

cancellationToken: CancellationToken

The cancellation token.

Returns

Task<ComputeNodeGetRemoteLoginSettingsResult>

Remarks

Before you can remotely login to a Compute Node using the remote login settings, you must create a user Account on the Compute Node. This API can be invoked only on Pools created with the virtual machine configuration property. For Pools created with a cloud service configuration, see the GetRemoteDesktop API.

Applies to

Share via