SearchIndexClient.GetSynonymMapAsync 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 |
|---|---|
| GetSynonymMapAsync(String, CancellationToken) |
Retrieves a synonym map definition. |
| GetSynonymMapAsync(String, RequestContext) |
[Protocol Method] Retrieves a synonym map definition.
|
GetSynonymMapAsync(String, CancellationToken)
- Source:
- SearchIndexClient.cs
- Source:
- SearchIndexClient.cs
Retrieves a synonym map definition.
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Indexes.Models.SynonymMap>> GetSynonymMapAsync(string synonymMapName, System.Threading.CancellationToken cancellationToken = default);abstract member GetSynonymMapAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Indexes.Models.SynonymMap>>
override this.GetSynonymMapAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Indexes.Models.SynonymMap>>Public Overridable Function GetSynonymMapAsync (synonymMapName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of SynonymMap))Parameters
- synonymMapName
- String
The name of the synonym map.
- cancellationToken
- CancellationToken
The cancellation token that can be used to cancel the operation.
Returns
The Response<T> from the server containing the requested SynonymMap.
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
GetSynonymMapAsync(String, RequestContext)
- Source:
- SearchIndexClient.cs
- Source:
- SearchIndexClient.cs
[Protocol Method] Retrieves a synonym map definition.
- 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> GetSynonymMapAsync(string synonymMapName, Azure.RequestContext context);abstract member GetSynonymMapAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetSynonymMapAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function GetSynonymMapAsync (synonymMapName As String, context As RequestContext) As Task(Of Response)Parameters
- synonymMapName
- String
The name of the synonym map.
- 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.
