Skip to content

Commit 7796116

Browse files
emartinezrodemartinezrod
authored
Create Invoke-StartDirectToGroupAssignmentMigration.md
Adding new documentation for command Invoke-StartDirectToGroupAssignmentMigration related to GPA Adoption project from IC3 Tenant Policy team.
1 parent 9ff8805 commit 7796116

File tree

1 file changed

+132
-0
lines changed

1 file changed

+132
-0
lines changed

‎teams/teams-ps/MicrosoftTeams/Invoke-StartDirectToGroupAssignmentMigration.md‎

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
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: Invoke-StartDirectToGroupAssignmentMigration
8+
---
9+
10+
# Invoke-StartDirectToGroupAssignmentMigration
11+
12+
## SYNOPSIS
13+
As an admin, you can trigger a new direct assignments to group policy assignments migration.
14+
15+
## SYNTAX
16+
17+
```
18+
Invoke-StartDirectToGroupAssignmentMigration -Authority <String> -PolicyType <String> -PolicyName <String>
19+
-GroupId <Guid> [-AllowNonEmptyGroup <Boolean>] [<CommonParameters>]
20+
```
21+
22+
## DESCRIPTION
23+
As an admin, you can trigger a new direct assignments to group policy assignments migration for a specific authority, instance document and group id. The migration will be automatic and will move all the users that have the direct assignment with the provided parameters to the group provided and will apply the correct group policy assignment, removing after all the exiting direct assignments to avoid any conflict. At the end the behavior will be the same one but the admin will have now to manage only a group instead of a bunch of direct assignments.
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:\> Invoke-startDirectToGroupAssignmentMigration -Authority Tenant -PolicyType TeamsCallingPolicy -PolicyName Test-Gpa-Adoption-Policy-2 -GroupId cde9a331-5bf8-415c-990c-19838b0d898c
32+
```
33+
34+
In this example, the Invoke-startDirectToGroupAssignmentMigration cmdlet is used to trigger the direct assignment to group policy assignment migration for the instance document with policy type TeamsCallingPolicy and name Test-Gpa-Adoption-Policy-2 to the group cde9a331-5bf8-415c-990c-19838b0d898c. In this case the flag allowNonEmptyGroup is not provided and the default will be false which means if the group provided already have an active group policy assignment the operation wont be trigger.
35+
36+
### Example 2
37+
```powershell
38+
PS C:\> Invoke-startDirectToGroupAssignmentMigration -Authority Tenant -PolicyType TeamsCallingPolicy -PolicyName Test-Gpa-Adoption-Policy-2 -GroupId cde9a331-5bf8-415c-990c-19838b0d898c -allowNonEmptyGroup $True
39+
```
40+
41+
In this example, the Invoke-startDirectToGroupAssignmentMigration cmdlet is used to trigger the direct assignment to group policy assignment migration for the instance document with policy type TeamsCallingPolicy and name Test-Gpa-Adoption-Policy-2 to the group cde9a331-5bf8-415c-990c-19838b0d898c. In this case the flag allowNonEmptyGroup is provided which means even thought the group provided already have an active group policy assignment the operation will be trigger.
42+
43+
## PARAMETERS
44+
45+
### -AllowNonEmptyGroup
46+
Flag to know if the process should continue or not when the group provided already have an active group policy assignment.
47+
48+
```yaml
49+
Type: Boolean
50+
Parameter Sets: (All)
51+
Aliases:
52+
53+
Required: False
54+
Position: Named
55+
Default value: None
56+
Accept pipeline input: False
57+
Accept wildcard characters: False
58+
```
59+
60+
### -Authority
61+
The authority (issuer) of the policy.
62+
63+
```yaml
64+
Type: String
65+
Parameter Sets: (All)
66+
Aliases:
67+
68+
Required: True
69+
Position: Named
70+
Default value: None
71+
Accept pipeline input: False
72+
Accept wildcard characters: False
73+
```
74+
75+
### -GroupId
76+
The target group ID.
77+
78+
```yaml
79+
Type: Guid
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+
### -PolicyName
91+
The name of the policy.
92+
93+
```yaml
94+
Type: String
95+
Parameter Sets: (All)
96+
Aliases:
97+
98+
Required: True
99+
Position: Named
100+
Default value: None
101+
Accept pipeline input: False
102+
Accept wildcard characters: False
103+
```
104+
105+
### -PolicyType
106+
The type of the policy.
107+
108+
```yaml
109+
Type: String
110+
Parameter Sets: (All)
111+
Aliases:
112+
113+
Required: True
114+
Position: Named
115+
Default value: None
116+
Accept pipeline input: False
117+
Accept wildcard characters: False
118+
```
119+
120+
### CommonParameters
121+
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).
122+
123+
## INPUTS
124+
125+
### None
126+
127+
## OUTPUTS
128+
129+
### System.Object
130+
## NOTES
131+
132+
## RELATED LINKS

0 commit comments

Comments
 (0)