Get-AzureRemoteDesktopFile

Module:
Azure
Gets an RDP file for an Azure virtual machine.

Syntax

Get-AzureRemoteDesktopFile
   [-ServiceName] <String>
   [-Name] <String>
   [[-LocalPath] <String>]
   [-Launch]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]
Get-AzureRemoteDesktopFile
   [-ServiceName] <String>
   [-Name] <String>
   [-LocalPath] <String>
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

Description

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

Examples

Example 1: Get an RDP file

PS C:\> Get-AzureRemoteDesktopFile -ServiceName "ContosoService" -Name "VirtualMachine07" -LocalPath "C:\temp\VirtualMachine07.rdp"

This command gets an RDP file for the VirtualMachine07 virtual machine named VirtualMachine07 that runs on the service named ContosoService. The command stores that file as C:\temp\VirtualMachine07.rdp.

Example 2: Start a remote session

PS C:\> Get-AzureRemoteDesktopFile -ServiceName "ContosoService" -Name "VirtualMachine07" -Launch

This command gets an RDP file for the VirtualMachine07 virtual machine named VirtualMachine07 that runs on the service named ContosoService. The command launches a remote desktop session. The command deletes the RDP file when the connection is closed.

Required Parameters

-Launch

Indicates that this cmdlet starts a remote desktop session to the virtual machine.

Type:SwitchParameter
Position:3
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-LocalPath

Specifies the full path of the downloaded RDP file on the local computer.

Type:String
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Name

Specifies the virtual machine for which this cmdlet downloads an RDP file.

Type:String
Aliases:InstanceName
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ServiceName

Specifies the name of the Azure service to which the virtual machine belongs.

Type:String
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-InformationAction

Specifies how this cmdlet responds to an information event.

The acceptable values for this parameter are:

  • Continue
  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspend
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationVariable

Specifies an information variable.

Type:String
Aliases:iv
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

Type:AzureSMProfile
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False