Skip to content

Commit e50623b

Browse files
JithuGiitJithuGiit
authored
Merge branch 'main' into patch-2
2 parents 36ab68c + 7680386 commit e50623b

File tree

2 files changed

+114
-0
lines changed

2 files changed

+114
-0
lines changed

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

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
---
2+
applicable: Microsoft Teams
3+
author: radubulboaca
4+
external help file: Microsoft.Rtc.Management.dll-Help.xml
5+
Locale: en-US
6+
manager: gauravpa
7+
Module Name: MicrosoftTeams
8+
ms.author: radubulboaca
9+
online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csaiagents
10+
schema: 2.0.0
11+
title: Get-CsAiAgents
12+
---
13+
# Get-CsAiAgents
14+
15+
## SYNOPSIS
16+
17+
Retrieves the AI Agents in the tenant that match with the ProviderId.
18+
19+
## SYNTAX
20+
21+
```
22+
Get-CsAiAgents -ProviderId <string> [-IsTeamsIvrEnabled]
23+
```
24+
25+
## DESCRIPTION
26+
27+
> [!NOTE]
28+
> This cmdlet will only work for customers that are participating in the Voice Applications private preview for these features. General Availability for this functionality has not been determined at this time.
29+
30+
The Get-CsAiAgents cmdlet returns a list of all AI Agents in the tenant.
31+
32+
## EXAMPLES
33+
34+
### Example 1 - Get AI agents from a provider
35+
36+
This example gets the AI Agents from ProviderId "9d8f559b-5de4-46a4-902a-ad4271e83efa" that are compatible with Teams Interactive Voice Response (IVR). The output of the Get-CsAiAgents cmdlet is a list of AI Agents, with parameters such as `BotHandle`, `MsaAppId`, `MsaAppTenantId` and more.
37+
38+
```powershell
39+
Get-CsAiAgents -IsTeamsIvrEnabled -ProviderId "9d8f559b-5de4-46a4-902a-ad4271e83efa"
40+
```
41+
42+
```Output
43+
BotHandle CallingApiVersion Channel Cid IsTeamsIvrEnabled IsTeamsVoiceEnabled MessagingApiVersion MsaAppId MsaAppTenantId ProviderId PublishState
44+
--------- ----------------- ------- --- ----------------- ------------------- ------------------- -------- -------------- ---------- ------------
45+
8a1b2c33-4d55-4f1e-9a2b-7f4b3a2b1c7e {msteams} 0 True True 3 c91e0a62-8d9e-4d6d-9e55-2a0b7b9f3d64 1bdf0cd6-a880-43c0-adde-ebf94070c03d 9d8f559b-5de4-46a4-902a-ad4271e83efa Preview
46+
e5f7a913-0c2f-4f3a-8f69-9d1b40e2a3f1 {msteams} 0 True True 3 6b4a3fb2-0df5-47a8-8a77-4f1d8f6e2a39 1bdf0cd6-a880-43c0-adde-ebf94070c03d 9d8f559b-5de4-46a4-902a-ad4271e83efa Preview
47+
1a2b3c4d-5e6f-4711-8a2b-9c0d1e2f3a4b {msteams} 0 True True 3 4f0c1a2e-7b9d-4c1e-9123-6a7b8c9d0e1f 1bdf0cd6-a880-43c0-adde-ebf94070c03d 9d8f559b-5de4-46a4-902a-ad4271e83efa Preview
48+
9f8e7d6c-5b4a-4312-9a0b-d1c2e3f4a5b6 {msteams} 0 True True 3 a7c8d9e0-1f2a-4b3c-9d0e-1a2b3c4d5e6f 1bdf0cd6-a880-43c0-adde-ebf94070c03d 9d8f559b-5de4-46a4-902a-ad4271e83efa Preview
49+
0a9b8c7d-6e5f-4d3c-8b7a-6c5d4e3f2a1b {msteams} 0 True True 3 d2e3f4a5-b6c7-4819-9f0e-a1b2c3d4e5f6 1bdf0cd6-a880-43c0-adde-ebf94070c03d 9d8f559b-5de4-46a4-902a-ad4271e83efa Preview
50+
3b2c1d0e-9f8a-47b6-9123-4a5b6c7d8e9f {msteams} 0 True True 3 12ab34cd-56ef-4789-90ab-cdef12345678 1bdf0cd6-a880-43c0-adde-ebf94070c03d 9d8f559b-5de4-46a4-902a-ad4271e83efa Preview
51+
7c6d5e4f-3a2b-41c0-9f8e-7d6c5b4a3f2e {msteams} 0 True True 3 f0e1d2c3-b4a5-4698-8f7e-6d5c4b3a2f1e 1bdf0cd6-a880-43c0-adde-ebf94070c03d 9d8f559b-5de4-46a4-902a-ad4271e83efa Preview
52+
```
53+
54+
### Example 2 - Get AI agents from multiple providers
55+
56+
This example gets the AI Agents from multiple ProviderIds that are compatible with Teams Interactive Voice Response (IVR).
57+
58+
```powershell
59+
Get-CsAiAgents -IsTeamsIvrEnabled -ProviderId "9d8f559b-5de4-46a4-902a-ad4271e83efa,905de543-6cf8-44a4-ab05-83bcd500f39e"
60+
```
61+
62+
## PARAMETERS
63+
64+
### -ProviderId
65+
66+
A filter for ProviderId
67+
68+
```yaml
69+
Type: System.String
70+
Parameter Sets: (All)
71+
Aliases:
72+
73+
Required: False
74+
Position: 0
75+
Default value: None
76+
Accept pipeline input: False
77+
Accept wildcard characters: False
78+
```
79+
80+
### -IsTeamsIvrEnabled
81+
82+
Optional parameter. If specified, it filters the returned results to AI Agents that are compatible with Teams Interactive Voice Response (IVR).
83+
84+
```yaml
85+
Type: SwitchParameter
86+
Parameter Sets: (All)
87+
Aliases:
88+
89+
Required: False
90+
Position: Named
91+
Default value: None
92+
Accept pipeline input: False
93+
Accept wildcard characters: False
94+
```
95+
96+
### CommonParameters
97+
98+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
99+
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
100+
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
101+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
102+
103+
## INPUTS
104+
105+
## OUTPUTS
106+
107+
### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IAiAgentQueryResult
108+
109+
## NOTES
110+
111+
## RELATED LINKS

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,9 @@ This cmdlet returns all Microsoft Teams apps in the app catalog, including Micro
6565
### [Get-AssociatedTeam](Get-AssociatedTeam.md)
6666
This cmdlet supports retrieving all teams associated with a user, including teams which host shared channels.
6767

68+
### [Get-CsAiAgents](Get-CsAiAgents.md)
69+
Retrieves the AI Agents in the tenant.
70+
6871
### [Get-CsApplicationAccessPolicy](Get-CsApplicationAccessPolicy.md)
6972
Retrieves information about the application access policy configured for use in the tenant.
7073

0 commit comments

Comments
 (0)