Skip to content

Latest commit

 

History

History
275 lines (202 loc) · 6.32 KB

Remove-CMApplicationGroupDeployment.md

File metadata and controls

275 lines (202 loc) · 6.32 KB
external help file Module Name ms.date online version schema
AdminUI.PS.dll-Help.xml
ConfigurationManager
03/25/2021
2.0.0

Remove-CMApplicationGroupDeployment

SYNOPSIS

Remove the deployment of an application group.

SYNTAX

SearchByValue (Default)

Remove-CMApplicationGroupDeployment -InputObject <IResultObject> [-Force] [-Collection <IResultObject>]
 [-CollectionId <String>] [-CollectionName <String>] [-DisableWildcardHandling] [-ForceWildcardHandling]
 [-WhatIf] [-Confirm] [<CommonParameters>]

SearchByDeploymentId

Remove-CMApplicationGroupDeployment [-DeploymentId <String>] [-Force] [-Collection <IResultObject>]
 [-CollectionId <String>] [-CollectionName <String>] [-DisableWildcardHandling] [-ForceWildcardHandling]
 [-WhatIf] [-Confirm] [<CommonParameters>]

SearchByName

Remove-CMApplicationGroupDeployment [-Name <String>] [-Force] [-Collection <IResultObject>]
 [-CollectionId <String>] [-CollectionName <String>] [-DisableWildcardHandling] [-ForceWildcardHandling]
 [-WhatIf] [-Confirm] [<CommonParameters>]

SearchBySmsObjectId

Remove-CMApplicationGroupDeployment [-SmsObjectId <Int32>] [-Force] [-Collection <IResultObject>]
 [-CollectionId <String>] [-CollectionName <String>] [-DisableWildcardHandling] [-ForceWildcardHandling]
 [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Remove the deployment of an application group. An app group contains multiple applications, and users see the group in Software Center as a single entity. For more information, see Create application groups.

Note

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

EXAMPLES

Example 1

Get-CMApplicationGroupDeployment -DeploymentId "{483392DD-92BF-4CFD-9E21-2BB5F3C01BCD}" | Remove-CMApplicationGroupDeployment

PARAMETERS

-Collection

Specify a collection object to which the app group is deployed. To get this object, use the Get-CMCollection cmdlet.

Type: IResultObject
Parameter Sets: (All)
Aliases:

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

-CollectionId

Specify the ID of the collection to which the app group is deployed. The format is SMS00001 for example.

Type: String
Parameter Sets: (All)
Aliases:

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

-CollectionName

Specify the name of the collection to which the app group is deployed.

Type: String
Parameter Sets: (All)
Aliases:

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

-DeploymentId

Specify the ID for the app group deployment. The format of this ID is a standard GUID.

Type: String
Parameter Sets: SearchByDeploymentId
Aliases: AssignmentUniqueID, ApplicationDeploymentID

Required: False
Position: Named
Default value: None
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
Parameter Sets: (All)
Aliases:

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

-Force

Run the command without asking for confirmation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
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
Parameter Sets: (All)
Aliases:

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

-InputObject

Specify an object for the app group. To get this object, use the Get-CMApplicationGroup cmdlet.

Type: IResultObject
Parameter Sets: SearchByValue
Aliases: Assignment, ApplicationGroupDeployment, ApplicationGroup

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Name

Specify the name for the app group.

Type: String
Parameter Sets: SearchByName
Aliases: ApplicationGroupName

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

-SmsObjectId

Specify the ID of the application group.

Type: Int32
Parameter Sets: SearchBySmsObjectId
Aliases: CI_ID, ApplicationGroupID

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-WhatIf

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

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

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

OUTPUTS

System.Object

NOTES

RELATED LINKS

Get-CMApplicationGroupDeployment

New-CMApplicationGroupDeployment

Set-CMApplicationGroupDeployment

Get-CMApplicationGroup

Create application groups