Skip to content

Commit 1263d95

Browse files
committed
Add get-csaiagents
1 parent 4549fef commit 1263d95

File tree

1 file changed

+106
-0
lines changed

1 file changed

+106
-0
lines changed
Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
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.
18+
19+
## SYNTAX
20+
21+
> [!CAUTION]
22+
> 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.
23+
24+
```
25+
Get-CsAiAgents -ProviderId <string> [-IsTeamsIvrEnabled]
26+
```
27+
28+
## DESCRIPTION
29+
30+
The Get-CsAiAgents cmdlet returns a list of all AI Agents in the tenant.
31+
32+
## EXAMPLES
33+
34+
```
35+
Get-CsAiAgents -IsTeamsIvrEnabled -ProviderId "905a9543-6cf8-44a4-ab05-83b8b500f39e"
36+
```
37+
38+
This example gets the AI Agents from ProviderId "905a9543-6cf8-44a4-ab05-83b8b500f39e" that are compatible with Teams Interactive Voice Response (IVR).
39+
40+
## PARAMETERS
41+
42+
### -ProviderId
43+
44+
A filter for ProviderId
45+
46+
```yaml
47+
Type: System.String
48+
DefaultValue: ''
49+
SupportsWildcards: false
50+
Aliases: []
51+
ParameterSets:
52+
- Name: (All)
53+
Position: Named
54+
IsRequired: true
55+
ValueFromPipeline: false
56+
ValueFromPipelineByPropertyName: false
57+
ValueFromRemainingArguments: false
58+
DontShow: false
59+
AcceptedValues: []
60+
HelpMessage: ''
61+
```
62+
63+
### -IsTeamsIvrEnabled
64+
65+
Optional parameter. If specified, it filters the returned results to AI Agents that are compatible with Teams Interactive Voice Response (IVR).
66+
67+
```yaml
68+
Type: System.Management.Automation.SwitchParameter
69+
DefaultValue: ''
70+
SupportsWildcards: false
71+
Aliases: []
72+
ParameterSets:
73+
- Name: (All)
74+
Position: Named
75+
IsRequired: false
76+
ValueFromPipeline: false
77+
ValueFromPipelineByPropertyName: false
78+
ValueFromRemainingArguments: false
79+
DontShow: false
80+
AcceptedValues: []
81+
HelpMessage: ''
82+
```
83+
84+
### CommonParameters
85+
86+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
87+
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
88+
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
89+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
90+
91+
## OUTPUTS
92+
93+
The output of the Get-CsAiAgents cmdlet is a list of AI Agents, with parameters such as `BotHandle`, `MsaAppId`, `MsaAppTenantId` and more.
94+
95+
```
96+
BotHandle CallingApiVersion Channel Cid IsTeamsIvrEnabled IsTeamsVoiceEnabled MessagingApiVersion MsaAppId MsaAppTenantId ProviderId PublishState
97+
--------- ----------------- ------- --- ----------------- ------------------- ------------------- -------- -------------- ---------- ------------
98+
8a1b2c33-4d55-4f1e-9a2b-7f4b3a2b1c7e {msteams} 0 True True 3 c91e0a62-8d9e-4d6d-9e55-2a0b7b9f3d64 1bdf06d6-a880-43c0-adde-ebf94070c03d 9d8f559b-5984-46a4-902a-ad4271e83efa Preview
99+
e5f7a913-0c2f-4f3a-8f69-9d1b40e2a3f1 {msteams} 0 True True 3 6b4a3fb2-0df5-47a8-8a77-4f1d8f6e2a39 1bdf06d6-a880-43c0-adde-ebf94070c03d 9d8f559b-5984-46a4-902a-ad4271e83efa Preview
100+
1a2b3c4d-5e6f-4711-8a2b-9c0d1e2f3a4b {msteams} 0 True True 3 4f0c1a2e-7b9d-4c1e-9123-6a7b8c9d0e1f 1bdf06d6-a880-43c0-adde-ebf94070c03d 9d8f559b-5984-46a4-902a-ad4271e83efa Preview
101+
9f8e7d6c-5b4a-4312-9a0b-d1c2e3f4a5b6 {msteams} 0 True True 3 a7c8d9e0-1f2a-4b3c-9d0e-1a2b3c4d5e6f 1bdf06d6-a880-43c0-adde-ebf94070c03d 9d8f559b-5984-46a4-902a-ad4271e83efa Preview
102+
0a9b8c7d-6e5f-4d3c-8b7a-6c5d4e3f2a1b {msteams} 0 True True 3 d2e3f4a5-b6c7-4819-9f0e-a1b2c3d4e5f6 1bdf06d6-a880-43c0-adde-ebf94070c03d 9d8f559b-5984-46a4-902a-ad4271e83efa Preview
103+
3b2c1d0e-9f8a-47b6-9123-4a5b6c7d8e9f {msteams} 0 True True 3 12ab34cd-56ef-4789-90ab-cdef12345678 1bdf06d6-a880-43c0-adde-ebf94070c03d 9d8f559b-5984-46a4-902a-ad4271e83efa Preview
104+
7c6d5e4f-3a2b-41c0-9f8e-7d6c5b4a3f2e {msteams} 0 True True 3 f0e1d2c3-b4a5-4698-8f7e-6d5c4b3a2f1e 1bdf06d6-a880-43c0-adde-ebf94070c03d 9d8f559b-5984-46a4-902a-ad4271e83efa Preview
105+
```
106+

0 commit comments

Comments
 (0)