SearchIndexerClient.DeleteDataSourceConnection Method

Definition

Namespace:

Azure.Search.Documents.Indexes

Assembly:

Azure.Search.Documents.dll

Package:

Azure.Search.Documents v11.6.0

Overloads

DeleteDataSourceConnection(String, CancellationToken)	Deletes a data source connection.
DeleteDataSourceConnection(SearchIndexerDataSourceConnection, Boolean, CancellationToken)	Deletes a data source connection.

DeleteDataSourceConnection(String, CancellationToken)

Source:

SearchIndexerClient.DataSources.cs

Deletes a data source connection.

public virtual Azure.Response DeleteDataSourceConnection (string dataSourceConnectionName, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteDataSourceConnection : string * System.Threading.CancellationToken -> Azure.Response
override this.DeleteDataSourceConnection : string * System.Threading.CancellationToken -> Azure.Response

Public Overridable Function DeleteDataSourceConnection (dataSourceConnectionName As String, Optional cancellationToken As CancellationToken = Nothing) As Response

Parameters

dataSourceConnectionName

String

The name of the SearchIndexerDataSourceConnection to delete.

cancellationToken

CancellationToken

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

Returns

Response

The Response from the server.

Exceptions

ArgumentNullException

Thrown when dataSourceConnectionName is null.

RequestFailedException

Thrown when a failure is returned by the Search service.

DeleteDataSourceConnection(SearchIndexerDataSourceConnection, Boolean, CancellationToken)

Source:

SearchIndexerClient.DataSources.cs

Deletes a data source connection.

public virtual Azure.Response DeleteDataSourceConnection (Azure.Search.Documents.Indexes.Models.SearchIndexerDataSourceConnection dataSourceConnection, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteDataSourceConnection : Azure.Search.Documents.Indexes.Models.SearchIndexerDataSourceConnection * bool * System.Threading.CancellationToken -> Azure.Response
override this.DeleteDataSourceConnection : Azure.Search.Documents.Indexes.Models.SearchIndexerDataSourceConnection * bool * System.Threading.CancellationToken -> Azure.Response

Public Overridable Function DeleteDataSourceConnection (dataSourceConnection As SearchIndexerDataSourceConnection, Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Response

Parameters

dataSourceConnection

SearchIndexerDataSourceConnection

The SearchIndexerDataSourceConnection to delete.

onlyIfUnchanged

Boolean

True to throw a RequestFailedException if the ETag does not match the current service version; otherwise, the current service version will be overwritten.

cancellationToken

CancellationToken

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

Returns

Response

The Response from the server.

Exceptions

ArgumentNullException

Thrown when dataSourceConnection is null.

RequestFailedException

Thrown when a failure is returned by the Search service.