Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

SearchIndexClient.CreateIndexAsync Method

Definition

Namespace:
Azure.Search.Documents.Indexes
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v12.0.0
Package:
Azure.Search.Documents v12.1.0-beta.1

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.

Overloads

Name Description
CreateIndexAsync(SearchIndex, CancellationToken)

Creates a new search index.
CreateIndexAsync(RequestContent, RequestContext)

[Protocol Method] Creates a new search index.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

CreateIndexAsync(SearchIndex, CancellationToken)

Source:
SearchIndexClient.cs
Source:
SearchIndexClient.cs

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

The definition of the index to create.

cancellationToken
CancellationToken

The cancellation token that can be used to cancel the operation.

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

index is null.

Service returned a non-success status code.

Applies to

CreateIndexAsync(RequestContent, RequestContext)

Source:
SearchIndexClient.cs
Source:
SearchIndexClient.cs

[Protocol Method] Creates a new search index.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. 
public virtual System.Threading.Tasks.Task<Azure.Response> CreateIndexAsync(Azure.Core.RequestContent content, Azure.RequestContext context = default);
abstract member CreateIndexAsync : Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.CreateIndexAsync : Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
Public Overridable Function CreateIndexAsync (content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

content
RequestContent

The content to send as the body of the request.

context
RequestContext

The request options, which can override default behaviors of the client pipeline on a per-call basis.

Returns

The response returned from the service.

Exceptions

content is null.

Service returned a non-success status code.

Applies to

Feedback

Was this page helpful?