Microsoft.RecoveryServices vaults/backupFabrics/protectionContainers 2020-10-01

The vaults/backupFabrics/protectionContainers 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.RecoveryServices/vaults/backupFabrics/protectionContainers resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers@2020-10-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: parentSymbolicName
  eTag: 'string'
  properties: {
    backupManagementType: 'string'
    friendlyName: 'string'
    healthStatus: 'string'
    registrationStatus: 'string'
    containerType: 'string'
    // For remaining properties, see ProtectionContainer objects
  }
}

ProtectionContainer objects

Set the containerType property to specify the type of object.

For AzureBackupServerContainer, use:

  containerType: 'AzureBackupServerContainer'

For AzureSqlContainer, use:

  containerType: 'AzureSqlContainer'

For GenericContainer, use:

  containerType: 'GenericContainer'
  extendedInformation: {
    containerIdentityInfo: {
      aadTenantId: 'string'
      audience: 'string'
      servicePrincipalClientId: 'string'
      uniqueName: 'string'
    }
    rawCertData: 'string'
    serviceEndpoints: {}
  }
  fabricName: 'string'

For Microsoft.ClassicCompute/virtualMachines, use:

  containerType: 'Microsoft.ClassicCompute/virtualMachines'

For Microsoft.Compute/virtualMachines, use:

  containerType: 'Microsoft.Compute/virtualMachines'

For SQLAGWorkLoadContainer, use:

  containerType: 'SQLAGWorkLoadContainer'

For StorageContainer, use:

  containerType: 'StorageContainer'
  protectedItemCount: int
  resourceGroup: 'string'
  sourceResourceId: 'string'
  storageAccountVersion: 'string'

For VMAppContainer, use:

  containerType: 'VMAppContainer'

For Windows, use:

  containerType: 'Windows'
  agentVersion: 'string'
  canReRegister: bool
  containerHealthState: 'string'
  containerId: int
  extendedInfo: {
    backupItems: [ 'string' ]
    backupItemType: 'string'
    lastBackupStatus: 'string'
    lastRefreshedAt: 'string'
    policyName: 'string'
  }
  mabContainerHealthDetails: [
    {
      code: int
      message: 'string'
      recommendations: [ 'string' ]
      title: 'string'
    }
  ]
  protectedItemCount: int

Property values

vaults/backupFabrics/protectionContainers

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers'
apiVersion The resource api version

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

See how to set names and types for child resources in Bicep or JSON ARM templates.
string (required)
location Resource location. string
tags Resource tags. Dictionary of tag names and values. See Tags in templates
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.
parentSymbolicName
eTag Optional ETag. string
properties Base class for container with backup items. Containers with specific workloads are derived from this class. ProtectionContainer

ProtectionContainer

Name Description Value
backupManagementType Backup management type to execute the current job. 'AzureBackupServer'
'AzureIaasVM'
'AzureSql'
'AzureStorage'
'AzureWorkload'
'DPM'
'DefaultBackup'
'Invalid'
'MAB'
friendlyName Friendly name of the container. string
healthStatus Status of health of the container. string
registrationStatus Status of registration of the container with the Recovery Services Vault. string
containerType Set the object type AzureBackupServerContainer
AzureSqlContainer
GenericContainer
Microsoft.ClassicCompute/virtualMachines
Microsoft.Compute/virtualMachines
SQLAGWorkLoadContainer
StorageContainer
VMAppContainer
Windows

AzureBackupServerContainer

Name Description Value
containerType Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2.
Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is
Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload
Backup is VMAppContainer
'AzureBackupServerContainer'

AzureSqlContainer

Name Description Value
containerType Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2.
Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is
Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload
Backup is VMAppContainer
'AzureSqlContainer'

GenericContainer

Name Description Value
containerType Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2.
Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is
Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload
Backup is VMAppContainer
'GenericContainer'
extendedInformation Container extended information GenericContainerExtendedInfo
fabricName Name of the container's fabric string

GenericContainerExtendedInfo

Name Description Value
containerIdentityInfo Container identity information ContainerIdentityInfo
rawCertData Public key of container cert string
serviceEndpoints Azure Backup Service Endpoints for the container object

ContainerIdentityInfo

Name Description Value
aadTenantId Protection container identity - AAD Tenant string
audience Protection container identity - Audience string
servicePrincipalClientId Protection container identity - AAD Service Principal string
uniqueName Unique name of the container string

AzureIaaSClassicComputeVMContainer

Name Description Value
containerType Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2.
Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is
Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload
Backup is VMAppContainer
'Microsoft.ClassicCompute/virtualMachines'

AzureIaaSComputeVMContainer

Name Description Value
containerType Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2.
Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is
Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload
Backup is VMAppContainer
'Microsoft.Compute/virtualMachines'

AzureSqlagWorkloadContainerProtectionContainer

Name Description Value
containerType Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2.
Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is
Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload
Backup is VMAppContainer
'SQLAGWorkLoadContainer'

AzureStorageContainer

Name Description Value
containerType Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2.
Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is
Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload
Backup is VMAppContainer
'StorageContainer'
protectedItemCount Number of items backed up in this container. int
resourceGroup Resource group name of Recovery Services Vault. string
sourceResourceId Fully qualified ARM url. string
storageAccountVersion Storage account version. string

AzureVMAppContainerProtectionContainer

Name Description Value
containerType Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2.
Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is
Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload
Backup is VMAppContainer
'VMAppContainer'

MabContainer

Name Description Value
containerType Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2.
Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is
Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload
Backup is VMAppContainer
'Windows'
agentVersion Agent version of this container. string
canReRegister Can the container be registered one more time. bool
containerHealthState Health state of mab container. string
containerId ContainerID represents the container. int
extendedInfo Additional information of the container. MabContainerExtendedInfo
mabContainerHealthDetails Health details on this mab container. MABContainerHealthDetails[]
protectedItemCount Number of items backed up in this container. int

MabContainerExtendedInfo

Name Description Value
backupItems List of backup items associated with this container. string[]
backupItemType Type of backup items associated with this container. 'AzureFileShare'
'AzureSqlDb'
'Client'
'Exchange'
'FileFolder'
'GenericDataSource'
'Invalid'
'SAPAseDatabase'
'SAPHanaDatabase'
'SQLDB'
'SQLDataBase'
'Sharepoint'
'SystemState'
'VM'
'VMwareVM'
lastBackupStatus Latest backup status of this container. string
lastRefreshedAt Time stamp when this container was refreshed. string
policyName Backup policy associated with this container. string

MABContainerHealthDetails

Name Description Value
code Health Code int
message Health Message string
recommendations Health Recommended Actions string[]
title Health Title string

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Backup existing File Share using Recovery Services

Deploy to Azure
This template configures protection for an existing File Share present in an existing Storage Account. It creates a new or uses an existing Recovery Services Vault and Backup Policy based on the set parameter values.
Azure Backup for Workload in Azure Virtual Machines

Deploy to Azure
This template creates a Recovery Services Vault and a Workload specific Backup Policy. Registers VM with Backup service and Configures Protection