Azure Site Recovery Replication Events API

openapi: 3.2.0
info:
  title: Microsoft Azure Site Recovery Replication Events API
  version: '2026-11-01'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  description: 'Operations tagged ReplicationEvents across 2 of this provider''s published API definitions: microsoft-azure-site-recovery-service-2026-11-01.json, microsoft-azure-site-recovery-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: ReplicationEvents
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationEvents
  : get:
      operationId: ReplicationEvents_List
      tags:
      - ReplicationEvents
      summary: Gets the list of Azure Site Recovery events
      description: Gets the list of Azure Site Recovery events for the vault.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: resourceName
        in: path
        description: The name of the Vault
        required: true
        schema:
          type: string
      - name: $filter
        in: query
        description: OData filter options.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventCollection'
      x-ms-examples:
        Gets the list of Azure Site Recovery events.:
          $ref: ./examples/ReplicationEvents_List.json
      x-ms-pageable:
        nextLinkName: nextLink
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationEvents/{eventName}
  : get:
      operationId: ReplicationEvents_Get
      tags:
      - ReplicationEvents
      summary: Get the details of an Azure Site recovery event
      description: The operation to get the details of an Azure Site recovery event.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: resourceName
        in: path
        description: The name of the Vault
        required: true
        schema:
          type: string
      - name: eventName
        in: path
        description: The name of the Azure Site Recovery event.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Event'
      x-ms-examples:
        Get the details of an Azure Site recovery event.:
          $ref: ./examples/ReplicationEvents_Get.json
    servers:
    - url: https://management.azure.com
components:
  schemas:
    Event:
      type: object
      description: Implements the Event class.
      properties:
        properties:
          $ref: '#/components/schemas/EventProperties'
          description: Event related data.
        location:
          type: string
          description: Resource Location
      allOf:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
    InnerHealthError:
      type: object
      description: Implements InnerHealthError class. HealthError object has a list of InnerHealthErrors as child errors. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException.
      properties:
        errorSource:
          type: string
          description: Source of error.
        errorType:
          type: string
          description: Type of error.
        errorLevel:
          type: string
          description: Level of error.
        errorCategory:
          type: string
          description: Category of error.
        errorCode:
          type: string
          description: Error code.
        summaryMessage:
          type: string
          description: Summary message of the entity.
        errorMessage:
          type: string
          description: Error message.
        possibleCauses:
          type: string
          description: Possible causes of error.
        recommendedAction:
          type: string
          description: Recommended action to resolve error.
        creationTimeUtc:
          type: string
          format: date-time
          description: Error creation time (UTC).
        recoveryProviderErrorMessage:
          type: string
          description: DRA error message.
        entityId:
          type: string
          description: ID of the entity.
        errorId:
          type: string
          description: The health error unique id.
        customerResolvability:
          $ref: '#/components/schemas/HealthErrorCustomerResolvability'
          description: Value indicating whether the health error is customer resolvable.
    EventProperties:
      type: object
      description: The properties of a monitoring event.
      properties:
        eventCode:
          type: string
          description: The Id of the monitoring event.
        description:
          type: string
          description: The event name.
        eventType:
          type: string
          description: 'The type of the event. for example: VM Health, Server Health, Job Failure etc.'
        affectedObjectFriendlyName:
          type: string
          description: The friendly name of the source of the event on which it is raised (for example, VM, VMM etc).
        affectedObjectCorrelationId:
          type: string
          description: The affected object correlationId for the event.
        severity:
          type: string
          description: The severity of the event.
        timeOfOccurrence:
          type: string
          format: date-time
          description: The time of occurrence of the event.
        fabricId:
          type: string
          description: The ARM ID of the fabric.
        providerSpecificDetails:
          $ref: '#/components/schemas/EventProviderSpecificDetails'
          description: The provider specific settings.
        eventSpecificDetails:
          $ref: '#/components/schemas/EventSpecificDetails'
          description: The event specific settings.
        healthErrors:
          type: array
          description: The list of errors / warnings capturing details associated with the issue(s).
          items:
            $ref: '#/components/schemas/HealthError'
    EventSpecificDetails:
      type: object
      description: Model class for event specific details for an event.
      properties:
        instanceType:
          type: string
          description: Gets the class type. Overridden in derived classes.
      discriminator:
        propertyName: instanceType
      required:
      - instanceType
    EventCollection:
      type: object
      description: Collection of fabric details.
      properties:
        value:
          type: array
          description: The Event items on this page
          items:
            $ref: '#/components/schemas/Event'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    HealthErrorCustomerResolvability:
      type: string
      description: Value indicating whether the health error is customer resolvable.
      enum:
      - Allowed
      - NotAllowed
      x-ms-enum:
        name: HealthErrorCustomerResolvability
        modelAsString: true
        values:
        - name: Allowed
          value: Allowed
          description: Allowed
        - name: NotAllowed
          value: NotAllowed
          description: NotAllowed
    HealthError:
      type: object
      description: Health Error.
      properties:
        innerHealthErrors:
          type: array
          description: The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException.
          items:
            $ref: '#/components/schemas/InnerHealthError'
        errorSource:
          type: string
          description: Source of error.
        errorType:
          type: string
          description: Type of error.
        errorLevel:
          type: string
          description: Level of error.
        errorCategory:
          type: string
          description: Category of error.
        errorCode:
          type: string
          description: Error code.
        summaryMessage:
          type: string
          description: Summary message of the entity.
        errorMessage:
          type: string
          description: Error message.
        possibleCauses:
          type: string
          description: Possible causes of error.
        recommendedAction:
          type: string
          description: Recommended action to resolve error.
        creationTimeUtc:
          type: string
          format: date-time
          description: Error creation time (UTC).
        recoveryProviderErrorMessage:
          type: string
          description: DRA error message.
        entityId:
          type: string
          description: ID of the entity.
        errorId:
          type: string
          description: The health error unique id.
        customerResolvability:
          $ref: '#/components/schemas/HealthErrorCustomerResolvability'
          description: Value indicating whether the health error is customer resolvable.
    EventProviderSpecificDetails:
      type: object
      description: Model class for provider specific details for an event.
      properties:
        instanceType:
          type: string
          description: Gets the class type. Overridden in derived classes.
      discriminator:
        propertyName: instanceType
      required:
      - instanceType
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.
x-refined-from:
- microsoft-azure-site-recovery-service-2026-11-01.json
- microsoft-azure-site-recovery-openapi.yml