Azure Site Recovery Replication Vault Health API

openapi: 3.2.0
info:
  title: Microsoft Azure Site Recovery Replication Vault Health API
  version: '2026-11-01'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  description: 'Operations tagged ReplicationVaultHealth 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: ReplicationVaultHealth
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationVaultHealth
  : get:
      operationId: ReplicationVaultHealth_Get
      tags:
      - ReplicationVaultHealth
      summary: Gets the health summary for the vault
      description: Gets the health details of 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 recovery services vault.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VaultHealthDetails'
      x-ms-examples:
        Gets the health summary for the vault.:
          $ref: ./examples/ReplicationVaultHealth_Get.json
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationVaultHealth/default/refresh
  : post:
      operationId: ReplicationVaultHealth_Refresh
      tags:
      - ReplicationVaultHealth
      summary: Refreshes health summary of the vault
      description: Refreshes health summary of 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 recovery services vault.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VaultHealthDetails'
        '202':
          description: Resource operation accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
      x-ms-examples:
        Refreshes health summary of the vault.:
          $ref: ./examples/ReplicationVaultHealth_Refresh.json
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: '#/definitions/VaultHealthDetails'
      x-ms-long-running-operation: true
    servers:
    - url: https://management.azure.com
components:
  schemas:
    ResourceHealthSummary:
      type: object
      description: Base class to define the health summary of the resources contained under an Arm resource.
      properties:
        resourceCount:
          type: integer
          format: int32
          description: The count of total resources under the container.
        issues:
          type: array
          description: The list of summary of health errors across the resources under the container.
          items:
            $ref: '#/components/schemas/HealthErrorSummary'
        categorizedResourceCounts:
          type: object
          description: The categorized resource counts.
          additionalProperties:
            format: int32
            type: integer
    VaultHealthDetails:
      type: object
      description: Vault health details definition.
      properties:
        properties:
          $ref: '#/components/schemas/VaultHealthProperties'
          description: The vault health related data.
        location:
          type: string
          description: Resource Location
      allOf:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/Resource
    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.
    VaultHealthProperties:
      type: object
      description: class to define the health summary of the Vault.
      properties:
        vaultErrors:
          type: array
          description: The list of errors on the vault.
          items:
            $ref: '#/components/schemas/HealthError'
        protectedItemsHealth:
          $ref: '#/components/schemas/ResourceHealthSummary'
          description: The list of the health detail of the protected items in the vault.
        fabricsHealth:
          $ref: '#/components/schemas/ResourceHealthSummary'
          description: The list of the health detail of the fabrics in the vault.
        containersHealth:
          $ref: '#/components/schemas/ResourceHealthSummary'
          description: The list of the health detail of the containers in the vault.
    HealthErrorSummary:
      type: object
      description: class to define the summary of the health error details.
      properties:
        summaryCode:
          type: string
          description: The code of the health error.
        category:
          $ref: '#/components/schemas/HealthErrorCategory'
          description: The category of the health error.
        severity:
          $ref: '#/components/schemas/Severity'
          description: Severity of error.
        summaryMessage:
          type: string
          description: The summary message of the health error.
        affectedResourceType:
          type: string
          description: The type of affected ARM resource.
        affectedResourceSubtype:
          type: string
          description: The sub type of any subcomponent within the ARM resource that this might be applicable. Value remains null if not applicable.
        affectedResourceCorrelationIds:
          type: array
          description: The list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue.
          items:
            type: string
    HealthErrorCategory:
      type: string
      description: The category of the health error.
      enum:
      - None
      - Replication
      - TestFailover
      - Configuration
      - FabricInfrastructure
      - VersionExpiry
      - AgentAutoUpdateInfra
      - AgentAutoUpdateArtifactDeleted
      - AgentAutoUpdateRunAsAccount
      - AgentAutoUpdateRunAsAccountExpiry
      - AgentAutoUpdateRunAsAccountExpired
      x-ms-enum:
        name: HealthErrorCategory
        modelAsString: true
        values:
        - name: None
          value: None
          description: None
        - name: Replication
          value: Replication
          description: Replication
        - name: TestFailover
          value: TestFailover
          description: TestFailover
        - name: Configuration
          value: Configuration
          description: Configuration
        - name: FabricInfrastructure
          value: FabricInfrastructure
          description: FabricInfrastructure
        - name: VersionExpiry
          value: VersionExpiry
          description: VersionExpiry
        - name: AgentAutoUpdateInfra
          value: AgentAutoUpdateInfra
          description: AgentAutoUpdateInfra
        - name: AgentAutoUpdateArtifactDeleted
          value: AgentAutoUpdateArtifactDeleted
          description: AgentAutoUpdateArtifactDeleted
        - name: AgentAutoUpdateRunAsAccount
          value: AgentAutoUpdateRunAsAccount
          description: AgentAutoUpdateRunAsAccount
        - name: AgentAutoUpdateRunAsAccountExpiry
          value: AgentAutoUpdateRunAsAccountExpiry
          description: AgentAutoUpdateRunAsAccountExpiry
        - name: AgentAutoUpdateRunAsAccountExpired
          value: AgentAutoUpdateRunAsAccountExpired
          description: AgentAutoUpdateRunAsAccountExpired
    Severity:
      type: string
      description: Severity of error.
      enum:
      - NONE
      - Warning
      - Error
      - Info
      x-ms-enum:
        name: Severity
        modelAsString: true
        values:
        - name: NONE
          value: NONE
          description: NONE
        - name: Warning
          value: Warning
          description: Warning
        - name: Error
          value: Error
          description: Error
        - name: Info
          value: Info
          description: Info
    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.
  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