SearchIndexClient.CreateOrUpdateAlias 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.
Overloads
| Name | Description |
|---|---|
| CreateOrUpdateAlias(SearchAlias, Boolean, CancellationToken) |
Creates a new search alias or updates an alias if it already exists. |
| CreateOrUpdateAlias(String, SearchAlias, Boolean, CancellationToken) |
Creates a new search alias or updates an alias if it already exists. |
CreateOrUpdateAlias(SearchAlias, Boolean, CancellationToken)
- Source:
- SearchIndexClient.Aliases.cs
Creates a new search alias or updates an alias if it already exists.
public virtual Azure.Response<Azure.Search.Documents.Indexes.Models.SearchAlias> CreateOrUpdateAlias(Azure.Search.Documents.Indexes.Models.SearchAlias alias, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);abstract member CreateOrUpdateAlias : Azure.Search.Documents.Indexes.Models.SearchAlias * bool * System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Indexes.Models.SearchAlias>
override this.CreateOrUpdateAlias : Azure.Search.Documents.Indexes.Models.SearchAlias * bool * System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Indexes.Models.SearchAlias>Public Overridable Function CreateOrUpdateAlias (alias As SearchAlias, Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Response(Of SearchAlias)Parameters
- 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
SearchAlias defined by aliasName.
Applies to
CreateOrUpdateAlias(String, SearchAlias, Boolean, CancellationToken)
- Source:
- SearchIndexClient.Aliases.cs
Creates a new search alias or updates an alias if it already exists.
public virtual Azure.Response<Azure.Search.Documents.Indexes.Models.SearchAlias> CreateOrUpdateAlias(string aliasName, Azure.Search.Documents.Indexes.Models.SearchAlias alias, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);abstract member CreateOrUpdateAlias : string * Azure.Search.Documents.Indexes.Models.SearchAlias * bool * System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Indexes.Models.SearchAlias>
override this.CreateOrUpdateAlias : string * Azure.Search.Documents.Indexes.Models.SearchAlias * bool * System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Indexes.Models.SearchAlias>Public Overridable Function CreateOrUpdateAlias (aliasName As String, alias As SearchAlias, Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As 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
SearchAlias defined by aliasName.
