SearchIndexClient.CreateOrUpdateAliasAsync 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 or updates an alias if it already exists.

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

Parameters

aliasName
String

The name of the alias to create or update.

alias
SearchAlias

The definition of the alias to create or update.

onlyIfUnchanged
Boolean

True to throw a RequestFailedException if the ETag does not match the current alias version; otherwise, the current version will be overwritten.

cancellationToken
CancellationToken

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

Returns

Task<Response<SearchAlias>>

SearchAlias defined by aliasName.

Applies to