ConnectionsOperations interface

Package:

@azure/ai-projects

Interface representing a Connections operations.

Properties

get	Get a connection by name, without populating connection credentials
getDefault	Get the default connection for the project
getWithCredentials	Get a connection by name, with its connection credentials
list	List all connections in the project, without populating connection credentials

Property Details

get

Get a connection by name, without populating connection credentials

get: (name: string, includeCredentials?: boolean, options?: ConnectionsGetOptionalParams) => Promise<Connection>

Property Value

(name: string, includeCredentials?: boolean, options?: ConnectionsGetOptionalParams) => Promise<Connection>

getDefault

Get the default connection for the project

getDefault: (connectionType: ConnectionType, includeCredentials?: boolean) => Promise<Connection>

Property Value

(connectionType: ConnectionType, includeCredentials?: boolean) => Promise<Connection>

getWithCredentials

Get a connection by name, with its connection credentials

getWithCredentials: (name: string, options?: ConnectionsGetWithCredentialsOptionalParams) => Promise<Connection>

Property Value

(name: string, options?: ConnectionsGetWithCredentialsOptionalParams) => Promise<Connection>

list

List all connections in the project, without populating connection credentials

list: (options?: ConnectionsListOptionalParams) => PagedAsyncIterableIterator<Connection, Connection[], PageSettings>

Property Value

(options?: ConnectionsListOptionalParams) => PagedAsyncIterableIterator<Connection, Connection[], PageSettings>