Edit

Share via

Get-CMCollectionDirectMembershipRule

  • Reference
Module:
ConfigurationManager

Get a direct membership rule for a device or user collection.

Syntax

Get-CMCollectionDirectMembershipRule
   -CollectionName <String>
   [-ResourceName <String>]
   [<CommonParameters>]
Get-CMCollectionDirectMembershipRule
   -CollectionName <String>
   -Resource <IResultObject>
   [<CommonParameters>]
Get-CMCollectionDirectMembershipRule
   -CollectionName <String>
   -ResourceId <String>
   [<CommonParameters>]
Get-CMCollectionDirectMembershipRule
   -CollectionId <String>
   -Resource <IResultObject>
   [<CommonParameters>]
Get-CMCollectionDirectMembershipRule
   -CollectionId <String>
   -ResourceId <String>
   [<CommonParameters>]
Get-CMCollectionDirectMembershipRule
   -CollectionId <String>
   [-ResourceName <String>]
   [<CommonParameters>]
Get-CMCollectionDirectMembershipRule
   -InputObject <IResultObject>
   -Resource <IResultObject>
   [<CommonParameters>]
Get-CMCollectionDirectMembershipRule
   -InputObject <IResultObject>
   -ResourceId <String>
   [<CommonParameters>]
Get-CMCollectionDirectMembershipRule
   -InputObject <IResultObject>
   [-ResourceName <String>]
   [<CommonParameters>]

Description

Use this cmdlet to get one or more direct membership rules for a device or user collection. A direct membership rule lets you explicitly choose the members of the device 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.

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 direct membership rules for a collection by name

This command gets the direct membership rules for the collection named Device01.

Get-CMCollectionDirectMembershipRule -CollectionName "Device01"

Example 2: Get all direct membership rules by using the pipeline

This command uses the Get-CMCollection cmdlet to get the collection object named User02. It then uses the pipeline operator to pass the object to the Get-CMCollectionDirectMembershipRule cmdlet.

Get-CMCollection -Name "User02" | Get-CMCollectionDirectMembershipRule

Parameters

-CollectionId

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

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

-CollectionName

Specify the name of the collection to get the rule.

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

-InputObject

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

Type:IResultObject
Aliases:Collection
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Resource

Specify a resource, device, or user object to get its direct membership rule from the collection. To get this object, use the Get-CMResource, Get-CMDevice, or Get-CMUser cmdlets.

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

-ResourceId

Specify the ID of the resource to get its direct membership rule from the collection. This value is the ResourceID property, for example 16777219.

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

-ResourceName

Specify the name of the device or user to get its direct membership rule from the collection.

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

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object

Notes

This cmdlet is similar to Get-CMDeviceCollectionDirectMembershipRule and Get-CMUserCollectionDirectMembershipRule, which are specific to the type of collection. This cmdlet works with either device or user collections.