Get-CMCollectionQueryMembershipRule
Get a query membership rule for a device or user collection.
Syntax
Get-CMCollectionQueryMembershipRule
-CollectionName <String>
[-RuleName <String>]
[<CommonParameters>]
Get-CMCollectionQueryMembershipRule
-CollectionId <String>
[-RuleName <String>]
[<CommonParameters>]
Get-CMCollectionQueryMembershipRule
-InputObject <IResultObject>
[-RuleName <String>]
[<CommonParameters>]
Description
Use this cmdlet to get one or more query membership rules for a device or user collection. A query rule lets you dynamically update the membership of a collection based on a query that is run on a schedule. For more information, see How to create collections in Configuration Manager.
For more information about membership rules, see Introduction to 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 query membership rules for the All Systems collection
This command gets the query membership rules from the default device collection named All Systems.
Get-CMCollectionQueryMembershipRule -CollectionName "All Systems"
Example 2: View the query expression for a rule on the All Users collection
This command gets the query membership rule named All Users from the All Users collection and returns the query expression.
Get-CMCollectionQueryMembershipRule -CollectionId "SMS00002" -RuleName "All Users" | Select-Object QueryExpression
Parameters
-CollectionId
Specify the ID of the collection to get the rule. This value is the CollectionID property, for example, XYZ00012
or SMS00001
.
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 |
-RuleName
Specify the name of the query rule to get from the collection.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Microsoft.ConfigurationManagement.ManagementProvider.IResultObject
Outputs
System.Object
Notes
This cmdlet is similar to Get-CMDeviceCollectionQueryMembershipRule and Get-CMUserCollectionQueryMembershipRule, which are specific to the type of collection. This cmdlet works with either device or user collections.
Related Links
- Remove-CMCollectionQueryMembershipRule
- Get-CMCollectionDirectMembershipRule
- Get-CMCollectionExcludeMembershipRule
- Get-CMCollectionIncludeMembershipRule
- Add-CMDeviceCollectionQueryMembershipRule
- Add-CMUserCollectionQueryMembershipRule
- Get-CMDeviceCollectionQueryMembershipRule
- Get-CMUserCollectionQueryMembershipRule
- Get-CMCollection
- Get-CMDeviceCollection
- Get-CMUserCollection
- How to create collections in Configuration Manager