Documentation - v1.5.0-beta.6
    Preparing search index...

    Class ConnectionSettings

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

    Hierarchy

    • ConnectionOptions
      • ConnectionSettings
    Index

    Properties

    agentIdentifier? appClientId? authority? cloud? copilotAgentType? customPowerPlatformCloud? directConnectUrl? enableDiagnostics? environmentId? schemaName? tenantId? useExperimentalEndpoint?

    Properties

    agentIdentifier?: string

    The identifier of the agent.

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

    appClientId?: string

    The client ID of the application.

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

    authority?: string

    The login authority to use for the connection.

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

    cloud?: PowerPlatformCloud

    The cloud environment of the application.

    copilotAgentType?: AgentType

    The type of the Copilot agent.

    customPowerPlatformCloud?: string

    The custom Power Platform cloud URL, if any.

    directConnectUrl?: string

    The URL to connect directly to Copilot Studio endpoint

    enableDiagnostics?: boolean = false

    Flag to enable diagnostic logging. Default is false.

    environmentId?: string

    The environment ID of the application.

    schemaName?: string

    The identifier of the agent.

    tenantId?: string

    The tenant ID of the application.

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

    useExperimentalEndpoint?: boolean = false

    Flag to use the experimental endpoint if available

    Settings

    Member Visibility

    On This Page

    Properties