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:

• 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.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...

ProtectedItem

MabFileFolderProtectedItem

MabFileFolderProtectedItemExtendedInfo

AzureIaaSClassicComputeVMProtectedItem

AzureIaaSVMProtectedItemExtendedInfo

AzureIaaSComputeVMProtectedItem

AzureSqlProtectedItem

AzureSqlProtectedItemExtendedInfo

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
IBM Cloud Pak for Data on 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	Openshift Container Platform 4.3
Backup existing IaasVM using Recovery Services	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)	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)	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	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	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	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:

• 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.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...

ProtectedItem

MabFileFolderProtectedItem

MabFileFolderProtectedItemExtendedInfo

AzureIaaSClassicComputeVMProtectedItem

AzureIaaSVMProtectedItemExtendedInfo

AzureIaaSComputeVMProtectedItem

AzureSqlProtectedItem

AzureSqlProtectedItemExtendedInfo

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
IBM Cloud Pak for Data on 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	Openshift Container Platform 4.3
Backup existing IaasVM using Recovery Services	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)	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)	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	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	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	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...

ProtectedItem

MabFileFolderProtectedItem

MabFileFolderProtectedItemExtendedInfo

AzureIaaSClassicComputeVMProtectedItem

AzureIaaSVMProtectedItemExtendedInfo

AzureIaaSComputeVMProtectedItem

AzureSqlProtectedItem

AzureSqlProtectedItemExtendedInfo