Share via


SearchIndexClient.DeleteSynonymMapAsync Method

Definition

Overloads

DeleteSynonymMapAsync(String, CancellationToken)

Deletes a synonym map.

DeleteSynonymMapAsync(SynonymMap, Boolean, CancellationToken)

Deletes a synonym map.

DeleteSynonymMapAsync(String, CancellationToken)

Source:
SearchIndexClient.cs
Source:
SearchIndexClient.Aliases.cs

Deletes a synonym map.

public virtual System.Threading.Tasks.Task<Azure.Response> DeleteSynonymMapAsync (string synonymMapName, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteSynonymMapAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteSynonymMapAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
Public Overridable Function DeleteSynonymMapAsync (synonymMapName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

synonymMapName
String

The name of a SynonymMap to delete.

cancellationToken
CancellationToken

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

Returns

The Response from the server.

Exceptions

Thrown when synonymMapName or Name is null.

Thrown when a failure is returned by the Search service.

Applies to

DeleteSynonymMapAsync(SynonymMap, Boolean, CancellationToken)

Source:
SearchIndexClient.cs
Source:
SearchIndexClient.Aliases.cs

Deletes a synonym map.

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

Parameters

synonymMap
SynonymMap

The SynonymMap to delete.

onlyIfUnchanged
Boolean

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

cancellationToken
CancellationToken

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

Returns

The Response from the server.

Exceptions

Thrown when synonymMap or Name is null.

Thrown when a failure is returned by the Search service.

Applies to