Share via


SearchIndexClient.DeleteSynonymMap Method

Definition

Overloads

DeleteSynonymMap(SynonymMap, Boolean, CancellationToken)

Deletes a synonym map.

DeleteSynonymMap(String, CancellationToken)

Deletes a synonym map.

DeleteSynonymMap(SynonymMap, Boolean, CancellationToken)

Source:
SearchIndexClient.cs
Source:
SearchIndexClient.cs

Deletes a synonym map.

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

DeleteSynonymMap(String, CancellationToken)

Source:
SearchIndexClient.cs
Source:
SearchIndexClient.cs

Deletes a synonym map.

public virtual Azure.Response DeleteSynonymMap (string synonymMapName, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteSynonymMap : string * System.Threading.CancellationToken -> Azure.Response
override this.DeleteSynonymMap : string * System.Threading.CancellationToken -> Azure.Response
Public Overridable Function DeleteSynonymMap (synonymMapName As String, Optional cancellationToken As CancellationToken = Nothing) As 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