Skip to content

Add missing params to teams ai policy cmdlet docs #12135

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Sep 27, 2024
Merged

Add missing params to teams ai policy cmdlet docs #12135

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
77cb38d
Add missin params to teams ai policy cmdlet docs
Sep 27, 2024
9f69710
Add description to all teams ai policy cmdlet docs
Sep 27, 2024
0444085
Fix related links
Sep 27, 2024
35455cc
Merge branch 'main' into fix-teams-ai-cmdlet-docs
Andy447 Sep 27, 2024
c7dbf25
Merge branch 'main' into fix-teams-ai-cmdlet-docs
Andy447 Sep 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 36 additions & 3 deletions teams/teams-ps/teams/Get-CsTeamsAIPolicy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ Get-CsTeamsAIPolicy

## DESCRIPTION

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.

This cmdlet retrieves all Teams AI policies for current tenant.

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

## PARAMETERS

### -Identity
Identity of the Teams AI policy.

```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Filter
Enables you to use wildcard characters when indicating the policy (or policies) to be returned.
To return a collection of all the per-user policies, use this syntax: -Filter "tag:*".

```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters
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).

Expand All @@ -47,8 +80,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

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

[Remove-CsTeamsAIPolicy](Remove-CsTeamsAIPolicy.yml)
[Remove-CsTeamsAIPolicy](Remove-CsTeamsAIPolicy.md)

[Set-CsTeamsAIPolicy](Set-CsTeamsAIPolicy.yml)
[Set-CsTeamsAIPolicy](Set-CsTeamsAIPolicy.md)

[Grant-CsTeamsAIPolicy](Grant-CsTeamsAIPolicy.yml)
[Grant-CsTeamsAIPolicy](Grant-CsTeamsAIPolicy.md)
8 changes: 5 additions & 3 deletions teams/teams-ps/teams/Grant-CsTeamsAIPolicy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ Grant-CsTeamsAIPolicy [[-PolicyName] <String>] [-Global] [-Force] [<CommonParame

## DESCRIPTION

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.

This cmdlet applies an instance of the Teams AI policy to users or groups in a tenant.

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

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

[Remove-CsTeamsAIPolicy](Remove-CsTeamsAIPolicy.yml)
[Remove-CsTeamsAIPolicy](Remove-CsTeamsAIPolicy.md)

[Get-CsTeamsAIPolicy](Get-CsTeamsAIPolicy.yml)
[Get-CsTeamsAIPolicy](Get-CsTeamsAIPolicy.md)

[Set-CsTeamsAIPolicy](Set-CsTeamsAIPolicy.yml)
[Set-CsTeamsAIPolicy](Set-CsTeamsAIPolicy.md)
42 changes: 37 additions & 5 deletions teams/teams-ps/teams/New-CsTeamsAIPolicy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ New-CsTeamsAIPolicy -Identity <String>
```

## DESCRIPTION

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.

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.

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


## PARAMETERS

### -Identity
Expand All @@ -51,15 +53,45 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -EnrollFace
Policy value of the Teams AI EnrollFace policy. EnrollFace controls user access to user face enrollment in the Teams app settings.

```yaml
Type: Boolean
Parameter Sets: ("Enabled","Disabled")
Aliases:

Required: True
Position: Named
Default value: Enabled
Accept pipeline input: False
Accept wildcard characters: False
```

### -EnrollVoice
Policy value of the Teams AI EnrollVoice policy. EnrollVoice controls user access to user voice enrollment in the Teams app settings.

```yaml
Type: Boolean
Parameter Sets: ("Enabled","Disabled")
Aliases:

Required: True
Position: Named
Default value: Enabled
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters
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).


## RELATED LINKS
[Remove-CsTeamsAIPolicy](Remove-CsTeamsAIPolicy.yml)
[Remove-CsTeamsAIPolicy](Remove-CsTeamsAIPolicy.md)

[Get-CsTeamsAIPolicy](Get-CsTeamsAIPolicy.yml)
[Get-CsTeamsAIPolicy](Get-CsTeamsAIPolicy.md)

[Set-CsTeamsAIPolicy](Set-CsTeamsAIPolicy.yml)
[Set-CsTeamsAIPolicy](Set-CsTeamsAIPolicy.md)

[Grant-CsTeamsAIPolicy](Grant-CsTeamsAIPolicy.yml)
[Grant-CsTeamsAIPolicy](Grant-CsTeamsAIPolicy.md)
10 changes: 6 additions & 4 deletions teams/teams-ps/teams/Remove-CsTeamsAIPolicy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,13 @@ This cmdlet deletes a Teams AI policy.
## SYNTAX

```
Remove-CsTeamsAIPolicy -Identity <String>
Remove-CsTeamsAIPolicy -Identity <String>
```

## DESCRIPTION

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.

This cmdlet deletes a Teams AI policy with the specified identity string.

## EXAMPLES
Expand Down Expand Up @@ -62,8 +64,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

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

[Get-CsTeamsAIPolicy](Get-CsTeamsAIPolicy.yml)
[Get-CsTeamsAIPolicy](Get-CsTeamsAIPolicy.md)

[Grant-CsTeamsAIPolicy](Grant-CsTeamsAIPolicy.yml)
[Grant-CsTeamsAIPolicy](Grant-CsTeamsAIPolicy.md)

[Set-CsTeamsAIPolicy](Set-CsTeamsAIPolicy.yml)
[Set-CsTeamsAIPolicy](Set-CsTeamsAIPolicy.md)
8 changes: 5 additions & 3 deletions teams/teams-ps/teams/Set-CsTeamsAIPolicy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ Set-CsTeamsAIPolicy

## DESCRIPTION

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.

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".

## EXAMPLES
Expand Down Expand Up @@ -114,8 +116,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

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

[Remove-CsTeamsAIPolicy](Remove-CsTeamsAIPolicy.yml)
[Remove-CsTeamsAIPolicy](Remove-CsTeamsAIPolicy.md)

[Get-CsTeamsAIPolicy](Get-CsTeamsAIPolicy.yml)
[Get-CsTeamsAIPolicy](Get-CsTeamsAIPolicy.md)

[Grant-CsTeamsAIPolicy](Grant-CsTeamsAIPolicy.yml)
[Grant-CsTeamsAIPolicy](Grant-CsTeamsAIPolicy.md)