SearchIndexClient.CreateIndexAsync(SearchIndex, CancellationToken) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Creates a new search index.
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Indexes.Models.SearchIndex>> CreateIndexAsync (Azure.Search.Documents.Indexes.Models.SearchIndex index, System.Threading.CancellationToken cancellationToken = default);abstract member CreateIndexAsync : Azure.Search.Documents.Indexes.Models.SearchIndex * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Indexes.Models.SearchIndex>>
override this.CreateIndexAsync : Azure.Search.Documents.Indexes.Models.SearchIndex * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Indexes.Models.SearchIndex>>Public Overridable Function CreateIndexAsync (index As SearchIndex, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of SearchIndex))Parameters
- index
- SearchIndex
Required. The SearchIndex to create.
- cancellationToken
- CancellationToken
Optional CancellationToken to propagate notifications that the operation should be canceled.
Returns
The Response<T> from the server containing the SearchIndex that was created. This may differ slightly from what was passed in since the service may return back fields set to their default values depending on the field type and other properties.
Exceptions
Thrown when index is null.
Thrown when a failure is returned by the Search service.
