Microsoft Azure Track API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Track API
tags:
- name: Track
paths:
  /track:
    post:
      summary: Microsoft Azure Track Telemetry Events
      description: This operation sends a sequence of telemetry events that will be monitored by Azure Monitor.
      operationId: microsoftAzureTrack
      responses:
        '200':
          description: All of the telemetry items were accepted and processed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrackResponse'
        '206':
          description: Partial success. Some of the telemetry items were accepted and processed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrackResponse'
        '400':
          description: Bad Request
          x-ms-error-response: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrackResponse'
        '402':
          description: Payment Required
          x-ms-error-response: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrackResponse'
        '429':
          description: Too Many Requests
          x-ms-error-response: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrackResponse'
        '500':
          description: Internal Server Error
          x-ms-error-response: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrackResponse'
        '503':
          description: Service Unavailable
          x-ms-error-response: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrackResponse'
      x-ms-examples:
        Track examples:
          $ref: examples/track.json
      tags:
      - Track
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/TelemetryEnvelope'
          x-json-stream:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/TelemetryEnvelope'
        description: The list of telemetry events to track.
        required: true
components:
  schemas:
    ErrorDetails:
      x-ms-client-name: TelemetryErrorDetails
      description: The error details
      type: object
      properties:
        index:
          type: number
          format: int32
          description: The index in the original payload of the item.
        statusCode:
          type: number
          format: int32
          description: The item specific [HTTP Response status code](#Response Status Codes).
        message:
          type: string
          description: The error message.
    TrackResponse:
      description: Response containing the status of each telemetry item.
      type: object
      properties:
        itemsReceived:
          type: number
          format: int32
          description: The number of items received.
        itemsAccepted:
          type: number
          format: int32
          description: The number of items accepted.
        errors:
          type: array
          description: An array of error detail objects.
          items:
            $ref: '#/components/schemas/ErrorDetails'
    Base:
      x-ms-client-name: MonitorBase
      type: object
      description: Data struct to contain only C section with custom fields.
      properties:
        baseType:
          type: string
          description: Name of item (B section) if any. If telemetry data is derived straight from this, this should be null.
        baseData:
          $ref: '#/components/schemas/Domain'
          description: The data payload for the telemetry request
    Domain:
      x-ms-client-name: MonitorDomain
      type: object
      description: The abstract common base of all domains.
      required:
      - ver
      additionalProperties: true
      properties:
        ver:
          x-ms-client-name: version
          type: integer
          format: int32
          description: Schema version
          default: 2
    TelemetryEnvelope:
      x-ms-client-name: TelemetryItem
      description: System variables for a telemetry item.
      type: object
      required:
      - name
      - time
      properties:
        ver:
          type: number
          x-ms-client-name: version
          format: int32
          default: 1
          description: 'Envelope version. For internal use only. By assigning this the default, it will not be serialized within the payload unless changed to a value other than #1.'
        name:
          type: string
          description: Type name of telemetry data item.
        time:
          type: string
          format: date-time
          description: 'Event date time when telemetry item was created. This is the wall clock time on the client when the event was generated. There is no guarantee that the client''s time is accurate. This field must be formatted in UTC ISO 8601 format, with a trailing ''Z'' character, as described publicly on https://en.wikipedia.org/wiki/ISO_8601#UTC. Note: the number of decimal seconds digits provided are variable (and unspecified). Consumers should handle this, i.e. managed code consumers should not use format ''O'' for parsing as it specifies a fixed length. Example: 2009-06-15T13:45:30.0000000Z.'
        sampleRate:
          type: number
          format: float
          default: 100
          description: Sampling rate used in application. This telemetry item represents 100 / sampleRate actual telemetry items.
        seq:
          type: string
          x-ms-client-name: sequence
          maxLength: 64
          description: Sequence field used to track absolute order of uploaded events.
        iKey:
          type: string
          x-ms-client-name: instrumentationKey
          description: The instrumentation key of the Application Insights resource.
        tags:
          type: object
          description: Key/value collection of context properties. See ContextTagKeys for information on available properties.
          additionalProperties:
            type: string
        data:
          $ref: '#/components/schemas/Base'
          description: Telemetry data item.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'