Microsoft.RecoveryServices vaults/backupFabrics/protectionContainers/protectedItems 2016-06-01

Bicep resource definition

The vaults/backupFabrics/protectionContainers/protectedItems resource type can be deployed with operations that target:

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

Resource format

To create a Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems@2016-06-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  eTag: 'string'
  properties: {
    backupManagementType: 'string'
    lastRecoveryPoint: 'string'
    policyId: 'string'
    sourceResourceId: 'string'
    workloadType: 'string'
    protectedItemType: 'string'
    // For remaining properties, see ProtectedItem objects
  }
}

ProtectedItem objects

Set the protectedItemType property to specify the type of object.

For MabFileFolderProtectedItem, use:

  protectedItemType: 'MabFileFolderProtectedItem'
  computerName: 'string'
  extendedInfo: {
    lastRefreshedAt: 'string'
    oldestRecoveryPoint: 'string'
    recoveryPointCount: int
  }
  friendlyName: 'string'
  isScheduledForDeferredDelete: bool
  lastBackupStatus: 'string'
  protectionState: 'string'

For Microsoft.ClassicCompute/virtualMachines, use:

  protectedItemType: 'Microsoft.ClassicCompute/virtualMachines'
  extendedInfo: {
    oldestRecoveryPoint: 'string'
    policyInconsistent: bool
    recoveryPointCount: int
  }
  friendlyName: 'string'
  lastBackupStatus: 'string'
  lastBackupTime: 'string'
  protectionState: 'string'
  protectionStatus: 'string'
  virtualMachineId: 'string'

For Microsoft.Compute/virtualMachines, use:

  protectedItemType: 'Microsoft.Compute/virtualMachines'
  extendedInfo: {
    oldestRecoveryPoint: 'string'
    policyInconsistent: bool
    recoveryPointCount: int
  }
  friendlyName: 'string'
  lastBackupStatus: 'string'
  lastBackupTime: 'string'
  protectionState: 'string'
  protectionStatus: 'string'
  virtualMachineId: 'string'

For Microsoft.Sql/servers/databases, use:

  protectedItemType: 'Microsoft.Sql/servers/databases'
  extendedInfo: {
    oldestRecoveryPoint: 'string'
    policyState: 'string'
    recoveryPointCount: int
  }
  protectedItemDataId: 'string'
  protectionState: 'string'

Property values

vaults/backupFabrics/protectionContainers/protectedI...

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.
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.
Symbolic name for resource of type: protectionContainers
eTag Optional ETag. string
properties The base class for backup items. ProtectedItem

ProtectedItem

Name Description Value
backupManagementType The backup management type associated with the backup item. 'AzureBackupServer'
'AzureIaasVM'
'AzureSql'
'DPM'
'Invalid'
'MAB'
lastRecoveryPoint The timestamp when the most recent backup copy was created for this backup item. string
policyId The ID of the backup policy associated with this backup item. string
sourceResourceId The ID of the resource to be backed up. string
workloadType The workload type for this item. 'AzureSqlDb'
'DPMUnknown'
'Exchange'
'FileFolder'
'Invalid'
'SQLDB'
'Sharepoint'
'VM'
protectedItemType Set the object type MabFileFolderProtectedItem
Microsoft.ClassicCompute/virtualMachines
Microsoft.Compute/virtualMachines
Microsoft.Sql/servers/databases (required)

MabFileFolderProtectedItem

Name Description Value
protectedItemType The backup item type. 'MabFileFolderProtectedItem' (required)
computerName The name of the computer associated with this backup item. string
extendedInfo Additional information for this backup item. MabFileFolderProtectedItemExtendedInfo
friendlyName The friendly name of this backup item. string
isScheduledForDeferredDelete bool
lastBackupStatus The status of last backup operation. string
protectionState The states for this property are: Protected, ProtectionStopped, IRPending, or ProtectionError. string

MabFileFolderProtectedItemExtendedInfo

Name Description Value
lastRefreshedAt The last day and time the agent synced with the service. string
oldestRecoveryPoint The oldest backup copy available. string
recoveryPointCount The number of backup copies associated with the backup item. int

AzureIaaSClassicComputeVMProtectedItem

Name Description Value
protectedItemType The backup item type. 'Microsoft.ClassicCompute/virtualMachines' (required)
extendedInfo Additional information for this backup item. AzureIaaSVMProtectedItemExtendedInfo
friendlyName The friendly name of the VM represented by this backup item. string
lastBackupStatus The last backup operation status. The possible values are: Healthy or Unhealthy. string
lastBackupTime The timestamp of the last backup operation for this backup item. string
protectionState The backup state of this backup item. 'IRPending'
'Invalid'
'Protected'
'ProtectionError'
'ProtectionPaused'
'ProtectionStopped'
protectionStatus The backup status of this backup item. string
virtualMachineId The fully qualified Resource Manager ID of the virtual machine represented by this item. string

AzureIaaSVMProtectedItemExtendedInfo

Name Description Value
oldestRecoveryPoint The oldest backup copy available for this backup item. string
policyInconsistent Specifies if the backup policy associated with the backup item is inconsistent. bool
recoveryPointCount The number of backup copies available for this backup item. int

AzureIaaSComputeVMProtectedItem

Name Description Value
protectedItemType The backup item type. 'Microsoft.Compute/virtualMachines' (required)
extendedInfo Additional information for this backup item. AzureIaaSVMProtectedItemExtendedInfo
friendlyName The friendly name of the VM represented by this backup item. string
lastBackupStatus The last backup operation status. The possible values are: Healthy or Unhealthy. string
lastBackupTime The timestamp of the last backup operation for this backup item. string
protectionState The backup state of this backup item. 'IRPending'
'Invalid'
'Protected'
'ProtectionError'
'ProtectionPaused'
'ProtectionStopped'
protectionStatus The backup status of this backup item. string
virtualMachineId The fully qualified Resource Manager ID of the virtual machine represented by this item. string

AzureSqlProtectedItem

Name Description Value
protectedItemType The backup item type. 'Microsoft.Sql/servers/databases' (required)
extendedInfo Additional information for this backup item. AzureSqlProtectedItemExtendedInfo
protectedItemDataId The internal ID of a backup item. The internal ID is used by the Azure SQL Backup engine to contact Recovery Services. string
protectionState The backup state of the backup item. 'IRPending'
'Invalid'
'Protected'
'ProtectionError'
'ProtectionPaused'
'ProtectionStopped'

AzureSqlProtectedItemExtendedInfo

Name Description Value
oldestRecoveryPoint The oldest backup copy available for this item in the service. string
policyState The state of the backup policy associated with this backup item. string
recoveryPointCount The number of available backup copies for this backup item. int

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
IBM Cloud Pak for Data on Azure

Deploy to Azure
This template deploys an Openshift cluster on Azure with all the required resources, infrastructure and then deploys IBM Cloud Pak for Data along with the add-ons that user chooses.
Openshift Container Platform 4.3

Deploy to Azure
Openshift Container Platform 4.3
Backup existing IaasVM using Recovery Services

Deploy to Azure
This template will use existing recovery services vault and existing backup policy, and configures protection of multiple classic and ARM based Azure IaasVMs.
Backup existing File Share using Recovery Services (Daily)

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.
Backup existing File Share using Recovery Services (hourly)

Deploy to Azure
This template configures protection with hourly frequency 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.
Backup Resource Manager VMs using Recovery Services vault

Deploy to Azure
This template will use existing recovery services vault and existing backup policy, and configures backup of multiple Resource Manager VMs that belong to same resource group
Deploy a Windows VM and enable backup using Azure Backup

Deploy to Azure
This template allows you to deploy a Windows VM and Recovery Services Vault configured with the DefaultPolicy for Protection.
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

ARM template resource definition

The vaults/backupFabrics/protectionContainers/protectedItems resource type can be deployed with operations that target:

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

Resource format

To create a Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems resource, add the following JSON to your template.

{
  "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems",
  "apiVersion": "2016-06-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "eTag": "string",
  "properties": {
    "backupManagementType": "string",
    "lastRecoveryPoint": "string",
    "policyId": "string",
    "sourceResourceId": "string",
    "workloadType": "string",
    "protectedItemType": "string"
    // For remaining properties, see ProtectedItem objects
  }
}

ProtectedItem objects

Set the protectedItemType property to specify the type of object.

For MabFileFolderProtectedItem, use:

  "protectedItemType": "MabFileFolderProtectedItem",
  "computerName": "string",
  "extendedInfo": {
    "lastRefreshedAt": "string",
    "oldestRecoveryPoint": "string",
    "recoveryPointCount": "int"
  },
  "friendlyName": "string",
  "isScheduledForDeferredDelete": "bool",
  "lastBackupStatus": "string",
  "protectionState": "string"

For Microsoft.ClassicCompute/virtualMachines, use:

  "protectedItemType": "Microsoft.ClassicCompute/virtualMachines",
  "extendedInfo": {
    "oldestRecoveryPoint": "string",
    "policyInconsistent": "bool",
    "recoveryPointCount": "int"
  },
  "friendlyName": "string",
  "lastBackupStatus": "string",
  "lastBackupTime": "string",
  "protectionState": "string",
  "protectionStatus": "string",
  "virtualMachineId": "string"

For Microsoft.Compute/virtualMachines, use:

  "protectedItemType": "Microsoft.Compute/virtualMachines",
  "extendedInfo": {
    "oldestRecoveryPoint": "string",
    "policyInconsistent": "bool",
    "recoveryPointCount": "int"
  },
  "friendlyName": "string",
  "lastBackupStatus": "string",
  "lastBackupTime": "string",
  "protectionState": "string",
  "protectionStatus": "string",
  "virtualMachineId": "string"

For Microsoft.Sql/servers/databases, use:

  "protectedItemType": "Microsoft.Sql/servers/databases",
  "extendedInfo": {
    "oldestRecoveryPoint": "string",
    "policyState": "string",
    "recoveryPointCount": "int"
  },
  "protectedItemDataId": "string",
  "protectionState": "string"

Property values

vaults/backupFabrics/protectionContainers/protectedI...

Name Description Value
type The resource type 'Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems'
apiVersion The resource api version '2016-06-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
string (required)
location Resource location. string
tags Resource tags. Dictionary of tag names and values. See Tags in templates
eTag Optional ETag. string
properties The base class for backup items. ProtectedItem

ProtectedItem

Name Description Value
backupManagementType The backup management type associated with the backup item. 'AzureBackupServer'
'AzureIaasVM'
'AzureSql'
'DPM'
'Invalid'
'MAB'
lastRecoveryPoint The timestamp when the most recent backup copy was created for this backup item. string
policyId The ID of the backup policy associated with this backup item. string
sourceResourceId The ID of the resource to be backed up. string
workloadType The workload type for this item. 'AzureSqlDb'
'DPMUnknown'
'Exchange'
'FileFolder'
'Invalid'
'SQLDB'
'Sharepoint'
'VM'
protectedItemType Set the object type MabFileFolderProtectedItem
Microsoft.ClassicCompute/virtualMachines
Microsoft.Compute/virtualMachines
Microsoft.Sql/servers/databases (required)

MabFileFolderProtectedItem

Name Description Value
protectedItemType The backup item type. 'MabFileFolderProtectedItem' (required)
computerName The name of the computer associated with this backup item. string
extendedInfo Additional information for this backup item. MabFileFolderProtectedItemExtendedInfo
friendlyName The friendly name of this backup item. string
isScheduledForDeferredDelete bool
lastBackupStatus The status of last backup operation. string
protectionState The states for this property are: Protected, ProtectionStopped, IRPending, or ProtectionError. string

MabFileFolderProtectedItemExtendedInfo

Name Description Value
lastRefreshedAt The last day and time the agent synced with the service. string
oldestRecoveryPoint The oldest backup copy available. string
recoveryPointCount The number of backup copies associated with the backup item. int

AzureIaaSClassicComputeVMProtectedItem

Name Description Value
protectedItemType The backup item type. 'Microsoft.ClassicCompute/virtualMachines' (required)
extendedInfo Additional information for this backup item. AzureIaaSVMProtectedItemExtendedInfo
friendlyName The friendly name of the VM represented by this backup item. string
lastBackupStatus The last backup operation status. The possible values are: Healthy or Unhealthy. string
lastBackupTime The timestamp of the last backup operation for this backup item. string
protectionState The backup state of this backup item. 'IRPending'
'Invalid'
'Protected'
'ProtectionError'
'ProtectionPaused'
'ProtectionStopped'
protectionStatus The backup status of this backup item. string
virtualMachineId The fully qualified Resource Manager ID of the virtual machine represented by this item. string

AzureIaaSVMProtectedItemExtendedInfo

Name Description Value
oldestRecoveryPoint The oldest backup copy available for this backup item. string
policyInconsistent Specifies if the backup policy associated with the backup item is inconsistent. bool
recoveryPointCount The number of backup copies available for this backup item. int

AzureIaaSComputeVMProtectedItem

Name Description Value
protectedItemType The backup item type. 'Microsoft.Compute/virtualMachines' (required)
extendedInfo Additional information for this backup item. AzureIaaSVMProtectedItemExtendedInfo
friendlyName The friendly name of the VM represented by this backup item. string
lastBackupStatus The last backup operation status. The possible values are: Healthy or Unhealthy. string
lastBackupTime The timestamp of the last backup operation for this backup item. string
protectionState The backup state of this backup item. 'IRPending'
'Invalid'
'Protected'
'ProtectionError'
'ProtectionPaused'
'ProtectionStopped'
protectionStatus The backup status of this backup item. string
virtualMachineId The fully qualified Resource Manager ID of the virtual machine represented by this item. string

AzureSqlProtectedItem

Name Description Value
protectedItemType The backup item type. 'Microsoft.Sql/servers/databases' (required)
extendedInfo Additional information for this backup item. AzureSqlProtectedItemExtendedInfo
protectedItemDataId The internal ID of a backup item. The internal ID is used by the Azure SQL Backup engine to contact Recovery Services. string
protectionState The backup state of the backup item. 'IRPending'
'Invalid'
'Protected'
'ProtectionError'
'ProtectionPaused'
'ProtectionStopped'

AzureSqlProtectedItemExtendedInfo

Name Description Value
oldestRecoveryPoint The oldest backup copy available for this item in the service. string
policyState The state of the backup policy associated with this backup item. string
recoveryPointCount The number of available backup copies for this backup item. int

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
IBM Cloud Pak for Data on Azure

Deploy to Azure
This template deploys an Openshift cluster on Azure with all the required resources, infrastructure and then deploys IBM Cloud Pak for Data along with the add-ons that user chooses.
Openshift Container Platform 4.3

Deploy to Azure
Openshift Container Platform 4.3
Backup existing IaasVM using Recovery Services

Deploy to Azure
This template will use existing recovery services vault and existing backup policy, and configures protection of multiple classic and ARM based Azure IaasVMs.
Backup existing File Share using Recovery Services (Daily)

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.
Backup existing File Share using Recovery Services (hourly)

Deploy to Azure
This template configures protection with hourly frequency 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.
Backup Resource Manager VMs using Recovery Services vault

Deploy to Azure
This template will use existing recovery services vault and existing backup policy, and configures backup of multiple Resource Manager VMs that belong to same resource group
Deploy a Windows VM and enable backup using Azure Backup

Deploy to Azure
This template allows you to deploy a Windows VM and Recovery Services Vault configured with the DefaultPolicy for Protection.
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

Terraform (AzAPI provider) resource definition

The vaults/backupFabrics/protectionContainers/protectedItems resource type can be deployed with operations that target:

  • Resource groups

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

Resource format

To create a Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems@2016-06-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      backupManagementType = "string"
      lastRecoveryPoint = "string"
      policyId = "string"
      sourceResourceId = "string"
      workloadType = "string"
      protectedItemType = "string"
      // For remaining properties, see ProtectedItem objects
    }
    eTag = "string"
  })
}

ProtectedItem objects

Set the protectedItemType property to specify the type of object.

For MabFileFolderProtectedItem, use:

  protectedItemType = "MabFileFolderProtectedItem"
  computerName = "string"
  extendedInfo = {
    lastRefreshedAt = "string"
    oldestRecoveryPoint = "string"
    recoveryPointCount = int
  }
  friendlyName = "string"
  isScheduledForDeferredDelete = bool
  lastBackupStatus = "string"
  protectionState = "string"

For Microsoft.ClassicCompute/virtualMachines, use:

  protectedItemType = "Microsoft.ClassicCompute/virtualMachines"
  extendedInfo = {
    oldestRecoveryPoint = "string"
    policyInconsistent = bool
    recoveryPointCount = int
  }
  friendlyName = "string"
  lastBackupStatus = "string"
  lastBackupTime = "string"
  protectionState = "string"
  protectionStatus = "string"
  virtualMachineId = "string"

For Microsoft.Compute/virtualMachines, use:

  protectedItemType = "Microsoft.Compute/virtualMachines"
  extendedInfo = {
    oldestRecoveryPoint = "string"
    policyInconsistent = bool
    recoveryPointCount = int
  }
  friendlyName = "string"
  lastBackupStatus = "string"
  lastBackupTime = "string"
  protectionState = "string"
  protectionStatus = "string"
  virtualMachineId = "string"

For Microsoft.Sql/servers/databases, use:

  protectedItemType = "Microsoft.Sql/servers/databases"
  extendedInfo = {
    oldestRecoveryPoint = "string"
    policyState = "string"
    recoveryPointCount = int
  }
  protectedItemDataId = "string"
  protectionState = "string"

Property values

vaults/backupFabrics/protectionContainers/protectedI...

Name Description Value
type The resource type "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems@2016-06-01"
name The resource name string (required)
location Resource location. string
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: protectionContainers
tags Resource tags. Dictionary of tag names and values.
eTag Optional ETag. string
properties The base class for backup items. ProtectedItem

ProtectedItem

Name Description Value
backupManagementType The backup management type associated with the backup item. "AzureBackupServer"
"AzureIaasVM"
"AzureSql"
"DPM"
"Invalid"
"MAB"
lastRecoveryPoint The timestamp when the most recent backup copy was created for this backup item. string
policyId The ID of the backup policy associated with this backup item. string
sourceResourceId The ID of the resource to be backed up. string
workloadType The workload type for this item. "AzureSqlDb"
"DPMUnknown"
"Exchange"
"FileFolder"
"Invalid"
"SQLDB"
"Sharepoint"
"VM"
protectedItemType Set the object type MabFileFolderProtectedItem
Microsoft.ClassicCompute/virtualMachines
Microsoft.Compute/virtualMachines
Microsoft.Sql/servers/databases (required)

MabFileFolderProtectedItem

Name Description Value
protectedItemType The backup item type. "MabFileFolderProtectedItem" (required)
computerName The name of the computer associated with this backup item. string
extendedInfo Additional information for this backup item. MabFileFolderProtectedItemExtendedInfo
friendlyName The friendly name of this backup item. string
isScheduledForDeferredDelete bool
lastBackupStatus The status of last backup operation. string
protectionState The states for this property are: Protected, ProtectionStopped, IRPending, or ProtectionError. string

MabFileFolderProtectedItemExtendedInfo

Name Description Value
lastRefreshedAt The last day and time the agent synced with the service. string
oldestRecoveryPoint The oldest backup copy available. string
recoveryPointCount The number of backup copies associated with the backup item. int

AzureIaaSClassicComputeVMProtectedItem

Name Description Value
protectedItemType The backup item type. "Microsoft.ClassicCompute/virtualMachines" (required)
extendedInfo Additional information for this backup item. AzureIaaSVMProtectedItemExtendedInfo
friendlyName The friendly name of the VM represented by this backup item. string
lastBackupStatus The last backup operation status. The possible values are: Healthy or Unhealthy. string
lastBackupTime The timestamp of the last backup operation for this backup item. string
protectionState The backup state of this backup item. "IRPending"
"Invalid"
"Protected"
"ProtectionError"
"ProtectionPaused"
"ProtectionStopped"
protectionStatus The backup status of this backup item. string
virtualMachineId The fully qualified Resource Manager ID of the virtual machine represented by this item. string

AzureIaaSVMProtectedItemExtendedInfo

Name Description Value
oldestRecoveryPoint The oldest backup copy available for this backup item. string
policyInconsistent Specifies if the backup policy associated with the backup item is inconsistent. bool
recoveryPointCount The number of backup copies available for this backup item. int

AzureIaaSComputeVMProtectedItem

Name Description Value
protectedItemType The backup item type. "Microsoft.Compute/virtualMachines" (required)
extendedInfo Additional information for this backup item. AzureIaaSVMProtectedItemExtendedInfo
friendlyName The friendly name of the VM represented by this backup item. string
lastBackupStatus The last backup operation status. The possible values are: Healthy or Unhealthy. string
lastBackupTime The timestamp of the last backup operation for this backup item. string
protectionState The backup state of this backup item. "IRPending"
"Invalid"
"Protected"
"ProtectionError"
"ProtectionPaused"
"ProtectionStopped"
protectionStatus The backup status of this backup item. string
virtualMachineId The fully qualified Resource Manager ID of the virtual machine represented by this item. string

AzureSqlProtectedItem

Name Description Value
protectedItemType The backup item type. "Microsoft.Sql/servers/databases" (required)
extendedInfo Additional information for this backup item. AzureSqlProtectedItemExtendedInfo
protectedItemDataId The internal ID of a backup item. The internal ID is used by the Azure SQL Backup engine to contact Recovery Services. string
protectionState The backup state of the backup item. "IRPending"
"Invalid"
"Protected"
"ProtectionError"
"ProtectionPaused"
"ProtectionStopped"

AzureSqlProtectedItemExtendedInfo

Name Description Value
oldestRecoveryPoint The oldest backup copy available for this item in the service. string
policyState The state of the backup policy associated with this backup item. string
recoveryPointCount The number of available backup copies for this backup item. int