swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Indexers API
schemes:
- https
tags:
- name: Indexers
paths:
  /indexers('{indexerName}')/search.reset:
    post:
      tags:
      - Indexers
      operationId: microsoftAzureIndexersReset
      x-ms-examples:
        SearchServiceResetIndexer:
          $ref: ./examples/SearchServiceResetIndexer.json
      description: Resets the change tracking state associated with an indexer.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Reset-Indexer
      parameters:
      - name: indexerName
        in: path
        required: true
        type: string
        description: The name of the indexer to reset.
      - $ref: '#/parameters/ClientRequestIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '204':
          description: ''
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: Microsoft Azure Post Indexers Indexername  Search Reset
  /indexers('{indexerName}')/search.run:
    post:
      tags:
      - Indexers
      operationId: microsoftAzureIndexersRun
      x-ms-examples:
        SearchServiceRunIndexer:
          $ref: ./examples/SearchServiceRunIndexer.json
      description: Runs an indexer on-demand.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Run-Indexer
      parameters:
      - name: indexerName
        in: path
        required: true
        type: string
        description: The name of the indexer to run.
      - $ref: '#/parameters/ClientRequestIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '202':
          description: ''
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: Microsoft Azure Post Indexers Indexername  Search Run
  /indexers('{indexerName}'):
    put:
      tags:
      - Indexers
      operationId: microsoftAzureIndexersCreateorupdate
      x-ms-examples:
        SearchServiceCreateOrUpdateIndexer:
          $ref: ./examples/SearchServiceCreateOrUpdateIndexer.json
      description: Creates a new indexer or updates an indexer if it already exists.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Create-Indexer
      parameters:
      - name: indexerName
        in: path
        required: true
        type: string
        description: The name of the indexer to create or update.
      - name: indexer
        in: body
        required: true
        schema:
          $ref: '#/definitions/SearchIndexer'
        description: The definition of the indexer to create or update.
      - $ref: '#/parameters/ClientRequestIdParameter'
      - $ref: '#/parameters/IfMatchParameter'
      - $ref: '#/parameters/IfNoneMatchParameter'
      - $ref: '#/parameters/PreferHeaderParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/SearchIndexer'
        '201':
          description: ''
          schema:
            $ref: '#/definitions/SearchIndexer'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: Microsoft Azure Put Indexers Indexername
    delete:
      tags:
      - Indexers
      operationId: microsoftAzureIndexersDelete
      x-ms-examples:
        SearchServiceDeleteIndexer:
          $ref: ./examples/SearchServiceDeleteIndexer.json
      description: Deletes an indexer.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Delete-Indexer
      parameters:
      - name: indexerName
        in: path
        required: true
        type: string
        description: The name of the indexer to delete.
      - $ref: '#/parameters/ClientRequestIdParameter'
      - $ref: '#/parameters/IfMatchParameter'
      - $ref: '#/parameters/IfNoneMatchParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '204':
          description: ''
        '404':
          description: ''
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: Microsoft Azure Delete Indexers Indexername
    get:
      tags:
      - Indexers
      operationId: microsoftAzureIndexersGet
      x-ms-examples:
        SearchServiceGetIndexer:
          $ref: ./examples/SearchServiceGetIndexer.json
      description: Retrieves an indexer definition.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Get-Indexer
      parameters:
      - name: indexerName
        in: path
        required: true
        type: string
        description: The name of the indexer to retrieve.
      - $ref: '#/parameters/ClientRequestIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/SearchIndexer'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: Microsoft Azure Get Indexers Indexername
  /indexers:
    get:
      tags:
      - Indexers
      operationId: microsoftAzureIndexersList
      x-ms-examples:
        SearchServiceListIndexers:
          $ref: ./examples/SearchServiceListIndexers.json
      description: Lists all indexers available for a search service.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/List-Indexers
      parameters:
      - name: $select
        in: query
        required: false
        type: string
        description: Selects which top-level properties of the indexers to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties.
      - $ref: '#/parameters/ClientRequestIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/ListIndexersResult'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: Microsoft Azure Get Indexers
    post:
      tags:
      - Indexers
      operationId: microsoftAzureIndexersCreate
      x-ms-examples:
        SearchServiceCreateIndexer:
          $ref: ./examples/SearchServiceCreateIndexer.json
      description: Creates a new indexer.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Create-Indexer
      parameters:
      - name: indexer
        in: body
        required: true
        schema:
          $ref: '#/definitions/SearchIndexer'
        description: The definition of the indexer to create.
      - $ref: '#/parameters/ClientRequestIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '201':
          description: ''
          schema:
            $ref: '#/definitions/SearchIndexer'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: Microsoft Azure Post Indexers
  /indexers('{indexerName}')/search.status:
    get:
      tags:
      - Indexers
      operationId: microsoftAzureIndexersGetstatus
      x-ms-examples:
        SearchServiceGetIndexerStatus:
          $ref: ./examples/SearchServiceGetIndexerStatus.json
      description: Returns the current status and execution history of an indexer.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Get-Indexer-Status
      parameters:
      - name: indexerName
        in: path
        required: true
        type: string
        description: The name of the indexer for which to retrieve status.
      - $ref: '#/parameters/ClientRequestIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/SearchIndexerStatus'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: Microsoft Azure Get Indexers Indexername  Search Status
definitions:
  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.
  IndexerStatus:
    type: string
    enum:
    - unknown
    - error
    - running
    x-ms-enum:
      name: IndexerStatus
      modelAsString: false
      values:
      - value: unknown
        name: Unknown
        description: Indicates that the indexer is in an unknown state.
      - value: error
        name: Error
        description: Indicates that the indexer experienced an error that cannot be corrected without human intervention.
      - value: running
        name: Running
        description: Indicates that the indexer is running normally.
    x-nullable: false
    description: Represents the overall indexer status.
  SearchIndexerWarning:
    properties:
      key:
        type: string
        readOnly: true
        description: The key of the item which generated a warning.
      message:
        type: string
        readOnly: true
        description: The message describing the warning that occurred while processing the item.
      name:
        type: string
        readOnly: true
        description: The name of the source at which the warning originated. For example, this could refer to a particular skill in the attached skillset. This may not be always available.
      details:
        type: string
        readOnly: true
        description: Additional, verbose details about the warning to assist in debugging the indexer. This may not be always available.
      documentationLink:
        type: string
        readOnly: true
        description: A link to a troubleshooting guide for these classes of warnings. This may not be always available.
    required:
    - message
    description: Represents an item-level warning.
  SearchIndexerError:
    properties:
      key:
        type: string
        readOnly: true
        description: The key of the item for which indexing failed.
      errorMessage:
        type: string
        readOnly: true
        description: The message describing the error that occurred while processing the item.
      statusCode:
        type: integer
        format: int32
        x-nullable: false
        readOnly: true
        description: 'The status code indicating why the indexing operation failed. Possible values include: 400 for a malformed input document, 404 for document not found, 409 for a version conflict, 422 when the index is temporarily unavailable, or 503 for when the service is too busy.'
      name:
        type: string
        readOnly: true
        description: The name of the source at which the error originated. For example, this could refer to a particular skill in the attached skillset. This may not be always available.
      details:
        type: string
        readOnly: true
        description: Additional, verbose details about the error to assist in debugging the indexer. This may not be always available.
      documentationLink:
        type: string
        readOnly: true
        description: A link to a troubleshooting guide for these classes of errors. This may not be always available.
    required:
    - errorMessage
    - statusCode
    description: Represents an item- or document-level indexing error.
  SearchIndexer:
    properties:
      name:
        externalDocs:
          url: https://docs.microsoft.com/rest/api/searchservice/Naming-rules
        type: string
        description: The name of the indexer.
      description:
        type: string
        description: The description of the indexer.
      dataSourceName:
        type: string
        description: The name of the datasource from which this indexer reads data.
      skillsetName:
        type: string
        description: The name of the skillset executing with this indexer.
      targetIndexName:
        type: string
        description: The name of the index to which this indexer writes data.
      schedule:
        $ref: '#/definitions/IndexingSchedule'
        description: The schedule for this indexer.
      parameters:
        $ref: '#/definitions/IndexingParameters'
        description: Parameters for indexer execution.
      fieldMappings:
        type: array
        items:
          $ref: '#/definitions/FieldMapping'
        description: Defines mappings between fields in the data source and corresponding target fields in the index.
        externalDocs:
          url: https://docs.microsoft.com/azure/search/search-indexer-field-mappings
      outputFieldMappings:
        type: array
        items:
          $ref: '#/definitions/FieldMapping'
        description: Output field mappings are applied after enrichment and immediately before indexing.
        externalDocs:
          url: https://docs.microsoft.com/azure/search/search-indexer-field-mappings
      disabled:
        x-ms-client-name: IsDisabled
        type: boolean
        default: false
        description: A value indicating whether the indexer is disabled. Default is false.
      '@odata.etag':
        x-ms-client-name: ETag
        type: string
        description: The ETag of the indexer.
    required:
    - name
    - dataSourceName
    - targetIndexName
    externalDocs:
      url: https://docs.microsoft.com/rest/api/searchservice/Indexer-operations
    description: Represents an indexer.
  IndexerExecutionResult:
    properties:
      status:
        $ref: '#/definitions/IndexerExecutionStatus'
        readOnly: true
        description: The outcome of this indexer execution.
      errorMessage:
        type: string
        readOnly: true
        description: The error message indicating the top-level error, if any.
      startTime:
        type: string
        format: date-time
        readOnly: true
        description: The start time of this indexer execution.
      endTime:
        type: string
        format: date-time
        readOnly: true
        description: The end time of this indexer execution, if the execution has already completed.
      errors:
        type: array
        readOnly: true
        items:
          $ref: '#/definitions/SearchIndexerError'
        description: The item-level indexing errors.
      warnings:
        type: array
        readOnly: true
        items:
          $ref: '#/definitions/SearchIndexerWarning'
        description: The item-level indexing warnings.
      itemsProcessed:
        x-ms-client-name: ItemCount
        type: integer
        format: int32
        x-nullable: false
        readOnly: true
        description: The number of items that were processed during this indexer execution. This includes both successfully processed items and items where indexing was attempted but failed.
      itemsFailed:
        x-ms-client-name: FailedItemCount
        type: integer
        format: int32
        x-nullable: false
        readOnly: true
        description: The number of items that failed to be indexed during this indexer execution.
      initialTrackingState:
        type: string
        readOnly: true
        description: Change tracking state with which an indexer execution started.
      finalTrackingState:
        type: string
        readOnly: true
        description: Change tracking state with which an indexer execution finished.
    required:
    - status
    - errors
    - warnings
    - itemsProcessed
    - itemsFailed
    description: Represents the result of an individual indexer execution.
  IndexingParameters:
    properties:
      batchSize:
        type: integer
        format: int32
        description: The number of items that are read from the data source and indexed as a single batch in order to improve performance. The default depends on the data source type.
      maxFailedItems:
        type: integer
        format: int32
        default: 0
        description: The maximum number of items that can fail indexing for indexer execution to still be considered successful. -1 means no limit. Default is 0.
      maxFailedItemsPerBatch:
        type: integer
        format: int32
        default: 0
        description: The maximum number of items in a single batch that can fail indexing for the batch to still be considered successful. -1 means no limit. Default is 0.
      configuration:
        type: object
        additionalProperties:
          type: object
        description: A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type.
    description: Represents parameters for indexer execution.
  FieldMappingFunction:
    properties:
      name:
        type: string
        description: The name of the field mapping function.
      parameters:
        type: object
        additionalProperties:
          type: object
        description: A dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type.
    required:
    - name
    description: Represents a function that transforms a value from a data source before indexing.
    externalDocs:
      url: https://docs.microsoft.com/azure/search/search-indexer-field-mappings
  IndexerExecutionStatus:
    type: string
    enum:
    - transientFailure
    - success
    - inProgress
    - reset
    x-ms-enum:
      name: IndexerExecutionStatus
      modelAsString: false
      values:
      - value: transientFailure
        name: TransientFailure
        description: An indexer invocation has failed, but the failure may be transient. Indexer invocations will continue per schedule.
      - value: success
        name: Success
        description: Indexer execution completed successfully.
      - value: inProgress
        name: InProgress
        description: Indexer execution is in progress.
      - value: reset
        name: Reset
        description: Indexer has been reset.
    x-nullable: false
    description: Represents the status of an individual indexer execution.
  FieldMapping:
    properties:
      sourceFieldName:
        type: string
        description: The name of the field in the data source.
      targetFieldName:
        type: string
        description: The name of the target field in the index. Same as the source field name by default.
      mappingFunction:
        $ref: '#/definitions/FieldMappingFunction'
        description: A function to apply to each source field value before indexing.
    required:
    - sourceFieldName
    description: Defines a mapping between a field in a data source and a target field in an index.
    externalDocs:
      url: https://docs.microsoft.com/azure/search/search-indexer-field-mappings
  SearchIndexerLimits:
    properties:
      maxRunTime:
        type: string
        format: duration
        readOnly: true
        description: The maximum duration that the indexer is permitted to run for one execution.
      maxDocumentExtractionSize:
        type: number
        format: int64
        readOnly: true
        description: The maximum size of a document, in bytes, which will be considered valid for indexing.
      maxDocumentContentCharactersToExtract:
        type: number
        format: int64
        readOnly: true
        description: The maximum number of characters that will be extracted from a document picked up for indexing.
  SearchIndexerStatus:
    properties:
      status:
        $ref: '#/definitions/IndexerStatus'
        readOnly: true
        description: Overall indexer status.
      lastResult:
        $ref: '#/definitions/IndexerExecutionResult'
        readOnly: true
        description: The result of the most recent or an in-progress indexer execution.
      executionHistory:
        type: array
        readOnly: true
        items:
          $ref: '#/definitions/IndexerExecutionResult'
        description: History of the recent indexer executions, sorted in reverse chronological order.
      limits:
        $ref: '#/definitions/SearchIndexerLimits'
        readOnly: true
        description: The execution limits for the indexer.
    required:
    - status
    - executionHistory
    - limits
    description: Represents the current status and execution history of an indexer.
  IndexingSchedule:
    properties:
      interval:
        type: string
        format: duration
        description: The interval of time between indexer executions.
      startTime:
        type: string
        format: date-time
        description: The time when an indexer should start running.
    required:
    - interval
    description: Represents a schedule for indexer execution.
  ListIndexersResult:
    properties:
      value:
        x-ms-client-name: Indexers
        type: array
        readOnly: true
        items:
          $ref: '#/definitions/SearchIndexer'
        description: The indexers in the Search service.
    required:
    - value
    description: Response from a List Indexers request. If successful, it includes the full definitions of all indexers.
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
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Client Api Version.
  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
  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
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'