Microsoft Azure Data Export API

openapi: 3.2.0
info:
  title: Microsoft Azure Azure IoT Central Data Export API
  description: Azure IoT Central is a service that makes it easy to connect, monitor, and manage your IoT devices at scale.
  version: 2022-10-31-preview
servers:
- url: /api
security:
- azure_auth:
  - user_impersonation
tags:
- name: Data Export
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: '#/components/parameters/Version'
      x-ms-pageable:
        nextLinkName: nextLink
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DestinationCollection'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              description: Error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      description: Needs a more full description created.
      tags:
      - Data Export
  /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: '#/components/parameters/Version'
      - $ref: '#/components/parameters/DestinationId'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Destination'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              description: Error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      description: Needs a more full description created.
      tags:
      - Data Export
    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: '#/components/parameters/Version'
      - $ref: '#/components/parameters/DestinationId'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Destination'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              description: Error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Data Export
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Destination'
        description: Destination body.
        required: true
    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
      parameters:
      - $ref: '#/components/parameters/Version'
      - $ref: '#/components/parameters/DestinationId'
      - $ref: '#/components/parameters/IfMatch'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Destination'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              description: Error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Data Export
      requestBody:
        content:
          application/json:
            schema:
              type: object
          application/merge-patch+json:
            schema:
              type: object
        description: Destination patch body.
        required: true
    delete:
      operationId: microsoftAzureDestinationsRemove
      summary: Microsoft Azure Delete A Destination
      x-ms-examples:
        Delete data export destination:
          $ref: ./examples/dataexports_destinations_delete.json
      parameters:
      - $ref: '#/components/parameters/Version'
      - $ref: '#/components/parameters/DestinationId'
      responses:
        '204':
          description: Success
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              description: Error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      description: Needs a more full description created.
      tags:
      - Data Export
  /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: '#/components/parameters/Version'
      - $ref: '#/components/parameters/DestinationId'
      x-ms-pageable:
        nextLinkName: nextLink
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportCollection'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              description: Error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      description: Needs a more full description created.
      tags:
      - Data Export
  /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: '#/components/parameters/Version'
      x-ms-pageable:
        nextLinkName: nextLink
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportCollection'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              description: Error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      description: Needs a more full description created.
      tags:
      - Data Export
  /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: '#/components/parameters/Version'
      - $ref: '#/components/parameters/ExportId'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Export'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              description: Error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      description: Needs a more full description created.
      tags:
      - Data Export
    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: '#/components/parameters/Version'
      - $ref: '#/components/parameters/ExportId'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Export'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              description: Error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Data Export
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Export'
        description: Export body.
        required: true
    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
      parameters:
      - $ref: '#/components/parameters/Version'
      - $ref: '#/components/parameters/ExportId'
      - $ref: '#/components/parameters/IfMatch'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Export'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              description: Error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Data Export
      requestBody:
        content:
          application/json:
            schema:
              type: object
          application/merge-patch+json:
            schema:
              type: object
        description: Export patch body.
        required: true
    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: '#/components/parameters/Version'
      - $ref: '#/components/parameters/ExportId'
      responses:
        '204':
          description: Success
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              description: Error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      description: Needs a more full description created.
      tags:
      - Data Export
  /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: '#/components/parameters/Version'
      - $ref: '#/components/parameters/ExportId'
      x-ms-pageable:
        nextLinkName: nextLink
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DestinationCollection'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              description: Error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      description: Needs a more full description created.
      tags:
      - Data Export
components:
  parameters:
    DestinationId:
      in: path
      name: destinationId
      description: Unique ID for the destination.
      x-ms-parameter-location: method
      required: true
      schema:
        type: string
    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
      required: false
      schema:
        type: string
    Version:
      in: query
      name: api-version
      description: The version of the API being called.
      x-ms-parameter-location: client
      required: true
      schema:
        type: string
    ExportId:
      in: path
      name: exportId
      description: Unique ID for the export.
      x-ms-parameter-location: method
      required: true
      schema:
        type: string
  schemas:
    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
    Destination:
      description: The destination definition.
      allOf:
      - $ref: '#/components/schemas/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:
        propertyName: type
    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
    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
    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.
    Error:
      description: The response error definition.
      type: object
      properties:
        error:
          description: Error details for current request.
          $ref: '#/components/schemas/ErrorDetails'
      required:
      - error
    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: '#/components/schemas/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
    Export:
      description: The data export definition.
      allOf:
      - $ref: '#/components/schemas/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: '#/components/schemas/Enrichment'
        destinations:
          description: The list of destinations to which the export should send data.
          type: array
          items:
            $ref: '#/components/schemas/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: '#/components/schemas/Export'
        nextLink:
          description: URL to get the next page of exports.
          type: string
      required:
      - value
    DestinationCollection:
      description: The paged results of destinations.
      type: object
      properties:
        value:
          description: The collection of destinations.
          type: array
          items:
            $ref: '#/components/schemas/Destination'
        nextLink:
          description: URL to get the next page of destinations.
          type: string
      required:
      - value
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow
x-ms-parameterized-host:
  hostTemplate: '{subdomain}.{baseDomain}'
  parameters:
  - $ref: '#/components/parameters/BaseDomain'
  - $ref: '#/components/parameters/Subdomain'