Get-CMUserCollectionIncludeMembershipRule

Module:

ConfigurationManager Module

Get an include membership rule for a user collection.

Syntax

ByNameAndName (Default)

Get-CMUserCollectionIncludeMembershipRule
    -CollectionName <String>
    [-IncludeCollectionName <String>]
    [<CommonParameters>]

ByNameAndValue

Get-CMUserCollectionIncludeMembershipRule
    -CollectionName <String>
    -IncludeCollection <IResultObject>
    [<CommonParameters>]

ByNameAndId

Get-CMUserCollectionIncludeMembershipRule
    -CollectionName <String>
    -IncludeCollectionId <String>
    [<CommonParameters>]

ByIdAndValue

Get-CMUserCollectionIncludeMembershipRule
    -CollectionId <String>
    -IncludeCollection <IResultObject>
    [<CommonParameters>]

ByIdAndId

Get-CMUserCollectionIncludeMembershipRule
    -CollectionId <String>
    -IncludeCollectionId <String>
    [<CommonParameters>]

ByIdAndName

Get-CMUserCollectionIncludeMembershipRule
    -CollectionId <String>
    [-IncludeCollectionName <String>]
    [<CommonParameters>]

ByValueAndValue

Get-CMUserCollectionIncludeMembershipRule
    -InputObject <IResultObject>
    -IncludeCollection <IResultObject>
    [<CommonParameters>]

ByValueAndId

Get-CMUserCollectionIncludeMembershipRule
    -InputObject <IResultObject>
    -IncludeCollectionId <String>
    [<CommonParameters>]

ByValueAndName

Get-CMUserCollectionIncludeMembershipRule
    -InputObject <IResultObject>
    [-IncludeCollectionName <String>]
    [<CommonParameters>]

Description

Use this cmdlet to get one or more include membership rules for a user collection. An include membership rule includes the members of another collection to the user collection where the rule is applied.

Configuration Manager dynamically updates the membership of the user collection on a schedule if the membership of the included collection changes.

For more information, see How to create collections in Configuration Manager.

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 all include membership rules

This command gets all include membership rules for the collection named Users.

Get-CMUserCollectionIncludeMembershipRule -CollectionName "Users"

Parameters

-CollectionId

Specify the ID of the user collection to get the rule. This value is the CollectionID property, for example, XYZ00012. Since default collections don't have include membership rules, this ID starts with the site code and not SMS.

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 to get the rule.

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

-IncludeCollection

Specify an object for the included collection to get the rule. To get this object, use the Get-CMCollection or Get-CMUserCollection cmdlets.

Parameter properties

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

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

-IncludeCollectionId

Specify the ID of the included collection to get the rule. This value is the CollectionID property, for example, XYZ00012. You can include default collections, so this value can start with either the site code or SMS.

Parameter properties

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

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

-IncludeCollectionName

Specify the name of the included collection to get the rule.

Parameter properties

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

Parameter sets

ByNameAndName

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

ByIdAndName

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

ByValueAndName

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

-InputObject

Specify an object for the user collection to get the rule. 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

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

Related Links

• Add-CMUserCollectionIncludeMembershipRule
• Remove-CMUserCollectionIncludeMembershipRule
• Get-CMCollectionIncludeMembershipRule
• Get-CMCollection
• Get-CMUserCollection
• Get-CMDeviceCollectionIncludeMembershipRule
• How to create collections in Configuration Manager