The Get Synonym Map operation gets the synonym map definition from Azure AI Search.
Parameter
Description
service name
Required. Set this to the unique, user-defined name of your search service.
synonym map name
Required. The request URI specifies the name of the synonym map to return.
api-version
Required. The current stable version is . See API versions for more versions.
The following table describes the required and optional request headers.
Fields
Description
Content-Type
Required. Set this to
api-key
Optional if you're using Azure roles and a bearer token is provided on the request, otherwise a key is required. An api-key is a unique, system-generated string that authenticates the request to your search service. Get requests for an object definition must include an api-key field set to your admin key (as opposed to a query key). See Connect to Azure AI Search using key authentication for details.
None.
Status Code: 200 OK is returned for a successful response.
The response is similar to examples in Create Synonym Map (Azure AI Search REST API).
