SearchIndexerClient.DeleteIndexerAsync Method

Definition

Namespace:

Azure.Search.Documents.Indexes

Assembly:

Azure.Search.Documents.dll

Package:

Azure.Search.Documents v11.5.1

Overloads

DeleteIndexerAsync(SearchIndexer, Boolean, CancellationToken)	Deletes an indexer.
DeleteIndexerAsync(String, CancellationToken)	Deletes an indexer.

DeleteIndexerAsync(SearchIndexer, Boolean, CancellationToken)

Source:

SearchIndexerClient.cs

Deletes an indexer.

public virtual System.Threading.Tasks.Task<Azure.Response> DeleteIndexerAsync (Azure.Search.Documents.Indexes.Models.SearchIndexer indexer, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteIndexerAsync : Azure.Search.Documents.Indexes.Models.SearchIndexer * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteIndexerAsync : Azure.Search.Documents.Indexes.Models.SearchIndexer * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function DeleteIndexerAsync (indexer As SearchIndexer, Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

indexer

SearchIndexer

The SearchIndexer 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

Task<Response>

The Response from the server.

Exceptions

ArgumentNullException

Thrown when indexer is null.

RequestFailedException

Thrown when a failure is returned by the Search service.

DeleteIndexerAsync(String, CancellationToken)

Source:

SearchIndexerClient.cs

Deletes an indexer.

public virtual System.Threading.Tasks.Task<Azure.Response> DeleteIndexerAsync (string indexerName, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteIndexerAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteIndexerAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function DeleteIndexerAsync (indexerName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

indexerName

String

The name of the SearchIndexer to delete.

cancellationToken

CancellationToken

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

Returns

Task<Response>

The Response from the server.

Exceptions

ArgumentNullException

Thrown when indexerName is null.

RequestFailedException

Thrown when a failure is returned by the Search service.