Microsoft Azure Events API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Events API
tags:
- name: Events
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/migrateEvents
  : get:
      tags:
      - Events
      summary: Microsoft Azure Gets A List Of Events In The Migrate Project
      operationId: microsoftAzureEventsEnumerateevents
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - $ref: '#/components/parameters/migrateProjectName'
      - $ref: '#/components/parameters/api-version'
      - $ref: '#/components/parameters/continuationToken'
      - $ref: '#/components/parameters/pageSize'
      - $ref: '#/components/parameters/acceptLanguage'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventCollection'
      deprecated: false
      x-ms-examples:
        MigrateEvents_List:
          $ref: ./examples/MigrateEvents_List.json
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/migrateEvents/{eventName}
  : get:
      tags:
      - Events
      summary: Microsoft Azure Gets An Event In The Migrate Project
      operationId: microsoftAzureEventsGetevent
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - $ref: '#/components/parameters/migrateProjectName'
      - $ref: '#/components/parameters/api-version'
      - $ref: '#/components/parameters/eventName'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MigrateEvent'
      deprecated: false
      x-ms-examples:
        MigrateEvents_Get:
          $ref: ./examples/MigrateEvents_Get.json
      description: Needs a more full description created.
    delete:
      tags:
      - Events
      summary: Microsoft Azure Delete The Migrate Event
      description: Delete the migrate event. Deleting non-existent migrate event is a no-operation.
      operationId: microsoftAzureEventsDeleteevent
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - $ref: '#/components/parameters/migrateProjectName'
      - $ref: '#/components/parameters/api-version'
      - $ref: '#/components/parameters/eventName'
      responses:
        '200':
          description: OK
      deprecated: false
      x-ms-examples:
        MigrateEvents_Delete:
          $ref: ./examples/MigrateEvents_Delete.json
  /subscriptions/{subscriptionId}/providers/Microsoft.ResourceHealth/events:
    get:
      tags:
      - Events
      operationId: microsoftAzureEventsListbysubscriptionid
      description: Lists service health events in the subscription.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: '#/components/parameters/FilterParameter'
      - $ref: '#/components/parameters/QueryStartTimeParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: The list of current service health events in the subscription
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/events'
        default:
          description: DefaultErrorResponse
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        ListEventsBySubscriptionId:
          $ref: ./examples/Events_ListBySubscriptionId.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Resourcehealth Events
  /providers/Microsoft.ResourceHealth/events:
    get:
      tags:
      - Events
      operationId: microsoftAzureEventsListbytenantid
      description: Lists current service health events in the tenant.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: '#/components/parameters/FilterParameter'
      - $ref: '#/components/parameters/QueryStartTimeParameter'
      responses:
        '200':
          description: The list of service health events in the tenant
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/events'
        default:
          description: DefaultErrorResponse
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        ListEventsByTenantId:
          $ref: ./examples/Events_ListByTenantId.json
      summary: Microsoft Azure Get Providers Microsoft Resourcehealth Events
  /{resourceUri}/providers/Microsoft.ResourceHealth/events:
    get:
      tags:
      - Events
      operationId: microsoftAzureEventsListbysingleresource
      description: Lists current service health events for given resource.
      parameters:
      - name: resourceUri
        in: path
        required: true
        description: 'The fully qualified ID of the resource, including the resource name and resource type. Currently the API support not nested and one nesting level resource types : /subscriptions/{subscriptionId}/resourceGroups/{resource-group-name}/providers/{resource-provider-name}/{resource-type}/{resource-name} and /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName}'
        x-ms-skip-url-encoding: true
        schema:
          type: string
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: '#/components/parameters/FilterParameter'
      responses:
        '200':
          description: The list of current service health events for given resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/events'
        default:
          description: DefaultErrorResponse
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        ListEventsBySingleResource:
          $ref: ./examples/Events_ListBySingleResource.json
      summary: Microsoft Azure Get Resourceuri Providers Microsoft Resourcehealth Events
  /events/{eventId}/reward:
    post:
      tags:
      - Events
      summary: Microsoft Azure Post Reward
      description: Report reward between 0 and 1 that resulted from using the action specified in rewardActionId, for the specified event.
      operationId: microsoftAzureEventsReward
      parameters:
      - name: eventId
        in: path
        description: The event id this reward applies to.
        required: true
        schema:
          type: string
          maxLength: 256
      responses:
        '204':
          description: Success
        default:
          description: Invalid reward request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
      x-ms-examples:
        Successful Events_Reward request:
          $ref: ./examples/Events_Reward.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RewardRequest'
        description: The reward should be a floating point number, typically between 0 and 1.
        required: true
  /events/{eventId}/activate:
    post:
      tags:
      - Events
      summary: Microsoft Azure Activate Event
      description: Report that the specified event was actually used (e.g. by being displayed to the user) and a reward should be expected for it.
      operationId: microsoftAzureEventsActivate
      parameters:
      - name: eventId
        in: path
        description: The event ID to be activated.
        required: true
        schema:
          type: string
          maxLength: 256
      responses:
        '204':
          description: Success
        default:
          description: Invalid activate event request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
      x-ms-examples:
        Successful Events_Activate request:
          $ref: ./examples/Events_Activate.json
  ? /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/batch/events
  : post:
      tags:
      - Events
      summary: Microsoft Azure Batch Post Event Data
      description: Post event data to a specific Run Id.
      operationId: microsoftAzureEventsBatchpost
      parameters:
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/workspaceNameParameter'
      - name: experimentName
        in: path
        description: The experiment name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The batch of Events is posted successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchEventCommandResult'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_6'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchEventCommand'
        description: The batch of Event details.
  ? /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/events
  : post:
      tags:
      - Events
      summary: Microsoft Azure Post Event Data
      description: Post event data to a specific Run Id.
      operationId: microsoftAzureEventsPost
      parameters:
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/workspaceNameParameter'
      - name: experimentName
        in: path
        description: The experiment name.
        required: true
        schema:
          type: string
      - name: runId
        in: path
        description: The identifier of the Run.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The Event is posted successfully.
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_6'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BaseEvent'
        description: The Event details.
components:
  parameters:
    migrateProjectName:
      name: migrateProjectName
      description: Name of the Azure Migrate project.
      in: path
      x-ms-parameter-location: method
      required: true
      schema:
        type: string
    continuationToken:
      name: continuationToken
      description: The continuation token.
      in: query
      required: false
      x-ms-parameter-location: method
      schema:
        type: string
    subscriptionId:
      name: subscriptionId
      description: Azure Subscription Id in which migrate project was created.
      in: path
      required: true
      schema:
        type: string
    pageSize:
      name: pageSize
      description: The number of items to be returned in a single page. This value is honored only if it is less than the 100.
      in: query
      required: false
      x-ms-parameter-location: method
      schema:
        type: integer
    eventName:
      name: eventName
      description: Unique name of an event within a migrate project.
      in: path
      x-ms-parameter-location: method
      required: true
      schema:
        type: string
    resourceGroupNameParameter:
      name: resourceGroupName
      in: path
      description: The Name of the resource group in which the workspace is located.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    resourceGroupName:
      name: resourceGroupName
      description: Name of the Azure Resource Group that migrate project is part of.
      in: path
      x-ms-parameter-location: method
      required: true
      schema:
        type: string
    workspaceNameParameter:
      name: workspaceName
      in: path
      description: The name of the workspace.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    acceptLanguage:
      description: Standard request header. Used by service to respond to client in appropriate language.
      name: Accept-Language
      in: header
      x-ms-parameter-location: client
      schema:
        type: string
    QueryStartTimeParameter:
      name: queryStartTime
      in: query
      required: false
      description: Specifies from when to return events, based on the lastUpdateTime property. For example, queryStartTime = 7/24/2020 OR queryStartTime=7%2F24%2F2020
      x-ms-parameter-location: method
      schema:
        type: string
    subscriptionIdParameter:
      name: subscriptionId
      in: path
      description: The Azure Subscription ID.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        format: uuid
    api-version:
      name: api-version
      description: Standard request header. Used by service to identify API version used by client.
      in: query
      required: true
      schema:
        type: string
        enum:
        - 2018-09-01-preview
    FilterParameter:
      name: $filter
      in: query
      required: false
      description: The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN
      x-ms-parameter-location: method
      schema:
        type: string
  schemas:
    event:
      type: object
      description: Service health event
      properties:
        properties:
          x-ms-client-flatten: true
          type: object
          description: Properties of event.
          properties:
            eventType:
              type: string
              description: Type of event.
              enum:
              - ServiceIssue
              - PlannedMaintenance
              - HealthAdvisory
              - RCA
              - EmergingIssues
              - SecurityAdvisory
              x-ms-enum:
                name: EventTypeValues
                modelAsString: true
            eventSubType:
              type: string
              description: Sub type of the event. Currently used to determine retirement communications for health advisory events
              enum:
              - Retirement
              x-ms-enum:
                name: EventSubTypeValues
                modelAsString: true
            eventSource:
              type: string
              description: Source of event.
              enum:
              - ResourceHealth
              - ServiceHealth
              x-ms-enum:
                name: EventSourceValues
                modelAsString: true
            status:
              type: string
              description: Current status of event.
              enum:
              - Active
              - Resolved
              x-ms-enum:
                name: EventStatusValues
                modelAsString: true
            title:
              type: string
              description: Title text of event.
            summary:
              type: string
              description: Summary text of event.
            header:
              type: string
              description: Header text of event.
            level:
              type: string
              description: Level of insight.
              enum:
              - Critical
              - Warning
              x-ms-enum:
                name: LevelValues
                modelAsString: true
            eventLevel:
              type: string
              description: Level of event.
              enum:
              - Critical
              - Error
              - Warning
              - Informational
              x-ms-enum:
                name: EventLevelValues
                modelAsString: true
            externalIncidentId:
              type: string
              description: The id of the Incident
            reason:
              type: string
              description: The reason for the Incident
            article:
              type: object
              description: Article of event.
              properties:
                articleContent:
                  type: string
                  description: Article content of event.
                articleId:
                  type: string
                  description: Article Id
                parameters:
                  type: object
                  description: It provides a map of parameter name and value
            links:
              type: array
              x-ms-identifiers: []
              description: Useful links of event.
              items:
                $ref: '#/components/schemas/link'
            impactStartTime:
              type: string
              description: It provides the Timestamp for when the health impacting event started.
              format: date-time
            impactMitigationTime:
              type: string
              description: It provides the Timestamp for when the health impacting event resolved.
              format: date-time
            impact:
              type: array
              x-ms-identifiers: []
              description: List services impacted by the service health event.
              items:
                $ref: '#/components/schemas/impact'
            recommendedActions:
              type: object
              description: Recommended actions of event.
              properties:
                message:
                  type: string
                  description: Recommended action title for the service health event.
                actions:
                  type: array
                  x-ms-identifiers: []
                  description: Recommended actions for the service health event.
                  items:
                    type: object
                    description: Recommended action for the service health event.
                    properties:
                      groupId:
                        type: integer
                        format: int32
                        description: Recommended action group Id for the service health event.
                      actionText:
                        type: string
                        description: Recommended action text
                localeCode:
                  type: string
                  description: Recommended action locale for the service health event.
            faqs:
              type: array
              x-ms-identifiers: []
              description: Frequently asked questions for the service health event.
              items:
                $ref: '#/components/schemas/faq'
            isHIR:
              type: boolean
              description: It provides information if the event is High incident rate event or not.
            enableMicrosoftSupport:
              type: boolean
              description: Tells if we want to enable or disable Microsoft Support for this event.
            description:
              type: string
              description: Contains the communication message for the event, that could include summary, root cause and other details.
            platformInitiated:
              type: boolean
              description: Is true if the event is platform initiated.
            enableChatWithUs:
              type: boolean
              description: Tells if we want to enable or disable Microsoft Support for this event.
            priority:
              type: integer
              format: int32
              description: Priority level of the event. Has value from 0 to 23. 0 is the highest priority. Service issue events have higher priority followed by planned maintenance and health advisory. Critical events have higher priority followed by error, warning and informational. Furthermore, active events have higher priority than resolved.
            lastUpdateTime:
              type: string
              description: It provides the Timestamp for when the health impacting event was last updated.
              format: date-time
            hirStage:
              type: string
              description: Stage for HIR Document
            additionalInformation:
              type: object
              description: Additional information
              properties:
                message:
                  type: string
                  description: Additional information Message
            duration:
              type: integer
              description: duration in seconds
              format: int32
            impactType:
              type: string
              description: The type of the impact
            maintenanceId:
              type: string
              description: Unique identifier for planned maintenance event.
            maintenanceType:
              type: string
              description: The type of planned maintenance event.
            argQuery:
              type: string
              description: Azure Resource Graph query to fetch the affected resources from their existing Azure Resource Graph locations.
      allOf:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource
    ErrorResponse_6:
      description: The error response.
      type: object
      properties:
        error:
          $ref: '#/components/schemas/RootError'
          description: The top level error that occurred.
        correlation:
          description: Dictionary containing correlation details for the error.
          type: object
          additionalProperties:
            type: string
        environment:
          description: The hosting environment.
          type: string
        location:
          description: The Azure region.
          type: string
        time:
          format: date-time
          description: The time in UTC.
          type: string
    InternalError:
      description: An object containing more specific information than the parent object about the error.
      type: object
      properties:
        code:
          description: Detailed error code.
          type: string
        innererror:
          $ref: '#/components/schemas/InternalError'
    MigrateEventProperties:
      description: Properties of the error resource.
      type: object
      properties:
        instanceType:
          description: Gets the Instance type.
          type: string
          readOnly: true
        errorCode:
          description: Gets or sets the error code.
          type: string
        errorMessage:
          description: Gets or sets the error message.
          type: string
        recommendation:
          description: Gets or sets the recommendation for the error.
          type: string
        possibleCauses:
          description: Gets or sets the possible causes for the error.
          type: string
        solution:
          description: Gets or sets the solution for which the error is being reported.
          type: string
        clientRequestId:
          description: Gets or sets the client request Id of the payload for which the event is being reported.
          type: string
      discriminator:
        propertyName: instanceType
    InnerErrorResponse:
      description: A nested structure of errors.
      type: object
      properties:
        code:
          description: The error code.
          type: string
        innerError:
          $ref: '#/components/schemas/InnerErrorResponse'
          description: A nested list of inner errors. When evaluating errors, clients MUST traverse through all of the nested “innerErrors” and choose the deepest one that they understand.
    ErrorResponse_2:
      description: Used to return an error to the client
      required:
      - error
      type: object
      properties:
        error:
          $ref: '#/components/schemas/PersonalizerError'
    update:
      type: object
      description: Update for service health event.
      properties:
        summary:
          type: string
          description: Summary text for the given update for the service health event.
        updateDateTime:
          type: string
          description: It provides the Timestamp for the given update for the service health event.
          format: date-time
    KeyValuePairBaseEventErrorResponse:
      type: object
      properties:
        key:
          $ref: '#/components/schemas/BaseEvent'
          readOnly: true
        value:
          $ref: '#/components/schemas/ErrorResponse_6'
          readOnly: true
    BatchEventCommandResult:
      type: object
      properties:
        errors:
          uniqueItems: false
          type: array
          items:
            $ref: '#/components/schemas/KeyValuePairBaseEventErrorResponse'
    BatchEventCommand:
      type: object
      properties:
        events:
          uniqueItems: false
          type: array
          items:
            $ref: '#/components/schemas/BaseEvent'
    ErrorDetails:
      description: The error details.
      type: object
      properties:
        code:
          description: The error code.
          type: string
        message:
          description: The error message.
          type: string
        target:
          description: The target of the error (e.g., the name of the property in error).
          type: string
    RewardRequest:
      description: Reward given to a rank response.
      required:
      - value
      type: object
      properties:
        value:
          format: float
          description: Reward to be assigned to an action. Value is a float calculated by your application, typically between 0 and 1, and must be between -1 and 1.
          type: number
    events:
      type: object
      properties:
        value:
          type: array
          x-ms-identifiers: []
          items:
            $ref: '#/components/schemas/event'
          description: The list of event.
        nextLink:
          type: string
          description: The URI to fetch the next page of events. Call ListNext() with this URI to fetch the next page of events.
      required:
      - value
      description: The List events operation response.
    impact:
      type: object
      description: Azure service impacted by the service health event.
      properties:
        impactedService:
          type: string
          description: Impacted service name.
        impactedRegions:
          type: array
          x-ms-identifiers: []
          description: List regions impacted by the service health event.
          items:
            $ref: '#/components/schemas/impactedServiceRegion'
    BaseEvent:
      description: Base event is the envelope used to post event data to the Event controller
      type: object
      properties:
        timestamp:
          format: date-time
          type: string
        name:
          type: string
        data:
          type: object
    ErrorResponse:
      description: Error details.
      type: object
      properties:
        code:
          description: The error code.
          type: string
          readOnly: true
        message:
          description: The error message.
          type: string
          readOnly: true
        details:
          description: The error details.
          type: string
          readOnly: true
    impactedServiceRegion:
      type: object
      description: Azure region impacted by the service health event.
      properties:
        impactedRegion:
          type: string
          description: Impacted region name.
        status:
          type: string
          description: Current status of event in the region.
          enum:
          - Active
          - Resolved
          x-ms-enum:
            name: EventStatusValues
            modelAsString: true
        impactedSubscriptions:
          type: array
          x-ms-identifiers: []
          description: List subscription impacted by the service health event.
          items:
            type: string
            description: Subscription impacted by the service health event.
        impactedTenants:
          type: array
          x-ms-identifiers: []
          description: List tenant impacted by the service health event.
          items:
            type: string
            description: Tenant impacted by the service health event.
        lastUpdateTime:
          type: string
          description: It provides the Timestamp for when the last update for the service health event.
          format: date-time
        updates:
          type: array
          x-ms-identifiers: []
          description: List of updates for given service health event.
          items:
            $ref: '#/components/schemas/update'
    PersonalizerError:
      description: The error object.
      required:
      - code
      - message
      type: object
      properties:
        code:
          description: Error Codes returned by Personalizer
          enum:
          - BadRequest
          - InvalidServiceConfiguration
          - InvalidLearningModeServiceConfiguration
          - InvalidPolicyConfiguration
          - InvalidPolicyContract
          - InvalidEvaluationContract
          - DuplicateCustomPolicyNames
          - NoLogsExistInDateRange
          - LogsSizeExceedAllowedLimit
          - InvalidRewardRequest
          - InvalidEventIdToActivate
          - InvalidRankRequest
          - InvalidExportLogsRequest
          - InvalidRequest
          - InvalidContainer
          - InvalidModelMetadata
          - ApprenticeModeNeverTurnedOn
          - MissingAppId
          - InvalidRewardWaitTime
          - InvalidMultiSlotApiAccess
          - ModelFileAccessDenied
          - ProblemTypeIncompatibleWithAutoOptimization
          - ResourceNotFound
          - FrontEndNotFound
          - EvaluationNotFound
          - LearningSettingsNotFound
          - EvaluationModelNotFound
          - LogsPropertiesNotFound
          - ModelRankingError
          - InternalServerError
          - RankNullResponse
          - UpdateConfigurationFailed
          - ModelResetFailed
          - ModelPublishFailed
          - ModelMetadataUpdateFailed
          - OperationNotAllowed
          type: string
          x-ms-enum:
            name: PersonalizerErrorCode
            modelAsString: true
            values:
            - value: BadRequest
              description: Request could not be understood by the server.
            - value: InvalidServiceConfiguration
              description: Invalid service configuration.
            - value: InvalidLearningModeServiceConfiguration
              description: Updating defaultReward, rewardWaitTime and rewardAggregation when changing learning mode from Online to Apprentice mode and vice versa is not allowed. Make the mode change and then change the additional settings with an additional API call.
            - value: InvalidPolicyConfiguration
              description: Invalid policy configuration.
            - value: InvalidPolicyContract
              description: Invalid policy contrac

# --- truncated at 32 KB (39 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-events-api-openapi.yml