swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector DataSources API
schemes:
- https
tags:
- name: DataSources
paths:
  /datasources/{dataSourceName}:
    put:
      tags:
      - DataSources
      description: Creates or Updates a data source
      operationId: microsoftAzureDatasourcesCreateorupdate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: dataSourceName
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      - in: body
        name: body
        schema:
          $ref: '#/definitions/DataSource'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DataSource'
        '201':
          description: Success
          schema:
            $ref: '#/definitions/DataSource'
        default:
          description: An error response received from the Scanning Service
          schema:
            $ref: '#/definitions/ErrorResponseModel'
      x-ms-examples:
        DataSources_CreateOrUpdate:
          $ref: ./examples/DataSources_CreateOrUpdate.json
      summary: Microsoft Azure Put Datasources Datasourcename
    get:
      tags:
      - DataSources
      description: Get a data source
      operationId: microsoftAzureDatasourcesGet
      produces:
      - application/json
      parameters:
      - in: path
        name: dataSourceName
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DataSource'
        default:
          description: An error response received from the Scanning Service
          schema:
            $ref: '#/definitions/ErrorResponseModel'
      x-ms-examples:
        DataSources_Get:
          $ref: ./examples/DataSources_Get.json
      summary: Microsoft Azure Get Datasources Datasourcename
    delete:
      tags:
      - DataSources
      description: Deletes a data source
      operationId: microsoftAzureDatasourcesDelete
      produces:
      - application/json
      parameters:
      - in: path
        name: dataSourceName
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DataSource'
        '204':
          description: Success
        default:
          description: An error response received from the Scanning Service
          schema:
            $ref: '#/definitions/ErrorResponseModel'
      x-ms-examples:
        DataSources_Delete:
          $ref: ./examples/DataSources_Delete.json
      summary: Microsoft Azure Delete Datasources Datasourcename
  /datasources:
    get:
      tags:
      - DataSources
      description: List data sources in Data catalog
      operationId: microsoftAzureDatasourcesListall
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DataSourceList'
        default:
          description: An error response received from the Scanning Service
          schema:
            $ref: '#/definitions/ErrorResponseModel'
      x-ms-examples:
        DataSources_ListAll:
          $ref: ./examples/DataSources_ListAll.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Datasources
    post:
      tags:
      - DataSources
      operationId: microsoftAzureDatasourcesCreate
      x-ms-examples:
        SearchServiceCreateDataSource:
          $ref: ./examples/SearchServiceCreateDataSource.json
      description: Creates a new datasource.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Create-Data-Source
      parameters:
      - name: dataSource
        in: body
        required: true
        schema:
          $ref: '#/definitions/SearchIndexerDataSource'
        description: The definition of the datasource to create.
      - $ref: '#/parameters/ClientRequestIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '201':
          description: ''
          schema:
            $ref: '#/definitions/SearchIndexerDataSource'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: Microsoft Azure Post Datasources
  /datasources('{dataSourceName}'):
    put:
      tags:
      - DataSources
      operationId: microsoftAzureDatasourcesCreateorupdate
      x-ms-examples:
        SearchServiceCreateOrUpdateDataSource:
          $ref: ./examples/SearchServiceCreateOrUpdateDataSource.json
      description: Creates a new datasource or updates a datasource if it already exists.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Update-Data-Source
      parameters:
      - name: dataSourceName
        in: path
        required: true
        type: string
        description: The name of the datasource to create or update.
      - name: dataSource
        in: body
        required: true
        schema:
          $ref: '#/definitions/SearchIndexerDataSource'
        description: The definition of the datasource to create or update.
      - $ref: '#/parameters/ClientRequestIdParameter'
      - $ref: '#/parameters/IfMatchParameter'
      - $ref: '#/parameters/IfNoneMatchParameter'
      - $ref: '#/parameters/PreferHeaderParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/SearchIndexerDataSource'
        '201':
          description: ''
          schema:
            $ref: '#/definitions/SearchIndexerDataSource'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: Microsoft Azure Put Datasources Datasourcename
    delete:
      tags:
      - DataSources
      operationId: microsoftAzureDatasourcesDelete
      x-ms-examples:
        SearchServiceDeleteDataSource:
          $ref: ./examples/SearchServiceDeleteDataSource.json
      description: Deletes a datasource.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Delete-Data-Source
      parameters:
      - name: dataSourceName
        in: path
        required: true
        type: string
        description: The name of the datasource to delete.
      - $ref: '#/parameters/ClientRequestIdParameter'
      - $ref: '#/parameters/IfMatchParameter'
      - $ref: '#/parameters/IfNoneMatchParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '204':
          description: ''
        '404':
          description: ''
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: Microsoft Azure Delete Datasources Datasourcename
    get:
      tags:
      - DataSources
      operationId: microsoftAzureDatasourcesGet
      x-ms-examples:
        SearchServiceGetDataSource:
          $ref: ./examples/SearchServiceGetDataSource.json
      description: Retrieves a datasource definition.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Get-Data-Source
      parameters:
      - name: dataSourceName
        in: path
        required: true
        type: string
        description: The name of the datasource to retrieve.
      - $ref: '#/parameters/ClientRequestIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/SearchIndexerDataSource'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: Microsoft Azure Get Datasources Datasourcename
definitions:
  ProxyResource:
    type: object
    properties:
      id:
        type: string
        readOnly: true
      name:
        type: string
        readOnly: true
  Scan:
    required:
    - kind
    type: object
    allOf:
    - $ref: '#/definitions/ProxyResource'
    properties:
      kind:
        enum:
        - AzureSubscriptionCredential
        - AzureSubscriptionMsi
        - AzureResourceGroupCredential
        - AzureResourceGroupMsi
        - AzureSynapseWorkspaceCredential
        - AzureSynapseWorkspaceMsi
        - AzureSynapseCredential
        - AzureSynapseMsi
        - AdlsGen1Credential
        - AdlsGen1Msi
        - AdlsGen2Credential
        - AdlsGen2Msi
        - AmazonAccountCredential
        - AmazonS3Credential
        - AmazonS3RoleARN
        - AmazonSqlCredential
        - AzureCosmosDbCredential
        - AzureDataExplorerCredential
        - AzureDataExplorerMsi
        - AzureFileServiceCredential
        - AzureSqlDatabaseCredential
        - AzureSqlDatabaseMsi
        - AmazonPostgreSqlCredential
        - AzurePostgreSqlCredential
        - SqlServerDatabaseCredential
        - AzureSqlDatabaseManagedInstanceCredential
        - AzureSqlDatabaseManagedInstanceMsi
        - AzureSqlDataWarehouseCredential
        - AzureSqlDataWarehouseMsi
        - AzureMySqlCredential
        - AzureStorageCredential
        - AzureStorageMsi
        - TeradataTeradataCredential
        - TeradataTeradataUserPass
        - TeradataUserPass
        - OracleOracleCredential
        - OracleOracleUserPass
        - SapS4HanaSapS4HanaCredential
        - SapS4HanaSapS4HanaUserPass
        - SapEccSapEccCredential
        - SapEccSapEccUserPass
        - PowerBIDelegated
        - PowerBIMsi
        type: string
        x-ms-enum:
          name: ScanAuthorizationType
          modelAsString: true
      scanResults:
        type: array
        items:
          $ref: '#/definitions/ScanResult'
        readOnly: true
    discriminator: kind
  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.
  ErrorModel:
    type: object
    properties:
      code:
        type: string
      message:
        type: string
      target:
        type: string
      details:
        type: array
        items:
          $ref: '#/definitions/ErrorModel'
  DataSourceCredentials:
    properties:
      connectionString:
        externalDocs:
          url: https://docs.microsoft.com/rest/api/searchservice/Create-Data-Source
        type: string
        description: The connection string for the datasource.
    description: Represents credentials that can be used to connect to a datasource.
  DataChangeDetectionPolicy:
    discriminator: '@odata.type'
    properties:
      '@odata.type':
        type: string
        description: Identifies the concrete type of the data change detection policy.
    required:
    - '@odata.type'
    description: Base type for data change detection policies.
  ScanDiagnostics:
    type: object
    properties:
      notifications:
        type: array
        items:
          $ref: '#/definitions/Notification'
      exceptionCountMap:
        type: object
        additionalProperties:
          format: int32
          type: integer
        readOnly: true
  SearchIndexerDataSourceType:
    type: string
    enum:
    - azuresql
    - cosmosdb
    - azureblob
    - azuretable
    - mysql
    x-ms-enum:
      name: SearchIndexerDataSourceType
      modelAsString: true
      values:
      - value: azuresql
        name: AzureSql
        description: Indicates an Azure SQL datasource.
      - value: cosmosdb
        name: CosmosDb
        description: Indicates a CosmosDB datasource.
      - value: azureblob
        name: AzureBlob
        description: Indicates a Azure Blob datasource.
      - value: azuretable
        name: AzureTable
        description: Indicates a Azure Table datasource.
      - value: mysql
        name: MySql
        description: Indicates a MySql datasource.
    description: Defines the type of a datasource.
  DataDeletionDetectionPolicy:
    discriminator: '@odata.type'
    properties:
      '@odata.type':
        type: string
        description: Identifies the concrete type of the data deletion detection policy.
    required:
    - '@odata.type'
    description: Base type for data deletion detection policies.
  DataSourceList:
    required:
    - value
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/DataSource'
      nextLink:
        type: string
      count:
        format: int64
        type: integer
  SearchIndexerDataContainer:
    properties:
      name:
        type: string
        description: The name of the table or view (for Azure SQL data source) or collection (for CosmosDB data source) that will be indexed.
      query:
        type: string
        description: A query that is applied to this data container. The syntax and meaning of this parameter is datasource-specific. Not supported by Azure SQL datasources.
    required:
    - name
    description: Represents information about the entity (such as Azure SQL table or CosmosDB collection) that will be indexed.
  ErrorResponseModel:
    type: object
    properties:
      error:
        allOf:
        - $ref: '#/definitions/ErrorModel'
  DataSource:
    required:
    - kind
    type: object
    allOf:
    - $ref: '#/definitions/ProxyResource'
    properties:
      kind:
        enum:
        - None
        - AzureSubscription
        - AzureResourceGroup
        - AzureSynapseWorkspace
        - AzureSynapse
        - AdlsGen1
        - AdlsGen2
        - AmazonAccount
        - AmazonS3
        - AmazonSql
        - AzureCosmosDb
        - AzureDataExplorer
        - AzureFileService
        - AzureSqlDatabase
        - AmazonPostgreSql
        - AzurePostgreSql
        - SqlServerDatabase
        - AzureSqlDatabaseManagedInstance
        - AzureSqlDataWarehouse
        - AzureMySql
        - AzureStorage
        - Teradata
        - Oracle
        - SapS4Hana
        - SapEcc
        - PowerBI
        type: string
        x-ms-enum:
          name: DataSourceType
          modelAsString: true
      scans:
        type: array
        items:
          $ref: '#/definitions/Scan'
        readOnly: true
    discriminator: kind
  SearchIndexerDataSource:
    properties:
      name:
        externalDocs:
          url: https://docs.microsoft.com/rest/api/searchservice/Naming-rules
        type: string
        description: The name of the datasource.
      description:
        type: string
        description: The description of the datasource.
      type:
        $ref: '#/definitions/SearchIndexerDataSourceType'
        description: The type of the datasource.
      credentials:
        $ref: '#/definitions/DataSourceCredentials'
        description: Credentials for the datasource.
      container:
        $ref: '#/definitions/SearchIndexerDataContainer'
        description: The data container for the datasource.
      dataChangeDetectionPolicy:
        $ref: '#/definitions/DataChangeDetectionPolicy'
        description: The data change detection policy for the datasource.
      dataDeletionDetectionPolicy:
        $ref: '#/definitions/DataDeletionDetectionPolicy'
        description: The data deletion detection policy for the datasource.
      '@odata.etag':
        x-ms-client-name: ETag
        type: string
        description: The ETag of the data source.
    required:
    - name
    - type
    - credentials
    - container
    description: Represents a datasource definition, which can be used to configure an indexer.
  Notification:
    type: object
    properties:
      message:
        type: string
      code:
        format: int32
        type: integer
  ScanResult:
    type: object
    properties:
      parentId:
        type: string
        readOnly: true
      id:
        type: string
        readOnly: true
      resourceId:
        type: string
        readOnly: true
      status:
        type: string
        readOnly: true
      assetsDiscovered:
        format: int64
        type: integer
        readOnly: true
      assetsClassified:
        format: int64
        type: integer
        readOnly: true
      diagnostics:
        allOf:
        - $ref: '#/definitions/ScanDiagnostics'
        readOnly: true
      startTime:
        format: date-time
        type: string
        readOnly: true
      queuedTime:
        format: date-time
        type: string
        readOnly: true
      pipelineStartTime:
        format: date-time
        type: string
        readOnly: true
      endTime:
        format: date-time
        type: string
        readOnly: true
      scanRulesetVersion:
        format: int32
        type: integer
        readOnly: true
      scanRulesetType:
        enum:
        - Custom
        - System
        type: string
        readOnly: true
        x-ms-enum:
          name: ScanRulesetType
          modelAsString: true
      scanLevelType:
        enum:
        - Full
        - Incremental
        type: string
        readOnly: true
        x-ms-enum:
          name: ScanLevelType
          modelAsString: true
      errorMessage:
        type: string
        readOnly: true
      error:
        allOf:
        - $ref: '#/definitions/ErrorModel'
        readOnly: true
      runType:
        type: string
        readOnly: true
      dataSourceType:
        enum:
        - None
        - AzureSubscription
        - AzureResourceGroup
        - AzureSynapseWorkspace
        - AzureSynapse
        - AdlsGen1
        - AdlsGen2
        - AmazonAccount
        - AmazonS3
        - AmazonSql
        - AzureCosmosDb
        - AzureDataExplorer
        - AzureFileService
        - AzureSqlDatabase
        - AmazonPostgreSql
        - AzurePostgreSql
        - SqlServerDatabase
        - AzureSqlDatabaseManagedInstance
        - AzureSqlDataWarehouse
        - AzureMySql
        - AzureStorage
        - Teradata
        - Oracle
        - SapS4Hana
        - SapEcc
        - PowerBI
        type: string
        readOnly: true
        x-ms-enum:
          name: DataSourceType
          modelAsString: 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
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Client Api Version.
  api-version:
    in: query
    name: api-version
    description: The api version to use.
    required: true
    type: string
    x-ms-client-name: ApiVersion
  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'