Get-AzureRemoteDesktopFile

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Get-AzureRemoteDesktopFile

Gets a remote desktop connection file (.RDP) for the specified Azure virtual machine.

Syntax

Parameter Set: Download
Get-AzureRemoteDesktopFile [-ServiceName] <String> [-Name] <String> [-LocalPath] <String> [ <CommonParameters>]

Parameter Set: Launch
Get-AzureRemoteDesktopFile [-ServiceName] <String> [-Name] <String> [[-LocalPath] <String> ] [-Launch] [ <CommonParameters>]

Detailed Description

This topic describes the cmdlet in the 0.8.10 version of the Microsoft Azure PowerShell module. To get the version of the module you're using, in the Azure PowerShell console, type (Get-Module -Name Azure).Version.

The Get-AzureRemoteDesktopFile cmdlet downloads and saves a remote desktop connection (RDP) file to a local disk file. The cmdlet can optionally launch a remote desktop connection to the specified virtual machine.

Parameters

-Launch

When specified, launches a remote desktop session to the specified virtual machine.

Aliases	none
Required?	true
Position?	4
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-LocalPath<String>

Specifies the path and name of the downloaded RDP file on the local disk.

Aliases	none
Required?	true
Position?	3
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-Name<String>

Specifies the virtual machine to download an RDP file for.

Aliases	InstanceName
Required?	true
Position?	2
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-ServiceName<String>

Specifies the Azure service name.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see  about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example 1

This command gets an RDP file for the "MyVM-01_IN_0" virtual machine running on the "myservice" service and stores it as "c:\temp\MyVM01.rdp".

C:\PS>Get-AzureRemoteDesktopFile -ServiceName "myservice" -Name "MyVM-01_IN_0" -LocalPath "c:\temp\MyVM01.rdp"

Example 2

This command gets an RDP connection file for the "MyVM-01_IN_0" virtual machine running on the "myservice" service and launches a remote desktop connection to the specified virtual machine. The RDP file is deleted when the connection is closed.

C:\PS>Get-AzureRemoteDesktopFile -ServiceName "myservice" -Name "MyVM-01_IN_0" –Launch