Skip to content

Commit ecccda1

Browse files
Ruchika-mittal01Ruchika-mittal01
authored
Merge pull request #13360 from minwoolee-msft/update1
Create New/Set/Get/Remove-CsAgent
2 parents 72949ed + 3b75d8f commit ecccda1

5 files changed

Lines changed: 391 additions & 0 deletions

File tree

‎teams/teams-ps/MicrosoftTeams/Get-CsAgent.md‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
---
2+
applicable: Microsoft Teams
3+
author: minwoolee-msft
4+
external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml
5+
Locale: en-US
6+
Module Name: MicrosoftTeams
7+
ms.author: tomkau
8+
ms.reviewer: williamlooney
9+
online version: https://learn.microsoft.com/powershell/module/microsoftteams/Get-CsAgent
10+
schema: 2.0.0
11+
title: Get-CsAgent
12+
---
13+
14+
# Get-CsAgent
15+
16+
## SYNOPSIS
17+
Use the Get-CsAgent cmdlet to list the AI Agent(s).
18+
19+
## SYNTAX
20+
21+
```
22+
Get-CsAgent [-Id <string>] [<CommonParameters>]
23+
```
24+
25+
## DESCRIPTION
26+
Use the Get-CsAgent cmdlet to list the AI Agent(s) configured in the tenant. When the -Id parameter is omitted, all AI Agents in the tenant are returned.
27+
28+
> [!CAUTION]
29+
> This cmdlet will only work for customers that are participating in the AI Agent private preview for this feature. General Availability for this functionality has not been determined at this time.
30+
31+
## EXAMPLES
32+
33+
### Example 1
34+
```
35+
Get-CsAgent -Id 7d9997d0-1013-4d9c-83eb-caa6ec05f1b3
36+
```
37+
38+
This example retrieves the AI Agent with the Id `7d9997d0-1013-4d9c-83eb-caa6ec05f1b3`.
39+
40+
### Example 2
41+
```
42+
Get-CsAgent
43+
```
44+
45+
This example retrieves all the AI Agents.
46+
47+
## PARAMETERS
48+
49+
### -Id
50+
51+
The Id of the AI Agent. Optional.
52+
53+
```yaml
54+
Type: System.String
55+
Parameter Sets: (All)
56+
Aliases:
57+
58+
Required: false
59+
Position: Named
60+
Default value: None
61+
Accept pipeline input: False
62+
Accept wildcard characters: False
63+
```
64+
65+
### CommonParameters
66+
67+
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).
68+
69+
## INPUTS
70+
71+
### None
72+
73+
## OUTPUTS
74+
75+
### Microsoft.Rtc.Management.OAA.Models.AIAgentConfiguration
76+
77+
## NOTES
78+
79+
## RELATED LINKS
80+
81+
[New-CsAgent](./New-CsAgent.md)
82+
83+
[Set-CsAgent](./Set-CsAgent.md)
84+
85+
[Remove-CsAgent](./Remove-CsAgent.md)
86+
87+
[New-CsOnlineApplicationInstanceAssociation](./New-CsOnlineApplicationInstanceAssociation.md)

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,9 @@ Use the Find-CsGroup cmdlet to search groups.
5959
### [Find-CsOnlineApplicationInstance](Find-CsOnlineApplicationInstance.md)
6060
Use the Find-CsOnlineApplicationInstance cmdlet to find application instances that match your search criteria.
6161

62+
### [Get-CsAgent](Get-CsAgent.md)
63+
Retrieves the AI Agent(s) in the tenant.
64+
6265
### [Get-AllM365TeamsApps](Get-AllM365TeamsApps.md)
6366
This cmdlet returns all Microsoft Teams apps in the app catalog, including Microsoft, custom, and non-Microsoft apps.
6467

@@ -791,6 +794,9 @@ Trigger a new direct assignments to group policy assignments cleanup.
791794
### [Invoke-StartDirectToGroupAssignmentMigration](Invoke-StartDirectToGroupAssignmentMigration.md)
792795
Trigger a new direct assignments to group policy assignments migration
793796

797+
### [New-CsAgent](New-CsAgent.md)
798+
Create an AI Agent that can be associated with a Teams Phone Resource Account.
799+
794800
### [New-CsApplicationAccessPolicy](New-CsApplicationAccessPolicy.md)
795801
Creates a new application access policy. Application access policy contains a list of application (client) IDs.
796802

@@ -1139,6 +1145,9 @@ Creates a new app in the Teams tenant app store.
11391145
### [Register-CsOnlineDialInConferencingServiceNumber](Register-CsOnlineDialInConferencingServiceNumber.md)
11401146
The Register-CsOnlineDialInConferencingServiceNumber command allows you to assign any additional service number that you may have acquired to your conference bridge.
11411147

1148+
### [Remove-CsAgent](Remove-CsAgent.md)
1149+
Deletes an AI Agent.
1150+
11421151
### [Remove-CsApplicationAccessPolicy](Remove-CsApplicationAccessPolicy.md)
11431152
Deletes an existing application access policy.
11441153

@@ -1451,6 +1460,9 @@ Removes the tenant's hierarchy.
14511460
### [Remove-TeamUser](Remove-TeamUser.md)
14521461
Remove an owner or member from a team, and from the unified group which backs the team.
14531462

1463+
### [Set-CsAgent](Set-CsAgent.md)
1464+
Modifies an AI Agent that can be associated with a Teams Phone Resource Account.
1465+
14541466
### [Set-CsApplicationAccessPolicy](Set-CsApplicationAccessPolicy.md)
14551467
Modifies an existing application access policy.
14561468

‎teams/teams-ps/MicrosoftTeams/New-CsAgent.md‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
---
2+
applicable: Microsoft Teams
3+
author: minwoolee-msft
4+
external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml
5+
Locale: en-US
6+
Module Name: MicrosoftTeams
7+
ms.author: tomkau
8+
ms.reviewer: williamlooney
9+
online version: https://learn.microsoft.com/powershell/module/microsoftteams/New-CsAgent
10+
schema: 2.0.0
11+
title: New-CsAgent
12+
---
13+
14+
# New-CsAgent
15+
16+
## SYNOPSIS
17+
Use the New-CsAgent cmdlet to create an AI Agent that can be associated with a Teams Phone Resource Account.
18+
19+
## SYNTAX
20+
21+
```
22+
New-CsAgent -Name <String> -AIAgentId <String> -AIAgentType <String> [-AIAgentTargetTagTemplateId <String>] [<CommonParameters>]
23+
```
24+
25+
## DESCRIPTION
26+
Use the New-CsAgent cmdlet to create an AI Agent in the tenant. The AI Agent represents an external conversational provider (such as Microsoft Copilot Studio) that can answer calls on behalf of a Teams Phone Resource Account. After the agent is created, associate it with a Resource Account by using `New-CsOnlineApplicationInstanceAssociation`; the agent is not reachable until the association is made.
27+
28+
> [!CAUTION]
29+
> This cmdlet will only work for customers that are participating in the AI Agent private preview for this feature. General Availability for this functionality has not been determined at this time.
30+
31+
## EXAMPLES
32+
33+
### Example 1
34+
```
35+
New-CsAgent -Name "SmartAgent" -AIAgentId "9e6a9737-edbe-4452-9ec8-702944ef6a07" -AIAgentType "MicrosoftCopilotStudio"
36+
```
37+
38+
This example creates a new AI Agent that is associated with Microsoft Copilot Studio.
39+
40+
## PARAMETERS
41+
42+
### -Name
43+
44+
The name of the AI Agent.
45+
46+
```yaml
47+
Type: String
48+
Parameter Sets: (All)
49+
Aliases:
50+
51+
Required: True
52+
Position: Named
53+
Default value: None
54+
Accept pipeline input: False
55+
Accept wildcard characters: False
56+
```
57+
58+
### -AIAgentId
59+
60+
The ID of the agent as issued by the AI provider (for example, the Microsoft Copilot Studio agent ID).
61+
62+
```yaml
63+
Type: String
64+
Parameter Sets: (All)
65+
Aliases:
66+
67+
Required: True
68+
Position: Named
69+
Default value: None
70+
Accept pipeline input: False
71+
Accept wildcard characters: False
72+
```
73+
74+
### -AIAgentType
75+
76+
The type of AI Agent provider. Currently supported value: MicrosoftCopilotStudio.
77+
78+
```yaml
79+
Type: String
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+
### -AIAgentTargetTagTemplateId
91+
92+
Tag Template Id of this AI Agent. If given, this command will validate if the given tag template id exists or not. If the given Id of the tag template does not exist, this command will fail.
93+
94+
```yaml
95+
Type: System.String
96+
Parameter Sets: (All)
97+
Aliases:
98+
99+
Required: false
100+
Position: Named
101+
Default value: None
102+
Accept pipeline input: False
103+
Accept wildcard characters: False
104+
```
105+
106+
### CommonParameters
107+
108+
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).
109+
110+
## INPUTS
111+
112+
### None
113+
114+
## OUTPUTS
115+
116+
### Microsoft.Rtc.Management.OAA.Models.AIAgentConfiguration
117+
118+
## NOTES
119+
120+
## RELATED LINKS
121+
122+
[Get-CsAgent](./Get-CsAgent.md)
123+
124+
[Set-CsAgent](./Set-CsAgent.md)
125+
126+
[Remove-CsAgent](./Remove-CsAgent.md)
127+
128+
[New-CsTagsTemplate](./New-CsTagsTemplate.md)
129+
130+
[New-CsOnlineApplicationInstanceAssociation](./New-CsOnlineApplicationInstanceAssociation.md)

‎teams/teams-ps/MicrosoftTeams/Remove-CsAgent.md‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
---
2+
applicable: Microsoft Teams
3+
author: minwoolee-msft
4+
external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml
5+
Locale: en-US
6+
Module Name: MicrosoftTeams
7+
ms.author: tomkau
8+
ms.reviewer: williamlooney
9+
online version: https://learn.microsoft.com/powershell/module/microsoftteams/Remove-CsAgent
10+
schema: 2.0.0
11+
title: Remove-CsAgent
12+
---
13+
14+
# Remove-CsAgent
15+
16+
## SYNOPSIS
17+
Deletes an AI Agent.
18+
19+
## SYNTAX
20+
21+
```
22+
Remove-CsAgent -Id <String> [<CommonParameters>]
23+
```
24+
25+
## DESCRIPTION
26+
Use the Remove-CsAgent cmdlet to delete an AI Agent.
27+
28+
> [!CAUTION]
29+
> This cmdlet will only work for customers that are participating in the AI Agent private preview for this feature. General Availability for this functionality has not been determined at this time.
30+
31+
## EXAMPLES
32+
33+
### Example 1
34+
```
35+
Remove-CsAgent -Id 7d9997d0-1013-4d9c-83eb-caa6ec05f1b3
36+
```
37+
38+
This example deletes the AI Agent with the identity 7d9997d0-1013-4d9c-83eb-caa6ec05f1b3. If no AI Agent exists with the identity 7d9997d0-1013-4d9c-83eb-caa6ec05f1b3, then this command generates an error.
39+
40+
## PARAMETERS
41+
42+
### -Id
43+
44+
The Id parameter is the unique identifier assigned to the AI Agent.
45+
46+
```yaml
47+
Type: System.String
48+
Parameter Sets: (All)
49+
Aliases:
50+
51+
Required: True
52+
Position: Named
53+
Default value: None
54+
Accept pipeline input: False
55+
Accept wildcard characters: False
56+
```
57+
58+
### CommonParameters
59+
60+
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).
61+
62+
## INPUTS
63+
64+
### None
65+
66+
## OUTPUTS
67+
68+
### None
69+
70+
## NOTES
71+
72+
## RELATED LINKS
73+
74+
[New-CsAgent](./New-CsAgent.md)
75+
76+
[Set-CsAgent](./Set-CsAgent.md)
77+
78+
[Get-CsAgent](./Get-CsAgent.md)
79+
80+
[New-CsOnlineApplicationInstanceAssociation](./New-CsOnlineApplicationInstanceAssociation.md)

0 commit comments

Comments
 (0)