Get-RDAvailableApp
Get-RDAvailableApp
Retrieves a list of publishable applications from a collection.
Syntax
Parameter Set: Session
Get-RDAvailableApp [-CollectionName] <String> [-ConnectionBroker <String> ] [ <CommonParameters>]
Parameter Set: VirtualDesktop
Get-RDAvailableApp [-CollectionName] <String> -VirtualDesktopName <String> [-ConnectionBroker <String> ] [ <CommonParameters>]
Detailed Description
The Get-RDAvailableApp cmdlet retrieves a list of publishable applications from a collection specified in the CollectionName parameter.
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 supply 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 |
-VirtualDesktopName<String>
Specifies the name of the virtual desktop. This parameter is required. The virtual desktop identified here must be a member of the of the collection specified by the CollectionName parameter.
Aliases |
VMName |
Required? |
true |
Position? |
named |
Default Value |
none |
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.
- Microsoft.RemoteDesktopServices.Management.StartMenuApp
Examples
Example 1: Retrieve the list of applications available to be published for a Session Collection
This command retrieves a list of the applications available from the session collection named Session Collection, on the RD Connection Broker server named Rdcb.Contoso.com.
PS C:\> Get-RDAvailableApp -CollectionName "Session Collection" –ConnectionBroker "Rdcb.Contoso.com"
Example 2: Retrieve the list of applications available to be published for a Virtual Desktop Collection
This command retrieves a list of the applications available from the session collection named Virtual Desk Pool, on the RD Connection Broker server named Rdcb.Contoso.com. The cmdlet uses the virtual desktop named RDS-WKS-A26 as the source of a list of applications.
PS C:\> Get-RDAvailableApp -CollectionName "Virtual Desktop Pool" -ConnectionBroker "Rdcb.Contoso.com" -VirtualDesktopName "RDS-WKS-A26"