New-CMApplicationGroup

Create a new application group.

Syntax

New-CMApplicationGroup
   [-Name] <String>
   -AddApplication <String[]>
   [-Description <String>]
   [-Publisher <String>]
   [-SoftwareVersion <String>]
   [-OptionalReference <String>]
   [-ReleaseDate <DateTime>]
   [-AddOwner <String[]>]
   [-AddSupportContact <String[]>]
   [-AppGroupCatalog <AppDisplayInfo[]>]
   [-DefaultLanguageId <Int32>]
   [-LocalizedName <String>]
   [-UserDocumentation <String>]
   [-LinkText <String>]
   [-PrivacyUrl <String>]
   [-LocalizedDescription <String>]
   [-Keyword <String[]>]
   [-IconLocationFile <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Use this cmdlet to create an application group. Use an application group to deploy multiple applications to a collection as a single deployment. The metadata you specify about the app group is seen in Software Center as a single entity. You can order the apps in the group so that the client installs them in a specific order. For more information, see Create application groups.

There are some settings of an app group that you can't configure when you create it. To configure other settings, use the Set-CMApplicationGroup cmdlet.

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Examples

Example 1: Create a group with two apps

This example creates a new app group named Central app that includes two apps.

$apps = @('LOB Framework','CA UI')

New-CMApplicationGroup -Name 'Central app' -AddApplication $apps -Description 'Central app group' -Publisher 'Contoso IT' -SoftwareVersion '1.1.2' -ReleaseDate (Get-Date) -AddOwner 'jqpublic' -AddSupportContact 'jdoe' -LocalizedAppGroupName 'Central app'

Parameters

-AddApplication

Specify a string array of app names to add to the group. If you already have an app object from another cmdlet like Get-CMApplication, this value is the LocalizedDisplayName property. For example: $appList = @($app1.LocalizedDisplayName,$app2.LocalizedDisplayName)

Type:String[]
Aliases:AddApplications
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-AddOwner

Specify one or more administrative users who are responsible for this app group.

Type:String[]
Aliases:AddOwners
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AddSupportContact

Specify one or more administrative users that end users can contact for help with this application.

Type:String[]
Aliases:AddSupportContacts
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AppGroupCatalog

Use this parameter to specify a Software Center entry for a specific language. This entry can include all of the localized information about the app group:

  • Description
  • IconLocationFile
  • Keyword
  • LinkText
  • PrivacyUrl
  • Title
  • UserDocumentation

To get this object, use the New-CMApplicationDisplayInfo cmdlet.

Type:AppDisplayInfo[]
Aliases:AppCatalogs
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultLanguageId

Specify the language ID for the default Software Center language.

This ID is the decimal equivalent of the Windows language ID. For example, 1033 is 0x0409 for English (United States), and 2108 is 0x083C for Irish (Ireland). For more information, see [MS-LCID]: Windows Language Code Identifier (LCID) Reference.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Specify an optional administrator comment for the app group. The maximum length is 2048 characters.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisableWildcardHandling

This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ForceWildcardHandling

This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IconLocationFile

Specify the path to the file that contains the icon for this app group. Icons can have pixel dimensions of up to 512x512. The file can be of the following image and icon file types:

  • DLL
  • EXE
  • JPG
  • ICO
  • PNG
Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Keyword

Specify a list of keywords in the selected language. These keywords help Software Center users search for the app group.

Tip

To add multiple keywords, use CultureInfo.CurrentCulture.TextInfo.ListSeparator as the delimiter.

Type:String[]
Aliases:Keywords
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LinkText

When you use the UserDocumentation parameter, use this parameter to show a string in place of "Additional information" in Software Center. The maximum length is 128 characters.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LocalizedDescription

Specify a description for this app group in the selected language. The maximum length is 2048 characters.

Type:String
Aliases:LocalizedAppGroupDescription
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LocalizedName

Specify the app group name in the selected language. This name appears in Software Center.

A name is required for each language that you add.

The maximum length is 256 characters.

Type:String
Aliases:LocalizedAppGroupName
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specify a name for the app group. The maximum length is 256 characters.

Type:String
Aliases:LocalizedDisplayName, ApplicationGroupName
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-OptionalReference

Specify an optional string to help you find the app group in the console. The maximum length is 256 characters.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PrivacyUrl

Specify a website address to the privacy statement for the app group. The format needs to be a valid URL, for example https://contoso.com/privacy. The maximum length of the entire string is 128 characters.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Publisher

Specify optional vendor information for this app group. The maximum length is 256 characters.

Type:String
Aliases:Manufacturer
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ReleaseDate

Specify a date object for when this app group was released. To get this object, use the Get-Date built-in cmdlet.

Type:DateTime
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SoftwareVersion

Specify an optional version string for the app group. The maximum length is 64 characters.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UserDocumentation

Specify the location of a file from which Software Center users can get more information about this app group. This location is a website address, or a network path and file name. Make sure that users have access to this location.

The maximum length of the entire string is 256 characters.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet doesn't run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

IResultObject

Notes

This cmdlet returns the SMS_ApplicationGroup WMI class object.