SearchIndexerClient.GetIndexerStatus(String, CancellationToken) Method

Definition

Gets the current status and execution history of an indexer.

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

Parameters

indexerName
System.String

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

cancellationToken
System.Threading.CancellationToken

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

Returns

Response<SearchIndexerStatus>

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

Exceptions

System.ArgumentNullException

Thrown when indexerName is null.

Thrown when a failure is returned by the Search service.

Applies to