{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-backup/json-schema/microsoft-azure-backup-backup-instance-resource-list-schema.json",
  "title": "BackupInstanceResourceList",
  "description": "BackupInstance Resource list response",
  "x-generated": "2026-11-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_superseded/microsoft-azure-backup-backupinstances-api-openapi.yml#/components/schemas/BackupInstanceResourceList",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "description": "List of resources.",
      "items": {
        "$ref": "#/$defs/BackupInstanceResource"
      }
    }
  },
  "allOf": [
    {
      "$ref": "#/$defs/DppResourceList"
    }
  ],
  "$defs": {
    "AuthCredentials": {
      "type": "object",
      "description": "Base class for different types of authentication credentials.",
      "properties": {
        "objectType": {
          "type": "string",
          "description": "Type of the specific object - used for deserializing"
        }
      },
      "required": [
        "objectType"
      ]
    },
    "BackupDatasourceParameters": {
      "type": "object",
      "description": "Parameters for Backup Datasource",
      "properties": {
        "objectType": {
          "type": "string",
          "description": "Type of the specific object - used for deserializing"
        }
      },
      "required": [
        "objectType"
      ]
    },
    "BackupInstance": {
      "type": "object",
      "description": "Backup Instance",
      "properties": {
        "friendlyName": {
          "type": "string",
          "description": "Gets or sets the Backup Instance friendly name."
        },
        "dataSourceInfo": {
          "$ref": "#/$defs/Datasource",
          "description": "Gets or sets the data source information."
        },
        "dataSourceSetInfo": {
          "$ref": "#/$defs/DatasourceSet",
          "description": "Gets or sets the data source set information."
        },
        "policyInfo": {
          "$ref": "#/$defs/PolicyInfo",
          "description": "Gets or sets the policy information."
        },
        "resourceGuardOperationRequests": {
          "type": "array",
          "description": "ResourceGuardOperationRequests on which LAC check will be performed",
          "items": {
            "type": "string"
          }
        },
        "protectionStatus": {
          "$ref": "#/$defs/ProtectionStatusDetails",
          "description": "Specifies the protection status of the resource",
          "readOnly": true
        },
        "currentProtectionState": {
          "$ref": "#/$defs/CurrentProtectionState",
          "description": "Specifies the current protection state of the resource",
          "readOnly": true
        },
        "protectionErrorDetails": {
          "$ref": "#/$defs/UserFacingError",
          "description": "Specifies the protection error of the resource",
          "readOnly": true
        },
        "provisioningState": {
          "type": "string",
          "description": "Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed",
          "readOnly": true
        },
        "datasourceAuthCredentials": {
          "$ref": "#/$defs/AuthCredentials",
          "description": "Credentials to use to authenticate with data source provider."
        },
        "validationType": {
          "$ref": "#/$defs/ValidationType",
          "description": "Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again."
        },
        "identityDetails": {
          "$ref": "#/$defs/IdentityDetails",
          "description": "Contains information of the Identity Details for the BI.\nIf it is null, default will be considered as System Assigned."
        },
        "objectType": {
          "type": "string"
        }
      },
      "required": [
        "dataSourceInfo",
        "policyInfo",
        "objectType"
      ]
    },
    "BackupInstanceResource": {
      "type": "object",
      "description": "BackupInstance Resource",
      "properties": {
        "properties": {
          "$ref": "#/$defs/BackupInstance",
          "description": "BackupInstanceResource properties"
        },
        "tags": {
          "type": "object",
          "description": "Proxy Resource tags.",
          "additionalProperties": {
            "type": "string"
          }
        }
      },
      "allOf": [
        {
          "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
        }
      ]
    },
    "BaseResourceProperties": {
      "type": "object",
      "description": "Properties which are specific to datasource/datasourceSets",
      "properties": {
        "objectType": {
          "$ref": "#/$defs/ResourcePropertiesObjectType",
          "description": "Type of the specific object - used for deserializing"
        }
      },
      "required": [
        "objectType"
      ]
    },
    "CurrentProtectionState": {
      "type": "string",
      "description": "Specifies the current protection state of the resource",
      "enum": [
        "Invalid",
        "NotProtected",
        "ConfiguringProtection",
        "ProtectionConfigured",
        "BackupSchedulesSuspended",
        "RetentionSchedulesSuspended",
        "ProtectionStopped",
        "ProtectionError",
        "ConfiguringProtectionFailed",
        "SoftDeleting",
        "SoftDeleted",
        "UpdatingProtection"
      ],
      "x-ms-enum": {
        "name": "CurrentProtectionState",
        "modelAsString": true,
        "values": [
          {
            "name": "Invalid",
            "value": "Invalid"
          },
          {
            "name": "NotProtected",
            "value": "NotProtected"
          },
          {
            "name": "ConfiguringProtection",
            "value": "ConfiguringProtection"
          },
          {
            "name": "ProtectionConfigured",
            "value": "ProtectionConfigured"
          },
          {
            "name": "BackupSchedulesSuspended",
            "value": "BackupSchedulesSuspended"
          },
          {
            "name": "RetentionSchedulesSuspended",
            "value": "RetentionSchedulesSuspended"
          },
          {
            "name": "ProtectionStopped",
            "value": "ProtectionStopped"
          },
          {
            "name": "ProtectionError",
            "value": "ProtectionError"
          },
          {
            "name": "ConfiguringProtectionFailed",
            "value": "ConfiguringProtectionFailed"
          },
          {
            "name": "SoftDeleting",
            "value": "SoftDeleting"
          },
          {
            "name": "SoftDeleted",
            "value": "SoftDeleted"
          },
          {
            "name": "UpdatingProtection",
            "value": "UpdatingProtection"
          }
        ]
      }
    },
    "DataStoreParameters": {
      "type": "object",
      "description": "Parameters for DataStore",
      "properties": {
        "objectType": {
          "type": "string",
          "description": "Type of the specific object - used for deserializing"
        },
        "dataStoreType": {
          "$ref": "#/$defs/DataStoreTypes",
          "description": "type of datastore; Operational/Vault/Archive"
        }
      },
      "required": [
        "objectType",
        "dataStoreType"
      ]
    },
    "DataStoreTypes": {
      "type": "string",
      "description": "type of datastore; Operational/Vault/Archive",
      "enum": [
        "OperationalStore",
        "VaultStore",
        "ArchiveStore"
      ],
      "x-ms-enum": {
        "name": "DataStoreTypes",
        "modelAsString": true,
        "values": [
          {
            "name": "OperationalStore",
            "value": "OperationalStore"
          },
          {
            "name": "VaultStore",
            "value": "VaultStore"
          },
          {
            "name": "ArchiveStore",
            "value": "ArchiveStore"
          }
        ]
      }
    },
    "Datasource": {
      "type": "object",
      "description": "Datasource to be backed up",
      "properties": {
        "datasourceType": {
          "type": "string",
          "description": "DatasourceType of the resource."
        },
        "objectType": {
          "type": "string",
          "description": "Type of Datasource object, used to initialize the right inherited type"
        },
        "resourceID": {
          "type": "string",
          "description": "Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault."
        },
        "resourceLocation": {
          "type": "string",
          "description": "Location of datasource."
        },
        "resourceName": {
          "type": "string",
          "description": "Unique identifier of the resource in the context of parent."
        },
        "resourceType": {
          "type": "string",
          "description": "Resource Type of Datasource."
        },
        "resourceUri": {
          "type": "string",
          "description": "Uri of the resource."
        },
        "resourceProperties": {
          "$ref": "#/$defs/BaseResourceProperties",
          "description": "Properties specific to data source"
        }
      },
      "required": [
        "resourceID"
      ]
    },
    "DatasourceSet": {
      "type": "object",
      "description": "DatasourceSet details of datasource to be backed up",
      "properties": {
        "datasourceType": {
          "type": "string",
          "description": "DatasourceType of the resource."
        },
        "objectType": {
          "type": "string",
          "description": "Type of Datasource object, used to initialize the right inherited type"
        },
        "resourceID": {
          "type": "string",
          "description": "Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault."
        },
        "resourceLocation": {
          "type": "string",
          "description": "Location of datasource."
        },
        "resourceName": {
          "type": "string",
          "description": "Unique identifier of the resource in the context of parent."
        },
        "resourceType": {
          "type": "string",
          "description": "Resource Type of Datasource."
        },
        "resourceUri": {
          "type": "string",
          "description": "Uri of the resource."
        },
        "resourceProperties": {
          "$ref": "#/$defs/BaseResourceProperties",
          "description": "Properties specific to data source set"
        }
      },
      "required": [
        "resourceID"
      ]
    },
    "DppResourceList": {
      "type": "object",
      "description": "ListResource",
      "properties": {
        "nextLink": {
          "type": "string",
          "description": "The uri to fetch the next page of resources. Call ListNext() fetches next page of resources."
        }
      }
    },
    "IdentityDetails": {
      "type": "object",
      "properties": {
        "useSystemAssignedIdentity": {
          "type": "boolean",
          "description": "Specifies if the BI is protected by System Identity."
        },
        "userAssignedIdentityArmUrl": {
          "type": "string",
          "description": "ARM URL for User Assigned Identity."
        }
      }
    },
    "InnerError": {
      "type": "object",
      "description": "Inner Error",
      "properties": {
        "additionalInfo": {
          "type": "object",
          "description": "Any Key value pairs that can be provided to the client for additional  verbose information.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "code": {
          "type": "string",
          "description": "Unique code for this error"
        },
        "embeddedInnerError": {
          "$ref": "#/$defs/InnerError",
          "description": "Child Inner Error, to allow Nesting."
        }
      }
    },
    "PolicyInfo": {
      "type": "object",
      "description": "Policy Info in backupInstance",
      "properties": {
        "policyId": {
          "type": "string"
        },
        "policyVersion": {
          "type": "string",
          "readOnly": true
        },
        "policyParameters": {
          "$ref": "#/$defs/PolicyParameters",
          "description": "Policy parameters for the backup instance"
        }
      },
      "required": [
        "policyId"
      ]
    },
    "PolicyParameters": {
      "type": "object",
      "description": "Parameters in Policy",
      "properties": {
        "dataStoreParametersList": {
          "type": "array",
          "description": "Gets or sets the DataStore Parameters",
          "items": {
            "$ref": "#/$defs/DataStoreParameters"
          },
          "x-ms-identifiers": []
        },
        "backupDatasourceParametersList": {
          "type": "array",
          "description": "Gets or sets the Backup Data Source Parameters",
          "items": {
            "$ref": "#/$defs/BackupDatasourceParameters"
          },
          "x-ms-identifiers": []
        }
      }
    },
    "ProtectionStatusDetails": {
      "type": "object",
      "description": "Protection status details",
      "properties": {
        "errorDetails": {
          "$ref": "#/$defs/UserFacingError",
          "description": "Specifies the protection status error of the resource"
        },
        "status": {
          "$ref": "#/$defs/Status",
          "description": "Specifies the protection status of the resource"
        }
      }
    },
    "ResourcePropertiesObjectType": {
      "type": "string",
      "description": "Type of the specific object - used for deserializing",
      "enum": [
        "DefaultResourceProperties"
      ],
      "x-ms-enum": {
        "name": "ResourcePropertiesObjectType",
        "modelAsString": true,
        "values": [
          {
            "name": "DefaultResourceProperties",
            "value": "DefaultResourceProperties"
          }
        ]
      }
    },
    "Status": {
      "type": "string",
      "description": "Specifies the protection status of the resource",
      "enum": [
        "ConfiguringProtection",
        "ConfiguringProtectionFailed",
        "ProtectionConfigured",
        "ProtectionStopped",
        "SoftDeleted",
        "SoftDeleting"
      ],
      "x-ms-enum": {
        "name": "Status",
        "modelAsString": true,
        "values": [
          {
            "name": "ConfiguringProtection",
            "value": "ConfiguringProtection"
          },
          {
            "name": "ConfiguringProtectionFailed",
            "value": "ConfiguringProtectionFailed"
          },
          {
            "name": "ProtectionConfigured",
            "value": "ProtectionConfigured"
          },
          {
            "name": "ProtectionStopped",
            "value": "ProtectionStopped"
          },
          {
            "name": "SoftDeleted",
            "value": "SoftDeleted"
          },
          {
            "name": "SoftDeleting",
            "value": "SoftDeleting"
          }
        ]
      }
    },
    "UserFacingError": {
      "type": "object",
      "description": "Error object used by layers that have access to localized content, and propagate that to user",
      "properties": {
        "code": {
          "type": "string",
          "description": "Unique code for this error"
        },
        "details": {
          "type": "array",
          "description": "Additional related Errors",
          "items": {
            "$ref": "#/$defs/UserFacingError"
          },
          "x-ms-identifiers": []
        },
        "innerError": {
          "$ref": "#/$defs/InnerError",
          "description": "Inner Error"
        },
        "isRetryable": {
          "type": "boolean",
          "description": "Whether the operation will be retryable or not"
        },
        "isUserError": {
          "type": "boolean",
          "description": "Whether the operation is due to a user error or service error"
        },
        "properties": {
          "type": "object",
          "description": "Any key value pairs that can be injected inside error object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "message": {
          "type": "string"
        },
        "recommendedAction": {
          "type": "array",
          "description": "RecommendedAction � localized.",
          "items": {
            "type": "string"
          }
        },
        "target": {
          "type": "string",
          "description": "Target of the error."
        }
      }
    },
    "ValidationType": {
      "type": "string",
      "description": "Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again.",
      "enum": [
        "ShallowValidation",
        "DeepValidation"
      ],
      "x-ms-enum": {
        "name": "ValidationType",
        "modelAsString": true,
        "values": [
          {
            "name": "ShallowValidation",
            "value": "ShallowValidation"
          },
          {
            "name": "DeepValidation",
            "value": "DeepValidation"
          }
        ]
      }
    }
  }
}