Remove-CMUserCollectionFromAdministrativeUser
Remove-CMUserCollectionFromAdministrativeUser
Removes a user collection from an administrative user in Configuration Manager.
Syntax
Parameter Set: RemoveUserCollectionFromAdminByName_Name
Remove-CMUserCollectionFromAdministrativeUser -AdministrativeUserName <String> -UserCollectionName <String> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: RemoveUserCollectionFromAdminById_Id
Remove-CMUserCollectionFromAdministrativeUser -AdministrativeUserId <Int32> -UserCollectionId <String> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: RemoveUserCollectionFromAdminById_Name
Remove-CMUserCollectionFromAdministrativeUser -AdministrativeUserName <String> -UserCollectionId <String> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: RemoveUserCollectionFromAdminById_Object
Remove-CMUserCollectionFromAdministrativeUser -AdministrativeUser <IResultObject> -UserCollectionId <String> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: RemoveUserCollectionFromAdminByName_Id
Remove-CMUserCollectionFromAdministrativeUser -AdministrativeUserId <Int32> -UserCollectionName <String> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: RemoveUserCollectionFromAdminByName_Object
Remove-CMUserCollectionFromAdministrativeUser -AdministrativeUser <IResultObject> -UserCollectionName <String> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: RemoveUserCollectionFromAdminByObject_Id
Remove-CMUserCollectionFromAdministrativeUser -AdministrativeUserId <Int32> -UserCollection <IResultObject> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: RemoveUserCollectionFromAdminByObject_Name
Remove-CMUserCollectionFromAdministrativeUser -AdministrativeUserName <String> -UserCollection <IResultObject> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: RemoveUserCollectionFromAdminByObject_Object
Remove-CMUserCollectionFromAdministrativeUser -AdministrativeUser <IResultObject> -UserCollection <IResultObject> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Remove-CMUserCollectionFromAdministrativeUser cmdlet removes a user collection from an administrative user. In Microsoft System Center 2012 SP1 Configuration Manager, collections represent logical groupings of users or devices. Use collections to perform tasks such as managing settings or installing software updates.
Parameters
-AdministrativeUser<IResultObject>
Specifies a CMUserCollection object. To obtain a user collection object, use the Get-CMUserCollection cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-AdministrativeUserId<Int32>
Specifies a unique ID of an administrative group or user.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-AdministrativeUserName<String>
Specifies a name of an administrative group or user.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Force
Forces the command to run without asking for user confirmation.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-UserCollection<IResultObject>
Specifies a CMUserCollection object. To obtain a user collection object, use the Get-CMUserCollection cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-UserCollectionId<String>
Specifies a unique ID of a user collection associated with an administrative user.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-UserCollectionName<String>
Specifies a name of a user collection associated with an administrative user.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Add a user collection to an administrative user
This command removes a user collection from an administrative user.
PS C:\> Remove-CMUserCollectionFromAdministrativeUser -AdministrativeUserName "TSQA\teamadmin" -UserCollectionName "All Users and User Groups"