Microsoft.DataProtection backupVaults/backupInstances 2021-01-01

The backupVaults/backupInstances resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.DataProtection/backupVaults/backupInstances resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.DataProtection/backupVaults/backupInstances@2021-01-01' = {
  name: 'string'
  properties: {
    dataSourceInfo: {
      datasourceType: 'string'
      objectType: 'string'
      resourceID: 'string'
      resourceLocation: 'string'
      resourceName: 'string'
      resourceType: 'string'
      resourceUri: 'string'
    }
    dataSourceSetInfo: {
      datasourceType: 'string'
      objectType: 'string'
      resourceID: 'string'
      resourceLocation: 'string'
      resourceName: 'string'
      resourceType: 'string'
      resourceUri: 'string'
    }
    friendlyName: 'string'
    objectType: 'string'
    policyInfo: {
      policyId: 'string'
      policyParameters: {
        dataStoreParametersList: [
          {
            dataStoreType: 'string'
            objectType: 'string'
            // For remaining properties, see DataStoreParameters objects
          }
        ]
      }
    }
  }
}

DataStoreParameters objects

Set the objectType property to specify the type of object.

For AzureOperationalStoreParameters, use:

  objectType: 'AzureOperationalStoreParameters'
  resourceGroupId: 'string'

Property values

backupVaults/backupInstances

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.DataProtection/backupVaults/backupInstances'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2021-01-01'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
string (required)
properties Backup Instance BackupInstance

BackupInstance

Name Description Value
dataSourceInfo Datasource to be backed up Datasource (required)
dataSourceSetInfo DatasourceSet details of datasource to be backed up DatasourceSet
friendlyName Gets or sets the Backup Instance friendly name. string
objectType string (required)
policyInfo Policy Info in backupInstance PolicyInfo (required)

Datasource

Name Description Value
datasourceType DatasourceType of the resource. string
objectType Type of Datasource object, used to initialize the right inherited type string
resourceID 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. string (required)
resourceLocation Location of datasource. string
resourceName Unique identifier of the resource in the context of parent. string
resourceType Resource Type of Datasource. string
resourceUri Uri of the resource. string

DatasourceSet

Name Description Value
datasourceType DatasourceType of the resource. string
objectType Type of Datasource object, used to initialize the right inherited type string
resourceID 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. string (required)
resourceLocation Location of datasource. string
resourceName Unique identifier of the resource in the context of parent. string
resourceType Resource Type of Datasource. string
resourceUri Uri of the resource. string

PolicyInfo

Name Description Value
policyId string (required)
policyParameters Parameters in Policy PolicyParameters

PolicyParameters

Name Description Value
dataStoreParametersList Gets or sets the DataStore Parameters DataStoreParameters[]

DataStoreParameters

Name Description Value
dataStoreType type of datastore; Operational/Vault/Archive 'ArchiveStore'
'OperationalStore'
'VaultStore'
objectType Set the object type AzureOperationalStoreParameters

AzureOperationalStoreParameters

Name Description Value
objectType Type of the specific object - used for deserializing 'AzureOperationalStoreParameters'
resourceGroupId Gets or sets the Snapshot Resource Group Uri. string

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create Disk & enable protection via Backup Vault

Deploy to Azure
Template that creates a disk and enables protection via Backup Vault
Create Storage Account & enable protection via Backup Vault

Deploy to Azure
Template that creates storage account and enable protection via Backup Vault