Microsoft Azure Event API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Event API
  description: Event Controller.
schemes:
- https
tags:
- name: Event
  description: Event Controller.
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/events/{eventName}
  : get:
      tags:
      - Event
      summary: Microsoft Azure Gets The Event
      description: Gets the details of the event.
      operationId: microsoftAzureEventGet
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/VaultNameParameter'
      - $ref: '#/parameters/EventNameParameter'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Returns Event Model on success.
          schema:
            $ref: '#/definitions/EventModel'
        default:
          description: Error
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Event_Get:
          $ref: ./examples/Event_Get.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/events
  : get:
      tags:
      - Event
      summary: Microsoft Azure Lists The Events
      description: Gets the list of events in the given vault.
      operationId: microsoftAzureEventList
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/VaultNameParameter'
      - in: query
        name: $filter
        description: Filter string.
        type: string
      - in: query
        name: continuationToken
        description: Continuation token.
        type: string
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Returns Event Model Collection on success.
          schema:
            $ref: '#/definitions/EventModelCollection'
        default:
          description: Error
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Event_List:
          $ref: ./examples/Event_List.json
  /subscriptions/{subscriptionId}/providers/Microsoft.ResourceHealth/events/{eventTrackingId}:
    get:
      tags:
      - Event
      operationId: microsoftAzureEventGetbysubscriptionidandtrackingid
      description: Service health event in the subscription by event tracking id
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/FilterParameter'
      - $ref: '#/parameters/QueryStartTimeParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/EventTrackingIdParameter'
      responses:
        '200':
          description: Service Health Event in the subscription requested by tracking id.
          schema:
            $ref: '#/definitions/event'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        SecurityAdvisoriesEventBySubscriptionIdAndTrackingId:
          $ref: ./examples/Event_GetBySubscriptionIdAndTrackingId.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Resourcehealth Events Eventtrackingid
  /subscriptions/{subscriptionId}/providers/Microsoft.ResourceHealth/events/{eventTrackingId}/fetchEventDetails:
    post:
      tags:
      - Event
      operationId: microsoftAzureEventFetchdetailsbysubscriptionidandtrackingid
      description: Service health event details in the subscription by event tracking id. This can be used to fetch sensitive properties for Security Advisory events
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/EventTrackingIdParameter'
      responses:
        '200':
          description: Service Health Event details in the subscription requested by tracking id.
          schema:
            $ref: '#/definitions/event'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        EventDetailsBySubscriptionIdAndTrackingId:
          $ref: ./examples/Event_fetchDetailsBySubscriptionIdAndTrackingId.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Resourcehealth Events Eventtrackingid Fetcheventdetails
  /providers/Microsoft.ResourceHealth/events/{eventTrackingId}:
    get:
      tags:
      - Event
      operationId: microsoftAzureEventGetbytenantidandtrackingid
      description: Service health event in the tenant by event tracking id
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/FilterParameter'
      - $ref: '#/parameters/QueryStartTimeParameter'
      - $ref: '#/parameters/EventTrackingIdParameter'
      responses:
        '200':
          description: Service Health Event in the subscription requested by tracking id.
          schema:
            $ref: '#/definitions/event'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        EventByTenantIdAndTrackingId:
          $ref: ./examples/Event_GetByTenantIdAndTrackingId.json
      summary: Microsoft Azure Get Providers Microsoft Resourcehealth Events Eventtrackingid
  /providers/Microsoft.ResourceHealth/events/{eventTrackingId}/fetchEventDetails:
    post:
      tags:
      - Event
      operationId: microsoftAzureEventFetchdetailsbytenantidandtrackingid
      description: Service health event details in the tenant by event tracking id. This can be used to fetch sensitive properties for Security Advisory events
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/EventTrackingIdParameter'
      responses:
        '200':
          description: Service health event details in the tenant by event tracking id.
          schema:
            $ref: '#/definitions/event'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        EventDetailsByTenantIdAndTrackingId:
          $ref: ./examples/Event_fetchDetailsByTenantIdAndTrackingId.json
      summary: Microsoft Azure Post Providers Microsoft Resourcehealth Events Eventtrackingid Fetcheventdetails
definitions:
  HealthErrorModel:
    description: Health error model.
    type: object
    properties:
      affectedResourceType:
        description: Gets or sets the type of affected resource type.
        type: string
      affectedResourceCorrelationIds:
        description: "Gets or sets the list of affected resource correlation Ids. This can be used to\r\nuniquely identify the count of items affected by a specific category and severity\r\nas well as count of item affected by an specific issue."
        type: array
        items:
          type: string
      childErrors:
        description: Gets or sets a list of child health errors associated with this error.
        type: array
        items:
          $ref: '#/definitions/InnerHealthErrorModel'
        x-ms-identifiers: []
      code:
        description: Gets or sets the error code.
        type: string
        readOnly: true
      healthCategory:
        description: Gets or sets the health category.
        type: string
        readOnly: true
      category:
        description: Gets or sets the error category.
        type: string
        readOnly: true
      severity:
        description: Gets or sets the error severity.
        type: string
        readOnly: true
      source:
        description: Gets or sets the error source.
        type: string
        readOnly: true
      creationTime:
        format: date-time
        description: Gets or sets the error creation time.
        type: string
        readOnly: true
      isCustomerResolvable:
        description: Gets or sets a value indicating whether the error is customer resolvable.
        type: boolean
        readOnly: true
      summary:
        description: Gets or sets the error summary.
        type: string
        readOnly: true
      message:
        description: Gets or sets the error message.
        type: string
        readOnly: true
      causes:
        description: Gets or sets possible causes of the error.
        type: string
        readOnly: true
      recommendation:
        description: Gets or sets recommended action to resolve the error.
        type: string
        readOnly: true
  link:
    type: object
    description: Useful links for service health event.
    properties:
      type:
        type: string
        description: Type of link.
        enum:
        - Button
        - Hyperlink
        x-ms-enum:
          name: LinkTypeValues
          modelAsString: true
      displayText:
        type: object
        description: Display text of link.
        properties:
          value:
            type: string
            description: Display text of link.
          localizedValue:
            type: string
            description: Localized display text of link.
      extensionName:
        type: string
        description: It provides the name of portal extension to produce link for given service health event.
      bladeName:
        type: string
        description: It provides the name of portal extension blade to produce link for given service health event.
      parameters:
        type: object
        description: It provides a map of parameter name and value for portal extension blade to produce lik for given service health event.
  EventModelCollection:
    description: Event model collection.
    type: object
    properties:
      value:
        description: Gets or sets the list of events.
        type: array
        items:
          $ref: '#/definitions/EventModel'
        x-ms-identifiers: []
      nextLink:
        description: Gets or sets the value of next link.
        type: string
  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: '#/definitions/impactedServiceRegion'
  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: '#/definitions/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: '#/definitions/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: '#/definitions/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
  EventModel:
    description: Event model.
    required:
    - properties
    type: object
    properties:
      properties:
        $ref: '#/definitions/EventModelProperties'
      id:
        description: Gets or sets the Id of the resource.
        type: string
        readOnly: true
      name:
        description: Gets or sets the name of the resource.
        type: string
        readOnly: true
      type:
        description: Gets or sets the type of the resource.
        type: string
        readOnly: true
      systemData:
        allOf:
        - $ref: '#/definitions/SystemDataModel'
        readOnly: true
  InnerHealthErrorModel:
    description: Inner health error model.
    type: object
    properties:
      code:
        description: Gets or sets the error code.
        type: string
        readOnly: true
      healthCategory:
        description: Gets or sets the health category.
        type: string
        readOnly: true
      category:
        description: Gets or sets the error category.
        type: string
        readOnly: true
      severity:
        description: Gets or sets the error severity.
        type: string
        readOnly: true
      source:
        description: Gets or sets the error source.
        type: string
        readOnly: true
      creationTime:
        format: date-time
        description: Gets or sets the error creation time.
        type: string
        readOnly: true
      isCustomerResolvable:
        description: Gets or sets a value indicating whether the error is customer resolvable.
        type: boolean
        readOnly: true
      summary:
        description: Gets or sets the error summary.
        type: string
        readOnly: true
      message:
        description: Gets or sets the error message.
        type: string
        readOnly: true
      causes:
        description: Gets or sets possible causes of the error.
        type: string
        readOnly: true
      recommendation:
        description: Gets or sets recommended action to resolve the error.
        type: string
        readOnly: true
  SystemDataModel:
    description: System data required to be defined for Azure resources.
    type: object
    properties:
      createdBy:
        description: Gets or sets identity that created the resource.
        type: string
      createdByType:
        description: "Gets or sets the type of identity that created the resource: user, application,\r\nmanagedIdentity."
        type: string
      createdAt:
        format: date-time
        description: Gets or sets the timestamp of resource creation (UTC).
        type: string
      lastModifiedBy:
        description: Gets or sets the identity that last modified the resource.
        type: string
      lastModifiedByType:
        description: "Gets or sets the type of identity that last modified the resource: user, application,\r\nmanagedIdentity."
        type: string
      lastModifiedAt:
        format: date-time
        description: Gets or sets the timestamp of resource last modification (UTC).
        type: string
  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
  faq:
    type: object
    description: Frequently asked question for the service health event
    properties:
      question:
        type: string
        description: FAQ question for the service health event.
      answer:
        type: string
        description: FAQ answer for the service health event.
      localeCode:
        type: string
        description: FAQ locale for the service health event.
  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: '#/definitions/update'
  EventModelProperties:
    description: Event model properties.
    required:
    - customProperties
    type: object
    properties:
      resourceType:
        description: Gets or sets the resource type.
        type: string
        readOnly: true
      resourceName:
        description: Gets or sets the resource name.
        type: string
        readOnly: true
      eventType:
        description: Gets or sets the event type.
        type: string
        readOnly: true
      eventName:
        description: Gets or sets the event name.
        type: string
        readOnly: true
      timeOfOccurrence:
        format: date-time
        description: Gets or sets the time at which the event occurred at source.
        type: string
        readOnly: true
      severity:
        description: Gets or sets the event severity.
        type: string
        readOnly: true
      description:
        description: Gets or sets the event description.
        type: string
        readOnly: true
      correlationId:
        description: Gets or sets the event correlation Id.
        type: string
        readOnly: true
      healthErrors:
        description: Gets or sets the errors associated with this event.
        type: array
        items:
          $ref: '#/definitions/HealthErrorModel'
        readOnly: true
        x-ms-identifiers: []
      customProperties:
        $ref: '#/definitions/EventModelCustomProperties'
  EventModelCustomProperties:
    description: Event model custom properties.
    required:
    - instanceType
    type: object
    properties:
      instanceType:
        description: Gets or sets the instance type.
        minLength: 1
        type: string
    discriminator: instanceType
parameters:
  VaultNameParameter:
    in: path
    name: vaultName
    description: The vault name.
    required: true
    type: string
    pattern: ^[a-zA-Z0-9]*$
    x-ms-parameter-location: method
  EventTrackingIdParameter:
    name: eventTrackingId
    in: path
    required: true
    type: string
    description: Event Id which uniquely identifies ServiceHealth event.
    x-ms-parameter-location: method
  FilterParameter:
    name: $filter
    in: query
    required: false
    type: string
    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
  EventNameParameter:
    in: path
    name: eventName
    description: The event name.
    required: true
    type: string
    pattern: ^[a-zA-Z0-9]*$
    x-ms-parameter-location: method
  QueryStartTimeParameter:
    name: queryStartTime
    in: query
    required: false
    type: string
    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
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'