SearchIndexerClient.CreateIndexerAsync Method

  • Reference

Definition

Namespace:
Azure.Search.Documents.Indexes
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v11.6.0
Package:
Azure.Search.Documents v11.7.0-beta.1
Source:
SearchIndexerClient.cs
Source:
SearchIndexerClient.cs

Creates a new indexer.

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

Parameters

indexer
SearchIndexer

Required. The SearchIndexer to create.

cancellationToken
CancellationToken

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

Returns

Task<Response<SearchIndexer>>

The Response<T> from the server containing the SearchIndexer created. This may differ slightly from what was passed into the service.

Exceptions

ArgumentNullException

Thrown when indexer is null.

RequestFailedException

Thrown when a failure is returned by the Search service.

Applies to