ConnectionSettings Class

Connection settings for the DirectToEngineConnectionConfiguration.

Constructor

ConnectionSettings()

Parameters

Name	Description
environment_id Required
agent_identifier Required
cloud	Default value: None
copilot_agent_type	Default value: None
custom_power_platform_cloud	Default value: None
client_session_settings	Default value: None
direct_connect_url	Default value: None
use_experimental_endpoint	Default value: False
enable_diagnostics	Default value: False

Methods

__init__	Initialize connection settings.
__new__
populate_from_environment	Populate connection settings from environment variables. This method reads configuration values from environment variables and returns them as a dictionary suitable for passing to ConnectionSettings.init().

__init__

Initialize connection settings.

__init__(environment_id: str, agent_identifier: str, cloud: PowerPlatformCloud | None = None, copilot_agent_type: AgentType | None = None, custom_power_platform_cloud: str | None = None, client_session_settings: dict | None = None, direct_connect_url: str | None = None, use_experimental_endpoint: bool = False, enable_diagnostics: bool = False) -> None

Parameters

Name	Description
environment_id Required	str The ID of the environment to connect to.
agent_identifier Required	str The identifier of the agent to use for the connection.
cloud	PowerPlatformCloud | None The PowerPlatformCloud to use for the connection. Default value: None
copilot_agent_type	AgentType | None The AgentType to use for the Copilot. Default value: None
custom_power_platform_cloud	str | None The custom PowerPlatformCloud URL. Default value: None
client_session_settings	dict | None Additional arguments for initialization of the underlying Aiohttp ClientSession. Default value: None
direct_connect_url	str | None Direct connection URL override. Default value: None
use_experimental_endpoint	bool Flag to enable experimental endpoint. Default value: False
enable_diagnostics	bool Flag to enable diagnostics. Default value: False

Returns

Type	Description
None

__new__

__new__(**kwargs)

populate_from_environment

Populate connection settings from environment variables.

This method reads configuration values from environment variables and returns them as a dictionary suitable for passing to ConnectionSettings.init().

static populate_from_environment(environment_id: str | None = None, agent_identifier: str | None = None, cloud: PowerPlatformCloud | None = None, copilot_agent_type: AgentType | None = None, custom_power_platform_cloud: str | None = None, direct_connect_url: str | None = None, use_experimental_endpoint: bool | None = None, enable_diagnostics: bool | None = None) -> Dict[str, Any]

Parameters

Name	Description
environment_id	str | None Optional override for ENVIRONMENT_ID env var. Default value: None
agent_identifier	str | None Optional override for AGENT_IDENTIFIER env var. Default value: None
cloud	PowerPlatformCloud | None Optional override for CLOUD env var. Default value: None
copilot_agent_type	AgentType | None Optional override for COPILOT_AGENT_TYPE env var. Default value: None
custom_power_platform_cloud	str | None Optional override for CUSTOM_POWER_PLATFORM_CLOUD env var. Default value: None
direct_connect_url	str | None Optional override for DIRECT_CONNECT_URL env var. Default value: None
use_experimental_endpoint	bool | None Optional override for USE_EXPERIMENTAL_ENDPOINT env var. Default value: None
enable_diagnostics	bool | None Optional override for ENABLE_DIAGNOSTICS env var. Default value: None

Returns

Type	Description
Dict[str, Any]	Dictionary of connection settings.

Attributes

agent_identifier

agent_identifier: str | None

cloud

cloud: PowerPlatformCloud | None

copilot_agent_type

copilot_agent_type: AgentType | None

custom_power_platform_cloud

custom_power_platform_cloud: str | None

environment_id

environment_id: str | None