|
| 1 | +--- |
| 2 | +applicable: Microsoft Teams |
| 3 | +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml |
| 4 | +Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core |
| 5 | +online version: |
| 6 | +schema: 2.0.0 |
| 7 | +title: Get-GroupAssignmentRecommendationsPerPolicyName |
| 8 | +--- |
| 9 | + |
| 10 | +# Get-GroupAssignmentRecommendationsPerPolicyName |
| 11 | + |
| 12 | +## SYNOPSIS |
| 13 | +As an admin, you can get group policy assignments recommendations based on the existing direct assignments for a policy document. |
| 14 | + |
| 15 | +## SYNTAX |
| 16 | + |
| 17 | +``` |
| 18 | +Get-GroupAssignmentRecommendationsPerPolicyName -EntityType <String> -PolicyType <String> |
| 19 | + [-GroupThreshold <String>] [<CommonParameters>] |
| 20 | +``` |
| 21 | + |
| 22 | +## DESCRIPTION |
| 23 | +As an admin, you can get a list of possible group policy assignments that can be created based on the existing direct assignments for a policy document provided, grouping by policy instance name. |
| 24 | + |
| 25 | +**This is only applicable for tenants who have activated the new features related to group policy assignment adoption.** |
| 26 | + |
| 27 | +## EXAMPLES |
| 28 | + |
| 29 | +### Example 1 |
| 30 | +```powershell |
| 31 | +PS C:\> Get-GroupAssignmentRecommendationsPerPolicyName -EntityType User -PolicyType TeamsCallingPolicy |
| 32 | +``` |
| 33 | + |
| 34 | +In this example, the Get-GroupAssignmentRecommendationsPerPolicyName cmdlet is used to get all the possible group policy assignments that can be created for the policy type TeamsCallingPolicy and entity type User. In this case the group threshold is not provided so the default will be 500, which means that all the recommendations will have at least 500 users. This threshold can change based on admin preferences. |
| 35 | + |
| 36 | +### Example 2 |
| 37 | +```powershell |
| 38 | +PS C:\> Get-GroupAssignmentRecommendationsPerPolicyName -EntityType User -GroupThreshold 1 -PolicyType TeamsCallingPolicy |
| 39 | +``` |
| 40 | + |
| 41 | +In this example, the Get-GroupAssignmentRecommendationsPerPolicyName cmdlet is used to get all the possible group policy assignments that can be created for the policy type TeamsCallingPolicy, entity type User and providing a group threshold of 1, which means that all the recommendations will have at least 1 user. This threshold can change based on admin preferences. |
| 42 | + |
| 43 | +## PARAMETERS |
| 44 | + |
| 45 | +### -EntityType |
| 46 | +Entity type from which the cmdlet will provide the recommendations. |
| 47 | + |
| 48 | +```yaml |
| 49 | +Type: String |
| 50 | +Parameter Sets: (All) |
| 51 | +Aliases: |
| 52 | + |
| 53 | +Required: True |
| 54 | +Position: Named |
| 55 | +Default value: None |
| 56 | +Accept pipeline input: False |
| 57 | +Accept wildcard characters: False |
| 58 | +``` |
| 59 | +
|
| 60 | +### -GroupThreshold |
| 61 | +Group threshold used to define the minimum number of users per group that will be recommended. |
| 62 | +
|
| 63 | +```yaml |
| 64 | +Type: String |
| 65 | +Parameter Sets: (All) |
| 66 | +Aliases: |
| 67 | + |
| 68 | +Required: False |
| 69 | +Position: Named |
| 70 | +Default value: None |
| 71 | +Accept pipeline input: False |
| 72 | +Accept wildcard characters: False |
| 73 | +``` |
| 74 | +
|
| 75 | +### -PolicyType |
| 76 | +Policy type of the instance from which the cmdlet will provide the recommendations. |
| 77 | +
|
| 78 | +```yaml |
| 79 | +Type: String |
| 80 | +Parameter Sets: (All) |
| 81 | +Aliases: |
| 82 | + |
| 83 | +Required: True |
| 84 | +Position: Named |
| 85 | +Default value: None |
| 86 | +Accept pipeline input: False |
| 87 | +Accept wildcard characters: False |
| 88 | +``` |
| 89 | +
|
| 90 | +### CommonParameters |
| 91 | +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). |
| 92 | +
|
| 93 | +## INPUTS |
| 94 | +
|
| 95 | +### None |
| 96 | +
|
| 97 | +## OUTPUTS |
| 98 | +
|
| 99 | +### System.Object |
| 100 | +## NOTES |
| 101 | +
|
| 102 | +## RELATED LINKS |
0 commit comments