Microsoft Azure SynonymMaps API

The SynonymMaps API from Microsoft Azure — 2 operation(s) for synonymmaps.

Documentation GitHub OpenAPI

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

PUT /synonymmaps('{synonymMapName}') Create or update a named synonym map · Microsoft Azure Put Synonymmaps Synonymmapname #

Ask an LLM

“How do I update the synonym rules of an existing synonym map in place?”

“Can I upsert a synonym map by name only if its ETag hasn't changed?”

Tell an agent

Upsert synonym map {synonymMapName} with {format} rules {synonyms}, name {name}, returning {Prefer}.

Replace the rules in synonym map {synonymMapName} only if its ETag is {If-Match}.

DELETE /synonymmaps('{synonymMapName}') Delete a synonym map · Microsoft Azure Delete Synonymmaps Synonymmapname #

Ask an LLM

“How do I delete a synonym map from my search service?”

“Can I make the delete conditional on the synonym map's current ETag?”

Tell an agent destructive · confirm first

Delete synonym map {synonymMapName}.

Remove synonym map {synonymMapName} only if its ETag matches {If-Match}.

GET /synonymmaps('{synonymMapName}') Get a search synonym map · Microsoft Azure Get Synonymmaps Synonymmapname #

Ask an LLM

“How do I view the synonym rules in one of my search service's synonym maps?”

“What synonyms are defined in a named synonym map?”

Tell an agent

Get synonym map {synonymMapName}.

Show the rules in synonym map {synonymMapName}.

GET /synonymmaps List synonym maps on a search service · Microsoft Azure Get Synonymmaps #

Ask an LLM

“Which synonym maps exist on my search service?”

“Can I return only certain properties, like names, when listing synonym maps?”

Tell an agent

List all synonym maps on the search service.

List synonym maps returning only {select}.

POST /synonymmaps Create a new synonym map · Microsoft Azure Post Synonymmaps #

Ask an LLM

“How do I add a brand-new synonym map so searches for one term match another?”

“What format do synonym rules need when I create a synonym map?”

Tell an agent

Create a new synonym map {name} in {format} format with rules {synonyms}.

Add synonym map {name} using solr rules {synonyms} and format {format}, encrypted with {encryptionKey}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/microsoft-azure:microsoft-azure-synonymmaps-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Microsoft Azure SearchServiceClient Synonym Maps API
  description: Client that can be used to manage and query indexes and documents, as well as manage other resources, on a search service.
  version: 2019-05-06-Preview
  x-ms-code-generation-settings:
    useDateTimeOffset: true
tags:
- name: SynonymMaps
paths:
  /synonymmaps('{synonymMapName}'):
    put:
      tags:
      - SynonymMaps
      operationId: microsoftAzureSynonymmapsCreateorupdate
      x-ms-examples:
        SearchServiceCreateOrUpdateSynonymMap:
          $ref: ./examples/SearchServiceCreateOrUpdateSynonymMap.json
      description: Creates a new synonym map or updates a synonym map if it already exists.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Update-Synonym-Map
      parameters:
      - name: synonymMapName
        in: path
        required: true
        description: The name of the synonym map to create or update.
        schema:
          type: string
      - $ref: '#/components/parameters/ClientRequestIdParameter'
      - $ref: '#/components/parameters/IfMatchParameter'
      - $ref: '#/components/parameters/IfNoneMatchParameter'
      - $ref: '#/components/parameters/PreferHeaderParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SynonymMap'
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SynonymMap'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchError'
      summary: Microsoft Azure Put Synonymmaps Synonymmapname
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SynonymMap'
        description: The definition of the synonym map to create or update.
        required: true
    delete:
      tags:
      - SynonymMaps
      operationId: microsoftAzureSynonymmapsDelete
      x-ms-examples:
        SearchServiceDeleteSynonymMap:
          $ref: ./examples/SearchServiceDeleteSynonymMap.json
      description: Deletes a synonym map.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Delete-Synonym-Map
      parameters:
      - name: synonymMapName
        in: path
        required: true
        description: The name of the synonym map to delete.
        schema:
          type: string
      - $ref: '#/components/parameters/ClientRequestIdParameter'
      - $ref: '#/components/parameters/IfMatchParameter'
      - $ref: '#/components/parameters/IfNoneMatchParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '204':
          description: ''
        '404':
          description: ''
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchError'
      summary: Microsoft Azure Delete Synonymmaps Synonymmapname
    get:
      tags:
      - SynonymMaps
      operationId: microsoftAzureSynonymmapsGet
      x-ms-examples:
        SearchServiceGetSynonymMap:
          $ref: ./examples/SearchServiceGetSynonymMap.json
      description: Retrieves a synonym map definition.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Get-Synonym-Map
      parameters:
      - name: synonymMapName
        in: path
        required: true
        description: The name of the synonym map to retrieve.
        schema:
          type: string
      - $ref: '#/components/parameters/ClientRequestIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SynonymMap'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchError'
      summary: Microsoft Azure Get Synonymmaps Synonymmapname
  /synonymmaps:
    get:
      tags:
      - SynonymMaps
      operationId: microsoftAzureSynonymmapsList
      x-ms-examples:
        SearchServiceListSynonymMaps:
          $ref: ./examples/SearchServiceListSynonymMaps.json
      description: Lists all synonym maps available for a search service.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/List-Synonym-Maps
      parameters:
      - name: $select
        in: query
        required: false
        description: Selects which top-level properties of the synonym maps to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties.
        schema:
          type: string
      - $ref: '#/components/parameters/ClientRequestIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSynonymMapsResult'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchError'
      summary: Microsoft Azure Get Synonymmaps
    post:
      tags:
      - SynonymMaps
      operationId: microsoftAzureSynonymmapsCreate
      x-ms-examples:
        SearchServiceCreateSynonymMap:
          $ref: ./examples/SearchServiceCreateSynonymMap.json
      description: Creates a new synonym map.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Create-Synonym-Map
      parameters:
      - $ref: '#/components/parameters/ClientRequestIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SynonymMap'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchError'
      summary: Microsoft Azure Post Synonymmaps
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SynonymMap'
        description: The definition of the synonym map to create.
        required: true
components:
  parameters:
    IfMatchParameter:
      name: If-Match
      in: header
      required: false
      description: Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.
      x-ms-parameter-location: method
      schema:
        type: string
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      description: Client Api Version.
      schema:
        type: string
    IfNoneMatchParameter:
      name: If-None-Match
      in: header
      required: false
      description: Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value.
      x-ms-parameter-location: method
      schema:
        type: string
    PreferHeaderParameter:
      name: Prefer
      in: header
      required: true
      description: For HTTP PUT requests, instructs the service to return the created/updated resource on success.
      x-ms-parameter-location: method
      schema:
        type: string
        enum:
        - return=representation
    ClientRequestIdParameter:
      name: x-ms-client-request-id
      in: header
      required: false
      description: The tracking ID sent with the request to help with debugging.
      x-ms-client-request-id: true
      x-ms-parameter-grouping:
        name: request-options
      x-ms-parameter-location: method
      schema:
        type: string
        format: uuid
  schemas:
    SearchError:
      properties:
        code:
          type: string
          readOnly: true
          description: One of a server-defined set of error codes.
        message:
          type: string
          readOnly: true
          description: A human-readable representation of the error.
        details:
          type: array
          items:
            $ref: '#/components/schemas/SearchError'
          readOnly: true
          description: An array of details about specific errors that led to this reported error.
      required:
      - message
      description: Describes an error condition for the Azure Cognitive Search API.
    ListSynonymMapsResult:
      properties:
        value:
          x-ms-client-name: SynonymMaps
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/SynonymMap'
          description: The synonym maps in the Search service.
      required:
      - value
      description: Response from a List SynonymMaps request. If successful, it includes the full definitions of all synonym maps.
    SynonymMap:
      properties:
        name:
          externalDocs:
            url: https://docs.microsoft.com/rest/api/searchservice/Naming-rules
          type: string
          description: The name of the synonym map.
        format:
          type: string
          enum:
          - solr
          x-ms-enum:
            name: SynonymMapFormat
            modelAsString: false
            values:
            - value: solr
              name: Solr
              description: Selects the SOLR format for synonym maps.
          description: The format of the synonym map. Only the 'solr' format is currently supported.
        synonyms:
          type: string
          description: A series of synonym rules in the specified synonym map format. The rules must be separated by newlines.
          externalDocs:
            url: https://docs.microsoft.com/rest/api/searchservice/Create-Synonym-Map#SynonymMapFormat
        encryptionKey:
          $ref: '#/components/schemas/SearchResourceEncryptionKey'
          description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data in Azure Cognitive Search. Once you have encrypted your data, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.
          externalDocs:
            url: https://aka.ms/azure-search-encryption-with-cmk
        '@odata.etag':
          x-ms-client-name: ETag
          type: string
          description: The ETag of the synonym map.
      required:
      - name
      - format
      - synonyms
      description: Represents a synonym map definition.
    AzureActiveDirectoryApplicationCredentials:
      properties:
        applicationId:
          type: string
          description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application.
        applicationSecret:
          type: string
          description: The authentication key of the specified AAD application.
      required:
      - applicationId
      description: Credentials of a registered application created for your search service, used for authenticated access to the encryption keys stored in Azure Key Vault.
    SearchResourceEncryptionKey:
      properties:
        keyVaultKeyName:
          x-ms-client-name: keyName
          type: string
          description: The name of your Azure Key Vault key to be used to encrypt your data at rest.
        keyVaultKeyVersion:
          x-ms-client-name: keyVersion
          type: string
          description: The version of your Azure Key Vault key to be used to encrypt your data at rest.
        keyVaultUri:
          x-ms-client-name: vaultUri
          type: string
          description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be https://my-keyvault-name.vault.azure.net.
        accessCredentials:
          $ref: '#/components/schemas/AzureActiveDirectoryApplicationCredentials'
          description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead.
          externalDocs:
            url: https://aka.ms/azure-search-msi
      required:
      - keyVaultKeyName
      - keyVaultKeyVersion
      - keyVaultUri
      description: A customer-managed encryption key in Azure Key Vault. Keys that you create and manage can be used to encrypt or decrypt data-at-rest in Azure Cognitive Search, such as indexes and synonym maps.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/EndpointParameter'

Microsoft Azure SynonymMaps API

Operations 5

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification