Share via

SearchIndexClient.CreateAliasAsync(SearchAlias, CancellationToken) Method

  • Reference

Definition

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

Creates a new search alias.

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

Parameters

alias
SearchAlias

The definition of the alias to create.

cancellationToken
CancellationToken

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

Returns

Task<Response<SearchAlias>>

SearchAlias created by the service.

Applies to