ConnectionSettings class

Package:
@microsoft/agents-copilotstudio-client

Represents the settings required to establish a connection to Copilot Studio.

Extends

ConnectionOptions

Constructors

ConnectionSettings()

Default constructor for the ConnectionSettings class.
ConnectionSettings(ConnectionOptions)

Creates an instance of ConnectionSettings.

Properties

cloud

The cloud environment of the application.
copilotAgentType

The type of the Copilot agent.

Inherited Properties

agentIdentifier

The identifier of the agent.
appClientId

The client ID of the application.
authority

The login authority to use for the connection.
customPowerPlatformCloud

The custom Power Platform cloud URL, if any.
directConnectUrl

The URL to connect directly to Copilot Studio endpoint
enableDiagnostics

Flag to enable diagnostic logging. Default is false.
environmentId

The environment ID of the application.
schemaName

The identifier of the agent.
tenantId

The tenant ID of the application.
useExperimentalEndpoint

Flag to use the experimental endpoint if available

Constructor Details

ConnectionSettings()

Default constructor for the ConnectionSettings class.

new ConnectionSettings()

ConnectionSettings(ConnectionOptions)

Creates an instance of ConnectionSettings.

new ConnectionSettings(options: ConnectionOptions)

Parameters

options

ConnectionOptions

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

Property Details

cloud

The cloud environment of the application.

cloud?: PowerPlatformCloud

Property Value

PowerPlatformCloud

copilotAgentType

The type of the Copilot agent.

copilotAgentType?: AgentType

Property Value

AgentType

Inherited 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

Inherited From ConnectionOptions.agentIdentifier

appClientId

Warning

This API is now deprecated.

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

The client ID of the application.

appClientId?: string

Property Value

string

Inherited From ConnectionOptions.appClientId

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

Inherited From ConnectionOptions.authority

customPowerPlatformCloud

The custom Power Platform cloud URL, if any.

customPowerPlatformCloud?: string

Property Value

string

Inherited From ConnectionOptions.customPowerPlatformCloud

directConnectUrl

The URL to connect directly to Copilot Studio endpoint

directConnectUrl?: string

Property Value

string

Inherited From ConnectionOptions.directConnectUrl

enableDiagnostics

Flag to enable diagnostic logging. Default is false.

enableDiagnostics?: boolean

Property Value

boolean

Inherited From ConnectionOptions.enableDiagnostics

environmentId

The environment ID of the application.

environmentId?: string

Property Value

string

Inherited From ConnectionOptions.environmentId

schemaName

The identifier of the agent.

schemaName?: string

Property Value

string

Inherited From ConnectionOptions.schemaName

tenantId

Warning

This API is now deprecated.

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

The tenant ID of the application.

tenantId?: string

Property Value

string

Inherited From ConnectionOptions.tenantId

useExperimentalEndpoint

Flag to use the experimental endpoint if available

useExperimentalEndpoint?: boolean

Property Value

boolean

Inherited From ConnectionOptions.useExperimentalEndpoint