通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.RecoveryServices vaults/backupPolicies 2021-01-01

  • 项目

Bicep 资源定义

可以使用目标操作部署保管库/backupPolicies 资源类型：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.RecoveryServices/vaults/backupPolicies 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.RecoveryServices/vaults/backupPolicies@2021-01-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  eTag: 'string'
  properties: {
    protectedItemsCount: int
    backupManagementType: 'string'
    // For remaining properties, see ProtectionPolicy objects
  }
}

ProtectionPolicy 对象

设置 backupManagementType 属性以指定对象的类型。

若要 AzureIaasVM，请使用：

  backupManagementType: 'AzureIaasVM'
  instantRPDetails: {
    azureBackupRGNamePrefix: 'string'
    azureBackupRGNameSuffix: 'string'
  }
  instantRpRetentionRangeInDays: int
  retentionPolicy: {
    retentionPolicyType: 'string'
    // For remaining properties, see RetentionPolicy objects
  }
  schedulePolicy: {
    schedulePolicyType: 'string'
    // For remaining properties, see SchedulePolicy objects
  }
  timeZone: 'string'

对于 azureSql，请使用：

  backupManagementType: 'AzureSql'
  retentionPolicy: {
    retentionPolicyType: 'string'
    // For remaining properties, see RetentionPolicy objects
  }

对于 azureStorage，请使用：

  backupManagementType: 'AzureStorage'
  retentionPolicy: {
    retentionPolicyType: 'string'
    // For remaining properties, see RetentionPolicy objects
  }
  schedulePolicy: {
    schedulePolicyType: 'string'
    // For remaining properties, see SchedulePolicy objects
  }
  timeZone: 'string'
  workLoadType: 'string'

若要 AzureWorkload，请使用：

  backupManagementType: 'AzureWorkload'
  makePolicyConsistent: bool
  settings: {
    isCompression: bool
    issqlcompression: bool
    timeZone: 'string'
  }
  subProtectionPolicy: [
    {
      policyType: 'string'
      retentionPolicy: {
        retentionPolicyType: 'string'
        // For remaining properties, see RetentionPolicy objects
      }
      schedulePolicy: {
        schedulePolicyType: 'string'
        // For remaining properties, see SchedulePolicy objects
      }
    }
  ]
  workLoadType: 'string'

对于 GenericProtectionPolicy，请使用：

  backupManagementType: 'GenericProtectionPolicy'
  fabricName: 'string'
  subProtectionPolicy: [
    {
      policyType: 'string'
      retentionPolicy: {
        retentionPolicyType: 'string'
        // For remaining properties, see RetentionPolicy objects
      }
      schedulePolicy: {
        schedulePolicyType: 'string'
        // For remaining properties, see SchedulePolicy objects
      }
    }
  ]
  timeZone: 'string'

对于 MAB，请使用：

  backupManagementType: 'MAB'
  retentionPolicy: {
    retentionPolicyType: 'string'
    // For remaining properties, see RetentionPolicy objects
  }
  schedulePolicy: {
    schedulePolicyType: 'string'
    // For remaining properties, see SchedulePolicy objects
  }

RetentionPolicy 对象

设置 retentionPolicyType 属性以指定对象的类型。

对于 LongTermRetentionPolicy，请使用：

  retentionPolicyType: 'LongTermRetentionPolicy'
  dailySchedule: {
    retentionDuration: {
      count: int
      durationType: 'string'
    }
    retentionTimes: [
      'string'
    ]
  }
  monthlySchedule: {
    retentionDuration: {
      count: int
      durationType: 'string'
    }
    retentionScheduleDaily: {
      daysOfTheMonth: [
        {
          date: int
          isLast: bool
        }
      ]
    }
    retentionScheduleFormatType: 'string'
    retentionScheduleWeekly: {
      daysOfTheWeek: [
        'string'
      ]
      weeksOfTheMonth: [
        'string'
      ]
    }
    retentionTimes: [
      'string'
    ]
  }
  weeklySchedule: {
    daysOfTheWeek: [
      'string'
    ]
    retentionDuration: {
      count: int
      durationType: 'string'
    }
    retentionTimes: [
      'string'
    ]
  }
  yearlySchedule: {
    monthsOfYear: [
      'string'
    ]
    retentionDuration: {
      count: int
      durationType: 'string'
    }
    retentionScheduleDaily: {
      daysOfTheMonth: [
        {
          date: int
          isLast: bool
        }
      ]
    }
    retentionScheduleFormatType: 'string'
    retentionScheduleWeekly: {
      daysOfTheWeek: [
        'string'
      ]
      weeksOfTheMonth: [
        'string'
      ]
    }
    retentionTimes: [
      'string'
    ]
  }

对于 SimpleRetentionPolicy，请使用：

  retentionPolicyType: 'SimpleRetentionPolicy'
  retentionDuration: {
    count: int
    durationType: 'string'
  }

SchedulePolicy 对象

设置 schedulePolicyType 属性以指定对象的类型。

对于 logSchedulePolicy，请使用：

  schedulePolicyType: 'LogSchedulePolicy'
  scheduleFrequencyInMins: int

对于 LongTermSchedulePolicy，请使用：

  schedulePolicyType: 'LongTermSchedulePolicy'

对于 simpleSchedulePolicy ，请使用：

  schedulePolicyType: 'SimpleSchedulePolicy'
  scheduleRunDays: [
    'string'
  ]
  scheduleRunFrequency: 'string'
  scheduleRunTimes: [
    'string'
  ]
  scheduleWeeklyFrequency: int

属性值

vaults/backupPolicies

名字 描述 价值
名字 资源名称

了解如何在 Bicep中设置子资源的名称和类型。		 string （必需）

字符限制：3-150

有效字符：
字母数字和连字符。

以字母开头。 不能以连字符结尾。
位置 资源位置。 字符串
标签 资源标记。 标记名称和值的字典。 请参阅模板 中的 标记
父母 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。

有关详细信息，请参阅 父资源外部的子资源。		 类型资源的符号名称：保管库
eTag 可选 ETag。 字符串
性能 ProtectionPolicyResource 属性 ProtectionPolicy

ProtectionPolicy

名字 描述 价值
protectedItemsCount 与此策略关联的项数。 int
backupManagementType 设置对象类型 AzureIaasVM
AzureSql
AzureStorage
AzureWorkload
GenericProtectionPolicy
MAB （必需）

AzureIaaSVMProtectionPolicy

名字 描述 价值
backupManagementType 此属性将用作用于确定类型多态链中特定类型的鉴别器。 “AzureIaasVM”（必需）
instantRPDetails InstantRPAdditionalDetails
instantRpRetentionRangeInDays 即时 RP 保留策略范围（以天为单位） int
retentionPolicy 保留策略，其中包含有关备份复制保留范围的详细信息。 RetentionPolicy
schedulePolicy 备份计划指定为备份策略的一部分。 SchedulePolicy
timeZone 时区可选输入作为字符串。 例如：TimeZone = “Pacific Standard Time”。 字符串

InstantRPAdditionalDetails

名字 描述 价值
azureBackupRGNamePrefix 字符串
azureBackupRGNameSuffix 字符串

RetentionPolicy

名字 描述 价值
retentionPolicyType 设置对象类型 LongTermRetentionPolicy
SimpleRetentionPolicy （必需）

LongTermRetentionPolicy

名字 描述 价值
retentionPolicyType 此属性将用作用于确定类型多态链中特定类型的鉴别器。 “LongTermRetentionPolicy”（必需）
dailySchedule 保护策略的每日保留计划。 DailyRetentionSchedule
monthlySchedule 保护策略的每月保留计划。 MonthlyRetentionSchedule
weeklySchedule 保护策略的每周保留计划。 WeeklyRetentionSchedule
yearlySchedule 保护策略的每年保留计划。 YearlyRetentionSchedule

DailyRetentionSchedule

名字 描述 价值
retentionDuration 保留策略的保留期。 RetentionDuration
retentionTimes 保留策略的保留时间。 string[]

RetentionDuration

名字 描述 价值
计数 持续时间类型的计数。 保留期是通过计数类型计数时间获取的。
例如，当 Count = 3 且 DurationType = Weeks 时，保留期将为 3 周。		 int
durationType 保留期策略的保留期类型。 “Days”
“Invalid”
“Month”
“Weeks”
“Years”

MonthlyRetentionSchedule

名字 描述 价值
retentionDuration 保留策略的保留期。 RetentionDuration
retentionScheduleDaily 每月保留策略的每日保留格式。 DailyRetentionFormat
retentionScheduleFormatType 每月保留策略的保留计划格式类型。 “每日”
“Invalid”
“Weekly”
retentionScheduleWeekly 每月保留策略的每周保留格式。 WeeklyRetentionFormat
retentionTimes 保留策略的保留时间。 string[]

DailyRetentionFormat

名字 描述 价值
daysOfTheMonth 月份的天数列表。 日[]

日

名字 描述 价值
日期 月份的日期 int
isLast 日期是否为月份的最后一个日期 bool

WeeklyRetentionFormat

名字 描述 价值
daysOfTheWeek 一周中的天数列表。 包含任一项的字符串数组：
“Friday”
“Monday”
“Saturday”
“星期日”
“星期四”
“Tuesday”
“Wednesday”
weeksOfTheMonth 月数周的列表。 包含任一项的字符串数组：
“First”
“Fourth”
“Invalid”
“Last”
“Second”
“Third”

WeeklyRetentionSchedule

名字 描述 价值
daysOfTheWeek 每周保留策略的星期几列表。 包含任一项的字符串数组：
“Friday”
“Monday”
“Saturday”
“星期日”
“星期四”
“Tuesday”
“Wednesday”
retentionDuration 保留策略的保留期。 RetentionDuration
retentionTimes 保留策略的保留时间。 string[]

YearlyRetentionSchedule

名字 描述 价值
monthsOfYear 年度保留策略的月份列表。 包含任一项的字符串数组：
“April”
“八月”
“12 月”
“2 月”
“Invalid”
“January”
“7 月”
“June”
“March”
“May”
“11 月”
“10 月”
“9 月”
retentionDuration 保留策略的保留期。 RetentionDuration
retentionScheduleDaily 每年保留策略的每日保留格式。 DailyRetentionFormat
retentionScheduleFormatType 每年保留策略的保留计划格式。 “每日”
“Invalid”
“Weekly”
retentionScheduleWeekly 每年保留策略的每周保留格式。 WeeklyRetentionFormat
retentionTimes 保留策略的保留时间。 string[]

SimpleRetentionPolicy

名字 描述 价值
retentionPolicyType 此属性将用作用于确定类型多态链中特定类型的鉴别器。 “SimpleRetentionPolicy”（必需）
retentionDuration 保护策略的保留期。 RetentionDuration

SchedulePolicy

名字 描述 价值
schedulePolicyType 设置对象类型 LogSchedulePolicy
LongTermSchedulePolicy
SimpleSchedulePolicy （必需）

LogSchedulePolicy

名字 描述 价值
schedulePolicyType 此属性将用作用于确定类型多态链中特定类型的鉴别器。 “LogSchedulePolicy”（必需）
scheduleFrequencyInMins 此策略的日志计划操作频率（以分钟为单位）。 int

LongTermSchedulePolicy

名字 描述 价值
schedulePolicyType 此属性将用作用于确定类型多态链中特定类型的鉴别器。 “LongTermSchedulePolicy”（必需）

SimpleSchedulePolicy

名字 描述 价值
schedulePolicyType 此属性将用作用于确定类型多态链中特定类型的鉴别器。 “SimpleSchedulePolicy”（必需）
scheduleRunDays 此计划必须运行每周天数的列表。 包含任一项的字符串数组：
“Friday”
“Monday”
“Saturday”
“星期日”
“星期四”
“Tuesday”
“Wednesday”
scheduleRunFrequency 此策略的计划操作的频率。 “每日”
“Invalid”
“Weekly”
scheduleRunTimes 此计划必须运行的一天时间列表。 string[]
scheduleWeeklyFrequency 在每几个星期，必须运行此计划。 int

AzureSqlProtectionPolicy

名字 描述 价值
backupManagementType 此属性将用作用于确定类型多态链中特定类型的鉴别器。 “AzureSql”（必需）
retentionPolicy 保留策略详细信息。 RetentionPolicy

AzureFileShareProtectionPolicy

名字 描述 价值
backupManagementType 此属性将用作用于确定类型多态链中特定类型的鉴别器。 “AzureStorage”（必需）
retentionPolicy 保留策略，其中包含有关备份复制保留范围的详细信息。 RetentionPolicy
schedulePolicy 备份计划指定为备份策略的一部分。 SchedulePolicy
timeZone 时区可选输入作为字符串。 例如：TimeZone = “Pacific Standard Time”。 字符串
workLoadType 备份管理的工作负荷类型 “AzureFileShare”
“AzureSqlDb”
“Client”
“Exchange”
“FileFolder”
“GenericDataSource”
“Invalid”
“SAPAseDatabase”
“SAPHanaDatabase”
“SQLDB”
“SQLDataBase”
“Sharepoint”
“SystemState”
“VM”
“VMwareVM”

AzureVmWorkloadProtectionPolicy

名字 描述 价值
backupManagementType 此属性将用作用于确定类型多态链中特定类型的鉴别器。 “AzureWorkload”（必需）
makePolicyConsistent 修复策略不一致问题 bool
设置 备份管理的常见设置 设置
subProtectionPolicy 包括计划和保留的子保护策略列表 SubProtectionPolicy[]
workLoadType 备份管理的工作负荷类型 “AzureFileShare”
“AzureSqlDb”
“Client”
“Exchange”
“FileFolder”
“GenericDataSource”
“Invalid”
“SAPAseDatabase”
“SAPHanaDatabase”
“SQLDB”
“SQLDataBase”
“Sharepoint”
“SystemState”
“VM”
“VMwareVM”

设置

名字 描述 价值
isCompression 工作负荷压缩标志。 已添加此项，以便“isSqlCompression”
客户端升级后将弃用此标志。		 bool
issqlcompression SQL 压缩标志 bool
timeZone 时区可选输入作为字符串。 例如：TimeZone = “Pacific Standard Time”。 字符串

SubProtectionPolicy

名字 描述 价值
policyType 备份策略类型 “CopyOnlyFull”
“差异”
“Full”
“Incremental”
“Invalid”
“Log”
retentionPolicy 保留策略，其中包含有关备份复制保留范围的详细信息。 RetentionPolicy
schedulePolicy 备份计划指定为备份策略的一部分。 SchedulePolicy

GenericProtectionPolicy

名字 描述 价值
backupManagementType 此属性将用作用于确定类型多态链中特定类型的鉴别器。 “GenericProtectionPolicy”（必需）
fabricName 此策略的结构的名称。 字符串
subProtectionPolicy 包括计划和保留的子保护策略列表 SubProtectionPolicy[]
timeZone 时区可选输入作为字符串。 例如：TimeZone = “Pacific Standard Time”。 字符串

MabProtectionPolicy

名字 描述 价值
backupManagementType 此属性将用作用于确定类型多态链中特定类型的鉴别器。 “MAB”（必需）
retentionPolicy 保留策略详细信息。 RetentionPolicy
schedulePolicy 备份策略的备份计划。 SchedulePolicy

快速入门模板

以下快速入门模板部署此资源类型。

模板 描述
使用恢复服务（每日） 备份现有文件共享

部署到 Azure 		此模板为现有存储帐户中存在的现有文件共享配置保护。 它基于设置参数值创建新的或使用现有的恢复服务保管库和备份策略。
使用恢复服务（每小时） 备份现有文件共享

部署到 Azure 		此模板为现有存储帐户中存在的现有文件共享配置每小时保护。 它基于设置参数值创建新的或使用现有的恢复服务保管库和备份策略。
使用恢复服务保管库 备份资源管理器 VM

部署到 Azure 		此模板将使用现有的恢复服务保管库和现有备份策略，并配置属于同一资源组的多个资源管理器 VM 的备份
使用备份策略创建恢复服务保管库

部署到 Azure 		此模板创建包含备份策略的恢复服务保管库，并配置系统标识、备份存储类型、跨区域还原和诊断日志和删除锁等可选功能。
为 RS Vault 创建每日备份策略以保护 IaaSVM

部署到 Azure 		此模板创建恢复服务保管库和每日备份策略，可用于保护经典和基于 ARM 的 IaaS VM。
Azure 虚拟机中工作负荷的 Azure 备份

部署到 Azure 		此模板创建恢复服务保管库和特定于工作负荷的备份策略。 将 VM 注册到备份服务和配置保护
为 RS 保管库创建每周备份策略以保护 IaaSVM

部署到 Azure 		此模板创建恢复服务保管库和每日备份策略，可用于保护经典和基于 ARM 的 IaaS VM。

ARM 模板资源定义

可以使用目标操作部署保管库/backupPolicies 资源类型：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.RecoveryServices/vaults/backupPolicies 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.RecoveryServices/vaults/backupPolicies",
  "apiVersion": "2021-01-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "eTag": "string",
  "properties": {
    "protectedItemsCount": "int",
    "backupManagementType": "string"
    // For remaining properties, see ProtectionPolicy objects
  }
}

ProtectionPolicy 对象

设置 backupManagementType 属性以指定对象的类型。

若要 AzureIaasVM，请使用：

  "backupManagementType": "AzureIaasVM",
  "instantRPDetails": {
    "azureBackupRGNamePrefix": "string",
    "azureBackupRGNameSuffix": "string"
  },
  "instantRpRetentionRangeInDays": "int",
  "retentionPolicy": {
    "retentionPolicyType": "string"
    // For remaining properties, see RetentionPolicy objects
  },
  "schedulePolicy": {
    "schedulePolicyType": "string"
    // For remaining properties, see SchedulePolicy objects
  },
  "timeZone": "string"

对于 azureSql，请使用：

  "backupManagementType": "AzureSql",
  "retentionPolicy": {
    "retentionPolicyType": "string"
    // For remaining properties, see RetentionPolicy objects
  }

对于 azureStorage，请使用：

  "backupManagementType": "AzureStorage",
  "retentionPolicy": {
    "retentionPolicyType": "string"
    // For remaining properties, see RetentionPolicy objects
  },
  "schedulePolicy": {
    "schedulePolicyType": "string"
    // For remaining properties, see SchedulePolicy objects
  },
  "timeZone": "string",
  "workLoadType": "string"

若要 AzureWorkload，请使用：

  "backupManagementType": "AzureWorkload",
  "makePolicyConsistent": "bool",
  "settings": {
    "isCompression": "bool",
    "issqlcompression": "bool",
    "timeZone": "string"
  },
  "subProtectionPolicy": [
    {
      "policyType": "string",
      "retentionPolicy": {
        "retentionPolicyType": "string"
        // For remaining properties, see RetentionPolicy objects
      },
      "schedulePolicy": {
        "schedulePolicyType": "string"
        // For remaining properties, see SchedulePolicy objects
      }
    }
  ],
  "workLoadType": "string"

对于 GenericProtectionPolicy，请使用：

  "backupManagementType": "GenericProtectionPolicy",
  "fabricName": "string",
  "subProtectionPolicy": [
    {
      "policyType": "string",
      "retentionPolicy": {
        "retentionPolicyType": "string"
        // For remaining properties, see RetentionPolicy objects
      },
      "schedulePolicy": {
        "schedulePolicyType": "string"
        // For remaining properties, see SchedulePolicy objects
      }
    }
  ],
  "timeZone": "string"

对于 MAB，请使用：

  "backupManagementType": "MAB",
  "retentionPolicy": {
    "retentionPolicyType": "string"
    // For remaining properties, see RetentionPolicy objects
  },
  "schedulePolicy": {
    "schedulePolicyType": "string"
    // For remaining properties, see SchedulePolicy objects
  }

RetentionPolicy 对象

设置 retentionPolicyType 属性以指定对象的类型。

对于 LongTermRetentionPolicy，请使用：

  "retentionPolicyType": "LongTermRetentionPolicy",
  "dailySchedule": {
    "retentionDuration": {
      "count": "int",
      "durationType": "string"
    },
    "retentionTimes": [ "string" ]
  },
  "monthlySchedule": {
    "retentionDuration": {
      "count": "int",
      "durationType": "string"
    },
    "retentionScheduleDaily": {
      "daysOfTheMonth": [
        {
          "date": "int",
          "isLast": "bool"
        }
      ]
    },
    "retentionScheduleFormatType": "string",
    "retentionScheduleWeekly": {
      "daysOfTheWeek": [ "string" ],
      "weeksOfTheMonth": [ "string" ]
    },
    "retentionTimes": [ "string" ]
  },
  "weeklySchedule": {
    "daysOfTheWeek": [ "string" ],
    "retentionDuration": {
      "count": "int",
      "durationType": "string"
    },
    "retentionTimes": [ "string" ]
  },
  "yearlySchedule": {
    "monthsOfYear": [ "string" ],
    "retentionDuration": {
      "count": "int",
      "durationType": "string"
    },
    "retentionScheduleDaily": {
      "daysOfTheMonth": [
        {
          "date": "int",
          "isLast": "bool"
        }
      ]
    },
    "retentionScheduleFormatType": "string",
    "retentionScheduleWeekly": {
      "daysOfTheWeek": [ "string" ],
      "weeksOfTheMonth": [ "string" ]
    },
    "retentionTimes": [ "string" ]
  }

对于 SimpleRetentionPolicy，请使用：

  "retentionPolicyType": "SimpleRetentionPolicy",
  "retentionDuration": {
    "count": "int",
    "durationType": "string"
  }

SchedulePolicy 对象

设置 schedulePolicyType 属性以指定对象的类型。

对于 logSchedulePolicy，请使用：

  "schedulePolicyType": "LogSchedulePolicy",
  "scheduleFrequencyInMins": "int"

对于 LongTermSchedulePolicy，请使用：

  "schedulePolicyType": "LongTermSchedulePolicy"

对于 simpleSchedulePolicy ，请使用：

  "schedulePolicyType": "SimpleSchedulePolicy",
  "scheduleRunDays": [ "string" ],
  "scheduleRunFrequency": "string",
  "scheduleRunTimes": [ "string" ],
  "scheduleWeeklyFrequency": "int"

属性值

vaults/backupPolicies

名字 描述 价值
类型 资源类型 “Microsoft.RecoveryServices/vaults/backupPolicies”
apiVersion 资源 API 版本 '2021-01-01'
名字 资源名称

了解如何在 JSON ARM 模板中设置子资源的名称和类型。		 string （必需）

字符限制：3-150

有效字符：
字母数字和连字符。

以字母开头。 不能以连字符结尾。
位置 资源位置。 字符串
标签 资源标记。 标记名称和值的字典。 请参阅模板 中的 标记
eTag 可选 ETag。 字符串
性能 ProtectionPolicyResource 属性 ProtectionPolicy

ProtectionPolicy

名字 描述 价值
protectedItemsCount 与此策略关联的项数。 int
backupManagementType 设置对象类型 AzureIaasVM
AzureSql
AzureStorage
AzureWorkload
GenericProtectionPolicy
MAB （必需）

AzureIaaSVMProtectionPolicy

名字 描述 价值
backupManagementType 此属性将用作用于确定类型多态链中特定类型的鉴别器。 “AzureIaasVM”（必需）
instantRPDetails InstantRPAdditionalDetails
instantRpRetentionRangeInDays 即时 RP 保留策略范围（以天为单位） int
retentionPolicy 保留策略，其中包含有关备份复制保留范围的详细信息。 RetentionPolicy
schedulePolicy 备份计划指定为备份策略的一部分。 SchedulePolicy
timeZone 时区可选输入作为字符串。 例如：TimeZone = “Pacific Standard Time”。 字符串

InstantRPAdditionalDetails

名字 描述 价值
azureBackupRGNamePrefix 字符串
azureBackupRGNameSuffix 字符串

RetentionPolicy

名字 描述 价值
retentionPolicyType 设置对象类型 LongTermRetentionPolicy
SimpleRetentionPolicy （必需）

LongTermRetentionPolicy

名字 描述 价值
retentionPolicyType 此属性将用作用于确定类型多态链中特定类型的鉴别器。 “LongTermRetentionPolicy”（必需）
dailySchedule 保护策略的每日保留计划。 DailyRetentionSchedule
monthlySchedule 保护策略的每月保留计划。 MonthlyRetentionSchedule
weeklySchedule 保护策略的每周保留计划。 WeeklyRetentionSchedule
yearlySchedule 保护策略的每年保留计划。 YearlyRetentionSchedule

DailyRetentionSchedule

名字 描述 价值
retentionDuration 保留策略的保留期。 RetentionDuration
retentionTimes 保留策略的保留时间。 string[]

RetentionDuration

名字 描述 价值
计数 持续时间类型的计数。 保留期是通过计数类型计数时间获取的。
例如，当 Count = 3 且 DurationType = Weeks 时，保留期将为 3 周。		 int
durationType 保留期策略的保留期类型。 “Days”
“Invalid”
“Month”
“Weeks”
“Years”

MonthlyRetentionSchedule

名字 描述 价值
retentionDuration 保留策略的保留期。 RetentionDuration
retentionScheduleDaily 每月保留策略的每日保留格式。 DailyRetentionFormat
retentionScheduleFormatType 每月保留策略的保留计划格式类型。 “每日”
“Invalid”
“Weekly”
retentionScheduleWeekly 每月保留策略的每周保留格式。 WeeklyRetentionFormat
retentionTimes 保留策略的保留时间。 string[]

DailyRetentionFormat

名字 描述 价值
daysOfTheMonth 月份的天数列表。 日[]

日

名字 描述 价值
日期 月份的日期 int
isLast 日期是否为月份的最后一个日期 bool

WeeklyRetentionFormat

名字 描述 价值
daysOfTheWeek 一周中的天数列表。 包含任一项的字符串数组：
“Friday”
“Monday”
“Saturday”
“星期日”
“星期四”
“Tuesday”
“Wednesday”
weeksOfTheMonth 月数周的列表。 包含任一项的字符串数组：
“First”
“Fourth”
“Invalid”
“Last”
“Second”
“Third”

WeeklyRetentionSchedule

名字 描述 价值
daysOfTheWeek 每周保留策略的星期几列表。 包含任一项的字符串数组：
“Friday”
“Monday”
“Saturday”
“星期日”
“星期四”
“Tuesday”
“Wednesday”
retentionDuration 保留策略的保留期。 RetentionDuration
retentionTimes 保留策略的保留时间。 string[]

YearlyRetentionSchedule

名字 描述 价值
monthsOfYear 年度保留策略的月份列表。 包含任一项的字符串数组：
“April”
“八月”
“12 月”
“2 月”
“Invalid”
“January”
“7 月”
“June”
“March”
“May”
“11 月”
“10 月”
“9 月”
retentionDuration 保留策略的保留期。 RetentionDuration
retentionScheduleDaily 每年保留策略的每日保留格式。 DailyRetentionFormat
retentionScheduleFormatType 每年保留策略的保留计划格式。 “每日”
“Invalid”
“Weekly”
retentionScheduleWeekly 每年保留策略的每周保留格式。 WeeklyRetentionFormat
retentionTimes 保留策略的保留时间。 string[]

SimpleRetentionPolicy

名字 描述 价值
retentionPolicyType 此属性将用作用于确定类型多态链中特定类型的鉴别器。 “SimpleRetentionPolicy”（必需）
retentionDuration 保护策略的保留期。 RetentionDuration

SchedulePolicy

名字 描述 价值
schedulePolicyType 设置对象类型 LogSchedulePolicy
LongTermSchedulePolicy
SimpleSchedulePolicy （必需）

LogSchedulePolicy

名字 描述 价值
schedulePolicyType 此属性将用作用于确定类型多态链中特定类型的鉴别器。 “LogSchedulePolicy”（必需）
scheduleFrequencyInMins 此策略的日志计划操作频率（以分钟为单位）。 int

LongTermSchedulePolicy

名字 描述 价值
schedulePolicyType 此属性将用作用于确定类型多态链中特定类型的鉴别器。 “LongTermSchedulePolicy”（必需）

SimpleSchedulePolicy

名字 描述 价值
schedulePolicyType 此属性将用作用于确定类型多态链中特定类型的鉴别器。 “SimpleSchedulePolicy”（必需）
scheduleRunDays 此计划必须运行每周天数的列表。 包含任一项的字符串数组：
“Friday”
“Monday”
“Saturday”
“星期日”
“星期四”
“Tuesday”
“Wednesday”
scheduleRunFrequency 此策略的计划操作的频率。 “每日”
“Invalid”
“Weekly”
scheduleRunTimes 此计划必须运行的一天时间列表。 string[]
scheduleWeeklyFrequency 在每几个星期，必须运行此计划。 int

AzureSqlProtectionPolicy

名字 描述 价值
backupManagementType 此属性将用作用于确定类型多态链中特定类型的鉴别器。 “AzureSql”（必需）
retentionPolicy 保留策略详细信息。 RetentionPolicy

AzureFileShareProtectionPolicy

名字 描述 价值
backupManagementType 此属性将用作用于确定类型多态链中特定类型的鉴别器。 “AzureStorage”（必需）
retentionPolicy 保留策略，其中包含有关备份复制保留范围的详细信息。 RetentionPolicy
schedulePolicy 备份计划指定为备份策略的一部分。 SchedulePolicy
timeZone 时区可选输入作为字符串。 例如：TimeZone = “Pacific Standard Time”。 字符串
workLoadType 备份管理的工作负荷类型 “AzureFileShare”
“AzureSqlDb”
“Client”
“Exchange”
“FileFolder”
“GenericDataSource”
“Invalid”
“SAPAseDatabase”
“SAPHanaDatabase”
“SQLDB”
“SQLDataBase”
“Sharepoint”
“SystemState”
“VM”
“VMwareVM”

AzureVmWorkloadProtectionPolicy

名字 描述 价值
backupManagementType 此属性将用作用于确定类型多态链中特定类型的鉴别器。 “AzureWorkload”（必需）
makePolicyConsistent 修复策略不一致问题 bool
设置 备份管理的常见设置 设置
subProtectionPolicy 包括计划和保留的子保护策略列表 SubProtectionPolicy[]
workLoadType 备份管理的工作负荷类型 “AzureFileShare”
“AzureSqlDb”
“Client”
“Exchange”
“FileFolder”
“GenericDataSource”
“Invalid”
“SAPAseDatabase”
“SAPHanaDatabase”
“SQLDB”
“SQLDataBase”
“Sharepoint”
“SystemState”
“VM”
“VMwareVM”

设置

名字 描述 价值
isCompression 工作负荷压缩标志。 已添加此项，以便“isSqlCompression”
客户端升级后将弃用此标志。		 bool
issqlcompression SQL 压缩标志 bool
timeZone 时区可选输入作为字符串。 例如：TimeZone = “Pacific Standard Time”。 字符串

SubProtectionPolicy

名字 描述 价值
policyType 备份策略类型 “CopyOnlyFull”
“差异”
“Full”
“Incremental”
“Invalid”
“Log”
retentionPolicy 保留策略，其中包含有关备份复制保留范围的详细信息。 RetentionPolicy
schedulePolicy 备份计划指定为备份策略的一部分。 SchedulePolicy

GenericProtectionPolicy

名字 描述 价值
backupManagementType 此属性将用作用于确定类型多态链中特定类型的鉴别器。 “GenericProtectionPolicy”（必需）
fabricName 此策略的结构的名称。 字符串
subProtectionPolicy 包括计划和保留的子保护策略列表 SubProtectionPolicy[]
timeZone 时区可选输入作为字符串。 例如：TimeZone = “Pacific Standard Time”。 字符串

MabProtectionPolicy

名字 描述 价值
backupManagementType 此属性将用作用于确定类型多态链中特定类型的鉴别器。 “MAB”（必需）
retentionPolicy 保留策略详细信息。 RetentionPolicy
schedulePolicy 备份策略的备份计划。 SchedulePolicy

快速入门模板

以下快速入门模板部署此资源类型。

模板 描述
使用恢复服务（每日） 备份现有文件共享

部署到 Azure 		此模板为现有存储帐户中存在的现有文件共享配置保护。 它基于设置参数值创建新的或使用现有的恢复服务保管库和备份策略。
使用恢复服务（每小时） 备份现有文件共享

部署到 Azure 		此模板为现有存储帐户中存在的现有文件共享配置每小时保护。 它基于设置参数值创建新的或使用现有的恢复服务保管库和备份策略。
使用恢复服务保管库 备份资源管理器 VM

部署到 Azure 		此模板将使用现有的恢复服务保管库和现有备份策略，并配置属于同一资源组的多个资源管理器 VM 的备份
使用备份策略创建恢复服务保管库

部署到 Azure 		此模板创建包含备份策略的恢复服务保管库，并配置系统标识、备份存储类型、跨区域还原和诊断日志和删除锁等可选功能。
为 RS Vault 创建每日备份策略以保护 IaaSVM

部署到 Azure 		此模板创建恢复服务保管库和每日备份策略，可用于保护经典和基于 ARM 的 IaaS VM。
Azure 虚拟机中工作负荷的 Azure 备份

部署到 Azure 		此模板创建恢复服务保管库和特定于工作负荷的备份策略。 将 VM 注册到备份服务和配置保护
为 RS 保管库创建每周备份策略以保护 IaaSVM

部署到 Azure 		此模板创建恢复服务保管库和每日备份策略，可用于保护经典和基于 ARM 的 IaaS VM。

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署保管库/backupPolicies 资源类型：

  • 资源组

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.RecoveryServices/vaults/backupPolicies 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.RecoveryServices/vaults/backupPolicies@2021-01-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      protectedItemsCount = int
      backupManagementType = "string"
      // For remaining properties, see ProtectionPolicy objects
    }
    eTag = "string"
  })
}

ProtectionPolicy 对象

设置 backupManagementType 属性以指定对象的类型。

若要 AzureIaasVM，请使用：

  backupManagementType = "AzureIaasVM"
  instantRPDetails = {
    azureBackupRGNamePrefix = "string"
    azureBackupRGNameSuffix = "string"
  }
  instantRpRetentionRangeInDays = int
  retentionPolicy = {
    retentionPolicyType = "string"
    // For remaining properties, see RetentionPolicy objects
  }
  schedulePolicy = {
    schedulePolicyType = "string"
    // For remaining properties, see SchedulePolicy objects
  }
  timeZone = "string"

对于 azureSql，请使用：

  backupManagementType = "AzureSql"
  retentionPolicy = {
    retentionPolicyType = "string"
    // For remaining properties, see RetentionPolicy objects
  }

对于 azureStorage，请使用：

  backupManagementType = "AzureStorage"
  retentionPolicy = {
    retentionPolicyType = "string"
    // For remaining properties, see RetentionPolicy objects
  }
  schedulePolicy = {
    schedulePolicyType = "string"
    // For remaining properties, see SchedulePolicy objects
  }
  timeZone = "string"
  workLoadType = "string"

若要 AzureWorkload，请使用：

  backupManagementType = "AzureWorkload"
  makePolicyConsistent = bool
  settings = {
    isCompression = bool
    issqlcompression = bool
    timeZone = "string"
  }
  subProtectionPolicy = [
    {
      policyType = "string"
      retentionPolicy = {
        retentionPolicyType = "string"
        // For remaining properties, see RetentionPolicy objects
      }
      schedulePolicy = {
        schedulePolicyType = "string"
        // For remaining properties, see SchedulePolicy objects
      }
    }
  ]
  workLoadType = "string"

对于 GenericProtectionPolicy，请使用：

  backupManagementType = "GenericProtectionPolicy"
  fabricName = "string"
  subProtectionPolicy = [
    {
      policyType = "string"
      retentionPolicy = {
        retentionPolicyType = "string"
        // For remaining properties, see RetentionPolicy objects
      }
      schedulePolicy = {
        schedulePolicyType = "string"
        // For remaining properties, see SchedulePolicy objects
      }
    }
  ]
  timeZone = "string"

对于 MAB，请使用：

  backupManagementType = "MAB"
  retentionPolicy = {
    retentionPolicyType = "string"
    // For remaining properties, see RetentionPolicy objects
  }
  schedulePolicy = {
    schedulePolicyType = "string"
    // For remaining properties, see SchedulePolicy objects
  }

RetentionPolicy 对象

设置 retentionPolicyType 属性以指定对象的类型。

对于 LongTermRetentionPolicy，请使用：

  retentionPolicyType = "LongTermRetentionPolicy"
  dailySchedule = {
    retentionDuration = {
      count = int
      durationType = "string"
    }
    retentionTimes = [
      "string"
    ]
  }
  monthlySchedule = {
    retentionDuration = {
      count = int
      durationType = "string"
    }
    retentionScheduleDaily = {
      daysOfTheMonth = [
        {
          date = int
          isLast = bool
        }
      ]
    }
    retentionScheduleFormatType = "string"
    retentionScheduleWeekly = {
      daysOfTheWeek = [
        "string"
      ]
      weeksOfTheMonth = [
        "string"
      ]
    }
    retentionTimes = [
      "string"
    ]
  }
  weeklySchedule = {
    daysOfTheWeek = [
      "string"
    ]
    retentionDuration = {
      count = int
      durationType = "string"
    }
    retentionTimes = [
      "string"
    ]
  }
  yearlySchedule = {
    monthsOfYear = [
      "string"
    ]
    retentionDuration = {
      count = int
      durationType = "string"
    }
    retentionScheduleDaily = {
      daysOfTheMonth = [
        {
          date = int
          isLast = bool
        }
      ]
    }
    retentionScheduleFormatType = "string"
    retentionScheduleWeekly = {
      daysOfTheWeek = [
        "string"
      ]
      weeksOfTheMonth = [
        "string"
      ]
    }
    retentionTimes = [
      "string"
    ]
  }

对于 SimpleRetentionPolicy，请使用：

  retentionPolicyType = "SimpleRetentionPolicy"
  retentionDuration = {
    count = int
    durationType = "string"
  }

SchedulePolicy 对象

设置 schedulePolicyType 属性以指定对象的类型。

对于 logSchedulePolicy，请使用：

  schedulePolicyType = "LogSchedulePolicy"
  scheduleFrequencyInMins = int

对于 LongTermSchedulePolicy，请使用：

  schedulePolicyType = "LongTermSchedulePolicy"

对于 simpleSchedulePolicy ，请使用：

  schedulePolicyType = "SimpleSchedulePolicy"
  scheduleRunDays = [
    "string"
  ]
  scheduleRunFrequency = "string"
  scheduleRunTimes = [
    "string"
  ]
  scheduleWeeklyFrequency = int

属性值

vaults/backupPolicies

名字 描述 价值
类型 资源类型 “Microsoft.RecoveryServices/vaults/backupPolicies@2021-01-01”
名字 资源名称 string （必需）

字符限制：3-150

有效字符：
字母数字和连字符。

以字母开头。 不能以连字符结尾。
位置 资源位置。 字符串
parent_id 此资源的父资源的 ID。 类型资源的 ID：保管库
标签 资源标记。 标记名称和值的字典。
eTag 可选 ETag。 字符串
性能 ProtectionPolicyResource 属性 ProtectionPolicy

ProtectionPolicy

名字 描述 价值
protectedItemsCount 与此策略关联的项数。 int
backupManagementType 设置对象类型 AzureIaasVM
AzureSql
AzureStorage
AzureWorkload
GenericProtectionPolicy
MAB （必需）

AzureIaaSVMProtectionPolicy

名字 描述 价值
backupManagementType 此属性将用作用于确定类型多态链中特定类型的鉴别器。 “AzureIaasVM”（必需）
instantRPDetails InstantRPAdditionalDetails
instantRpRetentionRangeInDays 即时 RP 保留策略范围（以天为单位） int
retentionPolicy 保留策略，其中包含有关备份复制保留范围的详细信息。 RetentionPolicy
schedulePolicy 备份计划指定为备份策略的一部分。 SchedulePolicy
timeZone 时区可选输入作为字符串。 例如：TimeZone = “Pacific Standard Time”。 字符串

InstantRPAdditionalDetails

名字 描述 价值
azureBackupRGNamePrefix 字符串
azureBackupRGNameSuffix 字符串

RetentionPolicy

名字 描述 价值
retentionPolicyType 设置对象类型 LongTermRetentionPolicy
SimpleRetentionPolicy （必需）

LongTermRetentionPolicy

名字 描述 价值
retentionPolicyType 此属性将用作用于确定类型多态链中特定类型的鉴别器。 “LongTermRetentionPolicy” （必需）
dailySchedule 保护策略的每日保留计划。 DailyRetentionSchedule
monthlySchedule 保护策略的每月保留计划。 MonthlyRetentionSchedule
weeklySchedule 保护策略的每周保留计划。 WeeklyRetentionSchedule
yearlySchedule 保护策略的每年保留计划。 YearlyRetentionSchedule

DailyRetentionSchedule

名字 描述 价值
retentionDuration 保留策略的保留期。 RetentionDuration
retentionTimes 保留策略的保留时间。 string[]

RetentionDuration

名字 描述 价值
计数 持续时间类型的计数。 保留期是通过计数类型计数时间获取的。
例如，当 Count = 3 且 DurationType = Weeks 时，保留期将为 3 周。		 int
durationType 保留期策略的保留期类型。 “天”
“无效”
“Month”
“周”
“年”

MonthlyRetentionSchedule

名字 描述 价值
retentionDuration 保留策略的保留期。 RetentionDuration
retentionScheduleDaily 每月保留策略的每日保留格式。 DailyRetentionFormat
retentionScheduleFormatType 每月保留策略的保留计划格式类型。 “每日”
“无效”
“每周”
retentionScheduleWeekly 每月保留策略的每周保留格式。 WeeklyRetentionFormat
retentionTimes 保留策略的保留时间。 string[]

DailyRetentionFormat

名字 描述 价值
daysOfTheMonth 月份的天数列表。 日[]

日

名字 描述 价值
日期 月份的日期 int
isLast 日期是否为月份的最后一个日期 bool

WeeklyRetentionFormat

名字 描述 价值
daysOfTheWeek 一周中的天数列表。 包含任一项的字符串数组：
“Friday”
“Monday”
“Saturday”
“星期日”
“星期四”
“Tuesday”
“星期三”
weeksOfTheMonth 月数周的列表。 包含任一项的字符串数组：
“First”
“Fourth”
“无效”
“Last”
“Second”
“Third”

WeeklyRetentionSchedule

名字 描述 价值
daysOfTheWeek 每周保留策略的星期几列表。 包含任一项的字符串数组：
“Friday”
“Monday”
“Saturday”
“星期日”
“星期四”
“Tuesday”
“星期三”
retentionDuration 保留策略的保留期。 RetentionDuration
retentionTimes 保留策略的保留时间。 string[]

YearlyRetentionSchedule

名字 描述 价值
monthsOfYear 年度保留策略的月份列表。 包含任一项的字符串数组：
“April”
“八月”
“12 月”
“2 月”
“无效”
“1 月”
“7 月”
“6 月”
“March”
“May”
“11 月”
“10 月”
“九月”
retentionDuration 保留策略的保留期。 RetentionDuration
retentionScheduleDaily 每年保留策略的每日保留格式。 DailyRetentionFormat
retentionScheduleFormatType 每年保留策略的保留计划格式。 “每日”
“无效”
“每周”
retentionScheduleWeekly 每年保留策略的每周保留格式。 WeeklyRetentionFormat
retentionTimes 保留策略的保留时间。 string[]

SimpleRetentionPolicy

名字 描述 价值
retentionPolicyType 此属性将用作用于确定类型多态链中特定类型的鉴别器。 “SimpleRetentionPolicy” （必需）
retentionDuration 保护策略的保留期。 RetentionDuration

SchedulePolicy

名字 描述 价值
schedulePolicyType 设置对象类型 LogSchedulePolicy
LongTermSchedulePolicy
SimpleSchedulePolicy （必需）

LogSchedulePolicy

名字 描述 价值
schedulePolicyType 此属性将用作用于确定类型多态链中特定类型的鉴别器。 “LogSchedulePolicy”（必需）
scheduleFrequencyInMins 此策略的日志计划操作频率（以分钟为单位）。 int

LongTermSchedulePolicy

名字 描述 价值
schedulePolicyType 此属性将用作用于确定类型多态链中特定类型的鉴别器。 “LongTermSchedulePolicy”（必需）

SimpleSchedulePolicy

名字 描述 价值
schedulePolicyType 此属性将用作用于确定类型多态链中特定类型的鉴别器。 “SimpleSchedulePolicy”（必需）
scheduleRunDays 此计划必须运行每周天数的列表。 包含任一项的字符串数组：
“Friday”
“Monday”
“Saturday”
“星期日”
“星期四”
“Tuesday”
“星期三”
scheduleRunFrequency 此策略的计划操作的频率。 “每日”
“无效”
“每周”
scheduleRunTimes 此计划必须运行的一天时间列表。 string[]
scheduleWeeklyFrequency 在每几个星期，必须运行此计划。 int

AzureSqlProtectionPolicy

名字 描述 价值
backupManagementType 此属性将用作用于确定类型多态链中特定类型的鉴别器。 “AzureSql”（必需）
retentionPolicy 保留策略详细信息。 RetentionPolicy

AzureFileShareProtectionPolicy

名字 描述 价值
backupManagementType 此属性将用作用于确定类型多态链中特定类型的鉴别器。 “AzureStorage”（必需）
retentionPolicy 保留策略，其中包含有关备份复制保留范围的详细信息。 RetentionPolicy
schedulePolicy 备份计划指定为备份策略的一部分。 SchedulePolicy
timeZone 时区可选输入作为字符串。 例如：TimeZone = “Pacific Standard Time”。 字符串
workLoadType 备份管理的工作负荷类型 “AzureFileShare”
“AzureSqlDb”
“Client”
“Exchange”
“FileFolder”
“GenericDataSource”
“无效”
“SAPAseDatabase”
“SAPHanaDatabase”
“SQLDB”
“SQLDataBase”
“Sharepoint”
“SystemState”
“VM”
“VMwareVM”

AzureVmWorkloadProtectionPolicy

名字 描述 价值
backupManagementType 此属性将用作用于确定类型多态链中特定类型的鉴别器。 “AzureWorkload”（必需）
makePolicyConsistent 修复策略不一致问题 bool
设置 备份管理的常见设置 设置
subProtectionPolicy 包括计划和保留的子保护策略列表 SubProtectionPolicy[]
workLoadType 备份管理的工作负荷类型 “AzureFileShare”
“AzureSqlDb”
“Client”
“Exchange”
“FileFolder”
“GenericDataSource”
“无效”
“SAPAseDatabase”
“SAPHanaDatabase”
“SQLDB”
“SQLDataBase”
“Sharepoint”
“SystemState”
“VM”
“VMwareVM”

设置

名字 描述 价值
isCompression 工作负荷压缩标志。 已添加此项，以便“isSqlCompression”
客户端升级后将弃用此标志。		 bool
issqlcompression SQL 压缩标志 bool
timeZone 时区可选输入作为字符串。 例如：TimeZone = “Pacific Standard Time”。 字符串

SubProtectionPolicy

名字 描述 价值
policyType 备份策略类型 “CopyOnlyFull”
“差异”
“Full”
“Incremental”
“无效”
“Log”
retentionPolicy 保留策略，其中包含有关备份复制保留范围的详细信息。 RetentionPolicy
schedulePolicy 备份计划指定为备份策略的一部分。 SchedulePolicy

GenericProtectionPolicy

名字 描述 价值
backupManagementType 此属性将用作用于确定类型多态链中特定类型的鉴别器。 “GenericProtectionPolicy” （必需）
fabricName 此策略的结构的名称。 字符串
subProtectionPolicy 包括计划和保留的子保护策略列表 SubProtectionPolicy[]
timeZone 时区可选输入作为字符串。 例如：TimeZone = “Pacific Standard Time”。 字符串

MabProtectionPolicy

名字 描述 价值
backupManagementType 此属性将用作用于确定类型多态链中特定类型的鉴别器。 “MAB”（必需）
retentionPolicy 保留策略详细信息。 RetentionPolicy
schedulePolicy 备份策略的备份计划。 SchedulePolicy