Set-RDFileTypeAssociation
Set-RDFileTypeAssociation
Changes the file type association of a RemoteApp program in a Remote Desktop deployment.
Syntax
Parameter Set: Session
Set-RDFileTypeAssociation [-CollectionName] <String> -AppAlias <String> -FileExtension <String> -IsPublished <Boolean> [-ConnectionBroker <String> ] [-IconIndex <String> ] [-IconPath <String> ] [ <CommonParameters>]
Parameter Set: VirtualDesktop
Set-RDFileTypeAssociation [-CollectionName] <String> -AppAlias <String> -FileExtension <String> -IsPublished <Boolean> -VirtualDesktopName <String> [-ConnectionBroker <String> ] [-IconIndex <String> ] [-IconPath <String> ] [ <CommonParameters>]
Detailed Description
The Set-RDFileTypeAssocation cmdlet modifies the file type association of a RemoteApp program in a Remote Desktop deployment.
Parameters
-AppAlias<String>
Specifies the alias for the RemoteApp program. The default alias is the program's file name without the extension.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-CollectionName<String>
Specifies the name of the session or 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 this Remote Desktop deployment. Remote users connect to this server to obtain views of available RemoteApp programs, session-based desktops, and virtual desktops. If this parameter does not appear, the default value is the fully qualified domain name (FQDN) of the local host.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-FileExtension<String>
Specifies the file name extension of the file type whose association you change.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-IconIndex<String>
Specifies the index in the icon file for the RemoteApp program icon. The IconPath parameter specifies the icon file.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-IconPath<String>
Specifies the path to a file containing the icon to display for the RemoteApp program identified by the Alias parameter. This path must not contain any environment variables. For session collections, the path must be a valid local path on all RD Session Host servers in the collection. For virtual desktop collections, the path must be a valid local path on all virtual desktops in the collection.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-IsPublished<Boolean>
Indicates whether users can see the file type association.
Set this parameter to $True if users need to open the RemoteApp that corresponds to a file type by double-clicking a file of that type.
Set this parameter to $False if you do not want to associate files of a particular type with a RemoteApp program on end users’ machines. For example, if you have published Microsoft Word as a RemoteApp, but you want end users to open .docx files in local copies of Wordpad rather than in the RemoteApp Word, set IsPublished to $False in the file type association for .docx files.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-VirtualDesktopName<String>
Specifies the name of the virtual desktop where the icon file whose name is in the IconPath parameter appears. This virtual desktop must belong to the collection whose value is in 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.
Null
None
Examples
Example 1: Set a file type association for a virtual desktop collection
This command sets the following options for file type association:
-- Collection named Virtual Desktop Collection.
-- Remote Desktop application alias of iexplore.
-- File name extension of .html to associate with the application.
-- Virtual desktop named RDS-WKS-A27.
-- Users can see the file name extension.
PS C:\> Set-RDFileTypeAssociation -CollectionName "Virtual Desktop Collection" -AppAlias "iexplore" -FileExtension ".html" -IsPublished $True -VirtualDesktopName "RDS-WKS-A27"
Example 2: Set a file type association for a session collection
This command sets these options for file type association:
-- Collection named Session Collection.
-- Remote Desktop application alias of Notepad.
-- File name extension of .txt to associate with the application.
-- The icon for the Remote Desktop program Notepad.exe appears in the \System32 subfolder of the Windows folder. The icon that appears for Notepad is at the first position of the icon file.
PS C:\> Set-RDFileTypeAssociation -CollectionName "Session Collection" -AppAlias "Notepad" -FileExtension ".txt" -IsPublished $True -IconPath "%windir%\System32\Notepad.exe" -IconIndex 0