Edit

Share via

Get-AzRemoteDesktopFile

  • Reference
Module:
Az.Compute

Gets an .rdp file.

Syntax

Get-AzRemoteDesktopFile
   [-ResourceGroupName] <String>
   [-Name] <String>
   [-LocalPath] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzRemoteDesktopFile
   [-ResourceGroupName] <String>
   [-Name] <String>
   [[-LocalPath] <String>]
   [-Launch]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzRemoteDesktopFile cmdlet gets a Remote Desktop Protocol (.rdp) file.

Examples

Example 1: Get a Remote Desktop file

Get-AzRemoteDesktopFile -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" -LocalPath "D:\RemoteDesktopFile07.rdp"

This command gets the Remote Desktop file for the virtual machine named VirtualMachine07. The command stores the result in the file named D:\RemoteDesktopFile07.rdp.

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Launch

Indicates that this cmdlet launches Remote Desktop after it gets the .rdp file.

Type:SwitchParameter
Position:3
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-LocalPath

Specifies the local full path where this cmdlet stores the .rdp file.

Type:String
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Specifies the name of the virtual machine to gets.

Type:String
Aliases:ResourceName, VMName
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

Specifies the name of a resource group.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

String

Outputs

Void