Microsoft Azure Indexes API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Indexes API
schemes:
- https
tags:
- name: Indexes
paths:
  /indexes:
    get:
      operationId: microsoftAzureIndexesListlatest
      description: List the latest version of each index.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - $ref: '#/parameters/Azure.Core.TopQueryParameter'
      - $ref: '#/parameters/Azure.Core.SkipQueryParameter'
      - $ref: '#/parameters/Azure.Core.MaxPageSizeQueryParameter'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/PagedIndex'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Indexes_ListLatest - generated by [MaximumSet] rule:
          $ref: ./examples/Indexes_ListLatest_MaximumSet_Gen.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Indexes
      tags:
      - 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
  /indexes/{name}:
    get:
      operationId: microsoftAzureIndexesGetlatest
      description: Get latest Index.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: name
        in: path
        description: Name of the index.
        required: true
        type: string
        pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_]{0,254}$
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/Index'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Indexes_GetLatest - generated by [MaximumSet] rule:
          $ref: ./examples/Indexes_GetLatest_MaximumSet_Gen.json
      summary: Microsoft Azure Get Indexes Name
      tags:
      - Indexes
  /indexes/{name}:getNextVersion:
    post:
      operationId: microsoftAzureIndexesGetnextversion
      description: Get next Index version.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: name
        in: path
        description: Name of the index.
        required: true
        type: string
        pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_]{0,254}$
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/VersionInfo'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Indexes_GetNextVersion - generated by [MaximumSet] rule:
          $ref: ./examples/Indexes_GetNextVersion_MaximumSet_Gen.json
      summary: Microsoft Azure Post Indexes Name:getnextversion
      tags:
      - Indexes
  /indexes/{name}/versions:
    get:
      operationId: microsoftAzureIndexesList
      description: The most basic operation.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: name
        in: path
        description: Name of the index.
        required: true
        type: string
        pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_]{0,254}$
      - name: listViewType
        in: query
        description: View type for including/excluding (for example) archived entities.
        required: true
        type: string
        default: ActiveOnly
      - name: orderBy
        in: query
        description: 'Ordering of list: Please choose OrderBy value from [''createdtime'', ''modifiedtime''].'
        required: false
        type: string
      - name: tags
        in: query
        description: 'Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2.'
        required: false
        type: string
      - $ref: '#/parameters/Azure.Core.TopQueryParameter'
      - $ref: '#/parameters/Azure.Core.SkipQueryParameter'
      - $ref: '#/parameters/Azure.Core.MaxPageSizeQueryParameter'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/PagedIndex'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Indexes_List - generated by [MaximumSet] rule:
          $ref: ./examples/Indexes_List_MaximumSet_Gen.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Indexes Name Versions
      tags:
      - Indexes
  /indexes/{name}/versions/{version}:
    get:
      operationId: microsoftAzureIndexesGet
      description: Fetch a IndexVersion by name.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: name
        in: path
        description: Name of the index.
        required: true
        type: string
        pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_]{0,254}$
      - name: version
        in: path
        description: Version of the index.
        required: true
        type: string
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/Index'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Indexes_Get - generated by [MaximumSet] rule:
          $ref: ./examples/Indexes_Get_MaximumSet_Gen.json
      summary: Microsoft Azure Get Indexes Name Versions Version
      tags:
      - Indexes
    put:
      operationId: microsoftAzureIndexesCreateorupdate
      description: Creates or updates a IndexVersion.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: name
        in: path
        description: Name of the index.
        required: true
        type: string
        pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_]{0,254}$
      - name: version
        in: path
        description: Version of the index.
        required: true
        type: string
      - name: body
        in: body
        description: Properties of an Index Version.
        required: true
        schema:
          $ref: '#/definitions/Index'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/Index'
        '201':
          description: The request has succeeded and a new resource has been created as a result.
          schema:
            $ref: '#/definitions/Index'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Indexes_CreateOrUpdate - generated by [MaximumSet] rule:
          $ref: ./examples/Indexes_CreateOrUpdate_MaximumSet_Gen.json
      summary: Microsoft Azure Put Indexes Name Versions Version
      tags:
      - 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
    get:
      tags:
      - Indexes
      operationId: microsoftAzureIndexesGet
      x-ms-examples:
        SearchServiceGetIndex:
          $ref: ./examples/SearchServiceGetIndex.json
      description: Retrieves an index definition.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Get-Index
      parameters:
      - name: indexName
        in: path
        required: true
        type: string
        description: The name of the index to retrieve.
      - $ref: '#/parameters/ClientRequestIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/SearchIndex'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: Microsoft Azure Get Indexes Indexname
  /indexes('{indexName}')/search.stats:
    get:
      tags:
      - Indexes
      operationId: microsoftAzureIndexesGetstatistics
      x-ms-examples:
        SearchServiceGetIndexStatistics:
          $ref: ./examples/SearchServiceGetIndexStatistics.json
      description: Returns statistics for the given index, including a document count and storage usage.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Get-Index-Statistics
      parameters:
      - name: indexName
        in: path
        required: true
        type: string
        description: The name of the index for which to retrieve statistics.
      - $ref: '#/parameters/ClientRequestIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/GetIndexStatisticsResult'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: Microsoft Azure Get Indexes Indexname  Search Stats
  /indexes('{indexName}')/search.analyze:
    post:
      tags:
      - Indexes
      operationId: microsoftAzureIndexesAnalyze
      x-ms-examples:
        SearchServiceIndexAnalyze:
          $ref: ./examples/SearchServiceIndexAnalyze.json
      description: Shows how an analyzer breaks text into tokens.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/test-analyzer
      parameters:
      - name: indexName
        in: path
        required: true
        type: string
        description: The name of the index for which to test an analyzer.
      - name: request
        in: body
        required: true
        schema:
          $ref: '#/definitions/AnalyzeRequest'
        description: The text and analyzer or analysis components to test.
      - $ref: '#/parameters/ClientRequestIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/AnalyzeResult'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: Microsoft Azure Post Indexes Indexname  Search Analyze
definitions:
  GetIndexStatisticsResult:
    properties:
      documentCount:
        type: integer
        format: int64
        x-nullable: false
        readOnly: true
        description: The number of documents in the index.
      storageSize:
        type: integer
        format: int64
        x-nullable: false
        readOnly: true
        description: The amount of storage in bytes consumed by the index.
    required:
    - documentCount
    - storageSize
    description: Statistics for a given index. Statistics are collected periodically and are not guaranteed to always be up-to-date.
  LexicalAnalyzerName:
    type: string
    enum:
    - ar.microsoft
    - ar.lucene
    - hy.lucene
    - bn.microsoft
    - eu.lucene
    - bg.microsoft
    - bg.lucene
    - ca.microsoft
    - ca.lucene
    - zh-Hans.microsoft
    - zh-Hans.lucene
    - zh-Hant.microsoft
    - zh-Hant.lucene
    - hr.microsoft
    - cs.microsoft
    - cs.lucene
    - da.microsoft
    - da.lucene
    - nl.microsoft
    - nl.lucene
    - en.microsoft
    - en.lucene
    - et.microsoft
    - fi.microsoft
    - fi.lucene
    - fr.microsoft
    - fr.lucene
    - gl.lucene
    - de.microsoft
    - de.lucene
    - el.microsoft
    - el.lucene
    - gu.microsoft
    - he.microsoft
    - hi.microsoft
    - hi.lucene
    - hu.microsoft
    - hu.lucene
    - is.microsoft
    - id.microsoft
    - id.lucene
    - ga.lucene
    - it.microsoft
    - it.lucene
    - ja.microsoft
    - ja.lucene
    - kn.microsoft
    - ko.microsoft
    - ko.lucene
    - lv.microsoft
    - lv.lucene
    - lt.microsoft
    - ml.microsoft
    - ms.microsoft
    - mr.microsoft
    - nb.microsoft
    - no.lucene
    - fa.lucene
    - pl.microsoft
    - pl.lucene
    - pt-BR.microsoft
    - pt-BR.lucene
    - pt-PT.microsoft
    - pt-PT.lucene
    - pa.microsoft
    - ro.microsoft
    - ro.lucene
    - ru.microsoft
    - ru.lucene
    - sr-cyrillic.microsoft
    - sr-latin.microsoft
    - sk.microsoft
    - sl.microsoft
    - es.microsoft
    - es.lucene
    - sv.microsoft
    - sv.lucene
    - ta.microsoft
    - te.microsoft
    - th.microsoft
    - th.lucene
    - tr.microsoft
    - tr.lucene
    - uk.microsoft
    - ur.microsoft
    - vi.microsoft
    - standard.lucene
    - standardasciifolding.lucene
    - keyword
    - pattern
    - simple
    - stop
    - whitespace
    x-ms-enum:
      name: LexicalAnalyzerName
      modelAsString: true
      values:
      - value: ar.microsoft
        name: ArMicrosoft
        description: Microsoft analyzer for Arabic.
      - value: ar.lucene
        name: ArLucene
        description: Lucene analyzer for Arabic.
      - value: hy.lucene
        name: HyLucene
        description: Lucene analyzer for Armenian.
      - value: bn.microsoft
        name: BnMicrosoft
        description: Microsoft analyzer for Bangla.
      - value: eu.lucene
        name: EuLucene
        description: Lucene analyzer for Basque.
      - value: bg.microsoft
        name: BgMicrosoft
        description: Microsoft analyzer for Bulgarian.
      - value: bg.lucene
        name: BgLucene
        description: Lucene analyzer for Bulgarian.
      - value: ca.microsoft
        name: CaMicrosoft
        description: Microsoft analyzer for Catalan.
      - value: ca.lucene
        name: CaLucene
        description: Lucene analyzer for Catalan.
      - value: zh-Hans.microsoft
        name: ZhHansMicrosoft
        description: Microsoft analyzer for Chinese (Simplified).
      - value: zh-Hans.lucene
        name: ZhHansLucene
        description: Lucene analyzer for Chinese (Simplified).
      - value: zh-Hant.microsoft
        name: ZhHantMicrosoft
        description: Microsoft analyzer for Chinese (Traditional).
      - value: zh-Hant.lucene
        name: ZhHantLucene
        description: Lucene analyzer for Chinese (Traditional).
      - value: hr.microsoft
        name: HrMicrosoft
        description: Microsoft analyzer for Croatian.
      - value: cs.microsoft
        name: CsMicrosoft
        description: Microsoft analyzer for Czech.
      - value: cs.lucene
        name: CsLucene
        description: Lucene analyzer for Czech.
      - value: da.microsoft
        name: DaMicrosoft
        description: Microsoft analyzer for Danish.
      - value: da.lucene
        name: DaLucene
        description: Lucene analyzer for Danish.
      - value: nl.microsoft
        name: NlMicrosoft
        description: Microsoft analyzer for Dutch.
      - value: nl.lucene
        name: NlLucene
        description: Lucene analyzer for Dutch.
      - value: en.microsoft
        name: EnMicrosoft
        description: Microsoft analyzer for English.
      - value: en.lucene
        name: EnLucene
        description: Lucene analyzer for English.
      - value: et.microsoft
        name: EtMicrosoft
        description: Microsoft analyzer for Estonian.
      - value: fi.microsoft
        name: FiMicrosoft
        description: Microsoft analyzer for Finnish.
      - value: fi.lucene
        name: FiLucene
        description: Lucene analyzer for Finnish.
      - value: fr.microsoft
        name: FrMicrosoft
        description: Microsoft analyzer for French.
      - value: fr.lucene
        name: FrLucene
        description: Lucene analyzer for French.
      - value: gl.lucene
        name: GlLucene
        description: Lucene analyzer for Galician.
      - value: de.microsoft
        name: DeMicrosoft
        description: Microsoft analyzer for German.
      - value: de.lucene
        name: DeLucene
        description: Lucene analyzer for German.
      - value: el.microsoft
        name: ElMicrosoft
        description: Microsoft analyzer for Greek.
      - value: el.lucene
        name: ElLucene
        description: Lucene analyzer for Greek.
      - value: gu.microsoft
        name: GuMicrosoft
        description: Microsoft analyzer for Gujarati.
      - value: he.microsoft
        name: HeMicrosoft
        description: Microsoft analyzer for Hebrew.
      - value: hi.microsoft
        name: HiMicrosoft
        description: Microsoft analyzer for Hindi.
      - value: hi.lucene
        name: HiLucene
        description: Lucene analyzer for Hindi.
      - value: hu.microsoft
        name: HuMicrosoft
        description: Microsoft analyzer for Hungarian.
      - value: hu.lucene
        name: HuLucene
        description: Lucene analyzer for Hungarian.
      - value: is.microsoft
        name: IsMicrosoft
        description: Microsoft analyzer for Icelandic.
      - value: id.microsoft
        name: IdMicrosoft
        description: Microsoft analyzer for Indonesian (Bahasa).
      - value: id.lucene
        name: IdLucene
        description: Lucene analyzer for Indonesian.
      - value: ga.lucene
        name: GaLucene
        description: Lucene analyzer for Irish.
      - value: it.microsoft
        name: ItMicrosoft
        description: Microsoft analyzer for Italian.
      - value: it.lucene
        name: ItLucene
        description: Lucene analyzer for Italian.
      - value: ja.microsoft
        name: JaMicrosoft
        description: Microsoft analyzer for Japanese.
      - value: ja.lucene
        name: JaLucene
        description: Lucene analyzer for Japanese.
      - value: kn.microsoft
        name: KnMicrosoft
        description: Microsoft analyzer for Kannada.
      - value: ko.microsoft
        name: KoMicrosoft
        description: Microsoft analyzer for Korean.
      - value: ko.lucene
        name: KoLucene
        description: Lucene analyzer for Korean.
      - value: lv.microsoft
        name: LvMicrosoft
        description: Microsoft analyzer for Latvian.
      - value: lv.lucene
        name: LvLucene
        description: Lucene analyzer for Latvian.
      - value: lt.microsoft
        name: LtMicrosoft
        description: Microsoft analyzer for Lithuanian.
      - value: ml.microsoft
        name: MlMicrosoft
        description: Microsoft analyzer for Malayalam.
      - value: ms.microsoft
        name: MsMicrosoft
        description: Microsoft analyzer for Malay (Latin).
      - value: mr.microsoft
        name: MrMicrosoft
        description: Microsoft analyzer for Marathi.
      - value: nb.microsoft
        name: NbMicrosoft
        description: Microsoft analyzer for Norwegian (Bokmål).
      - value: no.lucene
        name: NoLucene
        description: Lucene analyzer for Norwegian.
      - value: fa.lucene
        name: FaLucene
        description: Lucene analyzer for Persian.
      - value: pl.microsoft
        name: PlMicrosoft
        description: Microsoft analyzer for Polish.
      - value: pl.lucene
        name: PlLucene
        description: Lucene analyzer for Polish.
      - value: pt-BR.microsoft
        name: PtBrMicrosoft
        description: Microsoft analyzer for Portuguese (Brazil).
      - value: pt-BR.lucene
        name: PtBrLucene
        description: Lucene analyzer for Portuguese (Brazil).
      - value: pt-PT.microsoft
        name: PtPtMicrosoft
        description: Microsoft analyzer for Portuguese (Portugal).
      - value: pt-PT.lucene
        name: PtPtLucene
        description: Lucene analyzer for Portuguese (Portugal).
      - value: pa.microsoft
        name: PaMicrosoft
        description: Microsoft analyzer for Punjabi.
      - value: ro.microsoft
        name: RoMicrosoft
        description: Microsoft analyzer for Romanian.
      - value: ro.lucene
        name: RoLucene
        description: Lucene analyzer for Romanian.
      - value: ru.microsoft
        name: RuMicrosoft
        description: Microsoft analyzer for Russian.
      - value: ru.lucene
        name: RuLucene
        description: Lucene analyzer for Russian.
      - value: sr-cyrillic.microsoft
        name: SrCyrillicMicrosoft
        description: Microsoft analyzer for Serbian (Cyrillic).
      - value: sr-latin.microsoft
        name: SrLatinMicrosoft
        description: Microsoft analyzer for Serbian (Latin).
      - value: sk.microsoft
        name: SkMicrosoft
        description: Microsoft analyzer for Slovak.
      - value: sl.microsoft
        name: SlMicrosoft
        description: Microsoft analyzer for Slovenian.
      - value: es.microsoft
        name: EsMicrosoft
        description: Microsoft analyzer for Spanish.
      - value: es.lucene
        name: EsLucene
        description: Lucene analyzer for Spanish.
      - value: sv.microsoft
        name: SvMicrosoft
        description: Microsoft analyzer for Swedish.
      - value: sv.lucene
        name: SvLucene
        description: Lucene analyzer for Swedish.
      - value: ta.microsoft
        name: TaMicrosoft
        description: Microsoft analyzer for Tamil.
      - value: te.microsoft
        name: TeMicrosoft
        description: Microsoft analyzer for Telugu.
      - value: th.microsoft
        name: ThMicrosoft
        description: Microsoft analyzer for Thai.
      - value: th.lucene
        name: ThLucene
        description: Lucene analyzer for Thai.
      - value: tr.microsoft
        name: TrMicrosoft
        description: Microsoft analyzer for Turkish.
      - value: tr.lucene
        name: TrLucene
        description: Lucene analyzer for Turkish.
      - value: uk.microsoft
        name: UkMicrosoft
        description: Microsoft analyzer for Ukrainian.
      - value: ur.microsoft
        name: UrMicrosoft
        description: Microsoft analyzer for Urdu.
      - value: vi.microsoft
        name: ViMicrosoft
        description: Microsoft analyzer for Vietnamese.
      - value: standard.lucene
        name: StandardLucene
        description: Standard Lucene analyzer.
      - value: standardasciifolding.lucene
        name: StandardAsciiFoldingLucene
        description: Standard ASCII Folding Lucene analyzer. See https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers
      - value: keyword
        name: Keyword
        description: Treats the entire content of a field as a single token. This is useful for data like zip codes, ids, and some product names. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html
      - value: pattern
        name: Pattern
        description: Flexibly separates text into terms via a regular expression pattern. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html
      - value: simple
        name: Simple
        description: Divides text at non-letters and converts them to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html
      - value: stop
        name: Stop
        description: Divides text at non-letters; Applies the lowercase and stopword token filters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html
      - value: whitespace
        name: Whitespace
        description: An analyzer that uses the whitespace tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html
    description: Defines the names of all text analyzers supported by Azure Cognitive Search.
    externalDocs:
      url: https://docs.microsoft.com/rest/api/searchservice/Language-support
  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: '#/definitions/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.
  SearchIndex:
    properties:
      name:
        externalDocs:
          url: https://docs.microsoft.com/rest/api/searchservice/Naming-rules
        type: string
        description: The name of the index.
      fields:
        type: array
        items:
          $ref: '#/definitions/SearchField'
        description: The fields of the index.
      scoringProfiles:
        type: array
        items:
          $ref: '#/definitions/ScoringProfile'
        description: The scoring profiles for the index.
      defaultScoringProfile:
        type: string
        description: The name of the scoring profile to use if none is specified in the query. If this property is not set and no scoring profile is specified in the query, then default scoring (tf-idf) will be used.
      corsOptions:
        $ref: '#/definitions/CorsOptions'
        description: Options to control Cross-Origin Resource Sharing (CORS) for the index.
      suggesters:
        type: array
        items:
          $ref: '#/definitions/Suggester'
        description: The suggesters for the index.
      analyzers:
        type: array
        items:
          $ref: '#/definitions/LexicalAnalyzer'
        description: The analyzers for the index.
        externalDocs:
          url: https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search
      tokenizers:
        type: array
        items:
          $ref: '#/definitions/LexicalTokenizer'
        description: The tokenizers for the index.
        externalDocs:
          url: https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search
      tokenFilters:
        type: array
        items:
          $ref: '#/definitions/TokenFilter'
        description: The token filters for the index.
        externalDocs:
          url: https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search
      charFilters:
        type: array
        items:
          $ref: '#/definitions/CharFilter'
        description: The character filters for the index.
        externalDocs:
          url: https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search
      encryptionKey:
        $ref: '#/definitions/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
      similarity:
        $ref: '#/definitions/Similarity'
        description: The type of similarity algorithm to be used when scoring and ranking the documents matching a search query. The similarity algorithm can only be defined at index creation time and cannot be modified 

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