Replication Vault Health - Get

Service:

Recovery Services - Site Recovery

API Version:

2023-02-01

Gets the health summary for the vault.
Gets the health details of the vault.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationVaultHealth?api-version=2023-02-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group where the recovery services vault is present.
resourceName	path	True	string	The name of the recovery services vault.
subscriptionId	path	True	string	The subscription Id.
api-version	query	True	string	Client Api Version.

Responses

Name	Type	Description
200 OK	VaultHealthDetails	OK

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account.

Examples

Gets the health summary for the vault.

Sample Request

HTTP

GET https://management.azure.com/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationVaultHealth?api-version=2023-02-01

Sample Response

Status code:

200

Azure-AsyncOperation: https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-02-01

Response Body

{
  "name": "Default",
  "type": "Microsoft.RecoveryServices/vaults/replicationVaultHealth",
  "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationVaultHealth/Default",
  "properties": {
    "vaultErrors": [],
    "protectedItemsHealth": {
      "resourceCount": 6,
      "issues": [
        {
          "summaryCode": "10008",
          "category": "Replication",
          "severity": "Error",
          "summaryMessage": "RPO Throttled",
          "affectedResourceType": "replicationProtectedItems",
          "affectedResourceSubtype": "",
          "affectedResourceCorrelationIds": [
            "c183865e-6077-46f2-a3b1-deb0f4f4650a",
            "c183865e-6077-46f2-a3b1-ceb0a4c3751e"
          ]
        }
      ]
    },
    "fabricsHealth": {
      "resourceCount": 1,
      "issues": []
    }
  }
}

Definitions

Name	Description
HealthError	Health Error.
HealthErrorCategory	The category of the health error.
HealthErrorCustomerResolvability	Value indicating whether the health error is customer resolvable.
HealthErrorSummary	class to define the summary of the health error details.
InnerHealthError	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.
ResourceHealthSummary	Base class to define the health summary of the resources contained under an Arm resource.
Severity	Severity of error.
VaultHealthDetails	Vault health details definition.
VaultHealthProperties	class to define the health summary of the Vault.

HealthError

Health Error.

Name	Type	Description
creationTimeUtc	string	Error creation time (UTC).
customerResolvability	HealthErrorCustomerResolvability	Value indicating whether the health error is customer resolvable.
entityId	string	ID of the entity.
errorCategory	string	Category of error.
errorCode	string	Error code.
errorId	string	The health error unique id.
errorLevel	string	Level of error.
errorMessage	string	Error message.
errorSource	string	Source of error.
errorType	string	Type of error.
innerHealthErrors	InnerHealthError[]	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.
possibleCauses	string	Possible causes of error.
recommendedAction	string	Recommended action to resolve error.
recoveryProviderErrorMessage	string	DRA error message.
summaryMessage	string	Summary message of the entity.

HealthErrorCategory

The category of the health error.

Name	Type	Description
AgentAutoUpdateArtifactDeleted	string
AgentAutoUpdateInfra	string
AgentAutoUpdateRunAsAccount	string
AgentAutoUpdateRunAsAccountExpired	string
AgentAutoUpdateRunAsAccountExpiry	string
Configuration	string
FabricInfrastructure	string
None	string
Replication	string
TestFailover	string
VersionExpiry	string

HealthErrorCustomerResolvability

Value indicating whether the health error is customer resolvable.

Name	Type	Description
Allowed	string
NotAllowed	string

HealthErrorSummary

class to define the summary of the health error details.

Name	Type	Description
affectedResourceCorrelationIds	string[]	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.
affectedResourceSubtype	string	The sub type of any subcomponent within the ARM resource that this might be applicable. Value remains null if not applicable.
affectedResourceType	string	The type of affected ARM resource.
category	HealthErrorCategory	The category of the health error.
severity	Severity	Severity of error.
summaryCode	string	The code of the health error.
summaryMessage	string	The summary message of the health error.

InnerHealthError

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.

Name	Type	Description
creationTimeUtc	string	Error creation time (UTC).
customerResolvability	HealthErrorCustomerResolvability	Value indicating whether the health error is customer resolvable.
entityId	string	ID of the entity.
errorCategory	string	Category of error.
errorCode	string	Error code.
errorId	string	The health error unique id.
errorLevel	string	Level of error.
errorMessage	string	Error message.
errorSource	string	Source of error.
errorType	string	Type of error.
possibleCauses	string	Possible causes of error.
recommendedAction	string	Recommended action to resolve error.
recoveryProviderErrorMessage	string	DRA error message.
summaryMessage	string	Summary message of the entity.

ResourceHealthSummary

Base class to define the health summary of the resources contained under an Arm resource.

Name	Type	Description
categorizedResourceCounts	object	The categorized resource counts.
issues	HealthErrorSummary[]	The list of summary of health errors across the resources under the container.
resourceCount	integer	The count of total resources under the container.

Severity

Severity of error.

Name	Type	Description
Error	string
Info	string
NONE	string
Warning	string

VaultHealthDetails

Vault health details definition.

Name	Type	Description
id	string	Resource Id
location	string	Resource Location
name	string	Resource Name
properties	VaultHealthProperties	The vault health related data.
type	string	Resource Type

VaultHealthProperties

class to define the health summary of the Vault.

Name	Type	Description
containersHealth	ResourceHealthSummary	The list of the health detail of the containers in the vault.
fabricsHealth	ResourceHealthSummary	The list of the health detail of the fabrics in the vault.
protectedItemsHealth	ResourceHealthSummary	The list of the health detail of the protected items in the vault.
vaultErrors	HealthError[]	The list of errors on the vault.