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 on existing indexes. If null, the ClassicSimilarity algorithm is used.
        externalDocs:
          url: https://docs.microsoft.com/azure/search/index-ranking-similarity
      '@odata.etag':
        x-ms-client-name: ETag
        type: string
        description: The ETag of the index.
    required:
    - name
    - fields
    description: Represents a search index definition, which describes the fields and search behavior of an index.
  ScoringFunctionInterpolation:
    type: string
    enum:
    - linear
    - constant
    - quadratic
    - logarithmic
    x-ms-enum:
      name: ScoringFunctionInterpolation
      modelAsString: false
      values:
      - value: linear
        name: Linear
        description: Boosts scores by a linearly decreasing amount. This is the default interpolation for scoring functions.
      - value: constant
        name: Constant
        description: Boosts scores by a constant factor.
      - value: quadratic
        name: Quadratic
        description: Boosts scores by an amount that decreases quadratically. Boosts decrease slowly for higher scores, and more quickly as the scores decrease. This interpolation option is not allowed in tag scoring functions.
      - value: logarithmic
        name: Logarithmic
        description: Boosts scores by an amount that decreases logarithmically. Boosts decrease quickly for higher scores, and more slowly as the scores decrease. This interpolation option is not allowed in tag scoring functions.
    description: Defines the function used to interpolate score boosting across a range of documents.
  TextWeights:
    properties:
      weights:
        type: object
        additionalProperties:
          type: number
          format: double
          x-nullable: false
        description: The dictionary of per-field weights to boost document scoring. The keys are field names and the values are the weights for each field.
    required:
    - weights
    description: Defines weights on index fields for which matches should boost scoring in search queries.
  PagedIndex:
    type: object
    description: Paged collection of IndexVersion items.
    properties:
      value:
        type: array
        description: The list of Indexes.
        items:
          $ref: '#/definitions/Index'
        x-ms-identifiers: []
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  Index:
    type: object
    description: Index resource Definition
    properties:
      id:
        type: string
        description: 'Fully qualified resource Id: azureml://workspace/{workspaceName}/indexes/{name}/versions/{version} of the index.'
        readOnly: true
      stage:
        type: string
        description: Update stage to 'Archive' for soft delete. Default is Development, which means the asset is under development.
        default: Development
      description:
        type: string
        description: Description information of the asset.
      systemData:
        $ref: '#/definitions/SystemData'
        description: Metadata containing createdBy and modifiedBy information.
        readOnly: true
      tags:
        type: object
        description: Asset's tags.
        additionalProperties:
          type: string
      properties:
        type: object
        description: Asset's properties.
        additionalProperties:
          type: string
      storageUri:
        type: string
        description: Default workspace blob storage Uri. Should work across storage types and auth scenarios.
    required:
    - id
    - stage
    - storageUri
  TokenFilter:
    discriminator: '@odata.type'
    properties:
      '@odata.type':
        type: string
        description: Identifies the concrete type of the token filter.
      name:
        type: string
        externalDocs:
          url: https://docs.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference
        description: The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters.
    required:
    - '@odata.type'
    - name
    description: Base type for token filters.
    externalDocs:
      url: https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search
  Azure.Core.Foundations.Error:
    type: object
    description: The error object.
    properties:
      code:
        type: string
        description: One of a server-defined set of error codes.
      message:
        type: string
        description: A human-readable representation of the error.
      target:
        type: string
        description: The target of the error.
      details:
        type: array
        description: An array of details about specific errors that led to this reported error.
        items:
          $ref: '#/definitions/Azure.Core.Foundations.Error'
        x-ms-identifiers: []
      innererror:
        $ref: '#/definitions/Azure.Core.Foundations.InnerError'
        description: An object containing more specific information than the current object about the error.
    required:
    - code
    - message
  SearchFieldDataType:
    type: string
    enum:
    - Edm.String
    - Edm.Int32
    - Edm.Int64
    - Edm.Double
    - Edm.Boolean
    - Edm.DateTimeOffset
    - Edm.GeographyPoint
    - Edm.ComplexType
    x-ms-enum:
      name: SearchFieldDataType
      modelAsString: true
      values:
      - value: Edm.String
        name: String
        description: Indicates that a field contains a string.
      - value: Edm.Int32
        name: Int32
        description: Indicates that a field contains a 32-bit signed integer.
      - value: Edm.Int64
        name: Int64
        description: Indicates that a field contains a 64-bit signed integer.
      - value: Edm.Double
        name: Double
        description: Indicates that a field contains an IEEE double-precision floating point number.
      - value: Edm.Boolean
        name: Boolean
        description: Indicates that a field contains a Boolean value (true or false).
      - value: Edm.DateTimeOffset
        name: DateTimeOffset
        description: Indicates that a field contains a date/time value, including timezone information.
      - value: Edm.GeographyPoint
        name: GeographyPoint
        description: Indicates that a field contains a geo-location in terms of longitude and latitude.
      - value: Edm.ComplexType
        name: Complex
        description: Indicates that a field contains one or more complex objects that in turn have sub-fields of other types.
    description: Defines the data type of a field in a search index.
  CharFilterName:
    type: string
    enum:
    - html_strip
    x-ms-enum:
      name: CharFilterName
      modelAsString: true
      values:
      - value: html_strip
        name: HtmlStrip
        description: A character filter that attempts to strip out HTML constructs. See https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/charfilter/HTMLStripCharFilter.html
    description: Defines the names of all character filters supported by Azure Cognitive Search.
    externalDocs:
      url: https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search
  LexicalAnalyzer:
    discriminator: '@odata.type'
    properties:
      '@odata.type':
        type: string
        description: Identifies the concrete type of the analyzer.
      name:
        type: string
        externalDocs:
          url: https://docs.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference
        description: The name of the analyzer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters.
    required:
    - '@odata.type'
    - name
    description: Base type for analyzers.
  Azure.Core.Foundations.ErrorResponse:
    type: object
    description: A response containing error details.
    properties:
      error:
        $ref: '#/definitions/Azure.Core.Foundations.Error'
        description: The error object.
    required:
    - error
  SearchField:
    properties:
      name:
        type: string
        description: The name of the field, which must be unique within the fields collection of the index or parent field.
        externalDocs:
          url: https://docs.microsoft.com/rest/api/searchservice/Naming-rules
      type:
        $ref: '#/definitions/SearchFieldDataType'
        description: The data type of the field.
        externalDocs:
          url: https://docs.microsoft.com/rest/api/searchservice/supported-data-types
      key:
        type: boolean
        description: A value indicating whether the field uniquely identifies documents in the index. Exactly one top-level field in each index must be chosen as the key field and it must be of type Edm.String. Key fields can be used to look up documents directly and update or delete specific documents. Default is false for simple fields and null for complex fields.
      retrievable:
        type: boolean
        description: A value indicating whether the field can be returned in a search result. You can disable this option if you want to use a field (for example, margin) as a filter, sorting, or scoring mechanism but do not want the field to be visible to the end user. This property must be true for key fields, and it must be null for complex fields. This property can be changed on existing fields. Enabling this property does not cause any increase in index storage requirements. Default is true for simple fields and null for complex fields.
      searchable:
        type: boolean
        description: 'A value indicating whether the field is full-text searchable. This means it will undergo analysis such as word-breaking during indexing. If you set a searchable field to a value like "sunny day", internally it will be split into the individual tokens "sunny" and "day". This enables full-text searches for these terms. Fields of type Edm.String or Collection(Edm.String) are searchable by default. This property must be false for simple fields of other non-string data types, and it must be null for complex fields. Note: searchable fields consume extra space in your index since Azure Cognitive Search will store an additional tokenized version of the field value for full-text searches. If you want to save space in your index and you don''t need a field to be included in searches, set searchable to false.'
      filterable:
        type: boolean
        description: A value indicating whether to enable the field to be referenced in $filter queries. filterable differs from searchable in how strings are handled. Fields of type Edm.String or Collection(Edm.String) that are filterable do not undergo word-breaking, so comparisons are for exact matches only. For example, if you set such a field f to "sunny day", $filter=f eq 'sunny' will find no matches, but $filter=f eq 'sunny day' will. This property must be null for complex fields. Default is true for simple fields and null for complex fields.
      sortable:
        type: boolean
        description: A value indicating whether to enable the field to be referenced in $orderby expressions. By default Azure Cognitive Search sorts results by score, but in many experiences users will want to sort by fields in the documents. A simple field can be sortable only if it is single-valued (it has a single value in the scope of the parent document). Simple collection fields cannot be sortable, since they are multi-valued. Simple sub-fields of complex collections are also multi-valued, and therefore cannot be sortable. This is true whether it's an immediate parent field, or an ancestor field, that's the complex collection. Complex fields cannot be sortable and the sortable property must be null for such fields. The default for sortable is true for single-valued simple fields, false for multi-valued simple fields, and null for complex fields.
      facetable:
        type: boolean
        description: A value indicating whether to enable the field to be referenced in facet queries. Typically used in a presentation of search results that includes hit count by category (for example, search for digital cameras and see hits by brand, by megapixels, by price, and so on). This property must be null for complex fields. Fields of type Edm.GeographyPoint or Collection(Edm.GeographyPoint) cannot be facetable. Default is true for all other simple fields.
      analyzer:
        externalDocs:
          url: https://docs.microsoft.com/rest/api/searchservice/Language-support
        $ref: '#/definitions/LexicalAnalyzerName'
        description: The name of the analyzer to use for the field. This option can be used only with searchable fields and it can't be set together with either searchAnalyzer or indexAnalyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields.
      searchAnalyzer:
        externalDocs:
          url: https://docs.microsoft.com/rest/api/searchservice/Language-support
        $ref: '#/definitions/LexicalAnalyzerName'
        description: The name of the analyzer used at search time for the field. This option can be used only with searchable fields. It must be set together with indexAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. This analyzer can be updated on an existing field. Must be null for complex fields.
      indexAnalyzer:
        externalDocs:
          url: https://docs.microsoft.com/rest/api/searchservice/Language-support
        $ref: '#/definitions/LexicalAnalyzerName'
        description: The name of the analyzer used at indexing time for the field. This option can be used only with searchable fields. It must be set together with searchAnalyzer and it cannot be set together with the analyzer option.  This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields.
      synonymMaps:
        externalDocs:
          url: https://docs.microsoft.com/rest/api/searchservice/Synonym-Map-operations
        type: array
        items:
          type: string
        description: A list of the names of synonym maps to associate with this field. This option can be used only with searchable fields. Currently only one synonym map per field is supported. Assigning a synonym map to a field ensures that query terms targeting that field are expanded at query-time using the rules in the synonym map. This attribute can be changed on existing fields. Must be null or an empty collection for complex fields.
      fields:
        type: array
        items:
          $ref: '#/definitions/SearchField'
        description: A list of sub-fields if this is a field of type Edm.ComplexType or Collection(Edm.ComplexType). Must be null or empty for simple fields.
    required:
    - name
    - type
    externalDocs:
      url: https://docs.microsoft.com/rest/api/searchservice/Create-Index
    description: Represents a field in an index definition, which describes the name, data type, and search behavior of a field.
  TokenFilterName:
    type: string
    enum:
    - arabic_normalization
    - apostrophe
    - asciifolding
    - cjk_bigram
    - cjk_width
    - classic
    - common_grams
    - edgeNGram_v2
    - elision
    - german_normalization
    - hindi_normalization
    - indic_normalization
    - keyword_repeat
    - kstem
    - length
    - limit
    - lowercase
    - nGram_v2
    - persian_normalization
    - phonetic
    - porter_stem
    - reverse
    - scandinavian_normalization
    - scandinavian_folding
    - shingle
    - snowball
    - sorani_normalization
    - stemmer
    - stopwords
    - trim
    - truncate
    - unique
    - uppercase
    - word_delimiter
    x-ms-enum:
      name: TokenFilterName
      modelAsString: true
      values:
      - value: arabic_normalization
        name: ArabicNormalization
        description: A token filter that applies the Arabic normalizer to normalize the orthography. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ar/ArabicNormalizationFilter.html
      - value: apostrophe
        name: Apostrophe
        description: Strips all characters after an apostrophe (including the apostrophe itself). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/tr/ApostropheFilter.html
      - value: asciifolding
        name: AsciiFolding
        description: Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the "Basic Latin" Unicode block) into their ASCII equivalents, if such equivalents exist. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html
      - value: cjk_bigram
        name: CjkBigram
        description: Forms bigrams of CJK terms that are generated from the standard tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKBigramFilter.html
      - value: cjk_width
        name: CjkWidth
        description: Normalizes CJK width differences. Folds fullwidth ASCII variants into the equivalent basic Latin, and half-width Katakana variants into the equivalent Kana. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKWidthFilter.html
      - value: classic
        name: Classic
        description: Removes English possessives, and dots from acronyms. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/ClassicFilter.html
      - value: common_grams
        name: CommonGram
        description: Construct bigrams for frequently occurring terms while indexing. Single terms are still indexed too, with bigrams overlaid. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/commongrams/CommonGramsFilter.html
      - value: edgeNGram_v2
        name: EdgeNGram
        description: Generates n-grams of the given size(s) starting from the front or the back of an input token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenFilter.html
      - value: elision
        name: Elision
        description: Removes elisions. For example, "l'avion" (the plane) will be converted to "avion" (plane). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html
      - value: german_normalization
        name: GermanNormalization
        description: Normalizes German characters according to the heuristics of the German2 snowball algorithm. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/de/GermanNormalizationFilter.html
      - value: hindi_normalization
        name: HindiNormalization
        description: Normalizes text in Hindi to remove some differences in spelling variations. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/hi/HindiNormalizationFilter.html
      - value: indic_normalization
        name: IndicNormalization
        description: Normalizes the Unicode representation of text in Indian languages. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/in/IndicNormalizationFilter.html
      - value: keyword_repeat
        name: KeywordRepeat
        description: Emits each incoming token twice, once as keyword and once as non-keyword. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/KeywordRepeatFilter.html
      - value: kstem
        name: KStem
        description: A high-performance kstem filter for English. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/en/KStemFilter.html
      - value: length
        name: Length
        description: Removes words that are too long or too short. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LengthFilter.html
      - value: limit
        name: Limit
        description: Limits the number of tokens while indexing. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LimitTokenCountFilter.html
      - value: lowercase
        name: Lowercase
        description: Normalizes token text to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.htm
      - value: nGram_v2
        name: NGram
        description: Generates n-grams of the given size(s). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenFilter.html
      - value: persian_normalization
        name: PersianNormalization
        description: Applies normalization for Persian. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/fa/PersianNormalizationFilter.html
      - value: phonetic
        name: Phonetic
        description: Create tokens for phonetic matches. See https://lucene.apache.org/core/4_10_3/analyzers-phonetic/org/apache/lucene/analysis/phonetic/package-tree.html
      - value: porter_stem
        name: PorterStem
        description: Uses the Porter stemming algorithm to transform the token stream. See http://tartarus.org/~martin/PorterStemmer
      - value: reverse
        name: Reverse
        description: Reverses the token string. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/reverse/ReverseStringFilter.html
      - value: scandinavian_normalization
        name: ScandinavianNormalization
        description: Normalizes use of the interchangeable Scandinavian characters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ScandinavianNormalizationFilter.html
      - value: scandinavian_folding
        name: ScandinavianFoldingNormalization
        description: Folds Scandinavian characters åÅäæÄÆ->a and öÖøØ->o. It also discriminates against use of double vowels aa, ae, ao, oe and oo, leaving just the first one. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ScandinavianFoldingFilter.html
      - value: shingle
        name: Shingle
        description: Creates combinations of tokens as a single token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/shingle/ShingleFilter.html
      - value: snowball
        name: Snowball
        description: A filter that stems words using a Snowball-generated stemmer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/snowball/SnowballFilter.html
      - value: sorani_normalization
        name: SoraniNormalization
        description: Normalizes the Unicode representation of Sorani text. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ckb/SoraniNormalizationFilter.html
      - value: stemmer
        name: Stemmer
        description: Language specific stemming filter. See https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#TokenFilters
      - value: stopwords
        name: Stopwords
        description: Removes stop words from a token stream. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopFilter.html
      - value: trim
        name: Trim
        description: Trims leading and trailing whitespace from tokens. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TrimFilter.html
      - value: truncate
        name: Truncate
        description: Truncates the terms to a specific length. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TruncateTokenFilter.html
      - value: unique
        name: Unique
        description: Filters out tokens with same text as the previous token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/RemoveDuplicatesTokenFilter.html
      - value: uppercase
        name: Uppercase
        description: Normalizes token text to upper case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/UpperCaseFilter.html
      - value: word_delimiter
        name: WordDelimiter
        description: Splits words into subwords and performs optional transformations on subword groups.
    description: Defines the names of all token filters supported by Azure Cognitive Search.
    externalDocs:
      url: https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search
  LexicalTokenizerName:
    type: string
    enum:
    - classic
    - edgeNGram
    - keyword_v2
    - letter
    - lowercase
    - microsoft_language_tokenizer
    - microsoft_language_stemming_tokenizer
    - nGram
    - path_hierarchy_v2
    - pattern
    - standard_v2
    - uax_url_email
    - whitespace
    x-ms-enum:
      name: LexicalTokenizerName
      modelAsString: true
      values:
      - value: classic
        name: Classic
        description: Grammar-based tokenizer that is suitable for processing most European-language documents. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/ClassicTokenizer.html
      - value: edgeNGram
        name: EdgeNGram
        description: Tokenizes the input from an edge into n-grams of the given size(s). See https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenizer.html
      - value: keyword_v2
        name: Keyword
        description: Emits the entire input as a single token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordTokenizer.html
      - value: letter
        name: Letter
        description: Divides text at non-letters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/LetterTokenizer.html
      - value: lowercase
        name: Lowercase
        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/LowerCaseTokenizer.html
      - value: microsoft_language_tokenizer
        name: MicrosoftLanguageTokenizer
        description: Divides text using language-specific rules.
      - value: microsoft_language_stemming_tokenizer
        name: MicrosoftLanguageStemmingTokenizer
        description: Divides text using language-specific rules and reduces words to their base forms.
      - value: nGram
        name: NGram
        description: Tokenizes the input into n-grams of the given size(s). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenizer.html
      - value: path_hierarchy_v2
        name: PathHierarchy
        description: Tokenizer for path-like hierarchies. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/path/PathHierarchyTokenizer.html
      - value: pattern
        name: Pattern
        description: Tokenizer that uses regex pattern matching to construct distinct tokens. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternTokenizer.html
      - value: standard_v2
        name: Standard
        description: Standard Lucene analyzer; Composed of the standard tokenizer, lowercase filter and stop filter. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardTokenizer.html
      - value: uax_url_email
        name: UaxUrlEmail
        description: Tokenizes urls and emails as one token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/UAX29URLEmailTokenizer.html
      - value: whitespace
        name: Whitespace
        description: Divides text at whitespace. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceTokenizer.html
    description: Defines the names of all tokenizers supported by Azure Cognitive Search.
    externalDocs:
      url: https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search
  CorsOptions:
    properties:
      allowedOrigins:
        type: array
        items:
          type: string
        description: The list of origins from which JavaScript code will be granted access to your index. Can contain a list of hosts of the form {protocol}://{fully-qualified-domain-name}[:{port#}], or a single '*' to allow all origins (not recommended).
      maxAgeInSeconds:
        type: integer
        format: int64
        description: The duration for which browsers should cache CORS preflight responses. Defaults to 5 minutes.
    required:
    - allowedOrigins
    externalDocs:
      url: https://docs.microsoft.com/rest/api/searchservice/Create-Index
    description: Defines options to control Cross-Origin Resource Sharing (CORS) for an index.
  CharFilter:
    discriminator: '@odata.type'
    properties:
      '@odata.type':
        type: string
        description: Identifies the concrete type of the char filter.
      name:
        type: string
        externalDocs:
          url: https://docs.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference
        description: The name of the char filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters.
    required:
    - '@odata.type'
    - name
    description: Base type for character filters.
    externalDocs:
      url: https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search
  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: '#/definitions/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.
  ScoringFunctionAggregation:
    type: string
    enum:
    - sum
    - average
    - minimum
    - maximum
    - firstMatching
    x-ms-enum:
      name: ScoringFunctionAggregation
      modelAsString: false
      values:
      - value: sum
        name: Sum
        description: Boost scores by the sum of all scoring function results.
      - value: average
        name: Average
        description: Boost scores by the average of all scoring function results.
      - value: minimum
        name: Minimum
        description: Boost scores by the minimum of all scoring function results.
      - value: maximum
        name: Maximum
        description: Boost scores by the maximum of all scoring function results.
      - value: firstMatching
        name: FirstMatching
        description: Boost scores using the first applicable scoring function in the scoring profile.
    description: Defines the aggregation function used to combine the results of all the scoring functions in a scoring profile.
  AnalyzeRequest:
    properties:
      text:
        type: string
        description: The text to break into tokens.
      analyzer:
        $ref: '#/definitions/LexicalAnalyzerName'
        description: The name of the analyzer to use to break the given text. If this parameter is not specified, you must specify a tokenizer instead. The tokenizer and analyzer parameters are mutually exclusive.
      tokenizer:
        $ref: '#/definitions/LexicalTokenizerName'
        description: The name of the tokenizer to use to break the given text. If this parameter is not specified, you must specify an analyzer instead. The tokenizer and analyzer parameters are mutually exclusive.
      tokenFilters:
        type: array
        items:
          $ref: '#/definitions/TokenFilterName'
          x-nullable: false
        description: An optional list of token filters to use when breaking the given text. This parameter can only be set when using the tokenizer parameter.
      charFilters:
        type: array
        items:
          $ref: '#/definitions/CharFilterName'
          x-nullable: false
        description: An optional list of character filters to use when breaking the given text. This parameter can only be set when using the tokenizer parameter.
    required:
    - text
    description: Specifies some text and analysis components used to break that text into tokens.
  VersionInfo:
    type: object
    description: Next version definition.
    properties:
      nextVersion:
        type: integer
        format: int64
        description: Next version as defined by the server.
      latestVersion:
        type: string
        description: Current latest version of the resource.
    required:
    - latestVersion
  Suggester:
    properties:
      name:
        type: string
        description: The name of the suggester.
      searchMode:
        type: string
        enum:
        - analyzingInfixMatching
        x-ms-enum:
          name: SuggesterSearchMode
          modelAsString: false
          values:
          - value: analyzingInfixMatching
            name: AnalyzingInfixMatching
            description: Matches consecutive whole terms and prefixes in a field. For example, for the field 'The fastest brown fox', the queries 'fast' and 'fastest brow' would both match.
        description: A value indicating the capabilities of the suggester.
      sourceFields:
        type: array
        items:
          type: string
        description: The list of field names to which the suggester applies. Each field must be searchable.
    required:
    - name
    - searchMode
    - sourceFields
    description: Defines how the Suggest API should apply to a group of fields in the index.
  Azure.Core.Foundations.InnerError:
    type: object
    description: An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
    properties:
      code:
        type: string
        description: One of a server-defined set of error codes.
      innererror:
        $ref: '#/definitions/Azure.Core.Foundations.InnerError'
        description: Inner error.
  ScoringProfile:
    properties:
      name:
        externalDocs:
          url: https://docs.microsoft.com/rest/api/searchservice/Naming-rules
        type: string
        description: The name of the scoring profile.
      text:
        x-ms-client-name: TextWeights
        $ref: '#/definitions/TextWeights'
        description: Parameters that boost scoring based on text matches in certain index fields.
      functions:
        type: array
        items:
          $ref: '#/definitions/ScoringFunction'
        description: The collection of functions that influence the scoring of documents.
      functionAggregation:
        $ref: '#/definitions/ScoringFunctionAggregation'
        description: A value indicating how the results of individual scoring functions should be combined. Defaults to "Sum". Ignored if there are no scoring functions.
    required:
    - name
    externalDocs:
      url: https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index
    description: Defines parameters for a search index that influence scoring in search queries.
  Similarity:
    discriminator: '@odata.type'
    properties:
      '@odata.type':
        type: string
    required:
    - '@odata.type'
    description: Base type for similarity algorithms. Similarity algorithms are used to calculate scores that tie queries to documents. The higher the score, the more relevant the document is to that specific query. Those scores are used to rank the search results.
    externalDocs:
      url: https://docs.microsoft.com/azure/search/index-ranking-similarity
  ScoringFunction:
    discriminator: type
    properties:
      type:
        type: string
        description: Indicates the type of function to use. Valid values include magnitude, freshness, distance, and tag. The function type must be lower case.
      fieldName:
        type: string
        description: The name of the field used as input to the scoring function.
      boost:
        type: number
        format: double
        description: A multiplier for the raw score. Must be a positive number not equal to 1.0.
      interpolation:
        $ref: '#/definitions/ScoringFunctionInterpolation'
        description: A value indicating how boosting will be interpolated across document scores; defaults to "Linear".
    required:
    - type
    - fieldName
    - boost
    externalDocs:
      url: https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index
    description: Base type for functions that can modify document scores during ranking.
  AnalyzeResult:
    properties:
      tokens:
        type: array
        items:
          $ref: '#/definitions/AnalyzedTokenInfo'
        description: The list of tokens returned by the analyzer specified in the request.
    required:
    - tokens
    description: The result of testing an analyzer on text.
  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.
  LexicalTokenizer:
    discriminator: '@odata.type'
    properties:
      '@odata.type':
        type: string
        description: Identifies the concrete type of the tokenizer.
      name:
        type: string
        externalDocs:
          url: https://docs.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference
        description: The name of the tokenizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters.
    required:
    - '@odata.type'
    - name
    description: Base type for tokenizers.
    externalDocs:
      url: https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search
  AnalyzedTokenInfo:
    properties:
      token:
        type: string
        readOnly: true
        description: The token returned by the analyzer.
      startOffset:
        type: integer
        format: int32
        readOnly: true
        x-nullable: false
        description: The index of the first character of the token in the input text.
      endOffset:
        type: integer
        format: int32
        readOnly: true
        x-nullable: false
        description: The index of the last character of the token in the input text.
      position:
        type: integer
        format: int32
        readOnly: true
        x-nullable: false
        description: The position of the token in the input text relative to other tokens. The first token in the input text has position 0, the next has position 1, and so on. Depending on the analyzer used, some tokens might have the same position, for example if they are synonyms of each other.
    required:
    - token
    - startOffset
    - endOffset
    - position
    description: Information about a token returned by an analyzer.
  SystemData:
    type: object
    description: Metadata pertaining to creation and last modification of the resource.
    properties:
      createdAt:
        type: string
        format: date-time
        description: The timestamp the resource was created at.
        readOnly: true
      createdBy:
        type: string
        description: The identity that created the resource.
        readOnly: true
      createdByType:
        type: string
        description: The identity type that created the resource.
        readOnly: true
      lastModifiedAt:
        type: string
        format: date-time
        description: The timestamp of resource last modification (UTC)
        readOnly: true
parameters:
  PreferHeaderParameter:
    name: Prefer
    in: header
    required: true
    type: string
    enum:
    - return=representation
    description: For HTTP PUT requests, instructs the service to return the created/updated resource on success.
    x-ms-parameter-location: method
  IfMatchParameter:
    name: If-Match
    in: header
    required: false
    type: string
    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
  Azure.Core.TopQueryParameter:
    name: top
    in: query
    description: The number of result items to return.
    required: false
    type: integer
    format: int32
    x-ms-parameter-location: method
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Client Api Version.
  Azure.Core.MaxPageSizeQueryParameter:
    name: maxpagesize
    in: query
    description: The maximum number of result items per page.
    required: false
    type: integer
    format: int32
    x-ms-parameter-location: method
  ClientRequestIdParameter:
    name: x-ms-client-request-id
    in: header
    required: false
    type: string
    format: uuid
    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
  Azure.Core.SkipQueryParameter:
    name: skip
    in: query
    description: The number of result items to skip.
    required: false
    type: integer
    format: int32
    default: 0
    x-ms-parameter-location: method
  IfNoneMatchParameter:
    name: If-None-Match
    in: header
    required: false
    type: string
    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
  Azure.Core.Foundations.ApiVersionParameter:
    name: api-version
    in: query
    description: The API version to use for this operation.
    required: true
    type: string
    minLength: 1
    x-ms-parameter-location: method
    x-ms-client-name: apiVersion
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'