SearchIndexerClient.GetDataSourceConnectionAsync Method

Definition

Namespace:

Azure.Search.Documents.Indexes

Assembly:

Azure.Search.Documents.dll

Package:

Azure.Search.Documents v11.6.0

Source:

SearchIndexerClient.cs

Gets a specific SearchIndexerDataSourceConnection.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Indexes.Models.SearchIndexerDataSourceConnection>> GetDataSourceConnectionAsync (string dataSourceConnectionName, System.Threading.CancellationToken cancellationToken = default);

abstract member GetDataSourceConnectionAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Indexes.Models.SearchIndexerDataSourceConnection>>
override this.GetDataSourceConnectionAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Indexes.Models.SearchIndexerDataSourceConnection>>

Public Overridable Function GetDataSourceConnectionAsync (dataSourceConnectionName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of SearchIndexerDataSourceConnection))

Parameters

dataSourceConnectionName

String

Required. The name of the SearchIndexerDataSourceConnection to get.

cancellationToken

CancellationToken

Optional CancellationToken to propagate notifications that the operation should be canceled.

Returns

Task<Response<SearchIndexerDataSourceConnection>>

The Response<T> from the server containing the requested SearchIndexerDataSourceConnection.

Exceptions

ArgumentNullException

Thrown when dataSourceConnectionName is null.

RequestFailedException

Thrown when a failure is returned by the Search service.