AIProjectConnectionsOperations.GetDefaultConnectionAsync Method

Definition

Namespace:
Azure.AI.Projects
Assembly:
Azure.AI.Projects.dll
Package:
Azure.AI.Projects v2.0.1
Package:
Azure.AI.Projects v2.1.0-beta.1
Source:
AIProjectConnectionsOperations.cs
Source:
AIProjectConnectionsOperations.cs

Get the default connection.

public virtual System.Threading.Tasks.Task<Azure.AI.Projects.AIProjectConnection> GetDefaultConnectionAsync(Azure.AI.Projects.ConnectionType? connectionType = default, bool includeCredentials = false);
abstract member GetDefaultConnectionAsync : Nullable<Azure.AI.Projects.ConnectionType> * bool -> System.Threading.Tasks.Task<Azure.AI.Projects.AIProjectConnection>
override this.GetDefaultConnectionAsync : Nullable<Azure.AI.Projects.ConnectionType> * bool -> System.Threading.Tasks.Task<Azure.AI.Projects.AIProjectConnection>
Public Overridable Function GetDefaultConnectionAsync (Optional connectionType As Nullable(Of ConnectionType) = Nothing, Optional includeCredentials As Boolean = false) As Task(Of AIProjectConnection)

Parameters

connectionType
Nullable<ConnectionType>

List connections of this specific type.

includeCredentials
Boolean

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

Returns

Task<AIProjectConnection>

A AIProjectConnection object.

Exceptions

RequestFailedException

Thrown when the request fails.

Applies to