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

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

public static Task<VirtualMachineGetRemoteDesktopFileResponse> GetRemoteDesktopFileAsync(
    this IVirtualMachineOperations operations,
    string serviceName,
    string deploymentName,
    string virtualMachineName
)

public:
[ExtensionAttribute]
static Task<VirtualMachineGetRemoteDesktopFileResponse^>^ GetRemoteDesktopFileAsync(
    IVirtualMachineOperations^ operations,
    String^ serviceName,
    String^ deploymentName,
    String^ virtualMachineName
)

static member GetRemoteDesktopFileAsync : 
        operations:IVirtualMachineOperations *
        serviceName:string *
        deploymentName:string *
        virtualMachineName:string -> Task<VirtualMachineGetRemoteDesktopFileResponse>

<ExtensionAttribute>
Public Shared Function GetRemoteDesktopFileAsync (
    operations As IVirtualMachineOperations,
    serviceName As String,
    deploymentName As String,
    virtualMachineName As String
) As Task(Of VirtualMachineGetRemoteDesktopFileResponse)

Parameters

• operations
  Type: Microsoft.WindowsAzure.Management.Compute.IVirtualMachineOperations

  The IVirtualMachineOperations object that specifies the operations for managing Virtual Machines.

• serviceName
  Type: System.String

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

• deploymentName
  Type: System.String

  The name of the deployment.

• 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:

• Download RDP File

• How to Log on to a Virtual Machine Running Windows Server

• Get-AzureRemoteDesktopFile

See Also

VirtualMachineOperationsExtensions Class
Microsoft.WindowsAzure.Management.Compute Namespace

Return to top