SearchIndexerClient.GetDataSourceConnection Method

Definition

Namespace:

Azure.Search.Documents.Indexes

Assembly:

Azure.Search.Documents.dll

Package:

Azure.Search.Documents v12.0.0

Overloads

Name	Description
GetDataSourceConnection(String, CancellationToken)	Retrieves a datasource definition.
GetDataSourceConnection(String, RequestContext)	[Protocol Method] Retrieves a datasource definition. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

GetDataSourceConnection(String, CancellationToken)

Source:

SearchIndexerClient.cs

Retrieves a datasource definition.

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

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

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

Parameters

dataSourceConnectionName

String

The name of the datasource.

cancellationToken

CancellationToken

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

Returns

Response<SearchIndexerDataSourceConnection>

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

Exceptions

ArgumentNullException

dataSourceConnectionName is null.

ArgumentException

dataSourceConnectionName is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

GetDataSourceConnection(String, RequestContext)

Source:

SearchIndexerClient.cs

[Protocol Method] Retrieves a datasource definition.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

public virtual Azure.Response GetDataSourceConnection(string dataSourceConnectionName, Azure.RequestContext context);

abstract member GetDataSourceConnection : string * Azure.RequestContext -> Azure.Response
override this.GetDataSourceConnection : string * Azure.RequestContext -> Azure.Response

Public Overridable Function GetDataSourceConnection (dataSourceConnectionName As String, context As RequestContext) As Response

Parameters

dataSourceConnectionName

String

The name of the datasource.

context

RequestContext

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

Returns

Response

The response returned from the service.

Exceptions

ArgumentNullException

dataSourceConnectionName is null.

ArgumentException

dataSourceConnectionName is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.