RecoveryServicesProviderCollection

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-site-recovery/json-schema/microsoft-azure-site-recovery-recovery-services-provider-collection-schema.json",
  "title": "RecoveryServicesProviderCollection",
  "description": "Collection of providers.",
  "x-generated": "2026-11-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/microsoft-azure-site-recovery-replicationrecoveryservicesproviders-api-openapi.yml#/components/schemas/RecoveryServicesProviderCollection",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "description": "The RecoveryServicesProvider items on this page",
      "items": {
        "$ref": "#/$defs/RecoveryServicesProvider"
      }
    },
    "nextLink": {
      "type": "string",
      "format": "uri",
      "description": "The link to the next page of items"
    }
  },
  "required": [
    "value"
  ],
  "$defs": {
    "AgentVersionStatus": {
      "type": "string",
      "description": "A value indicating whether security update required.",
      "enum": [
        "Supported",
        "NotSupported",
        "Deprecated",
        "UpdateRequired",
        "SecurityUpdateRequired"
      ],
      "x-ms-enum": {
        "name": "AgentVersionStatus",
        "modelAsString": true,
        "values": [
          {
            "name": "Supported",
            "value": "Supported",
            "description": "Supported"
          },
          {
            "name": "NotSupported",
            "value": "NotSupported",
            "description": "NotSupported"
          },
          {
            "name": "Deprecated",
            "value": "Deprecated",
            "description": "Deprecated"
          },
          {
            "name": "UpdateRequired",
            "value": "UpdateRequired",
            "description": "UpdateRequired"
          },
          {
            "name": "SecurityUpdateRequired",
            "value": "SecurityUpdateRequired",
            "description": "SecurityUpdateRequired"
          }
        ]
      }
    },
    "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"
          }
        ]
      }
    },
    "IdentityProviderDetails": {
      "type": "object",
      "description": "Identity provider details.",
      "properties": {
        "tenantId": {
          "type": "string",
          "description": "The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services."
        },
        "applicationId": {
          "type": "string",
          "description": "The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services."
        },
        "objectId": {
          "type": "string",
          "description": "The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services."
        },
        "audience": {
          "type": "string",
          "description": "The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services."
        },
        "aadAuthority": {
          "type": "string",
          "description": "The base authority for Azure Active Directory authentication."
        }
      }
    },
    "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"
        }
      ]
    },
    "RecoveryServicesProvider": {
      "type": "object",
      "description": "Provider details.",
      "properties": {
        "properties": {
          "$ref": "#/$defs/RecoveryServicesProviderProperties",
          "description": "Provider properties."
        },
        "location": {
          "type": "string",
          "description": "Resource Location"
        }
      },
      "allOf": [
        {
          "$ref": "#/$defs/ProxyResource"
        }
      ]
    },
    "RecoveryServicesProviderProperties": {
      "type": "object",
      "description": "Recovery services provider properties.",
      "properties": {
        "fabricType": {
          "type": "string",
          "description": "Type of the site."
        },
        "friendlyName": {
          "type": "string",
          "description": "Friendly name of the DRA."
        },
        "providerVersion": {
          "type": "string",
          "description": "The provider version."
        },
        "serverVersion": {
          "type": "string",
          "description": "The fabric provider."
        },
        "providerVersionState": {
          "type": "string",
          "description": "DRA version status."
        },
        "providerVersionExpiryDate": {
          "type": "string",
          "format": "date-time",
          "description": "Expiry date of the version."
        },
        "fabricFriendlyName": {
          "type": "string",
          "description": "The fabric friendly name."
        },
        "lastHeartBeat": {
          "type": "string",
          "format": "date-time",
          "description": "Time when last heartbeat was sent by the DRA."
        },
        "connectionStatus": {
          "type": "string",
          "description": "A value indicating whether DRA is responsive."
        },
        "protectedItemCount": {
          "type": "integer",
          "format": "int32",
          "description": "Number of protected VMs currently managed by the DRA."
        },
        "allowedScenarios": {
          "type": "array",
          "description": "The scenarios allowed on this provider.",
          "items": {
            "type": "string"
          }
        },
        "healthErrorDetails": {
          "type": "array",
          "description": "The recovery services provider health error details.",
          "items": {
            "$ref": "#/$defs/HealthError"
          }
        },
        "draIdentifier": {
          "type": "string",
          "description": "The DRA Id."
        },
        "machineId": {
          "type": "string",
          "description": "The machine Id."
        },
        "machineName": {
          "type": "string",
          "description": "The machine name."
        },
        "biosId": {
          "type": "string",
          "description": "The Bios Id."
        },
        "authenticationIdentityDetails": {
          "$ref": "#/$defs/IdentityProviderDetails",
          "description": "The authentication identity details."
        },
        "resourceAccessIdentityDetails": {
          "$ref": "#/$defs/IdentityProviderDetails",
          "description": "The resource access identity details."
        },
        "dataPlaneAuthenticationIdentityDetails": {
          "$ref": "#/$defs/IdentityProviderDetails",
          "description": "The data plane authentication identity details."
        },
        "providerVersionDetails": {
          "$ref": "#/$defs/VersionDetails",
          "description": "The provider version details."
        }
      }
    },
    "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
    },
    "VersionDetails": {
      "type": "object",
      "description": "Version related details.",
      "properties": {
        "version": {
          "type": "string",
          "description": "The agent version."
        },
        "expiryDate": {
          "type": "string",
          "format": "date-time",
          "description": "Version expiry date."
        },
        "status": {
          "$ref": "#/$defs/AgentVersionStatus",
          "description": "A value indicating whether security update required."
        }
      }
    },
    "systemData": {
      "type": "object",
      "description": "Referenced by this document but never defined in it. API Evangelist added this empty placeholder so the document resolves; the shape is unknown and is NOT a claim about the API.",
      "x-ae-placeholder": true
    }
  }
}