New-CsAgent
Use the New-CsAgent cmdlet to create an AI Agent that can be associated with a Teams Phone Resource Account.
Syntax
Default (Default)
New-CsAgent
-Name <String>
-AIAgentId <String>
-AIAgentType <String>
[-AIAgentTargetTagTemplateId <String>]
[<CommonParameters>]
Description
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.
Caution
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.
Examples
Example 1
New-CsAgent -Name "SmartAgent" -AIAgentId "9e6a9737-edbe-4452-9ec8-702944ef6a07" -AIAgentType "MicrosoftCopilotStudio"
This example creates a new AI Agent that is associated with Microsoft Copilot Studio.
Parameters
-AIAgentId
The ID of the agent as issued by the AI provider (for example, the Microsoft Copilot Studio agent ID).
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-AIAgentTargetTagTemplateId
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.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-AIAgentType
The type of AI Agent provider. Currently supported value: MicrosoftCopilotStudio.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
The name of the AI Agent.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.