SearchIndexClient.DeleteSynonymMapAsync 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 |
|---|---|
| DeleteSynonymMapAsync(String, MatchConditions, CancellationToken) |
Deletes a synonym map. |
| DeleteSynonymMapAsync(String, MatchConditions, RequestContext) |
[Protocol Method] Deletes a synonym map.
|
| DeleteSynonymMapAsync(String, CancellationToken) |
Deletes a synonym map. |
| DeleteSynonymMapAsync(SynonymMap, Boolean, CancellationToken) |
Deletes a synonym map. |
DeleteSynonymMapAsync(String, MatchConditions, CancellationToken)
- Source:
- SearchIndexClient.cs
Deletes a synonym map.
public virtual System.Threading.Tasks.Task<Azure.Response> DeleteSynonymMapAsync(string synonymMapName, Azure.MatchConditions matchConditions = default, System.Threading.CancellationToken cancellationToken = default);abstract member DeleteSynonymMapAsync : string * Azure.MatchConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteSynonymMapAsync : string * Azure.MatchConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function DeleteSynonymMapAsync (synonymMapName As String, Optional matchConditions As MatchConditions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)Parameters
- synonymMapName
- String
The name of the synonym map.
- matchConditions
- MatchConditions
The content to send as the request conditions of the request.
- cancellationToken
- CancellationToken
The cancellation token that can be used to cancel the operation.
Returns
Exceptions
synonymMapName is null.
synonymMapName is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
Applies to
DeleteSynonymMapAsync(String, MatchConditions, RequestContext)
- Source:
- SearchIndexClient.cs
[Protocol Method] Deletes a synonym map.
- This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
public virtual System.Threading.Tasks.Task<Azure.Response> DeleteSynonymMapAsync(string synonymMapName, Azure.MatchConditions matchConditions, Azure.RequestContext context);abstract member DeleteSynonymMapAsync : string * Azure.MatchConditions * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteSynonymMapAsync : string * Azure.MatchConditions * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function DeleteSynonymMapAsync (synonymMapName As String, matchConditions As MatchConditions, context As RequestContext) As Task(Of Response)Parameters
- synonymMapName
- String
The name of the synonym map.
- matchConditions
- MatchConditions
The content to send as the request conditions of the request.
- context
- RequestContext
The request options, which can override default behaviors of the client pipeline on a per-call basis.
Returns
The response returned from the service.
Exceptions
synonymMapName is null.
synonymMapName is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
Applies to
DeleteSynonymMapAsync(String, CancellationToken)
- Source:
- SearchIndexClient.cs
- Source:
- SearchIndexClient.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.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.
