swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector dataExport API
schemes:
- https
tags:
- name: dataExport
paths:
  /dataExport/destinations:
    get:
      operationId: microsoftAzureDestinationsList
      summary: Microsoft Azure Get The List Of Destinations In An Application
      x-ms-examples:
        List data export destinations:
          $ref: ./examples/dataexports_destinations_list.json
      parameters:
      - $ref: '#/parameters/Version'
      x-ms-pageable:
        nextLinkName: nextLink
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DestinationCollection'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      description: Needs a more full description created.
      tags:
      - dataExport
  /dataExport/destinations/{destinationId}:
    get:
      operationId: microsoftAzureDestinationsGet
      summary: Microsoft Azure Get A Destination By Id
      x-ms-examples:
        Get a data export destination:
          $ref: ./examples/dataexports_destinations_get.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DestinationId'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Destination'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      description: Needs a more full description created.
      tags:
      - dataExport
    put:
      operationId: microsoftAzureDestinationsCreate
      summary: Microsoft Azure Create Or Update A Destination
      description: Create or update a definition for where to send data.
      x-ms-examples:
        Create a webhook destination:
          $ref: ./examples/dataexports_destinations_create_webhook.json
        Create an azure blob storage destination:
          $ref: ./examples/dataexports_destinations_create_blob.json
        Create an azure data explorer destination:
          $ref: ./examples/dataexports_destinations_create_adx.json
        Create an azure event hub destination:
          $ref: ./examples/dataexports_destinations_create_eventhub.json
        Create an azure service bus queue destination:
          $ref: ./examples/dataexports_destinations_create_queue.json
        Create an azure service bus topic destination:
          $ref: ./examples/dataexports_destinations_create_topic.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DestinationId'
      - in: body
        name: body
        description: Destination body.
        schema:
          $ref: '#/definitions/Destination'
        required: true
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Destination'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      tags:
      - dataExport
    patch:
      operationId: microsoftAzureDestinationsUpdate
      summary: Microsoft Azure Patch A Destination
      description: Perform an incremental update to a destination.
      x-ms-examples:
        Update an webhook destination:
          $ref: ./examples/dataexports_destinations_update_webhook.json
      consumes:
      - application/json
      - application/merge-patch+json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DestinationId'
      - in: body
        name: body
        description: Destination patch body.
        schema:
          type: object
        required: true
      - $ref: '#/parameters/IfMatch'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Destination'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      tags:
      - dataExport
    delete:
      operationId: microsoftAzureDestinationsRemove
      summary: Microsoft Azure Delete A Destination
      x-ms-examples:
        Delete data export destination:
          $ref: ./examples/dataexports_destinations_delete.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DestinationId'
      responses:
        '204':
          description: Success
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      description: Needs a more full description created.
      tags:
      - dataExport
  /dataExport/destinations/{destinationId}/exports:
    get:
      operationId: microsoftAzureDestinationsListexports
      summary: Microsoft Azure List All Exports Connected To The Given Destination
      x-ms-examples:
        List all exports connected to the given destination:
          $ref: ./examples/dataexports_destinations_exports_list.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DestinationId'
      x-ms-pageable:
        nextLinkName: nextLink
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ExportCollection'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      description: Needs a more full description created.
      tags:
      - dataExport
  /dataExport/exports:
    get:
      operationId: microsoftAzureExportsList
      summary: Microsoft Azure Get The List Of Exports In An Application
      x-ms-examples:
        List data exports:
          $ref: ./examples/dataexports_exports_list.json
      parameters:
      - $ref: '#/parameters/Version'
      x-ms-pageable:
        nextLinkName: nextLink
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ExportCollection'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      description: Needs a more full description created.
      tags:
      - dataExport
  /dataExport/exports/{exportId}:
    get:
      operationId: microsoftAzureExportsGet
      summary: Microsoft Azure Get An Export By Id
      x-ms-examples:
        Get data export by ID:
          $ref: ./examples/dataexports_exports_get.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/ExportId'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Export'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      description: Needs a more full description created.
      tags:
      - dataExport
    put:
      operationId: microsoftAzureExportsCreate
      summary: Microsoft Azure Create Or Update An Export
      description: Create or update a definition for exporting data. Also used to connect or disconnect an export from destinations.
      x-ms-examples:
        Create data export with ID:
          $ref: ./examples/dataexports_exports_create.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/ExportId'
      - in: body
        name: body
        description: Export body.
        schema:
          $ref: '#/definitions/Export'
        required: true
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Export'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      tags:
      - dataExport
    patch:
      operationId: microsoftAzureExportsUpdate
      summary: Microsoft Azure Patch An Export
      description: Perform an incremental update to an export.
      x-ms-examples:
        Update a data export:
          $ref: ./examples/dataexports_exports_update.json
      consumes:
      - application/json
      - application/merge-patch+json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/ExportId'
      - in: body
        name: body
        description: Export patch body.
        schema:
          type: object
        required: true
      - $ref: '#/parameters/IfMatch'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Export'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      tags:
      - dataExport
    delete:
      operationId: microsoftAzureExportsRemove
      summary: Microsoft Azure Delete An Export
      x-ms-examples:
        Delete a data export with ID:
          $ref: ./examples/dataexports_exports_delete.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/ExportId'
      responses:
        '204':
          description: Success
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      description: Needs a more full description created.
      tags:
      - dataExport
  /dataExport/exports/{exportId}/destinations:
    get:
      operationId: microsoftAzureExportsListdestinations
      summary: Microsoft Azure List All Destinations Connected To The Given Export
      x-ms-examples:
        List all destinations in given export:
          $ref: ./examples/dataexports_exports_destinations_list.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/ExportId'
      x-ms-pageable:
        nextLinkName: nextLink
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DestinationCollection'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      description: Needs a more full description created.
      tags:
      - dataExport
definitions:
  DataExportStatus:
    description: The data export status definition.
    type: object
    properties:
      status:
        description: Indication of the current health and operation of the export or destination.
        type: string
        readOnly: true
      errors:
        description: Errors encountered by the export or destination.
        type: array
        items:
          $ref: '#/definitions/DataExportError'
        readOnly: true
      lastExportTime:
        description: The timestamp of the last message that was sent to the export or destination.
        type: string
        format: date-time
        readOnly: true
  DestinationReference:
    description: The destination reference definition.
    type: object
    properties:
      id:
        type: string
        description: The ID of the destination where data should be sent.
      transform:
        type: string
        description: Query for transforming the message structure to a particular output.
    required:
    - id
  Destination:
    description: The destination definition.
    allOf:
    - $ref: '#/definitions/DataExportStatus'
    type: object
    properties:
      id:
        description: Unique ID of the destination.
        type: string
        readOnly: true
      displayName:
        description: Display name of the destination.
        type: string
      type:
        description: The type of destination configuration.
        type: string
    required:
    - displayName
    - type
    discriminator: type
  ErrorDetails:
    description: The detail information of the error.
    type: object
    properties:
      code:
        type: string
        description: Error code.
      message:
        type: string
        description: Error message details.
      requestId:
        type: string
        description: Correlation Id for current request.
      time:
        type: string
        format: date-time-rfc1123
        description: The time that error request failed.
    required:
    - code
    - message
  DestinationCollection:
    description: The paged results of destinations.
    type: object
    properties:
      value:
        description: The collection of destinations.
        type: array
        items:
          $ref: '#/definitions/Destination'
      nextLink:
        description: URL to get the next page of destinations.
        type: string
    required:
    - value
  Export:
    description: The data export definition.
    allOf:
    - $ref: '#/definitions/DataExportStatus'
    type: object
    properties:
      id:
        description: Unique ID of the export.
        type: string
        readOnly: true
      displayName:
        description: Display name of the export.
        type: string
      enabled:
        description: Toggle to start/stop an export from sending data.
        type: boolean
      source:
        description: The type of data to export.
        type: string
        enum:
        - telemetry
        - properties
        - deviceLifecycle
        - deviceTemplateLifecycle
        - deviceConnectivity
        - audit
        x-ms-enum:
          name: DestinationSource
          modelAsString: true
          values:
          - value: telemetry
            name: Telemetry
            description: Destination source from device telemetry
          - value: properties
            name: Properties
            description: Destination source from device properties
          - value: deviceLifecycle
            name: DeviceLifecycle
            description: Destination source from device lifecycle
          - value: deviceTemplateLifecycle
            name: DeviceTemplateLifecycle
            description: Destination source from device template lifecycle
          - value: deviceConnectivity
            name: DeviceConnectivity
            description: Destination source from device connectivity
          - value: audit
            name: Audit
            description: Destination source from audit logs
      filter:
        description: Query defining which events from the source should be exported.
        type: string
      enrichments:
        description: Additional pieces of information to include with each sent message. Data is represented as a set of key/value pairs, where the key is the name of the enrichment that will appear in the output message and the value identifies the data to send.
        type: object
        additionalProperties:
          $ref: '#/definitions/Enrichment'
      destinations:
        description: The list of destinations to which the export should send data.
        type: array
        items:
          $ref: '#/definitions/DestinationReference'
    required:
    - displayName
    - enabled
    - source
    - destinations
  ExportCollection:
    description: The paged results of exports.
    type: object
    properties:
      value:
        description: The collection of exports.
        type: array
        items:
          $ref: '#/definitions/Export'
      nextLink:
        description: URL to get the next page of exports.
        type: string
    required:
    - value
  Enrichment:
    description: The enrichment definition for data export.
    type: object
    properties:
      target:
        description: The device template or interface which defines the target capability for the enrichment.
        type: string
      path:
        description: The path to the target capability within the device template or the system property to use.
        type: string
      value:
        description: The raw value used for the enrichment.
  DataExportError:
    description: The data export error definition.
    type: object
    properties:
      code:
        description: The code for the error that occurred.
        type: string
        readOnly: true
      message:
        description: The description of the error that occurred.
        type: string
        readOnly: true
  Error:
    description: The response error definition.
    type: object
    properties:
      error:
        description: Error details for current request.
        $ref: '#/definitions/ErrorDetails'
    required:
    - error
parameters:
  ExportId:
    in: path
    name: exportId
    description: Unique ID for the export.
    x-ms-parameter-location: method
    type: string
    required: true
  DestinationId:
    in: path
    name: destinationId
    description: Unique ID for the destination.
    x-ms-parameter-location: method
    type: string
    required: true
  Version:
    in: query
    name: api-version
    description: The version of the API being called.
    x-ms-parameter-location: client
    type: string
    required: true
  IfMatch:
    in: header
    name: If-Match
    description: Only perform the operation if the entity's etag matches one of the etags provided or * is provided.
    x-ms-parameter-location: method
    type: string
    required: false
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'