Table of contents
TOC
Collapse the table of content
Expand the table of content

Remote Desktop client Universal Resource Identifier (URI) scheme support

Liza Poggemeyer|Last Updated: 12/1/2016

Applies To: Windows 10, Windows 8.1, Windows Server 2012 R2, Windows Server Technical Preview

Enabling a Uniform Resource Identifier (URI) scheme gives IT professionals and developers a way to integrate features of the Remote Desktop clients across platforms and enriches the user experience by allowing:

  • Third-party applications to launch Microsoft Remote Desktop and start remote sessions with predefined settings (provided as part of the URI string).
  • End users to start remote connections using pre-configured URLs.

Microsoft Remote Desktop uses the URI scheme rdp://query_string to store pre-configured attribute settings that are used when launching the client. The query strings represent a single or set of RDP attributes provided in the URL.

The RDP attributes are separated by the ampersand symbol (&). For example, when connecting to a PC, the string is:

rdp://full%20address=s:mypc:3389&audiomode=i:2&disable%20themes=i:1

This table gives a complete list of supported attributes that may be used with the iOS, Mac, and Android Remote Desktop clients. (An “x” in the platform column indicates the attribute is supported. The values denoted by chevrons (<>) represent the values that are supported by the Remote Desktop clients.)

RDP attributeAndroidMaciOS
allow desktop composition=i:<0 or 1>xxx
allow font smoothing=i:<0 or 1>xxx
alternate shell=s:<string>xxx
audiomode=i:<0, 1, or 2>xxx
authentication level=i:<0 or 1>xxx
connect to console=i:<0 or 1>xxx
disable cursor settings=i:<0 or 1>xxx
disable full window drag=i:<0 or 1>xxx
disable menu anims=i:<0 or 1>xxx
disable themes=i:<0 or 1>xxx
disable wallpaper=i:<0 or 1>xxx
drivestoredirect=s:* (this is the only supported value)xx
desktopheight=i:<value in pixels>x
desktopwidth=i:<value in pixels>x
domain=s:<string>xxx
full address=s:<string>xxx
gatewayhostname=s:<string>xxx
gatewayusagemethod=i:<1 or 2>xxx
prompt for credentials on client=i:<0 or 1>x
loadbalanceinfo=s:<string>xxx
redirectprinters=i:<0 or 1>x
remoteapplicationcmdline=s:<string>xxx
remoteapplicationmode=i:<0 or 1>xxx
remoteapplicationprogram=s:<string>xxx
shell working directory=s:<string>xxx
Use redirection server name=i:<0 or 1>xxx
username=s:<string>xxx
screen mode id=i:<1 or 2>x
session bpp=i:<8, 15, 16, 24, or 32>x
use multimon=i:<0 or 1>x
© 2017 Microsoft