Share via


SearchIndexerClient.GetIndexerStatusAsync(String, CancellationToken) Method

Definition

Gets the current status and execution history of an indexer.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Indexes.Models.SearchIndexerStatus>> GetIndexerStatusAsync (string indexerName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetIndexerStatusAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Indexes.Models.SearchIndexerStatus>>
override this.GetIndexerStatusAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Indexes.Models.SearchIndexerStatus>>
Public Overridable Function GetIndexerStatusAsync (indexerName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of SearchIndexerStatus))

Parameters

indexerName
String

Required. The name of the indexer for which to retrieve status.

cancellationToken
CancellationToken

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

Returns

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

Exceptions

Thrown when indexerName is null.

Thrown when a failure is returned by the Search service.

Applies to