Skip to content

Latest commit

 

History

History
144 lines (100 loc) · 3.93 KB

Get-CMUserCollectionQueryMembershipRule.md

File metadata and controls

144 lines (100 loc) · 3.93 KB
Raw

external help file: AdminUI.PS.psm1-help.xml Module Name: ConfigurationManager ms.date: 12/30/2021 schema: 2.0.0 title: Get-CMUserCollectionQueryMembershipRule

Get-CMUserCollectionQueryMembershipRule

SYNOPSIS

Get a query membership rule for a user collection.

SYNTAX

ByName (Default)

Get-CMUserCollectionQueryMembershipRule -CollectionName <String> [-RuleName <String>] [<CommonParameters>]

ById

Get-CMUserCollectionQueryMembershipRule -CollectionId <String> [-RuleName <String>] [<CommonParameters>]

ByValue

Get-CMUserCollectionQueryMembershipRule -InputObject <IResultObject> [-RuleName <String>] [<CommonParameters>]

DESCRIPTION

Use this cmdlet to get one or more query membership rules for a 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 a rule by using a collection name

This command gets the rule named Remote Users by Domain that belongs to the collection named Remote Users.

Get-CMUserCollectionQueryMembershipRule -CollectionName "Remote Users" -RuleName "Remote Users by Domain"

PARAMETERS

-CollectionId

Specify the ID of the user collection to get the rule. This value is the CollectionID property, for example, XYZ00012 or SMS00001.

Type: String
Parameter Sets: ById
Aliases: Id

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

-CollectionName

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

Type: String
Parameter Sets: ByName
Aliases: Name

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: 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.

Type: IResultObject
Parameter Sets: ByValue
Aliases: Collection

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-RuleName

Specify the name of the query rule to get from the collection.

Type: String
Parameter Sets: (All)
Aliases:

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

CommonParameters

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

INPUTS

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

OUTPUTS

System.Object

NOTES

RELATED LINKS

Add-CMUserCollectionQueryMembershipRule Remove-CMUserCollectionQueryMembershipRule

Get-CMCollectionQueryMembershipRule

Get-CMCollection Get-CMUserCollection

Get-CMDeviceCollectionQueryMembershipRule

How to create collections in Configuration Manager