RemoteDesktopDeployment.adoc

DSC Resource 'RemoteDesktopDeployment'

RemoteDesktopDeployment deploys the Remote Desktop Services infrastructure including Connection Broker, Web Access, Session Hosts, and Gateway servers.

When to use 'RemoteDesktopDeployment'

Use this resource when you need to deploy a new Remote Desktop Services environment. It installs and configures the RDS deployment with Connection Broker, Web Access, Session Host, and Gateway roles distributed across servers. This is the foundational RDS resource; apply it before RemoteDesktopCollections, RemoteDesktopLicensing, and RemoteDesktopCertificates.

Source	https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/RemoteDesktopDeployment
DSC Resource	xRemoteDesktopSessionHost
Documentation	xRDSessionDeployment

Table 1. Attributes of category 'RemoteDesktopDeployment'

Parameter	Attribute	DataType	Description	Allowed Values
ConnectionBroker	Mandatory	String	Specifies the RD Connection Broker server for the Remote Desktop deployment.
WebAccess		String	Specifies the RD Web Access server.
SessionHosts		String[]	Specifies the RD Session Host servers.
Gateways		Hashtable[]	Specifies the RD Gateway server configurations.

Table 2. Attributes of category 'RemoteDesktopDeployment/Gateways'

Parameter	Attribute	DataType	Description	Allowed Values
GatewayServer		String	Specifies the RD Gateway server name. Used as identifier for the deployment resource instance.
SessionHost	Key	String	Specifies the RD Session Host server for this deployment.
ConnectionBroker	Mandatory	String	Specifies the RD Connection Broker server.
WebAccessServer	Mandatory	String	Specifies the RD Web Access server.

Example

RemoteDesktopDeployment:
  ConnectionBroker: CB1
  SessionHosts:
    - SH1
    - SH2
  WebAccess: WA1

See also

• RemoteDesktopCollections

• RemoteDesktopLicensing

• RemoteDesktopCertificates

• RemoteDesktopHAMode

• RemoteDesktopServers