Microsoft.DataProtection backupVaults/backupInstances 2023-12-01

Article
2025-04-14

Bicep resource definition

The backupVaults/backupInstances resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

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

resource symbolicname 'Microsoft.DataProtection/backupVaults/backupInstances@2023-12-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    datasourceAuthCredentials: {
      objectType: 'string'
      // For remaining properties, see AuthCredentials objects
    }
    dataSourceInfo: {
      datasourceType: 'string'
      objectType: 'string'
      resourceID: 'string'
      resourceLocation: 'string'
      resourceName: 'string'
      resourceProperties: {
        objectType: 'string'
        // For remaining properties, see BaseResourceProperties objects
      }
      resourceType: 'string'
      resourceUri: 'string'
    }
    dataSourceSetInfo: {
      datasourceType: 'string'
      objectType: 'string'
      resourceID: 'string'
      resourceLocation: 'string'
      resourceName: 'string'
      resourceProperties: {
        objectType: 'string'
        // For remaining properties, see BaseResourceProperties objects
      }
      resourceType: 'string'
      resourceUri: 'string'
    }
    friendlyName: 'string'
    identityDetails: {
      userAssignedIdentityArmUrl: 'string'
      useSystemAssignedIdentity: bool
    }
    objectType: 'string'
    policyInfo: {
      policyId: 'string'
      policyParameters: {
        backupDatasourceParametersList: [
          {
            objectType: 'string'
            // For remaining properties, see BackupDatasourceParameters objects
          }
        ]
        dataStoreParametersList: [
          {
            dataStoreType: 'string'
            objectType: 'string'
            // For remaining properties, see DataStoreParameters objects
          }
        ]
      }
    }
    validationType: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

AuthCredentials objects

Set the objectType property to specify the type of object.

For SecretStoreBasedAuthCredentials, use:

{
  objectType: 'SecretStoreBasedAuthCredentials'
  secretStoreResource: {
    secretStoreType: 'string'
    uri: 'string'
    value: 'string'
  }
}

DataStoreParameters objects

Set the objectType property to specify the type of object.

For AzureOperationalStoreParameters, use:

{
  objectType: 'AzureOperationalStoreParameters'
  resourceGroupId: 'string'
}

BackupDatasourceParameters objects

Set the objectType property to specify the type of object.

For BlobBackupDatasourceParameters, use:

{
  containersList: [
    'string'
  ]
  objectType: 'BlobBackupDatasourceParameters'
}

For KubernetesClusterBackupDatasourceParameters, use:

{
  backupHookReferences: [
    {
      name: 'string'
      namespace: 'string'
    }
  ]
  excludedNamespaces: [
    'string'
  ]
  excludedResourceTypes: [
    'string'
  ]
  includeClusterScopeResources: bool
  includedNamespaces: [
    'string'
  ]
  includedResourceTypes: [
    'string'
  ]
  labelSelectors: [
    'string'
  ]
  objectType: 'KubernetesClusterBackupDatasourceParameters'
  snapshotVolumes: bool
}

BaseResourceProperties objects

Set the objectType property to specify the type of object.

For DefaultResourceProperties, use:

{
  objectType: 'DefaultResourceProperties'
}

Property Values

AuthCredentials

Name	Description	Value
objectType	Set to 'SecretStoreBasedAuthCredentials' for type SecretStoreBasedAuthCredentials.	'SecretStoreBasedAuthCredentials' (required)

AzureOperationalStoreParameters

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

BackupDatasourceParameters

Name	Description	Value
objectType	Set to 'BlobBackupDatasourceParameters' for type BlobBackupDatasourceParameters. Set to 'KubernetesClusterBackupDatasourceParameters' for type KubernetesClusterBackupDatasourceParameters.	'BlobBackupDatasourceParameters' 'KubernetesClusterBackupDatasourceParameters' (required)

BackupInstance

Name	Description	Value
datasourceAuthCredentials	Credentials to use to authenticate with data source provider.	AuthCredentials
dataSourceInfo	Gets or sets the data source information.	Datasource (required)
dataSourceSetInfo	Gets or sets the data source set information.	DatasourceSet
friendlyName	Gets or sets the Backup Instance friendly name.	string
identityDetails	Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned.	IdentityDetails
objectType		string (required)
policyInfo	Gets or sets the policy information.	PolicyInfo (required)
validationType	Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again.	'DeepValidation' 'ShallowValidation'

BaseResourceProperties

Name	Description	Value
objectType	Set to 'DefaultResourceProperties' for type DefaultResourceProperties.	'DefaultResourceProperties' (required)

BlobBackupDatasourceParameters

Name	Description	Value
containersList	List of containers to be backed up during configuration of backup of blobs	string[] (required)
objectType	Type of the specific object - used for deserializing	'BlobBackupDatasourceParameters' (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
resourceProperties	Properties specific to data source	BaseResourceProperties
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
resourceProperties	Properties specific to data source set	BaseResourceProperties
resourceType	Resource Type of Datasource.	string
resourceUri	Uri of the resource.	string

DataStoreParameters

Name	Description	Value
dataStoreType	type of datastore; Operational/Vault/Archive	'ArchiveStore' 'OperationalStore' 'VaultStore' (required)
objectType	Set to 'AzureOperationalStoreParameters' for type AzureOperationalStoreParameters.	'AzureOperationalStoreParameters' (required)

DefaultResourceProperties

Name	Description	Value
objectType	Type of the specific object - used for deserializing	'DefaultResourceProperties' (required)

DppProxyResourceTags

Name	Description	Value

IdentityDetails

Name	Description	Value
userAssignedIdentityArmUrl	ARM URL for User Assigned Identity.	string
useSystemAssignedIdentity	Specifies if the BI is protected by System Identity.	bool

KubernetesClusterBackupDatasourceParameters

Name	Description	Value
backupHookReferences	Gets or sets the backup hook references. This property sets the hook reference to be executed during backup.	NamespacedNameResource[]
excludedNamespaces	Gets or sets the exclude namespaces property. This property sets the namespaces to be excluded during backup.	string[]
excludedResourceTypes	Gets or sets the exclude resource types property. This property sets the resource types to be excluded during backup.	string[]
includeClusterScopeResources	Gets or sets the include cluster resources property. This property if enabled will include cluster scope resources during backup.	bool (required)
includedNamespaces	Gets or sets the include namespaces property. This property sets the namespaces to be included during backup.	string[]
includedResourceTypes	Gets or sets the include resource types property. This property sets the resource types to be included during backup.	string[]
labelSelectors	Gets or sets the LabelSelectors property. This property sets the resource with such label selectors to be included during backup.	string[]
objectType	Type of the specific object - used for deserializing	'KubernetesClusterBackupDatasourceParameters' (required)
snapshotVolumes	Gets or sets the volume snapshot property. This property if enabled will take volume snapshots during backup.	bool (required)