Commands › Microsoft Teams

Get-CsAiAgents

Microsoft Teams MicrosoftTeams Get-*

Retrieves the AI Agents in the tenant that match with the ProviderId.

Quick start script

# Get-CsAiAgents — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-MicrosoftTeams -CertificateThumbprint $thumb -ApplicationId $appId -TenantId $tenantId

# 2. Run and inspect
Get-CsAiAgents -ProviderId <String> | Format-List

# 3. Export for evidence / drift tracking
Get-CsAiAgents | Export-Clixml .\CsAiAgents-$(Get-Date -Format yyyyMMdd).xml

Syntax

Get-CsAiAgents -ProviderId <String> [-AgentId <String>] [-AgentIds <String>] [-Channel <String>]
 [-ContinuationToken <String>] [-DisplayNameContains <String>] [-DisplayNamePrefix <String>]
 [-IsTeamsIvrEnabled] [-MaxResult <Int32>] [-ShowCount] [<CommonParameters>]

Parameters (10)

Parameter	Type	Required	What it controls
-AgentId	String		A filter to retrieve a specific AI Agent by its unique identifier.
-AgentIds	String		A filter to retrieve multiple AI Agents by their unique identifiers.
-Channel	String		A filter to retrieve AI Agents on a specific channel, for example `msteams`, `skype`, `acschat`, or `msteamsphone`.
-ContinuationToken	String		A token used to retrieve the next page of results when the result set is large.
-DisplayNameContains	String		A filter to retrieve AI Agents whose display name contains the specified string.
-DisplayNamePrefix	String		A filter to retrieve AI Agents whose display name starts with the specified string.
-IsTeamsIvrEnabled	SwitchParameter		Optional parameter. If specified, it filters the returned results to AI Agents that are compatible with Teams Interactive Voice Response (IVR).
-MaxResult	Int32		Specifies the maximum number of results to return.
-ProviderId	String	yes	A filter for ProviderId.
-ShowCount	SwitchParameter		Optional parameter. If specified, includes the total count of matching AI Agents in the result.

Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.