New-BrokerApplicationGroup
Create a new application group to which applications can be added.
Syntax
New-BrokerApplicationGroup
[-AdminFolder <AdminFolder>]
[-Description <String>]
[-Enabled <Boolean>]
[-Name] <String>
[-RestrictToTag <String>]
[-Scope <String[]>]
[-SessionSharingEnabled <Boolean>]
[-SingleAppPerSession <Boolean>]
[-TenantId <Guid>]
[-UserFilterEnabled <Boolean>]
[-UUID <Guid>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
The New-BrokerApplicationGroup cmdlet creates a new application group. Applications that are added to the application group can then be managed centrally by setting properties on the application group rather than on each application individually.
Application groups may also be used to isolate applications that should not share sessions with other applications. To do this, create an application group with SessionSharingEnabled equal to \$false, and then add to it those applications that you wish to isolate. The isolated applications continue to share sessions with each other, but not with any other published applications.
To create a new application and add it to an application group, use New-BrokerApplication -ApplicationGroup. To add an existing application to an application group, use Add-BrokerApplication -ApplicationGroup.
After adding applications to an application group, you must then publish the application group to a desktop group before its applications can be launched. Use the Add-BrokerApplicationGroup cmdlet to do this.
To manipulate the user filter associated with an application group, use Add-BrokerUser -ApplicationGroup and Remove-BrokerUser -ApplicationGroup.
To manipulate the set of tags associated with an application group, use Add-BrokerTag -ApplicationGroup and Remove-BrokerTag -ApplicationGroup.
See about_Broker_Applications for more information.
Examples
EXAMPLE 1
Creates a new application group called 'Helpdesk Apps'.
New-BrokerApplicationGroup "Helpdesk Apps"
EXAMPLE 2
Creates a new application group called 'Accounts Apps', and then restrict access so that only members of the MYDOMAIN\Accounts user group can launch applications in 'Accounts Apps'.
New-BrokerApplicationGroup "Accounts Apps" -UserFilterEnabled $true
Add-BrokerUser "MYDOMAIN\Accounts" -ApplicationGroup "Accounts Apps"
Parameters
-Name
A name for the application group. Not visible to end users.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | True |
-AdminFolder
The folder in which the new application group should reside (if any).
| Type: | AdminFolder |
| Position: | Named |
| Default value: | None (root folder) |
| Required: | False |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-Description
A description for the application group. Not visible to end users.
| Type: | String |
| Position: | Named |
| Default value: | Null |
| Required: | False |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | True |
-Enabled
Whether the application group's applications can be launched by end users.
| Type: | Boolean |
| Position: | Named |
| Default value: | True |
| Required: | False |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-RestrictToTag
Optional tag that may be used further to restrict which machines may be used for launching the application group's applications. A machine may be used by an application group if either the application group has no tag restriction or the application group does have a tag restriction and the machine is tagged with the same tag.
| Type: | String |
| Position: | Named |
| Default value: | Null |
| Required: | False |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | True |
-Scope
Specifies the name of the delegated administration scope to which the application group should belong.
| Type: | String[] |
| Position: | Named |
| Default value: | Null |
| Required: | False |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-SessionSharingEnabled
Whether the application group's applications can share sessions with applications that are not a member of this application group. Please note this setting and SingleAppPerSession cannot be true at the same time.
| Type: | Boolean |
| Position: | Named |
| Default value: | True |
| Required: | False |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-SingleAppPerSession
Specifies whether each application launched from this application group starts in its own new session or can share an existing suitable session if present. Please note this setting and SessionSharingEnabled cannot be true at the same time.
| Type: | Boolean |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-TenantId
Specifies identity of tenant associated with application group. Must always be specified in multitenant sites, must not be specified otherwise.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-UserFilterEnabled
Whether the application group's user filter is enabled or disabled. Where the user filter is enabled, the application is visible only to users who appear in the filter (either explicitly or by virtue of group membership).
| Type: | Boolean |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-UUID
The UUID of the application group. If a UUID is not provided, then one will be generated automatically.
| Type: | Guid |
| Position: | Named |
| Default value: | Null |
| Required: | False |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-LoggingId
Specifies the identifier of the high level operation that this cmdlet call forms a part of. Desktop Studio and Desktop Director typically create High Level Operations. PowerShell scripts can also wrap a series of cmdlet calls in a High Level Operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
CitrixCommonParameters
This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
None
You cannot pipe input into this cmdlet.
Outputs
Citrix.Broker.Admin.SDK.ApplicationGroup
The newly created application group.