Set-RDRemoteDesktop
Set-RDRemoteDesktop
Changes whether to publish a Remote Desktop to a collection.
Syntax
Parameter Set: Default
Set-RDRemoteDesktop [-CollectionName] <String> [-ShowInWebAccess] <Boolean> [-ConnectionBroker <String> ] [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Set-RDRemoteDesktop cmdlet changes whether to publish a Remote Desktop connection to a collection.
When you publish a Remote Desktop connection, the Remote Desktop Web Access (RD Web Access) server displays the Remote Desktop connection for the collection defined by the CollectionName parameter. RemoteApp and Desktop Connections that the user subscribes to also display published Remote Desktop connections.
You can publish either RemoteApps or a Remote Desktop connection to a collection, but not both. Therefore, if you publish a Remote Desktop connection by using this cmdlet, it unpublishes any published RemoteApps.
Parameters
-CollectionName<String>
Specifies the name of a personal virtual desktop collection.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ConnectionBroker<String>
Specifies the Remote Desktop Connection Broker (RD Connection Broker) server for a Remote Desktop deployment. If you do not specify a value, the cmdlet uses the fully qualified domain name (FQDN) of the local computer.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Force
Performs the action without a confirmation message.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ShowInWebAccess<Boolean>
Specifies whether to publish a Remote Desktop connection.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Null
None.
Examples
Example 1: Publish a Remote Desktop
This command publishes a Remote Desktop to the collection named Session Collection. The ShowInWebAccess parameter has a value of $True, therefore the collection appears in RD Web Access. RemoteApp and Desktop Connections that the user subscribes to also display the collection.
PS C:\> Set-RDRemoteDesktop -CollectionName "Session Collection" -ShowInWebAccess $True