Microsoft Azure

Microsoft Azure Search Service Client

Microsoft Azure Search Service Client is a powerful tool that allows developers to easily integrate search functionality into their applications. With this service, users can search for specific data within their databases, websites, or other sources, enabling them to quickly find the information they need. The Search Service Client also offers advanced features such as faceted search, geospatial search, and fuzzy matching, which enhance the search experience for users.

GitHub OpenAPI

Documentation

📖
Documentation
https://learn.microsoft.com/en-us/azure/search/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/searchserviceclient-openapi-original.yml

OpenAPI Specification

searchserviceclient-openapi-original.yml Raw ↑ 
swagger: '2.0'
info:
  title: Microsoft Azure SearchServiceClient
  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
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
    - $ref: '#/parameters/EndpointParameter'
consumes:
  - application/json
produces:
  - application/json
paths:
  /datasources('{dataSourceName}'):
    put:
      tags:
        - DataSources
      operationId: microsoftAzureDatasourcesCreateorupdate
      x-ms-examples:
        SearchServiceCreateOrUpdateDataSource:
          $ref: ./examples/SearchServiceCreateOrUpdateDataSource.json
      description: Creates a new datasource or updates a datasource if it already exists.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Update-Data-Source
      parameters:
        - name: dataSourceName
          in: path
          required: true
          type: string
          description: The name of the datasource to create or update.
        - name: dataSource
          in: body
          required: true
          schema:
            $ref: '#/definitions/SearchIndexerDataSource'
          description: The definition of the datasource to create or update.
        - $ref: '#/parameters/ClientRequestIdParameter'
        - $ref: '#/parameters/IfMatchParameter'
        - $ref: '#/parameters/IfNoneMatchParameter'
        - $ref: '#/parameters/PreferHeaderParameter'
        - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/SearchIndexerDataSource'
        '201':
          description: ''
          schema:
            $ref: '#/definitions/SearchIndexerDataSource'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: 'Microsoft Azure Put Datasources Datasourcename'
    delete:
      tags:
        - DataSources
      operationId: microsoftAzureDatasourcesDelete
      x-ms-examples:
        SearchServiceDeleteDataSource:
          $ref: ./examples/SearchServiceDeleteDataSource.json
      description: Deletes a datasource.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Delete-Data-Source
      parameters:
        - name: dataSourceName
          in: path
          required: true
          type: string
          description: The name of the datasource to delete.
        - $ref: '#/parameters/ClientRequestIdParameter'
        - $ref: '#/parameters/IfMatchParameter'
        - $ref: '#/parameters/IfNoneMatchParameter'
        - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '204':
          description: ''
        '404':
          description: ''
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: 'Microsoft Azure Delete Datasources Datasourcename'
    get:
      tags:
        - DataSources
      operationId: microsoftAzureDatasourcesGet
      x-ms-examples:
        SearchServiceGetDataSource:
          $ref: ./examples/SearchServiceGetDataSource.json
      description: Retrieves a datasource definition.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Get-Data-Source
      parameters:
        - name: dataSourceName
          in: path
          required: true
          type: string
          description: The name of the datasource to retrieve.
        - $ref: '#/parameters/ClientRequestIdParameter'
        - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/SearchIndexerDataSource'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: 'Microsoft Azure Get Datasources Datasourcename'
  /datasources:
    get:
      tags:
        - DataSources
      operationId: microsoftAzureDatasourcesList
      x-ms-examples:
        SearchServiceListDataSources:
          $ref: ./examples/SearchServiceListDataSources.json
      description: Lists all datasources available for a search service.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/List-Data-Sources
      parameters:
        - name: $select
          in: query
          required: false
          type: string
          description: >-
            Selects which top-level properties of the data sources to retrieve.
            Specified as a comma-separated list of JSON property names, or '*'
            for all properties. The default is all properties.
        - $ref: '#/parameters/ClientRequestIdParameter'
        - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/ListDataSourcesResult'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: Microsoft Azure Get Datasources
    post:
      tags:
        - DataSources
      operationId: microsoftAzureDatasourcesCreate
      x-ms-examples:
        SearchServiceCreateDataSource:
          $ref: ./examples/SearchServiceCreateDataSource.json
      description: Creates a new datasource.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Create-Data-Source
      parameters:
        - name: dataSource
          in: body
          required: true
          schema:
            $ref: '#/definitions/SearchIndexerDataSource'
          description: The definition of the datasource to create.
        - $ref: '#/parameters/ClientRequestIdParameter'
        - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '201':
          description: ''
          schema:
            $ref: '#/definitions/SearchIndexerDataSource'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: Microsoft Azure Post Datasources
  /indexers('{indexerName}')/search.reset:
    post:
      tags:
        - Indexers
      operationId: microsoftAzureIndexersReset
      x-ms-examples:
        SearchServiceResetIndexer:
          $ref: ./examples/SearchServiceResetIndexer.json
      description: Resets the change tracking state associated with an indexer.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Reset-Indexer
      parameters:
        - name: indexerName
          in: path
          required: true
          type: string
          description: The name of the indexer to reset.
        - $ref: '#/parameters/ClientRequestIdParameter'
        - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '204':
          description: ''
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: Microsoft Azure Post Indexers Indexername  Search Reset
  /indexers('{indexerName}')/search.run:
    post:
      tags:
        - Indexers
      operationId: microsoftAzureIndexersRun
      x-ms-examples:
        SearchServiceRunIndexer:
          $ref: ./examples/SearchServiceRunIndexer.json
      description: Runs an indexer on-demand.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Run-Indexer
      parameters:
        - name: indexerName
          in: path
          required: true
          type: string
          description: The name of the indexer to run.
        - $ref: '#/parameters/ClientRequestIdParameter'
        - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '202':
          description: ''
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: Microsoft Azure Post Indexers Indexername  Search Run
  /indexers('{indexerName}'):
    put:
      tags:
        - Indexers
      operationId: microsoftAzureIndexersCreateorupdate
      x-ms-examples:
        SearchServiceCreateOrUpdateIndexer:
          $ref: ./examples/SearchServiceCreateOrUpdateIndexer.json
      description: Creates a new indexer or updates an indexer if it already exists.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Create-Indexer
      parameters:
        - name: indexerName
          in: path
          required: true
          type: string
          description: The name of the indexer to create or update.
        - name: indexer
          in: body
          required: true
          schema:
            $ref: '#/definitions/SearchIndexer'
          description: The definition of the indexer to create or update.
        - $ref: '#/parameters/ClientRequestIdParameter'
        - $ref: '#/parameters/IfMatchParameter'
        - $ref: '#/parameters/IfNoneMatchParameter'
        - $ref: '#/parameters/PreferHeaderParameter'
        - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/SearchIndexer'
        '201':
          description: ''
          schema:
            $ref: '#/definitions/SearchIndexer'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: 'Microsoft Azure Put Indexers Indexername'
    delete:
      tags:
        - Indexers
      operationId: microsoftAzureIndexersDelete
      x-ms-examples:
        SearchServiceDeleteIndexer:
          $ref: ./examples/SearchServiceDeleteIndexer.json
      description: Deletes an indexer.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Delete-Indexer
      parameters:
        - name: indexerName
          in: path
          required: true
          type: string
          description: The name of the indexer to delete.
        - $ref: '#/parameters/ClientRequestIdParameter'
        - $ref: '#/parameters/IfMatchParameter'
        - $ref: '#/parameters/IfNoneMatchParameter'
        - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '204':
          description: ''
        '404':
          description: ''
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: 'Microsoft Azure Delete Indexers Indexername'
    get:
      tags:
        - Indexers
      operationId: microsoftAzureIndexersGet
      x-ms-examples:
        SearchServiceGetIndexer:
          $ref: ./examples/SearchServiceGetIndexer.json
      description: Retrieves an indexer definition.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Get-Indexer
      parameters:
        - name: indexerName
          in: path
          required: true
          type: string
          description: The name of the indexer to retrieve.
        - $ref: '#/parameters/ClientRequestIdParameter'
        - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/SearchIndexer'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: 'Microsoft Azure Get Indexers Indexername'
  /indexers:
    get:
      tags:
        - Indexers
      operationId: microsoftAzureIndexersList
      x-ms-examples:
        SearchServiceListIndexers:
          $ref: ./examples/SearchServiceListIndexers.json
      description: Lists all indexers available for a search service.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/List-Indexers
      parameters:
        - name: $select
          in: query
          required: false
          type: string
          description: >-
            Selects which top-level properties of the indexers to retrieve.
            Specified as a comma-separated list of JSON property names, or '*'
            for all properties. The default is all properties.
        - $ref: '#/parameters/ClientRequestIdParameter'
        - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/ListIndexersResult'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: Microsoft Azure Get Indexers
    post:
      tags:
        - Indexers
      operationId: microsoftAzureIndexersCreate
      x-ms-examples:
        SearchServiceCreateIndexer:
          $ref: ./examples/SearchServiceCreateIndexer.json
      description: Creates a new indexer.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Create-Indexer
      parameters:
        - name: indexer
          in: body
          required: true
          schema:
            $ref: '#/definitions/SearchIndexer'
          description: The definition of the indexer to create.
        - $ref: '#/parameters/ClientRequestIdParameter'
        - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '201':
          description: ''
          schema:
            $ref: '#/definitions/SearchIndexer'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: Microsoft Azure Post Indexers
  /indexers('{indexerName}')/search.status:
    get:
      tags:
        - Indexers
      operationId: microsoftAzureIndexersGetstatus
      x-ms-examples:
        SearchServiceGetIndexerStatus:
          $ref: ./examples/SearchServiceGetIndexerStatus.json
      description: Returns the current status and execution history of an indexer.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Get-Indexer-Status
      parameters:
        - name: indexerName
          in: path
          required: true
          type: string
          description: The name of the indexer for which to retrieve status.
        - $ref: '#/parameters/ClientRequestIdParameter'
        - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/SearchIndexerStatus'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: Microsoft Azure Get Indexers Indexername  Search Status
  /skillsets('{skillsetName}'):
    put:
      tags:
        - Skillsets
      operationId: microsoftAzureSkillsetsCreateorupdate
      x-ms-examples:
        SearchServiceCreateOrUpdateSkillset:
          $ref: ./examples/SearchServiceCreateOrUpdateSkillset.json
      description: >-
        Creates a new skillset in a search service or updates the skillset if it
        already exists.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/update-skillset
      parameters:
        - name: skillsetName
          in: path
          required: true
          type: string
          description: The name of the skillset to create or update.
        - name: skillset
          in: body
          required: true
          schema:
            $ref: '#/definitions/SearchIndexerSkillset'
          description: >-
            The skillset containing one or more skills to create or update in a
            search service.
        - $ref: '#/parameters/ClientRequestIdParameter'
        - $ref: '#/parameters/IfMatchParameter'
        - $ref: '#/parameters/IfNoneMatchParameter'
        - $ref: '#/parameters/PreferHeaderParameter'
        - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: The skillset is successfully updated.
          schema:
            $ref: '#/definitions/SearchIndexerSkillset'
        '201':
          description: The skillset is successfully created.
          schema:
            $ref: '#/definitions/SearchIndexerSkillset'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: 'Microsoft Azure Put Skillsets Skillsetname'
    delete:
      tags:
        - Skillsets
      operationId: microsoftAzureSkillsetsDelete
      x-ms-examples:
        SearchServiceDeleteSkillset:
          $ref: ./examples/SearchServiceDeleteSkillset.json
      description: Deletes a skillset in a search service.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/delete-skillset
      parameters:
        - name: skillsetName
          in: path
          required: true
          type: string
          description: The name of the skillset to delete.
        - $ref: '#/parameters/ClientRequestIdParameter'
        - $ref: '#/parameters/IfMatchParameter'
        - $ref: '#/parameters/IfNoneMatchParameter'
        - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '204':
          description: The skillset is successfully deleted.
        '404':
          description: The provided skillset name is not found.
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: 'Microsoft Azure Delete Skillsets Skillsetname'
    get:
      tags:
        - Skillsets
      operationId: microsoftAzureSkillsetsGet
      x-ms-examples:
        SearchServiceGetSkillset:
          $ref: ./examples/SearchServiceGetSkillset.json
      description: Retrieves a skillset in a search service.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/get-skillset
      parameters:
        - name: skillsetName
          in: path
          required: true
          type: string
          description: The name of the skillset to retrieve.
        - $ref: '#/parameters/ClientRequestIdParameter'
        - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: The skillset is successfully returned.
          schema:
            $ref: '#/definitions/SearchIndexerSkillset'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: 'Microsoft Azure Get Skillsets Skillsetname'
  /skillsets:
    get:
      tags:
        - Skillsets
      operationId: microsoftAzureSkillsetsList
      x-ms-examples:
        SearchServiceListSkillsets:
          $ref: ./examples/SearchServiceListSkillsets.json
      description: List all skillsets in a search service.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/list-skillset
      parameters:
        - name: $select
          in: query
          required: false
          type: string
          description: >-
            Selects which top-level properties of the skillsets to retrieve.
            Specified as a comma-separated list of JSON property names, or '*'
            for all properties. The default is all properties.
        - $ref: '#/parameters/ClientRequestIdParameter'
        - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: The list is successfully returned.
          schema:
            $ref: '#/definitions/ListSkillsetsResult'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: Microsoft Azure Get Skillsets
    post:
      tags:
        - Skillsets
      operationId: microsoftAzureSkillsetsCreate
      x-ms-examples:
        SearchServiceCreateSkillset:
          $ref: ./examples/SearchServiceCreateSkillset.json
      description: Creates a new skillset in a search service.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/create-skillset
      parameters:
        - name: skillset
          in: body
          required: true
          schema:
            $ref: '#/definitions/SearchIndexerSkillset'
          description: >-
            The skillset containing one or more skills to create in a search
            service.
        - $ref: '#/parameters/ClientRequestIdParameter'
        - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '201':
          description: The skillset is successfully created.
          schema:
            $ref: '#/definitions/SearchIndexerSkillset'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: Microsoft Azure Post Skillsets
  /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
          type: string
          description: The name of the synonym map to create or update.
        - name: synonymMap
          in: body
          required: true
          schema:
            $ref: '#/definitions/SynonymMap'
          description: The definition of the synonym map to create or update.
        - $ref: '#/parameters/ClientRequestIdParameter'
        - $ref: '#/parameters/IfMatchParameter'
        - $ref: '#/parameters/IfNoneMatchParameter'
        - $ref: '#/parameters/PreferHeaderParameter'
        - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/SynonymMap'
        '201':
          description: ''
          schema:
            $ref: '#/definitions/SynonymMap'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: 'Microsoft Azure Put Synonymmaps Synonymmapname'
    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
          type: string
          description: The name of the synonym map to delete.
        - $ref: '#/parameters/ClientRequestIdParameter'
        - $ref: '#/parameters/IfMatchParameter'
        - $ref: '#/parameters/IfNoneMatchParameter'
        - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '204':
          description: ''
        '404':
          description: ''
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/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
          type: string
          description: The name of the synonym map to retrieve.
        - $ref: '#/parameters/ClientRequestIdParameter'
        - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/SynonymMap'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/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
          type: string
          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.
        - $ref: '#/parameters/ClientRequestIdParameter'
        - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/ListSynonymMapsResult'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/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:
        - name: synonymMap
          in: body
          required: true
          schema:
            $ref: '#/definitions/SynonymMap'
          description: The definition of the synonym map to create.
        - $ref: '#/parameters/ClientRequestIdParameter'
        - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '201':
          description: ''
          schema:
            $ref: '#/definitions/SynonymMap'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: Microsoft Azure Post Synonymmaps
  /indexes:
    post:
      tags:
        - Indexes
      operationId: microsoftAzureIndexesCreate
      x-ms-examples:
        SearchServiceCreateIndex:
          $ref: ./examples/SearchServiceCreateIndex.json
      description: Creates a new search index.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Create-Index
      parameters:
        - name: index
          in: body
          required: true
          schema:
            $ref: '#/definitions/SearchIndex'
          description: The definition of the index to create.
        - $ref: '#/parameters/ClientRequestIdParameter'
        - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '201':
          description: ''
          schema:
            $ref: '#/definitions/SearchIndex'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: Microsoft Azure Post Indexes
    get:
      tags:
        - Indexes
      operationId: microsoftAzureIndexesList
      x-ms-examples:
        SearchServiceListIndexes:
          $ref: ./examples/SearchServiceListIndexes.json
      description: Lists all indexes available for a search service.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/List-Indexes
      parameters:
        - name: $select
          in: query
          required: false
          type: string
          description: >-
            Selects which top-level properties of the index definitions to
            retrieve. Specified as a comma-separated list of JSON property
            names, or '*' for all properties. The default is all properties.
        - $ref: '#/parameters/ClientRequestIdParameter'
        - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/ListIndexesResult'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      x-ms-pageable:
        nextLinkName:
      summary: Microsoft Azure Get Indexes
  /indexes('{indexName}'):
    put:
      tags:
        - Indexes
      operationId: microsoftAzureIndexesCreateorupdate
      x-ms-examples:
        SearchServiceCreateOrUpdateIndex:
          $ref: ./examples/SearchServiceCreateOrUpdateIndex.json
      description: Creates a new search index or updates an index if it already exists.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Update-Index
      parameters:
        - name: indexName
          in: path
          required: true
          type: string
          description: The definition of the index to create or update.
        - name: index
          in: body
          required: true
          schema:
            $ref: '#/definitions/SearchIndex'
          description: The definition of the index to create or update.
        - name: allowIndexDowntime
          in: query
          required: false
          type: boolean
          description: >-
            Allows new analyzers, tokenizers, token filters, or char filters to
            be added to an index by taking the index offline for at least a few
            seconds. This temporarily causes indexing and query requests to
            fail. Performance and write availability of the index can be
            impaired for several minutes after the index is updated, or longer
            for very large indexes.
        - $ref: '#/parameters/ClientRequestIdParameter'
        - $ref: '#/parameters/IfMatchParameter'
        - $ref: '#/parameters/IfNoneMatchParameter'
        - $ref: '#/parameters/PreferHeaderParameter'
        - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/SearchIndex'
        '201':
          description: ''
          schema:
            $ref: '#/definitions/SearchIndex'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: 'Microsoft Azure Put Indexes Indexname'
    delete:
      tags:
        - Indexes
      operationId: microsoftAzureIndexesDelete
      x-ms-examples:
        SearchServiceDeleteIndex:
          $ref: ./examples/SearchServiceDeleteIndex.json
      description: >-
        Deletes a search index and all the documents it contains. This operation
        is permanent, with no recovery option. Make sure you have a master copy
        of your index definition, data ingestion code, and a backup of the
        primary data source in case you need to re-build the index.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Delete-Index
      parameters:
        - name: indexName
          in: path
          required: true
          type: string
          description: The name of the index to delete.
        - $ref: '#/parameters/ClientRequestIdParameter'
        - $ref: '#/parameters/IfMatchParameter'
        - $ref: '#/parameters/IfNoneMatchParameter'
        - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '204':
          description: ''
        '404':
          description: ''
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: 'Microsoft Azure Delete Indexes Indexname'
    ge

# --- truncated at 32 KB (240 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/searchserviceclient-openapi-original.yml