Get-AzureRmRemoteDesktopFile

NAME Get-AzureRmRemoteDesktopFile



SYNOPSIS

Gets an .rdp file.





SYNTAX

Get-AzureRmRemoteDesktopFile [-ResourceGroupName] <String> [-Name] <String> [[-LocalPath] <String>] [-Launch] [-DefaultProfile

<IAzureContextContainer>] [<CommonParameters>]



Get-AzureRmRemoteDesktopFile [-ResourceGroupName] <String> [-Name] <String> [-LocalPath] <String> [-DefaultProfile <IAzureContextContainer>]

[<CommonParameters>]





DESCRIPTION

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





PARAMETERS

-DefaultProfile <IAzureContextContainer>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Launch [<SwitchParameter>]

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



Required? true

Position? 3

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-LocalPath <String>

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



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Name <String>

Specifies the name of the availability set that this cmdlet gets.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceGroupName <String>

Specifies the name of a resource group.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None

This cmdlet does not accept any input.





OUTPUTS



NOTES









Example 1: Get a Remote Desktop file



PS C:\\> Get-AzureRmRemoteDesktopFile -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.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... esktopfile