ReplicationProtectionClusterCollection

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-site-recovery/json-schema/microsoft-azure-site-recovery-replication-protection-cluster-collection-schema.json",
  "title": "ReplicationProtectionClusterCollection",
  "description": "Replication protected item collection.",
  "x-generated": "2026-11-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/microsoft-azure-site-recovery-replicationprotectionclusters-api-openapi.yml#/components/schemas/ReplicationProtectionClusterCollection",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "description": "The ReplicationProtectionCluster items on this page",
      "items": {
        "$ref": "#/$defs/ReplicationProtectionCluster"
      }
    },
    "nextLink": {
      "type": "string",
      "format": "uri",
      "description": "The link to the next page of items"
    }
  },
  "required": [
    "value"
  ],
  "$defs": {
    "CurrentScenarioDetails": {
      "type": "object",
      "description": "Current scenario details of the protected entity.",
      "properties": {
        "scenarioName": {
          "type": "string",
          "description": "Scenario name."
        },
        "jobId": {
          "type": "string",
          "description": "ARM Id of the job being executed."
        },
        "startTime": {
          "type": "string",
          "format": "date-time",
          "description": "Start time of the workflow."
        }
      }
    },
    "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": "#/$defs/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": "#/$defs/HealthErrorCustomerResolvability",
          "description": "Value indicating whether the health error is customer resolvable."
        }
      }
    },
    "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"
          }
        ]
      }
    },
    "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": "#/$defs/HealthErrorCustomerResolvability",
          "description": "Value indicating whether the health error is customer resolvable."
        }
      }
    },
    "ProxyResource": {
      "type": "object",
      "title": "Proxy Resource",
      "description": "The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location",
      "allOf": [
        {
          "$ref": "#/$defs/Resource"
        }
      ]
    },
    "RegisteredClusterNodes": {
      "type": "object",
      "description": "Extended location of the resource.",
      "properties": {
        "clusterNodeFqdn": {
          "type": "string",
          "description": "The cluster node name."
        },
        "machineId": {
          "type": "string",
          "description": "The machine ID."
        },
        "biosId": {
          "type": "string",
          "description": "The BIOS ID."
        },
        "isSharedDiskVirtualNode": {
          "type": "boolean",
          "description": "A value indicating whether this represents virtual entity hosting all the shared disks."
        }
      }
    },
    "ReplicationClusterProviderSpecificSettings": {
      "type": "object",
      "description": "Replication cluster provider specific settings.",
      "properties": {
        "instanceType": {
          "type": "string",
          "description": "Gets the Instance type."
        }
      },
      "required": [
        "instanceType"
      ]
    },
    "ReplicationProtectionCluster": {
      "type": "object",
      "description": "Replication protection Cluster.",
      "properties": {
        "properties": {
          "$ref": "#/$defs/ReplicationProtectionClusterProperties",
          "description": "The custom data."
        }
      },
      "allOf": [
        {
          "$ref": "#/$defs/ProxyResource"
        }
      ]
    },
    "ReplicationProtectionClusterProperties": {
      "type": "object",
      "description": "Replication protection cluster custom data details.",
      "properties": {
        "protectionClusterType": {
          "type": "string",
          "description": "The type of protection cluster type."
        },
        "primaryFabricFriendlyName": {
          "type": "string",
          "description": "The friendly name of the primary fabric."
        },
        "primaryFabricProvider": {
          "type": "string",
          "description": "The fabric provider of the primary fabric."
        },
        "recoveryFabricFriendlyName": {
          "type": "string",
          "description": "The friendly name of recovery fabric."
        },
        "recoveryFabricId": {
          "type": "string",
          "format": "arm-id",
          "description": "The Arm Id of recovery fabric.",
          "x-ms-arm-id-details": {
            "allowedResources": [
              {
                "type": "Microsoft.RecoveryServices/vaults/replicationFabrics"
              }
            ]
          }
        },
        "primaryProtectionContainerFriendlyName": {
          "type": "string",
          "description": "The name of primary protection container friendly name."
        },
        "recoveryProtectionContainerFriendlyName": {
          "type": "string",
          "description": "The name of recovery container friendly name."
        },
        "protectionState": {
          "type": "string",
          "description": "The protection status."
        },
        "protectionStateDescription": {
          "type": "string",
          "description": "The protection state description."
        },
        "activeLocation": {
          "type": "string",
          "description": "The Current active location of the Protection cluster."
        },
        "testFailoverState": {
          "type": "string",
          "description": "The Test failover state."
        },
        "testFailoverStateDescription": {
          "type": "string",
          "description": "The Test failover state description."
        },
        "allowedOperations": {
          "type": "array",
          "description": "The allowed operations on the Replication protection cluster.",
          "items": {
            "type": "string"
          }
        },
        "replicationHealth": {
          "type": "string",
          "description": "The consolidated protection health for the VM taking any issues with SRS as well as all the replication units associated with the VM's replication group into account. This is a string representation of the ProtectionHealth enumeration."
        },
        "healthErrors": {
          "type": "array",
          "description": "List of health errors.",
          "items": {
            "$ref": "#/$defs/HealthError"
          },
          "x-ms-identifiers": []
        },
        "lastSuccessfulFailoverTime": {
          "type": "string",
          "format": "date-time",
          "description": "The last successful failover time."
        },
        "lastSuccessfulTestFailoverTime": {
          "type": "string",
          "format": "date-time",
          "description": "The last successful test failover time."
        },
        "policyFriendlyName": {
          "type": "string",
          "description": "The name of Policy governing this PE."
        },
        "currentScenario": {
          "$ref": "#/$defs/CurrentScenarioDetails",
          "description": "The current scenario."
        },
        "recoveryContainerId": {
          "type": "string",
          "format": "arm-id",
          "description": "The recovery container Id.",
          "x-ms-arm-id-details": {
            "allowedResources": [
              {
                "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers"
              }
            ]
          }
        },
        "agentClusterId": {
          "type": "string",
          "description": "The Agent cluster Id."
        },
        "clusterFqdn": {
          "type": "string",
          "description": "The cluster FQDN."
        },
        "clusterNodeFqdns": {
          "type": "array",
          "description": "The List of cluster Node FQDNs.",
          "items": {
            "type": "string"
          }
        },
        "clusterProtectedItemIds": {
          "type": "array",
          "description": "The List of Protected Item Id's.",
          "items": {
            "type": "string",
            "format": "arm-id",
            "description": "A type definition that refers the id to an Azure Resource Manager resource.",
            "x-ms-arm-id-details": {
              "allowedResources": [
                {
                  "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems"
                }
              ]
            }
          }
        },
        "provisioningState": {
          "type": "string",
          "description": "The provisioning state of the cluster.",
          "readOnly": true
        },
        "areAllClusterNodesRegistered": {
          "type": "boolean",
          "description": "A value indicating whether all nodes of the cluster are registered or not."
        },
        "clusterRegisteredNodes": {
          "type": "array",
          "description": "The registered node details.",
          "items": {
            "$ref": "#/$defs/RegisteredClusterNodes"
          },
          "x-ms-identifiers": [
            "clusterNodeFqdn"
          ]
        },
        "providerSpecificDetails": {
          "$ref": "#/$defs/ReplicationClusterProviderSpecificSettings",
          "description": "The Replication cluster provider custom settings."
        },
        "sharedDiskProperties": {
          "$ref": "#/$defs/SharedDiskReplicationItemProperties",
          "description": "The shared disk properties."
        },
        "policyId": {
          "type": "string",
          "format": "arm-id",
          "description": "The Policy Id.",
          "x-ms-arm-id-details": {
            "allowedResources": [
              {
                "type": "Microsoft.RecoveryServices/vaults/replicationPolicies"
              }
            ]
          }
        }
      }
    },
    "Resource": {
      "type": "object",
      "title": "Resource",
      "description": "Common fields that are returned in the response for all Azure Resource Manager resources",
      "properties": {
        "id": {
          "type": "string",
          "format": "arm-id",
          "description": "Fully qualified resource ID for the resource. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}\"",
          "readOnly": true
        },
        "name": {
          "type": "string",
          "description": "The name of the resource",
          "readOnly": true
        },
        "type": {
          "type": "string",
          "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\"",
          "readOnly": true
        },
        "systemData": {
          "$ref": "#/$defs/systemData",
          "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.",
          "readOnly": true
        }
      },
      "x-ms-azure-resource": true
    },
    "SharedDiskReplicationItemProperties": {
      "type": "object",
      "description": "Shared Disk Replication item custom data details.",
      "properties": {
        "protectionState": {
          "type": "string",
          "description": "The protection state of shared disk."
        },
        "testFailoverState": {
          "type": "string",
          "description": "The tfo state of shared disk."
        },
        "activeLocation": {
          "type": "string",
          "description": "The Current active location of the PE."
        },
        "allowedOperations": {
          "type": "array",
          "description": "The allowed operations on the Replication protected item.",
          "items": {
            "type": "string"
          }
        },
        "replicationHealth": {
          "type": "string",
          "description": "The consolidated protection health for the VM taking any issues with SRS as well as all the replication units associated with the VM's replication group into account. This is a string representation of the ProtectionHealth enumeration."
        },
        "healthErrors": {
          "type": "array",
          "description": "List of health errors.",
          "items": {
            "$ref": "#/$defs/HealthError"
          },
          "x-ms-identifiers": [
            "errorCode"
          ]
        },
        "currentScenario": {
          "$ref": "#/$defs/CurrentScenarioDetails",
          "description": "The current scenario."
        },
        "sharedDiskProviderSpecificDetails": {
          "$ref": "#/$defs/SharedDiskReplicationProviderSpecificSettings",
          "description": "The Replication provider custom settings."
        }
      }
    },
    "SharedDiskReplicationProviderSpecificSettings": {
      "type": "object",
      "description": "Replication provider specific settings.",
      "properties": {
        "instanceType": {
          "type": "string",
          "description": "Gets the Instance type."
        }
      },
      "required": [
        "instanceType"
      ]
    }
  }
}