Share via


SearchIndexerClient.DeleteIndexer Method

Definition

Overloads

DeleteIndexer(String, CancellationToken)

Deletes an indexer.

DeleteIndexer(SearchIndexer, Boolean, CancellationToken)

Deletes an indexer.

DeleteIndexer(String, CancellationToken)

Source:
SearchIndexerClient.cs
Source:
SearchIndexerClient.cs

Deletes an indexer.

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

The Response from the server.

Exceptions

Thrown when indexerName is null.

Thrown when a failure is returned by the Search service.

Applies to

DeleteIndexer(SearchIndexer, Boolean, CancellationToken)

Source:
SearchIndexerClient.cs
Source:
SearchIndexerClient.cs

Deletes an indexer.

public virtual Azure.Response DeleteIndexer (Azure.Search.Documents.Indexes.Models.SearchIndexer indexer, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteIndexer : Azure.Search.Documents.Indexes.Models.SearchIndexer * bool * System.Threading.CancellationToken -> Azure.Response
override this.DeleteIndexer : Azure.Search.Documents.Indexes.Models.SearchIndexer * bool * System.Threading.CancellationToken -> Azure.Response
Public Overridable Function DeleteIndexer (indexer As SearchIndexer, Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As 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

The Response from the server.

Exceptions

Thrown when indexer is null.

Thrown when a failure is returned by the Search service.

Applies to