Skip to content

Commit 4bbb171

Browse files
Stacyrch140Stacyrch140
authored
Merge pull request #12077 from Andy447/add-teams-ai-cmdlet-docs
Add TeamsAIPolicy cmdlets public docs
2 parents 0abc1e4 + 171e697 commit 4bbb171

File tree

5 files changed

+482
-0
lines changed

5 files changed

+482
-0
lines changed

‎teams/teams-ps/teams/Get-CsTeamsAIPolicy.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml
3+
Module Name: MicrosoftTeams
4+
applicable: Microsoft Teams
5+
title: Get-CsTeamsAIPolicy
6+
online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsAIPolicy
7+
schema: 2.0.0
8+
author: Andy447
9+
ms.author: andywang
10+
---
11+
12+
# Get-CsTeamsAIPolicy
13+
14+
## SYNOPSIS
15+
16+
This cmdlet retrieves all Teams AI policies for current tenant.
17+
18+
## SYNTAX
19+
20+
```
21+
Get-CsTeamsAIPolicy
22+
```
23+
24+
## DESCRIPTION
25+
26+
This cmdlet retrieves all Teams AI policies for current tenant.
27+
28+
## EXAMPLES
29+
30+
### Example 1
31+
```powershell
32+
PS C:\> Get-CsTeamsAIPolicy
33+
```
34+
35+
Retrieves Teams AI policies, shows "EnrollFace" and "EnrollVoice" values.
36+
37+
## PARAMETERS
38+
39+
### CommonParameters
40+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
41+
42+
## INPUTS
43+
44+
## OUTPUTS
45+
46+
## RELATED LINKS
47+
48+
[New-CsTeamsAIPolicy](New-CsTeamsAIPolicy.md)
49+
50+
[Remove-CsTeamsAIPolicy](Remove-CsTeamsAIPolicy.yml)
51+
52+
[Set-CsTeamsAIPolicy](Set-CsTeamsAIPolicy.yml)
53+
54+
[Grant-CsTeamsAIPolicy](Grant-CsTeamsAIPolicy.yml)

‎teams/teams-ps/teams/Grant-CsTeamsAIPolicy.md

Lines changed: 190 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,190 @@
1+
---
2+
external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml
3+
Module Name: MicrosoftTeams
4+
applicable: Microsoft Teams
5+
title: Grant-CsTeamsAIPolicy
6+
online version: https://learn.microsoft.com/powershell/module/teams/Grant-CsTeamsAIPolicy
7+
schema: 2.0.0
8+
author: Andy447
9+
ms.author: andywang
10+
---
11+
12+
# Grant-CsTeamsAIPolicy
13+
14+
## SYNOPSIS
15+
This cmdlet applies an instance of the Teams AI policy to users or groups in a tenant.
16+
17+
## SYNTAX
18+
19+
### Identity (Default)
20+
```
21+
Grant-CsTeamsAIPolicy [<CommonParameters>]
22+
```
23+
24+
### GrantToUser
25+
```
26+
Grant-CsTeamsAIPolicy -Identity <String> [[-PolicyName] <String>] [<CommonParameters>]
27+
```
28+
29+
### GrantToGroup
30+
```
31+
Grant-CsTeamsAIPolicy [[-PolicyName] <String>] [-Group] <String> -Rank <Int32>
32+
[<CommonParameters>]
33+
```
34+
35+
### GrantToTenant
36+
```
37+
Grant-CsTeamsAIPolicy [[-PolicyName] <String>] [-Global] [-Force] [<CommonParameters>]
38+
```
39+
40+
## DESCRIPTION
41+
42+
This cmdlet applies an instance of the Teams AI policy to users or groups in a tenant.
43+
44+
Passes in the `Identity` of the policy instance in the `PolicyName` parameter and the user identifier in the `Identity` parameter or the group name in the `Group` parameter. One of either `Identity` or `Group` needs to be passed.
45+
46+
## EXAMPLES
47+
48+
### Example 1
49+
```powershell
50+
PS C:\> Grant-CsTeamsAIPolicy -PolicyName Test -Identity testuser@test.onmicrosoft.com
51+
```
52+
53+
Assigns a given policy to a user.
54+
55+
### Example 2
56+
```powershell
57+
PS C:\> Grant-CsTeamsAIPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName Test
58+
```
59+
60+
Assigns a given policy to a group.
61+
62+
63+
### Example 3
64+
```powershell
65+
PS C:\> Grant-CsTeamsAIPolicy -Global -PolicyName Test
66+
```
67+
68+
Assigns a given policy to the tenant.
69+
70+
### Example 4
71+
```powershell
72+
PS C:\> Grant-CsTeamsAIPolicy -Global -PolicyName Test
73+
```
74+
75+
Note: _Using $null in place of a policy name can be used to unassigned a policy instance._
76+
77+
## PARAMETERS
78+
79+
### -Force
80+
Suppresses the display of any non-fatal error message that might arise when running the command.
81+
82+
```yaml
83+
Type: SwitchParameter
84+
Parameter Sets: GrantToTenant
85+
Aliases:
86+
87+
Required: False
88+
Position: Named
89+
Default value: None
90+
Accept pipeline input: False
91+
Accept wildcard characters: False
92+
```
93+
94+
### -Global
95+
This is the equivalent to `-Identity Global`.
96+
97+
```yaml
98+
Type: SwitchParameter
99+
Parameter Sets: GrantToTenant
100+
Aliases:
101+
102+
Required: True
103+
Position: 0
104+
Default value: None
105+
Accept pipeline input: False
106+
Accept wildcard characters: False
107+
```
108+
109+
### -Group
110+
This is the identifier of the group that the policy should be assigned to.
111+
112+
```yaml
113+
Type: String
114+
Parameter Sets: GrantToGroup
115+
Aliases:
116+
117+
Required: True
118+
Position: 0
119+
Default value: None
120+
Accept pipeline input: False
121+
Accept wildcard characters: False
122+
```
123+
124+
### -Identity
125+
Specifies the identity of the target user.
126+
127+
Example: testuser@test.onmicrosoft.com
128+
129+
Example: 98403f08-577c-46dd-851a-f0460a13b03d
130+
131+
Use the "Global" Identity if you wish to set the policy for the entire tenant.
132+
133+
```yaml
134+
Type: String
135+
Parameter Sets: GrantToUser
136+
Aliases:
137+
138+
Required: True
139+
Position: Named
140+
Default value: None
141+
Accept pipeline input: False
142+
Accept wildcard characters: False
143+
```
144+
145+
### -PolicyName
146+
Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), for example, a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled".
147+
148+
```yaml
149+
Type: String
150+
Parameter Sets: GrantToUser, GrantToGroup, GrantToTenant
151+
Aliases:
152+
153+
Required: False
154+
Position: 1
155+
Default value: None
156+
Accept pipeline input: False
157+
Accept wildcard characters: False
158+
```
159+
160+
### -Rank
161+
The rank of the policy assignment, relative to other group policy assignments for the same policy type.
162+
163+
```yaml
164+
Type: Int32
165+
Parameter Sets: GrantToGroup
166+
Aliases:
167+
168+
Required: True
169+
Position: Named
170+
Default value: None
171+
Accept pipeline input: False
172+
Accept wildcard characters: False
173+
```
174+
175+
### CommonParameters
176+
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).
177+
178+
## INPUTS
179+
180+
## OUTPUTS
181+
182+
## RELATED LINKS
183+
184+
[New-CsTeamsAIPolicy](New-CsTeamsAIPolicy.md)
185+
186+
[Remove-CsTeamsAIPolicy](Remove-CsTeamsAIPolicy.yml)
187+
188+
[Get-CsTeamsAIPolicy](Get-CsTeamsAIPolicy.yml)
189+
190+
[Set-CsTeamsAIPolicy](Set-CsTeamsAIPolicy.yml)

‎teams/teams-ps/teams/New-CsTeamsAIPolicy.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml
3+
Module Name: MicrosoftTeams
4+
applicable: Microsoft Teams
5+
title: New-CsTeamsAIPolicy
6+
online version: https://learn.microsoft.com/powershell/module/teams/New-CsTeamsAIPolicy
7+
schema: 2.0.0
8+
author: Andy447
9+
ms.author: andywang
10+
---
11+
12+
13+
# New-CsTeamsAIPolicy
14+
15+
## SYNOPSIS
16+
This cmdlet creates a Teams AI policy.
17+
18+
## SYNTAX
19+
20+
```powershell
21+
New-CsTeamsAIPolicy -Identity <String>
22+
```
23+
24+
## DESCRIPTION
25+
This cmdlet creates a Teams AI policy. If you get an error that the policy already exists, it means that the policy already exists for your tenant. In this case, run Get-CsTeamsAIPolicy.
26+
27+
## EXAMPLES
28+
29+
### Example 1
30+
```powershell
31+
PS C:\> New-CsTeamsAIPolicy -Identity Test
32+
```
33+
Creates a new Teams AI policy with the specified identity.
34+
The newly created policy with value will be printed on success.
35+
36+
37+
## PARAMETERS
38+
39+
### -Identity
40+
Identity of the Teams AI policy.
41+
42+
```yaml
43+
Type: String
44+
Parameter Sets: (All)
45+
Aliases:
46+
47+
Required: True
48+
Position: Named
49+
Default value: None
50+
Accept pipeline input: False
51+
Accept wildcard characters: False
52+
```
53+
54+
### CommonParameters
55+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
56+
57+
58+
## RELATED LINKS
59+
[Remove-CsTeamsAIPolicy](Remove-CsTeamsAIPolicy.yml)
60+
61+
[Get-CsTeamsAIPolicy](Get-CsTeamsAIPolicy.yml)
62+
63+
[Set-CsTeamsAIPolicy](Set-CsTeamsAIPolicy.yml)
64+
65+
[Grant-CsTeamsAIPolicy](Grant-CsTeamsAIPolicy.yml)

‎teams/teams-ps/teams/Remove-CsTeamsAIPolicy.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
---
2+
external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml
3+
Module Name: MicrosoftTeams
4+
applicable: Microsoft Teams
5+
title: Remove-CsTeamsAIPolicy
6+
online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsTeamsAIPolicy
7+
schema: 2.0.0
8+
author: Andy447
9+
ms.author: andywang
10+
---
11+
12+
# Remove-CsTeamsAIPolicy
13+
14+
## SYNOPSIS
15+
16+
This cmdlet deletes a Teams AI policy.
17+
18+
## SYNTAX
19+
20+
```
21+
Remove-CsTeamsAIPolicy -Identity <String>
22+
```
23+
24+
## DESCRIPTION
25+
26+
This cmdlet deletes a Teams AI policy with the specified identity string.
27+
28+
## EXAMPLES
29+
30+
### Example 1
31+
```powershell
32+
PS C:\> Remove-CsTeamsAIPolicy -Identity "Test"
33+
```
34+
35+
Deletes a Teams AI policy with the identify of "Test".
36+
37+
## PARAMETERS
38+
39+
### -Identity
40+
Identity of the Teams AI policy.
41+
42+
```yaml
43+
Type: String
44+
Parameter Sets: (All)
45+
Aliases:
46+
47+
Required: True
48+
Position: Named
49+
Default value: None
50+
Accept pipeline input: False
51+
Accept wildcard characters: False
52+
```
53+
54+
### CommonParameters
55+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
56+
57+
## INPUTS
58+
59+
## OUTPUTS
60+
61+
## RELATED LINKS
62+
63+
[New-CsTeamsAIPolicy](New-CsTeamsAIPolicy.md)
64+
65+
[Get-CsTeamsAIPolicy](Get-CsTeamsAIPolicy.yml)
66+
67+
[Grant-CsTeamsAIPolicy](Grant-CsTeamsAIPolicy.yml)
68+
69+
[Set-CsTeamsAIPolicy](Set-CsTeamsAIPolicy.yml)

0 commit comments

Comments
 (0)