AIProjectConnectionsOperations.GetConnection Method

Definition

Get a connection by name.

public virtual Azure.AI.Projects.AIProjectConnection GetConnection(string connectionName, bool includeCredentials = false, System.Threading.CancellationToken cancellationToken = default);
abstract member GetConnection : string * bool * System.Threading.CancellationToken -> Azure.AI.Projects.AIProjectConnection
override this.GetConnection : string * bool * System.Threading.CancellationToken -> Azure.AI.Projects.AIProjectConnection
Public Overridable Function GetConnection (connectionName As String, Optional includeCredentials As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As AIProjectConnection

Parameters

connectionName
String

The name of the connection. Required.

includeCredentials
Boolean

Whether to include credentials in the response. Default is false.

cancellationToken
CancellationToken

The cancellation token that can be used to cancel the operation.

Returns

A AIProjectConnection object.

Exceptions

Thrown when the request fails.

Applies to