IVirtualMachineOperations.GetRemoteDesktopFileAsync Method (String, String, String, CancellationToken)

  • Article

 

Asynchronously retrieves the Remote Desktop Protocol configuration file from the specified Virtual Machine.

Namespace:   Microsoft.WindowsAzure.Management.Compute
Assembly:  Microsoft.WindowsAzure.Management.Compute (in Microsoft.WindowsAzure.Management.Compute.dll)

Syntax

Task<VirtualMachineGetRemoteDesktopFileResponse> GetRemoteDesktopFileAsync(
    string serviceName,
    string deploymentName,
    string virtualMachineName,
    CancellationToken cancellationToken
)

Task<VirtualMachineGetRemoteDesktopFileResponse^>^ GetRemoteDesktopFileAsync(
    String^ serviceName,
    String^ deploymentName,
    String^ virtualMachineName,
    CancellationToken cancellationToken
)

abstract GetRemoteDesktopFileAsync : 
        serviceName:string *
        deploymentName:string *
        virtualMachineName:string *
        cancellationToken:CancellationToken -> Task<VirtualMachineGetRemoteDesktopFileResponse>

Function GetRemoteDesktopFileAsync (
    serviceName As String,
    deploymentName As String,
    virtualMachineName As String,
    cancellationToken As CancellationToken
) As Task(Of VirtualMachineGetRemoteDesktopFileResponse)

Parameters

  • serviceName
    Type: System.String

    The name of the cloud service that contains the Virtual Machine.

  • virtualMachineName
    Type: System.String

    The name of the Virtual Machine from which the RDP file should be retrieved.

Return Value

Type: System.Threading.Tasks.Task<VirtualMachineGetRemoteDesktopFileResponse>

The VirtualMachineGetRemoteDesktopFileResponse object that contains the RDP file for accessing the Virtual Machine.

Remarks

For more information about downloading the RDP file, see the following resources:

See Also

IVirtualMachineOperations Interface
Microsoft.WindowsAzure.Management.Compute Namespace

Return to top