Microsoft Azure AnomalyAlerting API

openapi: 3.2.0
info:
  title: Microsoft Azure Metrics Advisor Anomaly Alerting API
  description: Microsoft Azure Metrics Advisor REST API (OpenAPI v2)
  version: '1.0'
security:
- apim_key: []
  ma_api_key: []
tags:
- name: AnomalyAlerting
paths:
  /alert/anomaly/configurations/{configurationId}:
    get:
      tags:
      - AnomalyAlerting
      summary: Microsoft Azure Query A Single Anomaly Alerting Configuration
      operationId: microsoftAzureGetanomalyalertingconfiguration
      parameters:
      - in: path
        name: configurationId
        description: anomaly alerting configuration unique id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnomalyAlertingConfiguration'
        default:
          description: Client error or server error (4xx or 5xx)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCode'
      x-ms-examples:
        Query a single anomaly alerting configuration:
          $ref: ./examples/getAnomalyAlertingConfiguration.json
      description: Needs a more full description created.
    patch:
      tags:
      - AnomalyAlerting
      summary: Microsoft Azure Update Anomaly Alerting Configuration
      operationId: microsoftAzureUpdateanomalyalertingconfiguration
      parameters:
      - in: path
        name: configurationId
        description: anomaly alerting configuration unique id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnomalyAlertingConfiguration'
        default:
          description: Client error or server error (4xx or 5xx)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCode'
      x-ms-examples:
        Update anomaly alerting configuration:
          $ref: ./examples/updateAnomalyAlertingConfiguration.json
      description: Needs a more full description created.
      requestBody:
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/AnomalyAlertingConfigurationPatch'
        description: anomaly alerting configuration
        required: true
    delete:
      tags:
      - AnomalyAlerting
      summary: Microsoft Azure Delete Anomaly Alerting Configuration
      operationId: microsoftAzureDeleteanomalyalertingconfiguration
      parameters:
      - in: path
        name: configurationId
        description: anomaly alerting configuration unique id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: The resource is deleted successfully or does not exist.
        default:
          description: Client error or server error (4xx or 5xx)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCode'
      x-ms-examples:
        Delete anomaly alerting configuration:
          $ref: ./examples/deleteAnomalyAlertingConfiguration.json
      description: Needs a more full description created.
  /alert/anomaly/configurations:
    post:
      tags:
      - AnomalyAlerting
      summary: Microsoft Azure Create Anomaly Alerting Configuration
      operationId: microsoftAzureCreateanomalyalertingconfiguration
      responses:
        '201':
          description: Success
          headers:
            Location:
              description: Location of the newly created resource.
              schema:
                type: string
        default:
          description: Client error or server error (4xx or 5xx)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCode'
      x-ms-examples:
        Create anomaly alerting configuration:
          $ref: ./examples/createAnomalyAlertingConfiguration.json
      description: Needs a more full description created.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AnomalyAlertingConfiguration'
        description: anomaly alerting configuration
        required: true
  /alert/anomaly/configurations/{configurationId}/alerts/query:
    post:
      tags:
      - AnomalyAlerting
      summary: Microsoft Azure Query Alerts Under Anomaly Alerting Configuration
      operationId: microsoftAzureGetalertsbyanomalyalertingconfiguration
      parameters:
      - in: path
        name: configurationId
        description: anomaly alerting configuration unique id
        required: true
        schema:
          type: string
          format: uuid
      - in: query
        name: $skip
        description: for paging, skipped number
        schema:
          type: integer
          format: int32
      - in: query
        name: $maxpagesize
        description: the maximum number of items in one page
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertResultList'
        default:
          description: Client error or server error (4xx or 5xx)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCode'
      x-ms-pageable:
        nextLinkName: '@nextLink'
      x-ms-examples:
        Query alerts under anomaly alerting configuration:
          $ref: ./examples/getAlertsByAnomalyAlertingConfiguration.json
      description: Needs a more full description created.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertingResultQuery'
        description: query alerting result request
        required: true
  /alert/anomaly/configurations/{configurationId}/alerts/{alertId}/anomalies:
    get:
      tags:
      - AnomalyAlerting
      summary: Microsoft Azure Query Anomalies Under A Specific Alert
      operationId: microsoftAzureGetanomaliesfromalertbyanomalyalertingconfiguration
      parameters:
      - in: path
        name: configurationId
        description: anomaly alerting configuration unique id
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: alertId
        description: alert id
        required: true
        schema:
          type: string
      - in: query
        name: $skip
        description: for paging, skipped number
        schema:
          type: integer
          format: int32
      - in: query
        name: $maxpagesize
        description: the maximum number of items in one page
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnomalyResultList'
        default:
          description: Client error or server error (4xx or 5xx)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCode'
      x-ms-pageable:
        nextLinkName: '@nextLink'
      x-ms-examples:
        Query anomalies under a specific alert:
          $ref: ./examples/getAnomaliesFromAlertByAnomalyAlertingConfiguration.json
      description: Needs a more full description created.
  /alert/anomaly/configurations/{configurationId}/alerts/{alertId}/incidents:
    get:
      tags:
      - AnomalyAlerting
      summary: Microsoft Azure Query Incidents Under A Specific Alert
      operationId: microsoftAzureGetincidentsfromalertbyanomalyalertingconfiguration
      parameters:
      - in: path
        name: configurationId
        description: anomaly alerting configuration unique id
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: alertId
        description: alert id
        required: true
        schema:
          type: string
      - in: query
        name: $skip
        description: for paging, skipped number
        schema:
          type: integer
          format: int32
      - in: query
        name: $maxpagesize
        description: the maximum number of items in one page
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IncidentResultList'
        default:
          description: Client error or server error (4xx or 5xx)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCode'
      x-ms-pageable:
        nextLinkName: '@nextLink'
      x-ms-examples:
        Query incidents under a specific alert:
          $ref: ./examples/getIncidentsFromAlertByAnomalyAlertingConfiguration.json
      description: Needs a more full description created.
components:
  schemas:
    AnomalyResult:
      required:
      - dimension
      - property
      - timestamp
      type: object
      properties:
        dataFeedId:
          format: uuid
          description: 'data feed unique id


            only return for alerting anomaly result'
          type: string
          readOnly: true
        metricId:
          format: uuid
          description: 'metric unique id


            only return for alerting anomaly result'
          type: string
          readOnly: true
        anomalyDetectionConfigurationId:
          format: uuid
          description: 'anomaly detection configuration unique id


            only return for alerting anomaly result'
          type: string
          readOnly: true
        timestamp:
          format: date-time
          description: anomaly time
          type: string
        createdTime:
          format: date-time
          description: 'created time


            only return for alerting result'
          type: string
          readOnly: true
        modifiedTime:
          format: date-time
          description: 'modified time


            only return for alerting result'
          type: string
          readOnly: true
        dimension:
          description: dimension specified for series
          type: object
          additionalProperties:
            type: string
        property:
          $ref: '#/components/schemas/AnomalyProperty'
    SeverityCondition:
      required:
      - maxAlertSeverity
      - minAlertSeverity
      type: object
      properties:
        minAlertSeverity:
          description: min alert severity
          enum:
          - Low
          - Medium
          - High
          type: string
          x-ms-enum:
            name: Severity
            modelAsString: true
        maxAlertSeverity:
          description: max alert severity
          enum:
          - Low
          - Medium
          - High
          type: string
          x-ms-enum:
            name: Severity
            modelAsString: true
    AnomalyResultList:
      required:
      - value
      type: object
      properties:
        '@nextLink':
          type: string
          readOnly: true
        value:
          type: array
          items:
            $ref: '#/components/schemas/AnomalyResult'
    ErrorCode:
      type: object
      properties:
        message:
          type: string
        code:
          type: string
    AnomalyProperty:
      required:
      - anomalySeverity
      type: object
      properties:
        anomalySeverity:
          description: anomaly severity
          enum:
          - Low
          - Medium
          - High
          type: string
          x-ms-enum:
            name: Severity
            modelAsString: true
        anomalyStatus:
          description: 'anomaly status


            only return for alerting anomaly result'
          enum:
          - Active
          - Resolved
          type: string
          readOnly: true
          x-ms-enum:
            name: AnomalyStatus
            modelAsString: true
        value:
          format: double
          description: value of the anomaly
          type: number
          readOnly: true
        expectedValue:
          format: double
          description: expected value of the anomaly given by smart detector
          type: number
          readOnly: true
    AlertSnoozeCondition:
      required:
      - autoSnooze
      - onlyForSuccessive
      - snoozeScope
      type: object
      properties:
        autoSnooze:
          format: int32
          description: 'snooze point count, value range : [0, +∞)'
          type: integer
        snoozeScope:
          description: snooze scope
          enum:
          - Metric
          - Series
          type: string
          x-ms-enum:
            name: SnoozeScope
            modelAsString: true
        onlyForSuccessive:
          description: only snooze for successive anomalies
          type: boolean
    MetricAlertingConfiguration:
      required:
      - anomalyDetectionConfigurationId
      - anomalyScopeType
      type: object
      properties:
        anomalyDetectionConfigurationId:
          format: uuid
          description: Anomaly detection configuration unique id
          type: string
        anomalyScopeType:
          description: Anomaly scope
          enum:
          - All
          - Dimension
          - TopN
          type: string
          example: All
          x-ms-enum:
            name: AnomalyScope
            modelAsString: true
        negationOperation:
          description: Negation operation
          default: false
          type: boolean
        dimensionAnomalyScope:
          $ref: '#/components/schemas/DimensionGroupIdentity'
        topNAnomalyScope:
          $ref: '#/components/schemas/TopNGroupScope'
        severityFilter:
          $ref: '#/components/schemas/SeverityCondition'
        snoozeFilter:
          $ref: '#/components/schemas/AlertSnoozeCondition'
        valueFilter:
          $ref: '#/components/schemas/ValueCondition'
    IncidentResult:
      required:
      - incidentId
      - lastTime
      - property
      - rootNode
      - startTime
      type: object
      properties:
        dataFeedId:
          format: uuid
          description: 'data feed unique id


            only return for alerting anomaly result'
          type: string
          readOnly: true
        metricId:
          format: uuid
          description: 'metric unique id


            only return for alerting incident result'
          type: string
          readOnly: true
        anomalyDetectionConfigurationId:
          format: uuid
          description: 'anomaly detection configuration unique id


            only return for alerting incident result'
          type: string
          readOnly: true
        incidentId:
          description: incident id
          type: string
        startTime:
          format: date-time
          description: incident start time
          type: string
        lastTime:
          format: date-time
          description: incident last time
          type: string
        rootNode:
          $ref: '#/components/schemas/SeriesIdentity'
        property:
          $ref: '#/components/schemas/IncidentProperty'
    IncidentProperty:
      required:
      - maxSeverity
      type: object
      properties:
        maxSeverity:
          description: max severity of latest anomalies in the incident
          enum:
          - Low
          - Medium
          - High
          type: string
          x-ms-enum:
            name: Severity
            modelAsString: true
        incidentStatus:
          description: 'incident status


            only return for alerting incident result'
          enum:
          - Active
          - Resolved
          type: string
          readOnly: true
          x-ms-enum:
            name: IncidentStatus
            modelAsString: true
        valueOfRootNode:
          format: double
          description: value of the root node
          type: number
          readOnly: true
        expectedValueOfRootNode:
          format: double
          description: expected value of the root node given by smart detector
          type: number
          readOnly: true
    AlertResultList:
      required:
      - value
      type: object
      properties:
        '@nextLink':
          type: string
          readOnly: true
        value:
          type: array
          items:
            $ref: '#/components/schemas/AlertResult'
    AlertResult:
      type: object
      properties:
        alertId:
          description: alert id
          type: string
          readOnly: true
        timestamp:
          format: date-time
          description: anomaly time
          type: string
          readOnly: true
        createdTime:
          format: date-time
          description: created time
          type: string
          readOnly: true
        modifiedTime:
          format: date-time
          description: modified time
          type: string
          readOnly: true
    AlertingResultQuery:
      required:
      - endTime
      - startTime
      - timeMode
      type: object
      properties:
        startTime:
          format: date-time
          description: start time
          type: string
        endTime:
          format: date-time
          description: end time
          type: string
        timeMode:
          description: time mode
          enum:
          - AnomalyTime
          - CreatedTime
          - ModifiedTime
          type: string
          x-ms-enum:
            name: TimeMode
            modelAsString: true
      example:
        startTime: '2020-01-01T00:00:00Z'
        endTime: '2020-02-01T00:00:00Z'
        timeMode: AnomalyTime
    TopNGroupScope:
      required:
      - minTopCount
      - period
      - top
      type: object
      properties:
        top:
          format: int32
          description: 'top N, value range : [1, +∞)'
          type: integer
        period:
          format: int32
          description: 'point count used to look back, value range : [1, +∞)'
          type: integer
        minTopCount:
          format: int32
          description: 'min count should be in top N, value range : [1, +∞)


            should be less than or equal to period'
          type: integer
    AnomalyAlertingConfigurationPatch:
      type: object
      properties:
        name:
          description: Anomaly alerting configuration name
          type: string
        description:
          description: anomaly alerting configuration description
          default: ''
          type: string
        crossMetricsOperator:
          description: cross metrics operator
          enum:
          - AND
          - OR
          - XOR
          type: string
          x-ms-enum:
            name: AnomalyAlertingConfigurationLogicType
            modelAsString: true
        splitAlertByDimensions:
          description: dimensions used to split alert
          uniqueItems: true
          type: array
          items:
            type: string
        hookIds:
          description: hook unique ids
          uniqueItems: true
          type: array
          items:
            format: uuid
            type: string
        metricAlertingConfigurations:
          description: Anomaly alerting configurations
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/MetricAlertingConfiguration'
      example:
        name: alerting configuration name
        description: this is an anomaly alerting configuration
        crossMetricsOperator: AND
        hookIds:
        - 00000000-0000-0000-0000-000000000001
        metricAlertingConfigurations:
        - anomalyDetectionConfigurationId: 33333333-3333-3333-3333-000000000001
          anomalyScopeType: All
          negationOperation: false
          severityFilter:
            minAlertSeverity: Medium
            maxAlertSeverity: High
          snoozeFilter:
            autoSnooze: 0
            snoozeScope: Series
            onlyForSuccessive: true
        - anomalyDetectionConfigurationId: 33333333-3333-3333-3333-000000000002
          anomalyScopeType: Dimension
          negationOperation: false
          dimensionAnomalyScope:
            dimension:
              city: Beijing
          severityFilter:
            minAlertSeverity: Low
            maxAlertSeverity: High
          snoozeFilter:
            autoSnooze: 0
            snoozeScope: Series
            onlyForSuccessive: true
          valueFilter:
            lower: 0
            upper: 1000
            direction: Both
    SeriesIdentity:
      required:
      - dimension
      type: object
      properties:
        dimension:
          description: dimension specified for series
          type: object
          additionalProperties:
            type: string
    AnomalyAlertingConfiguration:
      required:
      - hookIds
      - metricAlertingConfigurations
      - name
      type: object
      properties:
        anomalyAlertingConfigurationId:
          format: uuid
          description: anomaly alerting configuration unique id
          type: string
          readOnly: true
        name:
          description: anomaly alerting configuration name
          type: string
        description:
          description: anomaly alerting configuration description
          default: ''
          type: string
        crossMetricsOperator:
          description: 'cross metrics operator


            should be specified when setting up multiple metric alerting configurations'
          enum:
          - AND
          - OR
          - XOR
          type: string
          x-ms-enum:
            name: AnomalyAlertingConfigurationLogicType
            modelAsString: true
        splitAlertByDimensions:
          description: dimensions used to split alert
          uniqueItems: true
          type: array
          items:
            type: string
        hookIds:
          description: hook unique ids
          uniqueItems: true
          type: array
          items:
            format: uuid
            type: string
        metricAlertingConfigurations:
          description: Anomaly alerting configurations
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/MetricAlertingConfiguration'
      example:
        name: alerting configuration name
        crossMetricsOperator: AND
        hookIds:
        - 00000000-0000-0000-0000-000000000001
        metricAlertingConfigurations:
        - anomalyDetectionConfigurationId: 33333333-3333-3333-3333-000000000001
          anomalyScopeType: All
          negationOperation: false
          severityFilter:
            minAlertSeverity: Medium
            maxAlertSeverity: High
          snoozeFilter:
            autoSnooze: 0
            snoozeScope: Series
            onlyForSuccessive: true
        - anomalyDetectionConfigurationId: 33333333-3333-3333-3333-000000000002
          anomalyScopeType: Dimension
          negationOperation: false
          dimensionAnomalyScope:
            dimension:
              city: Beijing
          severityFilter:
            minAlertSeverity: Low
            maxAlertSeverity: High
          snoozeFilter:
            autoSnooze: 0
            snoozeScope: Series
            onlyForSuccessive: true
          valueFilter:
            lower: 0
            upper: 1000
            direction: Both
            type: Value
    ValueCondition:
      required:
      - direction
      type: object
      properties:
        lower:
          format: double
          description: 'lower bound


            should be specified when direction is Both or Down'
          type: number
        upper:
          format: double
          description: 'upper bound


            should be specified when direction is Both or Up'
          type: number
        direction:
          description: value filter direction
          enum:
          - Both
          - Down
          - Up
          type: string
          x-ms-enum:
            name: Direction
            modelAsString: true
        type:
          description: data used to implement value filter
          default: Value
          enum:
          - Value
          - Mean
          type: string
          x-ms-enum:
            name: ValueType
            modelAsString: true
        metricId:
          format: uuid
          description: the other metric unique id used for value filter
          type: string
        triggerForMissing:
          description: 'trigger alert when the corresponding point is missing in the other metric


            should be specified only when using other metric to filter'
          type: boolean
    IncidentResultList:
      required:
      - value
      type: object
      properties:
        '@nextLink':
          type: string
          readOnly: true
        value:
          type: array
          items:
            $ref: '#/components/schemas/IncidentResult'
    DimensionGroupIdentity:
      required:
      - dimension
      type: object
      properties:
        dimension:
          description: dimension specified for series group
          type: object
          additionalProperties:
            type: string
  securitySchemes:
    ma_api_key:
      type: apiKey
      name: x-api-key
      in: header
    apim_key:
      type: apiKey
      name: Ocp-Apim-Subscription-Key
      in: header
x-ms-parameterized-host:
  hostTemplate: '{endpoint}/metricsadvisor/v1.0'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'