Skip to content

Commit 166872a

Browse files
minwoolee-msftminwoolee-msft
committed
adding cmdlet explanation
1 parent 8396fc6 commit 166872a

4 files changed

Lines changed: 371 additions & 0 deletions

File tree

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

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
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: minwoolee-msft
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+
> [!CAUTION]
17+
> 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.
18+
19+
## SYNOPSIS
20+
Use the Get-CsAgent cmdlet to list the AI Agent(s).
21+
22+
## SYNTAX
23+
24+
```
25+
Get-CsAgent [-Id <string>] [<CommonParameters>]
26+
```
27+
28+
## DESCRIPTION
29+
Use the Get-CsAgent cmdlet to list the AI Agent(s).
30+
31+
## EXAMPLES
32+
33+
### Example 1
34+
```
35+
Get-CsAgent -Id 3a4b3d9b-91d8-4fbf-bcff-6907f325842c
36+
```
37+
38+
This example retrieves the AI Agent with the Id `3a4b3d9b-91d8-4fbf-bcff-6907f325842c`
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)

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

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
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: minwoolee-msft
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 that can be associated with a Teams Phone Resource Account.
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 "1a438619-c158-4483-bb04-7ca8de89ca58" -AIAgentType "MicrosoftCopilotStudio"
36+
```
37+
38+
This example creates a new AI Agent that is assigned 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: Off
54+
Accept pipeline input: False
55+
Accept wildcard characters: False
56+
```
57+
58+
### -AIAgentId
59+
60+
Agent Id of given AI Agent Type.
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+
Type of given AI Agent. i.e. MicrosoftCopilotStudio
77+
78+
```yaml
79+
Type: String
80+
Parameter Sets: (All)
81+
Aliases:
82+
83+
Required: True
84+
Position: Named
85+
Default value: False
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 will command 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)

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

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
---
2+
applicable: Microsoft Teams
3+
author: tomkau
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 3a4b3d9b-91d8-4fbf-bcff-6907f325842c
36+
```
37+
38+
This example deletes the AI Agent with the identity 3a4b3d9b-91d8-4fbf-bcff-6907f325842c. If no AI Agent exists with the identity 3a4b3d9b-91d8-4fbf-bcff-6907f325842c, 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+
### Microsoft.Rtc.Management.OAA.Models.AIAgentConfiguration
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)

‎teams/teams-ps/MicrosoftTeams/Set-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: minwoolee-msft
8+
ms.reviewer: williamlooney
9+
online version: https://learn.microsoft.com/powershell/module/microsoftteams/Set-CsAgent
10+
schema: 2.0.0
11+
title: Set-CsAgent
12+
---
13+
14+
# Set-CsAgent
15+
16+
## SYNOPSIS
17+
Use the Set-CsAgent cmdlet to change an AI Agent
18+
19+
## SYNTAX
20+
21+
```
22+
Set-CsAgent -Instance <instance> [<CommonParameters>]
23+
```
24+
25+
## DESCRIPTION
26+
Use the Set-CsAgent cmdlet to change 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+
$AIAgent = Get-CsAgent -Id 3a4b3d9b-91d8-4fbf-bcff-6907f325842c
36+
$AIAgent.Name = "NewName"
37+
Set-CsAgent -Instance $AIAgent
38+
```
39+
40+
This example sets a new name value of a AI Agent with the Id `3a4b3d9b-91d8-4fbf-bcff-6907f325842c`
41+
42+
## PARAMETERS
43+
44+
### -Instance
45+
46+
The instance of the AI Agent to change.
47+
48+
```yaml
49+
Type: System.String
50+
Parameter Sets: (All)
51+
Aliases:
52+
53+
Required: True
54+
Position: Named
55+
Default value: None
56+
Accept pipeline input: False
57+
Accept wildcard characters: False
58+
```
59+
60+
### CommonParameters
61+
62+
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).
63+
64+
## INPUTS
65+
66+
### None
67+
68+
## OUTPUTS
69+
70+
### Microsoft.Rtc.Management.OAA.Models.AIAgentConfiguration
71+
72+
## NOTES
73+
74+
## RELATED LINKS
75+
76+
[New-CsAgent](./New-CsAgent.md)
77+
78+
[Get-CsAgent](./Get-CsAgent.md)
79+
80+
[Remove-CsAgent](./Remove-CsAgent.md)

0 commit comments

Comments
 (0)