Edit

Share via

Remove-CMUserCollectionDirectMembershipRule

Module:
ConfigurationManager Module

Remove a direct membership rule from a user collection.

Syntax

ByNameAndName (Default) 

Remove-CMUserCollectionDirectMembershipRule
    -CollectionName <String>
    -ResourceName <String[]>
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByNameAndValue 

Remove-CMUserCollectionDirectMembershipRule
    -CollectionName <String>
    -Resource <IResultObject[]>
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByNameAndId 

Remove-CMUserCollectionDirectMembershipRule
    -CollectionName <String>
    -ResourceId <String[]>
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByIdAndValue 

Remove-CMUserCollectionDirectMembershipRule
    -CollectionId <String>
    -Resource <IResultObject[]>
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByIdAndId 

Remove-CMUserCollectionDirectMembershipRule
    -CollectionId <String>
    -ResourceId <String[]>
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByIdAndName 

Remove-CMUserCollectionDirectMembershipRule
    -CollectionId <String>
    -ResourceName <String[]>
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByValueAndValue 

Remove-CMUserCollectionDirectMembershipRule
    -InputObject <IResultObject>
    -Resource <IResultObject[]>
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByValueAndId 

Remove-CMUserCollectionDirectMembershipRule
    -InputObject <IResultObject>
    -ResourceId <String[]>
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByValueAndName 

Remove-CMUserCollectionDirectMembershipRule
    -InputObject <IResultObject>
    -ResourceName <String[]>
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Use this cmdlet to remove a direct membership rule from a user collection. A direct membership rule lets you explicitly choose the members of the user collection. Default collections don't have direct membership rules. Any collection that you target should have an ID that starts with the site code, not SMS. For more information, see How to create collections in Configuration Manager.

When you remove a direct membership rule from a collection, the resource may no longer be a member of the collection. This action can cause any software or configuration deployment to not apply to the user.

Note

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

Examples

Example 1: Remove a direct membership rule from a user collection

This command removes the direct membership rule for the resource with ID 33555693 from the user collection that has the ID XYZ0001A.

Remove-CMUserCollectionDirectMembershipRule -CollectionID "XYZ0001A" -ResourceId "33555693"

Parameters

-CollectionId

Specify the ID of the user collection with the direct rule to remove. For example, "XYZ0003F".

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Id

Parameter sets

ByIdAndValue
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByIdAndId
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByIdAndName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CollectionName

Specify the name of the user collection with the direct rule to remove.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Name

Parameter sets

ByNameAndName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameAndValue
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameAndId
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Force

Run the command without asking for confirmation.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Specify a user collection object with the direct rule to remove. To get this object, use the Get-CMCollection or Get-CMUserCollection cmdlets.

Parameter properties

Type:IResultObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Collection

Parameter sets

ByValueAndValue
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
ByValueAndId
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
ByValueAndName
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Resource

Specify an array of resource objects to remove from the user collection. To get this object, use the Get-CMResource or Get-CMUser cmdlets.

Parameter properties

Type:

IResultObject[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:Resources

Parameter sets

ByNameAndValue
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByIdAndValue
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByValueAndValue
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceId

Specify an array of resource IDs to remove from the user collection. This value is the ResourceId property of the SMS_Resource class. For example, "33555693".

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:ResourceIds

Parameter sets

ByNameAndId
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByIdAndId
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByValueAndId
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceName

Specify an array of resource names to remove the direct membership rules from the user collection.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:True
DontShow:False
Aliases:ResourceNames

Parameter sets

ByNameAndName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByIdAndName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByValueAndName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object