ConnectionsClient.GetDefaultConnectionAsync Method

Definition

Namespace:

Azure.AI.Projects

Assembly:

Azure.AI.Projects.dll

Package:

Azure.AI.Projects v1.0.0-beta.2

Source:

ConnectionsClient.cs

List the details of all the connections (not including their credentials).

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.Projects.ConnectionResponse>> GetDefaultConnectionAsync (Azure.AI.Projects.ConnectionType category, bool? withCredential = default, bool? includeAll = default, string target = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetDefaultConnectionAsync : Azure.AI.Projects.ConnectionType * Nullable<bool> * Nullable<bool> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Projects.ConnectionResponse>>
override this.GetDefaultConnectionAsync : Azure.AI.Projects.ConnectionType * Nullable<bool> * Nullable<bool> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Projects.ConnectionResponse>>

Public Overridable Function GetDefaultConnectionAsync (category As ConnectionType, Optional withCredential As Nullable(Of Boolean) = Nothing, Optional includeAll As Nullable(Of Boolean) = Nothing, Optional target As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ConnectionResponse))

Parameters

category

ConnectionType

Category of the workspace connection.

withCredential

Nullable<Boolean>

includeAll

Nullable<Boolean>

Indicates whether to list datastores. Service default: do not list datastores.

target

String

Target of the workspace connection.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<ConnectionResponse>>