SearchIndexClient.GetSynonymMap Method

Definition

Namespace:: Azure.Search.Documents.Indexes

Assembly:: Azure.Search.Documents.dll

Package:: Azure.Search.Documents v12.0.0

Package:: Azure.Search.Documents v11.8.0-beta.1

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
GetSynonymMap(String, RequestContext)	[Protocol Method] Retrieves a synonym map definition. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetSynonymMap(String, CancellationToken)	Retrieves a synonym map definition.

Name

Description

GetSynonymMap(String, RequestContext)

[Protocol Method] Retrieves a synonym map definition.

This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

GetSynonymMap(String, CancellationToken)

Retrieves a synonym map definition.

GetSynonymMap(String, RequestContext)

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 Azure.Response GetSynonymMap(string synonymMapName, Azure.RequestContext context);

abstract member GetSynonymMap : string * Azure.RequestContext -> Azure.Response
override this.GetSynonymMap : string * Azure.RequestContext -> Azure.Response

Public Overridable Function GetSynonymMap (synonymMapName As String, context As RequestContext) As 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

Response

The response returned from the service.

Exceptions

ArgumentNullException

synonymMapName is null.

ArgumentException

synonymMapName is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Applies to

GetSynonymMap(String, CancellationToken)

Source:: SearchIndexClient.cs

Source:: SearchIndexClient.cs

Retrieves a synonym map definition.

public virtual Azure.Response<Azure.Search.Documents.Indexes.Models.SynonymMap> GetSynonymMap(string synonymMapName, System.Threading.CancellationToken cancellationToken = default);

abstract member GetSynonymMap : string * System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Indexes.Models.SynonymMap>
override this.GetSynonymMap : string * System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Indexes.Models.SynonymMap>

Public Overridable Function GetSynonymMap (synonymMapName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of SynonymMap)