Edit

Remove-CMSettingDeployment

  • Reference
Module:
ConfigurationManager

Remove a deployment for a settings policy object.

Syntax

Remove-CMSettingDeployment
      [-CMSettingsDeployment] <SettingsDeployment>
      [-Force]
      [-DisableWildcardHandling]
      [-ForceWildcardHandling]
      [<CommonParameters>]

Description

Delete a deployment for a settings policy object. For example, remove the deployment of a BitLocker management policy or a Microsoft Defender Application Control policy.

Examples

Example 1: Remove all deployments for a BitLocker management settings object

This example first gets a BitLocker management settings object. It then uses the pipe operator to get all deployments for that policy object, and deletes those deployments.

Get-CMBlmSetting -Name "My BitLocker settings" | Get-CMSettingDeployment | Remove-CMSettingDeployment

Example 2: Remove all deployments to a specific collection for a Microsoft Defender Application Control settings object

This example first gets a Microsoft Defender Application Control settings object. It then uses the pipe operator to get all deployments for that policy object. The Where-Object clause filters the list of deployments to those to the All Desktop and Server Clients collection, andr deletes those deployments.

Get-CMWdacSetting -Name "My App Control settings" | Get-CMSettingDeployment | Where-Object { $_.CollectionId -eq (Get-CMCollection -Name "All Desktop and Server Clients").CollectionId } | Remove-CMSettingDeployment

Parameters

-CMSettingsDeployment

Specify the settings deployment object to configure. To get the deployment object, use the Get-CMSettingDeployment cmdlet.

Type:SettingsDeployment
Position:1
Default value:None
Required:True
Accept pipeline input:True
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

-Force

Run the command without asking for confirmation.

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

Inputs

Microsoft.ConfigurationManagement.PowerShell.Cmdlets.Deployments.SettingsDeployment.SettingsDeployment

Outputs

Microsoft.ConfigurationManagement.PowerShell.Cmdlets.Deployments.SettingsDeployment.SettingsDeployment