swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector DatasourcePreferences API
schemes:
- https
tags:
- name: DatasourcePreferences
paths:
  /datasource-preferences:
    get:
      tags:
      - DatasourcePreferences
      description: Get Datasource Preferences for given scope.
      operationId: microsoftAzureDatasourcepreferencesList
      produces:
      - application/json
      parameters:
      - in: query
        name: scope
        description: Id for any resource managed by Purview.
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DatasourcePreferencesResponseUpdated'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponseModel'
      x-ms-examples:
        DatasourcePreferences_List:
          $ref: ./examples/DatasourcePreferences_List.json
      summary: Microsoft Azure Get Datasource Preferences
definitions:
  DatasourcePreferencesResponseUpdated:
    description: Response model for datasource preference API.
    type: object
    properties:
      value:
        description: Consent details.
        type: array
        items:
          $ref: '#/definitions/ConsentServiceModelSimplified'
      accountInfo:
        $ref: '#/definitions/AccountModelBase'
      frequency:
        $ref: '#/definitions/TimeSpan'
  ErrorResponseModel:
    description: Default error response model.
    required:
    - error
    type: object
    properties:
      error:
        $ref: '#/definitions/ErrorModel'
  ErrorModel:
    description: Default error model.
    required:
    - code
    - message
    type: object
    properties:
      code:
        description: Error code.
        minLength: 1
        type: string
      message:
        description: Error message.
        minLength: 1
        type: string
      target:
        description: Error description.
        type: string
      details:
        description: Error details.
        type: array
        items:
          $ref: '#/definitions/ErrorModel'
  AccountModelBase:
    description: Details of the purview account governing the requested resource.
    type: object
    properties:
      id:
        description: Id of the Purview account.
        type: string
      name:
        description: Name of the Purview account.
        type: string
      location:
        description: Location (Region) of the Purview account.
        type: string
      tenantId:
        description: Tenant Id of the Purview account.
        type: string
      gatewayEndpoint:
        description: Endpoint of the Purview account. This will be used by the RPs to call Purview APIs.
        type: string
  TimeSpan:
    description: This is an ISO8601 time span value.
    type: string
  ConsentServiceModelSimplified:
    description: Consent details.
    type: object
    properties:
      kind:
        description: Consent kind.
        type: string
      status:
        description: Consent status.
        type: string
      excludedScopes:
        description: List of scopes opted out of this consent.
        type: array
        items:
          type: string
parameters:
  api-version:
    in: query
    name: api-version
    description: The api-version of the service.
    required: true
    type: string
    x-ms-parameter-location: client
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'