ConnectionsClient.GetConnections Method

Definition

Namespace:

Azure.AI.Projects

Assembly:

Azure.AI.Projects.dll

Package:

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

Overloads

GetConnections(Nullable<ConnectionType>, Nullable<Boolean>, String, CancellationToken)	List the details of all the connections (not including their credentials).
GetConnections(String, Nullable<Boolean>, String, RequestContext)	[Protocol Method] List the details of all the connections (not including their credentials) This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetConnections(Nullable<ConnectionType>, Nullable<Boolean>, String, CancellationToken) convenience overload with strongly typed models first.

GetConnections(Nullable<ConnectionType>, Nullable<Boolean>, String, CancellationToken)

Source:

ConnectionsClient.cs

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

public virtual Azure.Response<Azure.AI.Projects.ListConnectionsResponse> GetConnections (Azure.AI.Projects.ConnectionType? category = default, bool? includeAll = default, string target = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetConnections : Nullable<Azure.AI.Projects.ConnectionType> * Nullable<bool> * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Projects.ListConnectionsResponse>
override this.GetConnections : Nullable<Azure.AI.Projects.ConnectionType> * Nullable<bool> * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Projects.ListConnectionsResponse>

Public Overridable Function GetConnections (Optional category As Nullable(Of ConnectionType) = Nothing, Optional includeAll As Nullable(Of Boolean) = Nothing, Optional target As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of ListConnectionsResponse)

Parameters

category

Nullable<ConnectionType>

Category of the workspace connection.

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

Response<ListConnectionsResponse>

GetConnections(String, Nullable<Boolean>, String, RequestContext)

Source:

ConnectionsClient.cs

[Protocol Method] List the details of all the connections (not including their credentials)

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
• Please try the simpler GetConnections(Nullable<ConnectionType>, Nullable<Boolean>, String, CancellationToken) convenience overload with strongly typed models first.

public virtual Azure.Response GetConnections (string category, bool? includeAll, string target, Azure.RequestContext context);

abstract member GetConnections : string * Nullable<bool> * string * Azure.RequestContext -> Azure.Response
override this.GetConnections : string * Nullable<bool> * string * Azure.RequestContext -> Azure.Response

Public Overridable Function GetConnections (category As String, includeAll As Nullable(Of Boolean), target As String, context As RequestContext) As Response

Parameters

category

String

Category of the workspace connection. Allowed values: "AzureOpenAI" | "Serverless" | "AzureBlob" | "AIServices" | "CognitiveSearch".

includeAll

Nullable<Boolean>

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

target

String

Target of the workspace connection.

context

RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Response

The response returned from the service.

Exceptions

RequestFailedException

Service returned a non-success status code.