-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Add TeamsAIPolicy cmdlets public docs #12077
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.
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
Stacyrch140
merged 13 commits into
MicrosoftDocs:main
from
Andy447:add-teams-ai-cmdlet-docs
Sep 4, 2024
Merged
Changes from 10 commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
23d7f2e
Add TeamsAIPolicy cmdlets public docs
07a743b
Fix author name as github id
0c610bc
Fix Grant doc wording
6252a1c
Merge branch 'main' into add-teams-ai-cmdlet-docs
Andy447 9ea2a59
Merge branch 'main' into add-teams-ai-cmdlet-docs
Andy447 36dfd86
Merge branch 'main' into add-teams-ai-cmdlet-docs
Andy447 1edefb5
Merge branch 'main' into add-teams-ai-cmdlet-docs
Andy447 30838a6
Merge branch 'main' into add-teams-ai-cmdlet-docs
Andy447 04cf383
Merge branch 'main' into add-teams-ai-cmdlet-docs
Andy447 83723b2
Merge branch 'main' into add-teams-ai-cmdlet-docs
Andy447 4821b61
Fixes
53b2ca9
Merge branch 'add-teams-ai-cmdlet-docs' of https://github.com/Andy447…
171e697
Merge branch 'main' into add-teams-ai-cmdlet-docs
Andy447 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
--- | ||
external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml | ||
Module Name: MicrosoftTeams | ||
applicable: Microsoft Teams | ||
title: Get-CsTeamsAIPolicy | ||
online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsAIPolicy | ||
schema: 2.0.0 | ||
author: Andy447 | ||
ms.author: andywang | ||
--- | ||
|
||
# Get-CsTeamsAIPolicy | ||
|
||
## SYNOPSIS | ||
|
||
This cmdlet retrieves all Teams AI policies for current tenant. | ||
|
||
## SYNTAX | ||
|
||
``` | ||
Get-CsTeamsAIPolicy | ||
``` | ||
|
||
## DESCRIPTION | ||
|
||
This cmdlet retrieves all Teams AI policies for current tenant. | ||
|
||
## EXAMPLES | ||
|
||
### Example 1 | ||
```powershell | ||
PS C:\> Get-CsTeamsAIPolicy | ||
``` | ||
|
||
retrieves Teams AI policies, shows "EnrollFace" and "EnrollVoice" values. | ||
|
||
## PARAMETERS | ||
|
||
### 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). | ||
|
||
## INPUTS | ||
|
||
## OUTPUTS | ||
|
||
## RELATED LINKS | ||
|
||
[New-CsTeamsAIPolicy](New-CsTeamsAIPolicy.md) | ||
|
||
[Remove-CsTeamsAIPolicy](Remove-CsTeamsAIPolicy.yml) | ||
|
||
[Set-CsTeamsAIPolicy](Set-CsTeamsAIPolicy.yml) | ||
|
||
[Grant-CsTeamsAIPolicy](Grant-CsTeamsAIPolicy.yml) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,190 @@ | ||
--- | ||
external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml | ||
Module Name: MicrosoftTeams | ||
applicable: Microsoft Teams | ||
title: Grant-CsTeamsAIPolicy | ||
online version: https://learn.microsoft.com/powershell/module/teams/Grant-CsTeamsAIPolicy | ||
schema: 2.0.0 | ||
author: Andy447 | ||
ms.author: andywang | ||
--- | ||
|
||
# Grant-CsTeamsAIPolicy | ||
|
||
## SYNOPSIS | ||
This cmdlet applies an instance of the Teams AI policy to users or groups in a tenant. | ||
|
||
## SYNTAX | ||
|
||
### Identity (Default) | ||
``` | ||
Grant-CsTeamsAIPolicy [<CommonParameters>] | ||
``` | ||
|
||
### GrantToUser | ||
``` | ||
Grant-CsTeamsAIPolicy -Identity <String> [[-PolicyName] <String>] [<CommonParameters>] | ||
``` | ||
|
||
### GrantToGroup | ||
``` | ||
Grant-CsTeamsAIPolicy [[-PolicyName] <String>] [-Group] <String> -Rank <Int32> | ||
[<CommonParameters>] | ||
``` | ||
|
||
### GrantToTenant | ||
``` | ||
Grant-CsTeamsAIPolicy [[-PolicyName] <String>] [-Global] [-Force] [<CommonParameters>] | ||
``` | ||
|
||
## DESCRIPTION | ||
|
||
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. | ||
|
||
## EXAMPLES | ||
|
||
### Example 1 | ||
```powershell | ||
PS C:\> Grant-CsTeamsAIPolicy -PolicyName Test -Identity [email protected] | ||
``` | ||
|
||
Assigns a given policy to a user. | ||
|
||
### Example 2 | ||
```powershell | ||
PS C:\> Grant-CsTeamsAIPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName Test | ||
``` | ||
|
||
Assigns a given policy to a group. | ||
|
||
|
||
### Example 3 | ||
```powershell | ||
PS C:\> Grant-CsTeamsAIPolicy -Global -PolicyName Test | ||
``` | ||
|
||
Assigns a given policy to the tenant. | ||
|
||
### Example 4 | ||
```powershell | ||
PS C:\> Grant-CsTeamsAIPolicy -Global -PolicyName Test | ||
``` | ||
|
||
Note: _Using $null in place of a policy name can be used to unassigned a policy instance._ | ||
|
||
## PARAMETERS | ||
|
||
### -Force | ||
Suppresses the display of any non-fatal error message that might arise when running the command. | ||
|
||
```yaml | ||
Type: SwitchParameter | ||
Parameter Sets: GrantToTenant | ||
Aliases: | ||
|
||
Required: False | ||
Position: Named | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
|
||
### -Global | ||
This is the equivalent to `-Identity Global`. | ||
|
||
```yaml | ||
Type: SwitchParameter | ||
Parameter Sets: GrantToTenant | ||
Aliases: | ||
|
||
Required: True | ||
Position: 0 | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
|
||
### -Group | ||
This is the identifier of the group that the policy should be assigned to. | ||
|
||
```yaml | ||
Type: String | ||
Parameter Sets: GrantToGroup | ||
Aliases: | ||
|
||
Required: True | ||
Position: 0 | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
|
||
### -Identity | ||
Specifies the identity of the target user. | ||
|
||
Example: [email protected] | ||
|
||
Example: 98403f08-577c-46dd-851a-f0460a13b03d | ||
|
||
Use the "Global" Identity if you wish to set the policy for the entire tenant. | ||
|
||
```yaml | ||
Type: String | ||
Parameter Sets: GrantToUser | ||
Aliases: | ||
|
||
Required: True | ||
Position: Named | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
|
||
### -PolicyName | ||
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". | ||
|
||
```yaml | ||
Type: String | ||
Parameter Sets: GrantToUser, GrantToGroup, GrantToTenant | ||
Aliases: | ||
|
||
Required: False | ||
Position: 1 | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
|
||
### -Rank | ||
The rank of the policy assignment, relative to other group policy assignments for the same policy type. | ||
|
||
```yaml | ||
Type: Int32 | ||
Parameter Sets: GrantToGroup | ||
Aliases: | ||
|
||
Required: True | ||
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](http://go.microsoft.com/fwlink/?LinkID=113216). | ||
|
||
## INPUTS | ||
|
||
## OUTPUTS | ||
|
||
## RELATED LINKS | ||
|
||
[New-CsTeamsAIPolicy](New-CsTeamsAIPolicy.md) | ||
|
||
[Remove-CsTeamsAIPolicy](Remove-CsTeamsAIPolicy.yml) | ||
|
||
[Get-CsTeamsAIPolicy](Get-CsTeamsAIPolicy.yml) | ||
|
||
[Set-CsTeamsAIPolicy](Set-CsTeamsAIPolicy.yml) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
--- | ||
external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml | ||
Module Name: MicrosoftTeams | ||
applicable: Microsoft Teams | ||
title: New-CsTeamsAIPolicy | ||
online version: https://learn.microsoft.com/powershell/module/teams/New-CsTeamsAIPolicy | ||
schema: 2.0.0 | ||
author: Andy447 | ||
ms.author: andywang | ||
--- | ||
|
||
|
||
# New-CsTeamsAIPolicy | ||
|
||
## SYNOPSIS | ||
This cmdlet creates a Teams AI policy. | ||
|
||
## SYNTAX | ||
|
||
```powershell | ||
New-CsTeamsAIPolicy -Identity <String> | ||
``` | ||
|
||
## DESCRIPTION | ||
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 | ||
|
||
### Example 1 | ||
```powershell | ||
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 | ||
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 | ||
``` | ||
|
||
### 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) | ||
|
||
[Get-CsTeamsAIPolicy](Get-CsTeamsAIPolicy.yml) | ||
|
||
[Set-CsTeamsAIPolicy](Set-CsTeamsAIPolicy.yml) | ||
|
||
[Grant-CsTeamsAIPolicy](Grant-CsTeamsAIPolicy.yml) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
--- | ||
external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml | ||
Module Name: MicrosoftTeams | ||
applicable: Microsoft Teams | ||
title: Remove-CsTeamsAIPolicy | ||
online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsTeamsAIPolicy | ||
schema: 2.0.0 | ||
author: Andy447 | ||
ms.author: andywang | ||
--- | ||
|
||
# Remove-CsTeamsAIPolicy | ||
|
||
## SYNOPSIS | ||
|
||
This cmdlet deletes a Teams AI policy. | ||
|
||
## SYNTAX | ||
|
||
``` | ||
Remove-CsTeamsAIPolicy -Identity <String> | ||
``` | ||
|
||
## DESCRIPTION | ||
|
||
This cmdlet deletes a Teams AI policy with the specified identity string. | ||
|
||
## EXAMPLES | ||
|
||
### Example 1 | ||
```powershell | ||
PS C:\> Remove-CsTeamsAIPolicy -Identity "Test" | ||
``` | ||
|
||
Deletes a Teams AI policy with the identify of "Test". | ||
|
||
## 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 | ||
``` | ||
|
||
### 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). | ||
|
||
## INPUTS | ||
|
||
## OUTPUTS | ||
|
||
## RELATED LINKS | ||
|
||
[New-CsTeamsAIPolicy](New-CsTeamsAIPolicy.md) | ||
|
||
[Get-CsTeamsAIPolicy](Get-CsTeamsAIPolicy.yml) | ||
|
||
[Grant-CsTeamsAIPolicy](Grant-CsTeamsAIPolicy.yml) | ||
|
||
[Set-CsTeamsAIPolicy](Set-CsTeamsAIPolicy.yml) |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.