Use this cmdlet to configure collection membership synchronization to Microsoft Entra groups for a device or user collection.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.
Examples
Example 1: Enable a collection to synchronize members to Microsoft Entra group
The first command gets the collection object named testUserCollection and stores it in the $userCollection variable.
The second command gets the Microsoft Entra tenant named contoso and stores it in the $AADTenant variable.
The third command enables the synchronization of the collection with Microsoft Entra group named testUserGroup belonging to tenant name "contoso"
Example 2: Remove collection synchronization with Microsoft Entra group
The first command gets the collection object named testUserCollection and stores it in the $userCollection variable.
The second command removes the synchronization of the collection with Microsoft Entra group named testUserGroup belonging to tenant name "contoso", which is passed as value for -TenantName parameter. Alternatively -TenantId parameter can also be used.
Use this parameter to remove synchronization with the specified Microsoft Entra group.
Parameter properties
Type:
String
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
-TenantId
Specify the ID of the Microsoft Entra tenant. This value is the TenantId property, for example, 72f988bf-00ab-11cd-22ef-2d7cd011db00.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-TenantName
Specify the name of the Microsoft Entra tenant, for example, contoso.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-TenantObject
Specify an object for the Microsoft Entra tenant. To get this object, use the Get-CMAADTenant cmdlet.
Parameter properties
Type:
IResultObject
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
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.