Add-CMUserCollectionToDistributionPointGroup
Add-CMUserCollectionToDistributionPointGroup
Associates members of a user collection to a distribution point group.
Syntax
Parameter Set: AddUserCollectionToDistributionPointGroupById_Id
Add-CMUserCollectionToDistributionPointGroup -DistributionPointGroupId <String> -UserCollectionId <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: AddUserCollectionToDistributionPointGroupById_Name
Add-CMUserCollectionToDistributionPointGroup -DistributionPointGroupName <String> -UserCollectionId <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: AddUserCollectionToDistributionPointGroupById_Object
Add-CMUserCollectionToDistributionPointGroup -DistributionPointGroup <IResultObject> -UserCollectionId <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: AddUserCollectionToDistributionPointGroupByName_Id
Add-CMUserCollectionToDistributionPointGroup -DistributionPointGroupId <String> -UserCollectionName <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: AddUserCollectionToDistributionPointGroupByName_Name
Add-CMUserCollectionToDistributionPointGroup -DistributionPointGroupName <String> -UserCollectionName <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: AddUserCollectionToDistributionPointGroupByName_Object
Add-CMUserCollectionToDistributionPointGroup -DistributionPointGroup <IResultObject> -UserCollectionName <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: AddUserCollectionToDistributionPointGroupByObject_Id
Add-CMUserCollectionToDistributionPointGroup -DistributionPointGroupId <String> -UserCollection <IResultObject> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: AddUserCollectionToDistributionPointGroupByObject_Name
Add-CMUserCollectionToDistributionPointGroup -DistributionPointGroupName <String> -UserCollection <IResultObject> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: AddUserCollectionToDistributionPointGroupByObject_Object
Add-CMUserCollectionToDistributionPointGroup -DistributionPointGroup <IResultObject> -UserCollection <IResultObject> [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Add-CMUserCollectionToDistributionPointGroup cmdlet associates members of a user collection to a distribution point group. A distribution point group is a set of distribution points that you can manage as a single entity.
After you distribute content to a collection, and then associate the collection to a new distribution point group, you must redistribute the content to the collection before the content is distributed to the new distribution point group.
Parameters
-DistributionPointGroup<IResultObject>
Specifies a CMDistributionPointGroup object. To obtain a CMDistributionPointGroup object, use the Get-CMDistributionPointGroup cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DistributionPointGroupId<String>
Specifies an ID of a distribution point group.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DistributionPointGroupName<String>
Specifies the name of a distribution point group.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-UserCollection<IResultObject>
Specifies a CMUserCollection object. To obtain a CMUserCollection 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 an ID of a user collection.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-UserCollectionName<String>
Specifies the name of a user collection.
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: Associate a user collection with a distribution point group by using a name
This command associates the user collection named UserCollection05 with the distribution point group named DPG05ContosoWest.
PS C:\> Add-CMUserCollectionToDistributionPointGroup -UserCollectionName "UserCollection05" -DistributionPointGroupName "DPG05ContosoWest"