Skip to content

Commit ef5de5d

Browse files
authored
Merge pull request #12135 from Andy447/fix-teams-ai-cmdlet-docs
Add missing params to teams ai policy cmdlet docs
2 parents 7bcdf27 + c7dbf25 commit ef5de5d

File tree

5 files changed

+89
-18
lines changed

5 files changed

+89
-18
lines changed

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

Lines changed: 36 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ Get-CsTeamsAIPolicy
2323

2424
## DESCRIPTION
2525

26+
The new csTeamsAIPolicy will replace the existing enrollment settings in csTeamsMeetingPolicy, providing enhanced flexibility and control for Teams meeting administrators. Unlike the current single setting, EnrollUserOverride, which applies to both face and voice enrollment, the new policy introduces two distinct settings: EnrollFace and EnrollVoice. These can be individually set to Enabled or Disabled, offering more granular control over biometric enrollments. In addition to improving the management of face and voice data, the csTeamsAIPolicy is designed to support future AI-related settings in Teams, making it a scalable solution for evolving needs.
27+
2628
This cmdlet retrieves all Teams AI policies for current tenant.
2729

2830
## EXAMPLES
@@ -36,6 +38,37 @@ Retrieves Teams AI policies, shows "EnrollFace" and "EnrollVoice" values.
3638

3739
## PARAMETERS
3840

41+
### -Identity
42+
Identity of the Teams AI policy.
43+
44+
```yaml
45+
Type: String
46+
Parameter Sets: (All)
47+
Aliases:
48+
49+
Required: True
50+
Position: Named
51+
Default value: None
52+
Accept pipeline input: False
53+
Accept wildcard characters: False
54+
```
55+
56+
### -Filter
57+
Enables you to use wildcard characters when indicating the policy (or policies) to be returned.
58+
To return a collection of all the per-user policies, use this syntax: -Filter "tag:*".
59+
60+
```yaml
61+
Type: String
62+
Parameter Sets: (All)
63+
Aliases:
64+
65+
Required: False
66+
Position: Named
67+
Default value: None
68+
Accept pipeline input: False
69+
Accept wildcard characters: False
70+
```
71+
3972
### CommonParameters
4073
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).
4174
@@ -47,8 +80,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
4780
4881
[New-CsTeamsAIPolicy](New-CsTeamsAIPolicy.md)
4982
50-
[Remove-CsTeamsAIPolicy](Remove-CsTeamsAIPolicy.yml)
83+
[Remove-CsTeamsAIPolicy](Remove-CsTeamsAIPolicy.md)
5184
52-
[Set-CsTeamsAIPolicy](Set-CsTeamsAIPolicy.yml)
85+
[Set-CsTeamsAIPolicy](Set-CsTeamsAIPolicy.md)
5386
54-
[Grant-CsTeamsAIPolicy](Grant-CsTeamsAIPolicy.yml)
87+
[Grant-CsTeamsAIPolicy](Grant-CsTeamsAIPolicy.md)

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

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@ Grant-CsTeamsAIPolicy [[-PolicyName] <String>] [-Global] [-Force] [<CommonParame
3939

4040
## DESCRIPTION
4141

42+
The new csTeamsAIPolicy will replace the existing enrollment settings in csTeamsMeetingPolicy, providing enhanced flexibility and control for Teams meeting administrators. Unlike the current single setting, EnrollUserOverride, which applies to both face and voice enrollment, the new policy introduces two distinct settings: EnrollFace and EnrollVoice. These can be individually set to Enabled or Disabled, offering more granular control over biometric enrollments. In addition to improving the management of face and voice data, the csTeamsAIPolicy is designed to support future AI-related settings in Teams, making it a scalable solution for evolving needs.
43+
4244
This cmdlet applies an instance of the Teams AI policy to users or groups in a tenant.
4345

4446
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.
@@ -183,8 +185,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
183185

184186
[New-CsTeamsAIPolicy](New-CsTeamsAIPolicy.md)
185187

186-
[Remove-CsTeamsAIPolicy](Remove-CsTeamsAIPolicy.yml)
188+
[Remove-CsTeamsAIPolicy](Remove-CsTeamsAIPolicy.md)
187189

188-
[Get-CsTeamsAIPolicy](Get-CsTeamsAIPolicy.yml)
190+
[Get-CsTeamsAIPolicy](Get-CsTeamsAIPolicy.md)
189191

190-
[Set-CsTeamsAIPolicy](Set-CsTeamsAIPolicy.yml)
192+
[Set-CsTeamsAIPolicy](Set-CsTeamsAIPolicy.md)

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

Lines changed: 37 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ New-CsTeamsAIPolicy -Identity <String>
2222
```
2323

2424
## DESCRIPTION
25+
26+
The new csTeamsAIPolicy will replace the existing enrollment settings in csTeamsMeetingPolicy, providing enhanced flexibility and control for Teams meeting administrators. Unlike the current single setting, EnrollUserOverride, which applies to both face and voice enrollment, the new policy introduces two distinct settings: EnrollFace and EnrollVoice. These can be individually set to Enabled or Disabled, offering more granular control over biometric enrollments. In addition to improving the management of face and voice data, the csTeamsAIPolicy is designed to support future AI-related settings in Teams, making it a scalable solution for evolving needs.
27+
2528
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.
2629

2730
## EXAMPLES
@@ -33,7 +36,6 @@ PS C:\> New-CsTeamsAIPolicy -Identity Test
3336
Creates a new Teams AI policy with the specified identity.
3437
The newly created policy with value will be printed on success.
3538

36-
3739
## PARAMETERS
3840

3941
### -Identity
@@ -51,15 +53,45 @@ Accept pipeline input: False
5153
Accept wildcard characters: False
5254
```
5355
56+
### -EnrollFace
57+
Policy value of the Teams AI EnrollFace policy. EnrollFace controls user access to user face enrollment in the Teams app settings.
58+
59+
```yaml
60+
Type: Boolean
61+
Parameter Sets: ("Enabled","Disabled")
62+
Aliases:
63+
64+
Required: True
65+
Position: Named
66+
Default value: Enabled
67+
Accept pipeline input: False
68+
Accept wildcard characters: False
69+
```
70+
71+
### -EnrollVoice
72+
Policy value of the Teams AI EnrollVoice policy. EnrollVoice controls user access to user voice enrollment in the Teams app settings.
73+
74+
```yaml
75+
Type: Boolean
76+
Parameter Sets: ("Enabled","Disabled")
77+
Aliases:
78+
79+
Required: True
80+
Position: Named
81+
Default value: Enabled
82+
Accept pipeline input: False
83+
Accept wildcard characters: False
84+
```
85+
5486
### CommonParameters
5587
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).
5688
5789
5890
## RELATED LINKS
59-
[Remove-CsTeamsAIPolicy](Remove-CsTeamsAIPolicy.yml)
91+
[Remove-CsTeamsAIPolicy](Remove-CsTeamsAIPolicy.md)
6092
61-
[Get-CsTeamsAIPolicy](Get-CsTeamsAIPolicy.yml)
93+
[Get-CsTeamsAIPolicy](Get-CsTeamsAIPolicy.md)
6294
63-
[Set-CsTeamsAIPolicy](Set-CsTeamsAIPolicy.yml)
95+
[Set-CsTeamsAIPolicy](Set-CsTeamsAIPolicy.md)
6496
65-
[Grant-CsTeamsAIPolicy](Grant-CsTeamsAIPolicy.yml)
97+
[Grant-CsTeamsAIPolicy](Grant-CsTeamsAIPolicy.md)

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

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,13 @@ This cmdlet deletes a Teams AI policy.
1818
## SYNTAX
1919

2020
```
21-
Remove-CsTeamsAIPolicy -Identity <String>
21+
Remove-CsTeamsAIPolicy -Identity <String>
2222
```
2323

2424
## DESCRIPTION
2525

26+
The new csTeamsAIPolicy will replace the existing enrollment settings in csTeamsMeetingPolicy, providing enhanced flexibility and control for Teams meeting administrators. Unlike the current single setting, EnrollUserOverride, which applies to both face and voice enrollment, the new policy introduces two distinct settings: EnrollFace and EnrollVoice. These can be individually set to Enabled or Disabled, offering more granular control over biometric enrollments. In addition to improving the management of face and voice data, the csTeamsAIPolicy is designed to support future AI-related settings in Teams, making it a scalable solution for evolving needs.
27+
2628
This cmdlet deletes a Teams AI policy with the specified identity string.
2729

2830
## EXAMPLES
@@ -62,8 +64,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
6264
6365
[New-CsTeamsAIPolicy](New-CsTeamsAIPolicy.md)
6466
65-
[Get-CsTeamsAIPolicy](Get-CsTeamsAIPolicy.yml)
67+
[Get-CsTeamsAIPolicy](Get-CsTeamsAIPolicy.md)
6668
67-
[Grant-CsTeamsAIPolicy](Grant-CsTeamsAIPolicy.yml)
69+
[Grant-CsTeamsAIPolicy](Grant-CsTeamsAIPolicy.md)
6870
69-
[Set-CsTeamsAIPolicy](Set-CsTeamsAIPolicy.yml)
71+
[Set-CsTeamsAIPolicy](Set-CsTeamsAIPolicy.md)

teams/teams-ps/teams/Set-CsTeamsAIPolicy.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ Set-CsTeamsAIPolicy
2626

2727
## DESCRIPTION
2828

29+
The new csTeamsAIPolicy will replace the existing enrollment settings in csTeamsMeetingPolicy, providing enhanced flexibility and control for Teams meeting administrators. Unlike the current single setting, EnrollUserOverride, which applies to both face and voice enrollment, the new policy introduces two distinct settings: EnrollFace and EnrollVoice. These can be individually set to Enabled or Disabled, offering more granular control over biometric enrollments. In addition to improving the management of face and voice data, the csTeamsAIPolicy is designed to support future AI-related settings in Teams, making it a scalable solution for evolving needs.
30+
2931
This cmdlet sets the Teams AI policy EnrollFace and EnrollVoice value for the tenant. The values of EnrollFace and EnrollVoice can be set to "Enabled" or "Disabled".
3032

3133
## EXAMPLES
@@ -114,8 +116,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
114116
115117
[New-CsTeamsAIPolicy](New-CsTeamsAIPolicy.md)
116118
117-
[Remove-CsTeamsAIPolicy](Remove-CsTeamsAIPolicy.yml)
119+
[Remove-CsTeamsAIPolicy](Remove-CsTeamsAIPolicy.md)
118120
119-
[Get-CsTeamsAIPolicy](Get-CsTeamsAIPolicy.yml)
121+
[Get-CsTeamsAIPolicy](Get-CsTeamsAIPolicy.md)
120122
121-
[Grant-CsTeamsAIPolicy](Grant-CsTeamsAIPolicy.yml)
123+
[Grant-CsTeamsAIPolicy](Grant-CsTeamsAIPolicy.md)

0 commit comments

Comments
 (0)