CopilotStudioConnectionSettings interface

Package:
@microsoft/agents-copilotstudio-client

Represents the settings required to establish a direct connection to the engine.

Properties

agentIdentifier

The identifier of the agent.
authority

The login authority to use for the connection.
cloud

The cloud environment of the application.
copilotAgentType

The type of the Copilot agent.
customPowerPlatformCloud

The custom Power Platform cloud URL.
directConnectUrl

URL provided to connect directly to Copilot Studio endpoint. When provided all other settings are ignored.
enableDiagnostics

Enables diagnostic logging for debugging purposes. When enabled, detailed logs about requests, responses, and connection status will be emitted. Default value is false.
environmentId

The environment ID of the application.
schemaName

The schema name of the agent.
useExperimentalEndpoint

Directs Copilot Studio Client to use the experimental endpoint if available. Default value is false.

Property Details

agentIdentifier

Warning

This API is now deprecated.

This property will not be supported in future versions. Use schemaName instead.

The identifier of the agent.

agentIdentifier?: string

Property Value

string

authority

Warning

This API is now deprecated.

This property will not be supported in future versions. Handle the auth properties in the agent.

The login authority to use for the connection.

authority?: string

Property Value

string

cloud

The cloud environment of the application.

cloud?: PowerPlatformCloud

Property Value

PowerPlatformCloud

copilotAgentType

The type of the Copilot agent.

copilotAgentType?: AgentType

Property Value

AgentType

customPowerPlatformCloud

The custom Power Platform cloud URL.

customPowerPlatformCloud?: string

Property Value

string

directConnectUrl

URL provided to connect directly to Copilot Studio endpoint. When provided all other settings are ignored.

directConnectUrl?: string

Property Value

string

enableDiagnostics

Enables diagnostic logging for debugging purposes. When enabled, detailed logs about requests, responses, and connection status will be emitted. Default value is false.

enableDiagnostics?: boolean

Property Value

boolean

environmentId

The environment ID of the application.

environmentId?: string

Property Value

string

schemaName

The schema name of the agent.

schemaName?: string

Property Value

string

useExperimentalEndpoint

Directs Copilot Studio Client to use the experimental endpoint if available. Default value is false.

useExperimentalEndpoint?: boolean

Property Value

boolean