New-RDRemoteApp

Назначение: Windows 10, Windows Server Technical Preview

New-RDRemoteApp

Publishes a RemoteApp program to a Remote Desktop deployment.

Синтаксис

Parameter Set: Session
New-RDRemoteApp [-CollectionName] <String> -DisplayName <String> -FilePath <String> [-Alias <String> ] [-CommandLineSetting <CommandLineSettingValue> {DoNotAllow | Allow | Require} ] [-ConnectionBroker <String> ] [-FileVirtualPath <String> ] [-FolderName <String> ] [-IconIndex <String> ] [-IconPath <String> ] [-InformationAction <System.Management.Automation.ActionPreference> {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend} ] [-InformationVariable <System.String> ] [-RequiredCommandLine <String> ] [-ShowInWebAccess <Boolean> ] [-UserGroups <String[]> ] [ <CommonParameters>]

Parameter Set: VirtualDesktop
New-RDRemoteApp [-CollectionName] <String> -DisplayName <String> -FilePath <String> -VirtualDesktopName <String> [-Alias <String> ] [-CommandLineSetting <CommandLineSettingValue> {DoNotAllow | Allow | Require} ] [-ConnectionBroker <String> ] [-FileVirtualPath <String> ] [-FolderName <String> ] [-IconIndex <String> ] [-IconPath <String> ] [-InformationAction <System.Management.Automation.ActionPreference> {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend} ] [-InformationVariable <System.String> ] [-RequiredCommandLine <String> ] [-ShowInWebAccess <Boolean> ] [-UserGroups <String[]> ] [ <CommonParameters>]

Подробное описание

The New-RDRemoteApp cmdlet publishes a Windows Server 2012 RemoteApp program to a Remote Desktop deployment, making it available to users.

RemoteApp allows Remote Desktop Services (RDS) to run a program remotely that appears as if it runs locally on a client computer. A RemoteApp program runs in its own resizable window and has its own entry on the taskbar.

Параметры

-Alias<String>

Specifies an alias for the RemoteApp program. If you do not specify an alias, the cmdlet generates one based on the FilePath parameter. This alias must be unique within the collection specified by the CollectionName parameter.

Псевдонимы

none

Обязательное поле?

false

Позиция?

named

Значение по умолчанию

none

Принимать входные данные конвейера?

True (ByPropertyName)

Обрабатывать символы-шаблоны?

false

-CollectionName<String>

Specifies the name of the personal virtual desktop collection or session collection. The cmdlet publishes the RemoteApp program to this collection.

Псевдонимы

none

Обязательное поле?

true

Позиция?

1

Значение по умолчанию

none

Принимать входные данные конвейера?

True (ByPropertyName)

Обрабатывать символы-шаблоны?

false

-CommandLineSetting<CommandLineSettingValue>

Specifies whether the RemoteApp program accepts command-line arguments from the client at connection time. Допустимые значения для этого параметра следующие:

-- Allow. Accepts command-line arguments.
-- DoNotAllow. Does not accept command-line arguments.
-- Require. Allows only command-line arguments specified in the RequiredCommandLine parameter.

Псевдонимы

none

Обязательное поле?

false

Позиция?

named

Значение по умолчанию

none

Принимать входные данные конвейера?

True (ByPropertyName)

Обрабатывать символы-шаблоны?

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.

Псевдонимы

none

Обязательное поле?

false

Позиция?

named

Значение по умолчанию

none

Принимать входные данные конвейера?

false

Обрабатывать символы-шаблоны?

false

-DisplayName<String>

Specifies a name to display to users for the RemoteApp program.

Псевдонимы

none

Обязательное поле?

true

Позиция?

named

Значение по умолчанию

none

Принимать входные данные конвейера?

True (ByPropertyName)

Обрабатывать символы-шаблоны?

false

-FilePath<String>

Specifies a path for the executable file for the application. Do not include any environment variables. For session collections, this path must be a valid local path on all Remote Desktop Session Host (RD Session Host) servers in the collection. For virtual desktop collections, this path must be a valid local path on all virtual desktops in the collection.

Псевдонимы

none

Обязательное поле?

true

Позиция?

named

Значение по умолчанию

none

Принимать входные данные конвейера?

True (ByPropertyName)

Обрабатывать символы-шаблоны?

false

-FileVirtualPath<String>

Specifies a path for the application executable file. This path resolves to the same location as the value of the FilePath parameter, but it can include environment variables.

Псевдонимы

none

Обязательное поле?

false

Позиция?

named

Значение по умолчанию

none

Принимать входные данные конвейера?

True (ByPropertyName)

Обрабатывать символы-шаблоны?

false

-FolderName<String>

Specifies the name of the folder that the RemoteApp program appears in on the Remote Desktop Web Access (RD Web Access) webpage and in the Start menu for subscribed RemoteApp and Desktop Connections.

Псевдонимы

none

Обязательное поле?

false

Позиция?

named

Значение по умолчанию

none

Принимать входные данные конвейера?

True (ByPropertyName)

Обрабатывать символы-шаблоны?

false

-IconIndex<String>

Specifies the index within the icon file (specified by the IconPath parameter) where the RemoteApp program’s icon can be found.

Псевдонимы

none

Обязательное поле?

false

Позиция?

named

Значение по умолчанию

none

Принимать входные данные конвейера?

True (ByPropertyName)

Обрабатывать символы-шаблоны?

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.

Псевдонимы

none

Обязательное поле?

false

Позиция?

named

Значение по умолчанию

none

Принимать входные данные конвейера?

True (ByPropertyName)

Обрабатывать символы-шаблоны?

false

-InformationAction<System.Management.Automation.ActionPreference>

Specifies how this cmdlet responds to an information event. The acceptable values for this parameter are:

-- SilentlyContinue
-- Stop
-- Continue
-- Inquire
-- Ignore
-- Suspend

Псевдонимы

infa

Обязательное поле?

false

Позиция?

named

Значение по умолчанию

none

Принимать входные данные конвейера?

false

Обрабатывать символы-шаблоны?

false

-InformationVariable<System.String>

Specifies a variable in which to store an information event message.

Псевдонимы

iv

Обязательное поле?

false

Позиция?

named

Значение по умолчанию

none

Принимать входные данные конвейера?

false

Обрабатывать символы-шаблоны?

false

-RequiredCommandLine<String>

Specifies a string that contains command-line arguments that the client can use at connection time with the RemoteApp program. If you specify this parameter, the CommandLineSetting parameter must have a value of Require.

Псевдонимы

none

Обязательное поле?

false

Позиция?

named

Значение по умолчанию

none

Принимать входные данные конвейера?

True (ByPropertyName)

Обрабатывать символы-шаблоны?

false

-ShowInWebAccess<Boolean>

Specifies whether to show the RemoteApp program in the RD Web Access server, and in RemoteApp and Desktop Connections that the user subscribes to.

Псевдонимы

none

Обязательное поле?

false

Позиция?

named

Значение по умолчанию

none

Принимать входные данные конвейера?

True (ByPropertyName)

Обрабатывать символы-шаблоны?

false

-UserGroups<String[]>

Specifies an array of domain groups and users that can view the RemoteApp in RD Web Access, and in RemoteApp and Desktop Connections. To allow all users to see a RemoteApp program, provide a value of $Null.

Псевдонимы

none

Обязательное поле?

false

Позиция?

named

Значение по умолчанию

none

Принимать входные данные конвейера?

True (ByPropertyName)

Обрабатывать символы-шаблоны?

false

-VirtualDesktopName<String>

Specifies the name of a virtual desktop. The icon file specified in the IconPath parameter resides in this virtual desktop. The virtual desktop must be a member of the collection specified by the CollectionName parameter.

Псевдонимы

VMName

Обязательное поле?

true

Позиция?

named

Значение по умолчанию

none

Принимать входные данные конвейера?

false

Обрабатывать символы-шаблоны?

false

<CommonParameters>

Этот командлет поддерживает общие параметры: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer и -OutVariable. Дополнительные сведения см. в разделе  about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Входы

Входной тип — это тип объектов, которые можно направить в командлет.

Выходные данные

Возвращаемый тип — это тип объектов, возвращаемых командлетом.

  • Microsoft.RemoteDesktopServices.Management.RemoteApp

Примеры

Example 1: Publish a RemoteApp program

This command creates a new RemoteApp program in the collection named Session Collection. The command specifies the display name Notepad and uses the .exe file at the specified file path.

PS C:\> New-RDRemoteApp -CollectionName "Session Collection" -DisplayName "Notepad" -FilePath "C:\Windows\System32\Notepad.exe"

Example 2: Publish a RemoteApp program with a required argument

This command publishes a RemoteApp to the collection named Virtual Desktop Collection. The command specifies the display name Bing and uses the .exe file at the specified file path. The command specifies the virtual desktop name RDS-WKS-A27. This command uses a required command line argument. This RemoteApp opens the specified browser to go to the specified URL.

PS C:\> New-RDRemoteApp -CollectionName "Virtual Desktop Collection" -DisplayName "Bing" -FilePath "C:\Program Files\Internet Explorer\iexplore.exe" -VirtualDesktopName "RDS-WKS-A27" -CommandLineSetting Require -RequiredCommandLine "https://www.bing.com"

См. также

Get-RDRemoteApp

Remove-RDRemoteApp

Set-RDRemoteApp