Share via


SearchIndexerClient.DeleteDataSourceConnectionAsync Method

Definition

Overloads

DeleteDataSourceConnectionAsync(String, CancellationToken)

Deletes a data source connection.

DeleteDataSourceConnectionAsync(SearchIndexerDataSourceConnection, Boolean, CancellationToken)

Deletes a data source connection.

DeleteDataSourceConnectionAsync(String, CancellationToken)

Source:
SearchIndexerClient.cs
Source:
SearchIndexerClient.cs

Deletes a data source connection.

public virtual System.Threading.Tasks.Task<Azure.Response> DeleteDataSourceConnectionAsync (string dataSourceConnectionName, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteDataSourceConnectionAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteDataSourceConnectionAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
Public Overridable Function DeleteDataSourceConnectionAsync (dataSourceConnectionName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of 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

The Response from the server.

Exceptions

Thrown when dataSourceConnectionName is null.

Thrown when a failure is returned by the Search service.

Applies to

DeleteDataSourceConnectionAsync(SearchIndexerDataSourceConnection, Boolean, CancellationToken)

Source:
SearchIndexerClient.cs
Source:
SearchIndexerClient.cs

Deletes a data source connection.

public virtual System.Threading.Tasks.Task<Azure.Response> DeleteDataSourceConnectionAsync (Azure.Search.Documents.Indexes.Models.SearchIndexerDataSourceConnection dataSourceConnection, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteDataSourceConnectionAsync : Azure.Search.Documents.Indexes.Models.SearchIndexerDataSourceConnection * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteDataSourceConnectionAsync : Azure.Search.Documents.Indexes.Models.SearchIndexerDataSourceConnection * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
Public Overridable Function DeleteDataSourceConnectionAsync (dataSourceConnection As SearchIndexerDataSourceConnection, Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

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

The Response from the server.

Exceptions

Thrown when dataSourceConnection is null.

Thrown when a failure is returned by the Search service.

Applies to