connections

Creates, updates, deletes, gets or lists a connections resource.

Overview

Name	connections
Type	Resource
Id	azure.ai_evaluation.connections

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	A unique identifier for the connection, generated by the service. Required.
name	string	The friendly name of the connection, provided by the user. Required.
credentials	object	The credentials used by the connection. Required.
isDefault	boolean	Whether the connection is tagged as the default connection of its type. Required.
metadata	object	Metadata of the connection. Required.
target	string	The connection URL to be used for this service. Required.
type	string	Category of the connection. Required. Known values are: "AzureOpenAI", "AzureBlob", "AzureStorageAccount", "CognitiveSearch", "CosmosDB", "ApiKey", "AppConfig", "AppInsights", and "CustomKeys". (AzureOpenAI, AzureBlob, AzureStorageAccount, CognitiveSearch, CosmosDB, ApiKey, AppConfig, AppInsights, CustomKeys)

list

Name	Datatype	Description
id	string	A unique identifier for the connection, generated by the service. Required.
name	string	The friendly name of the connection, provided by the user. Required.
credentials	object	The credentials used by the connection. Required.
isDefault	boolean	Whether the connection is tagged as the default connection of its type. Required.
metadata	object	Metadata of the connection. Required.
target	string	The connection URL to be used for this service. Required.
type	string	Category of the connection. Required. Known values are: "AzureOpenAI", "AzureBlob", "AzureStorageAccount", "CognitiveSearch", "CosmosDB", "ApiKey", "AppConfig", "AppInsights", and "CustomKeys". (AzureOpenAI, AzureBlob, AzureStorageAccount, CognitiveSearch, CosmosDB, ApiKey, AppConfig, AppInsights, CustomKeys)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	name, endpoint		Get a connection by name, without populating connection credentials.
list	select	endpoint	connectionType, defaultConnection	List all connections in the project, without populating connection credentials.
get_with_credentials	exec	name, endpoint		Get a connection by name, with its connection credentials.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
name	string	The friendly name of the connection, provided by the user. Required.
connectionType	string	List connections of this specific type. Known values are: "AzureOpenAI", "AzureBlob", "AzureStorageAccount", "CognitiveSearch", "CosmosDB", "ApiKey", "AppConfig", "AppInsights", and "CustomKeys". Default value is None.
defaultConnection	boolean	List connections that are default connections. Default value is None.

SELECT examples

get

Get a connection by name, without populating connection credentials.

SELECT
id,
name,
credentials,
isDefault,
metadata,
target,
type
FROM azure.ai_evaluation.connections
WHERE name = '{{ name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list

List all connections in the project, without populating connection credentials.

SELECT
id,
name,
credentials,
isDefault,
metadata,
target,
type
FROM azure.ai_evaluation.connections
WHERE endpoint = '{{ endpoint }}' -- required
AND connectionType = '{{ connectionType }}'
AND defaultConnection = '{{ defaultConnection }}'
;

Lifecycle Methods

get_with_credentials

Get a connection by name, with its connection credentials.

EXEC azure.ai_evaluation.connections.get_with_credentials 
@name='{{ name }}' --required, 
@endpoint='{{ endpoint }}' --required
;