共用方式為


Microsoft.RecoveryServices 保存庫/backupPolicies 2024-01-01

Bicep 資源定義

儲存庫/backupPolicies 資源類型可以使用目標作業來部署:

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔

資源格式

若要建立 Microsoft.RecoveryServices/vaults/backupPolicies 資源,請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.RecoveryServices/vaults/backupPolicies@2024-01-01' = {
  parent: resourceSymbolicName
  eTag: 'string'
  location: 'string'
  name: 'string'
  properties: {
    protectedItemsCount: int
    resourceGuardOperationRequests: [
      'string'
    ]
    backupManagementType: 'string'
    // For remaining properties, see ProtectionPolicy objects
  }
  tags: {
    {customized property}: 'string'
  }
}

ProtectionPolicy 物件

設定backupManagementType 屬性 屬性,以指定物件的類型。

針對 AzureIaasVM,請使用:

{
  backupManagementType: 'AzureIaasVM'
  instantRPDetails: {
    azureBackupRGNamePrefix: 'string'
    azureBackupRGNameSuffix: 'string'
  }
  instantRpRetentionRangeInDays: int
  policyType: 'string'
  retentionPolicy: {
    retentionPolicyType: 'string'
    // For remaining properties, see RetentionPolicy objects
  }
  schedulePolicy: {
    schedulePolicyType: 'string'
    // For remaining properties, see SchedulePolicy objects
  }
  snapshotConsistencyType: 'string'
  tieringPolicy: {
    {customized property}: {
      duration: int
      durationType: 'string'
      tieringMode: 'string'
    }
  }
  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'
  vaultRetentionPolicy: {
    snapshotRetentionInDays: int
    vaultRetention: {
      retentionPolicyType: 'string'
      // For remaining properties, see RetentionPolicy objects
    }
  }
  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
      }
      snapshotBackupAdditionalDetails: {
        instantRPDetails: 'string'
        instantRpRetentionRangeInDays: int
        userAssignedManagedIdentityDetails: {
          identityArmId: 'string'
          identityName: 'string'
          userAssignedIdentityProperties: {
            clientId: 'string'
            principalId: 'string'
          }
        }
      }
      tieringPolicy: {
        {customized property}: {
          duration: int
          durationType: 'string'
          tieringMode: 'string'
        }
      }
    }
  ]
  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
      }
      snapshotBackupAdditionalDetails: {
        instantRPDetails: 'string'
        instantRpRetentionRangeInDays: int
        userAssignedManagedIdentityDetails: {
          identityArmId: 'string'
          identityName: 'string'
          userAssignedIdentityProperties: {
            clientId: 'string'
            principalId: 'string'
          }
        }
      }
      tieringPolicy: {
        {customized property}: {
          duration: int
          durationType: 'string'
          tieringMode: 'string'
        }
      }
    }
  ]
  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,請使用:

{
  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'
    ]
  }
  retentionPolicyType: 'LongTermRetentionPolicy'
  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,請使用:

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

SchedulePolicy 物件

設定 schedulePolicyType 屬性,以指定對象的類型。

針對 logSchedulePolicy,請使用:

{
  scheduleFrequencyInMins: int
  schedulePolicyType: 'LogSchedulePolicy'
}

針對 LongTermSchedulePolicy,請使用:

{
  schedulePolicyType: 'LongTermSchedulePolicy'
}

針對 SimpleSchedulePolicy,請使用:

{
  hourlySchedule: {
    interval: int
    scheduleWindowDuration: int
    scheduleWindowStartTime: 'string'
  }
  schedulePolicyType: 'SimpleSchedulePolicy'
  scheduleRunDays: [
    'string'
  ]
  scheduleRunFrequency: 'string'
  scheduleRunTimes: [
    'string'
  ]
  scheduleWeeklyFrequency: int
}

針對 SimpleSchedulePolicyV2,請使用:

{
  dailySchedule: {
    scheduleRunTimes: [
      'string'
    ]
  }
  hourlySchedule: {
    interval: int
    scheduleWindowDuration: int
    scheduleWindowStartTime: 'string'
  }
  schedulePolicyType: 'SimpleSchedulePolicyV2'
  scheduleRunFrequency: 'string'
  weeklySchedule: {
    scheduleRunDays: [
      'string'
    ]
    scheduleRunTimes: [
      'string'
    ]
  }
}

屬性值

AzureFileShareProtectionPolicy

名字 描述 價值
backupManagementType 這個屬性將做為決定型別多型鏈結中特定類型的歧視性。 'AzureStorage' (必要)
retentionPolicy 保留原則,其中包含備份複製保留範圍的詳細數據。 RetentionPolicy
schedulePolicy 備份排程指定為備份原則的一部分。 SchedulePolicy
timeZone TimeZone 選擇性輸入做為字串。 例如:TimeZone = “Pacific Standard Time”。 字串
vaultRetentionPolicy 保留原則,其中包含強化備份複製保留範圍的詳細數據。 VaultRetentionPolicy
workLoadType 備份管理的工作負載類型 'AzureFileShare'
'AzureSqlDb'
'Client'
'Exchange'
'FileFolder'
'GenericDataSource'
'Invalid'
'SAPAseDatabase'
'SAPHanaDatabase'
'SAPHanaDBInstance'
'Sharepoint'
'SQLDataBase'
'SQLDB'
'SystemState'
'VM'
'VMwareVM'

AzureIaaSVMProtectionPolicy

名字 描述 價值
backupManagementType 這個屬性將做為決定型別多型鏈結中特定類型的歧視性。 'AzureIaasVM' (必要)
instantRPDetails InstantRPAdditionalDetails
instantRpRetentionRangeInDays 立即 RP 保留原則範圍天數 int
policyType 'Invalid'
'V1'
'V2'
retentionPolicy 保留原則,其中包含備份複製保留範圍的詳細數據。 RetentionPolicy
schedulePolicy 備份排程指定為備份原則的一部分。 SchedulePolicy
snapshotConsistencyType 'OnlyCrashConsistent'
tieringPolicy 階層處理原則,可自動將 RP 移至另一層
機碼是目標層,定義於 RecoveryPointTierType 列舉中。
階層處理原則會指定要將 RP 移至目標層的準則。
AzureIaaSVMProtectionPolicyTieringPolicy
timeZone TimeZone 選擇性輸入做為字串。 例如:TimeZone = “Pacific Standard Time”。 字串

AzureIaaSVMProtectionPolicyTieringPolicy

名字 描述 價值

AzureSqlProtectionPolicy

名字 描述 價值
backupManagementType 這個屬性將做為決定型別多型鏈結中特定類型的歧視性。 'AzureSql' (必要)
retentionPolicy 保留原則詳細數據。 RetentionPolicy

AzureVmWorkloadProtectionPolicy

名字 描述 價值
backupManagementType 這個屬性將做為決定型別多型鏈結中特定類型的歧視性。 'AzureWorkload' (必要)
makePolicyConsistent 修正原則不一致 bool
設置 備份管理的常見設定 設定
subProtectionPolicy 包含排程和保留的子保護原則清單 SubProtectionPolicy[]
workLoadType 備份管理的工作負載類型 'AzureFileShare'
'AzureSqlDb'
'Client'
'Exchange'
'FileFolder'
'GenericDataSource'
'Invalid'
'SAPAseDatabase'
'SAPHanaDatabase'
'SAPHanaDBInstance'
'Sharepoint'
'SQLDataBase'
'SQLDB'
'SystemState'
'VM'
'VMwareVM'

DailyRetentionFormat

名字 描述 價值
daysOfTheMonth 月份的天數清單。 []

DailyRetentionSchedule

名字 描述 價值
retentionDuration 保留原則的保留期間。 RetentionDuration
retentionTimes 保留原則的保留時間。 string[]

DailySchedule

名字 描述 價值
scheduleRunTimes 此排程必須執行的一天時間清單。 string[]

名字 描述 價值
日期 月份的日期 int
isLast Date 是否為月份的最後一個日期 bool

GenericProtectionPolicy

名字 描述 價值
backupManagementType 這個屬性將做為決定型別多型鏈結中特定類型的歧視性。 'GenericProtectionPolicy' (必要)
fabricName 此原則網狀架構的名稱。 字串
subProtectionPolicy 包含排程和保留的子保護原則清單 SubProtectionPolicy[]
timeZone TimeZone 選擇性輸入做為字串。 例如:TimeZone = “Pacific Standard Time”。 字串

HourlySchedule

名字 描述 價值
間隔 需要觸發備份的間隔。 針對每小時的值
可以是 4/6/8/12
int
scheduleWindowDuration 若要指定備份視窗的持續時間 int
scheduleWindowStartTime 若要指定備份視窗的開始時間 字串

InstantRPAdditionalDetails

名字 描述 價值
azureBackupRGNamePrefix 字串
azureBackupRGNameSuffix 字串

LogSchedulePolicy

名字 描述 價值
scheduleFrequencyInMins 此原則的記錄排程作業頻率,以分鐘為單位。 int
schedulePolicyType 這個屬性將做為決定型別多型鏈結中特定類型的歧視性。 'LogSchedulePolicy' (必要)

LongTermRetentionPolicy

名字 描述 價值
dailySchedule 保護原則的每日保留排程。 DailyRetentionSchedule
monthlySchedule 保護原則的每月保留排程。 MonthlyRetentionSchedule
retentionPolicyType 這個屬性將做為決定型別多型鏈結中特定類型的歧視性。 'LongTermRetentionPolicy' (必要)
weeklySchedule 保護原則的每周保留排程。 WeeklyRetentionSchedule
yearlySchedule 保護原則的每年保留排程。 YearlyRetentionSchedule

LongTermSchedulePolicy

名字 描述 價值
schedulePolicyType 這個屬性將做為決定型別多型鏈結中特定類型的歧視性。 'LongTermSchedulePolicy' (必要)

MabProtectionPolicy

名字 描述 價值
backupManagementType 這個屬性將做為決定型別多型鏈結中特定類型的歧視性。 'MAB' (必要)
retentionPolicy 保留原則詳細數據。 RetentionPolicy
schedulePolicy 備份原則的備份排程。 SchedulePolicy

Microsoft.RecoveryServices/vaults/backupPolicies

名字 描述 價值
eTag 選擇性 ETag。 字串
位置 資源位置。 字串
名字 資源名稱 字串 (必要)
父母 在 Bicep 中,您可以指定子資源的父資源。 只有在父資源外部宣告子資源時,才需要新增這個屬性。

如需詳細資訊,請參閱 父資源外部的子資源
類型資源的符號名稱:保存庫
性能 ProtectionPolicyResource 屬性 ProtectionPolicy
標籤 資源標籤 標記名稱和值的字典。 請參閱範本中的 標籤

MonthlyRetentionSchedule

名字 描述 價值
retentionDuration 保留原則的保留期間。 RetentionDuration
retentionScheduleDaily 每月保留原則的每日保留格式。 DailyRetentionFormat
retentionScheduleFormatType 每月保留原則的保留排程格式類型。 'Daily'
'Invalid'
'Weekly'
retentionScheduleWeekly 每月保留原則的每周保留格式。 WeeklyRetentionFormat
retentionTimes 保留原則的保留時間。 string[]

ProtectionPolicy

名字 描述 價值
backupManagementType 針對 azureIaaSVMProtectionPolicy類型 設定為 'AzureIaasVM'。 針對 azureSqlProtectionPolicy 類型 設定為 'AzureSql',。 針對 azureFileShareProtectionPolicy 類型設定為 'AzureStorage',。 針對 azureVmWorkloadProtectionPolicy 類型 設定為 'AzureWorkload'。 針對 genericProtectionPolicy GenericProtectionPolicy 類型設定為 'GenericProtectionPolicy',。 將 類型設定為 'MAB',MabProtectionPolicy 'AzureIaasVM'
'AzureSql'
'AzureStorage'
'AzureWorkload'
'GenericProtectionPolicy'
'MAB' (必要)
protectedItemsCount 與此原則相關聯的項目數目。 int
resourceGuardOperationRequests ResourceGuard 作業要求 string[]

ResourceTags

名字 描述 價值

RetentionDuration

名字 描述 價值
計數 持續時間類型的計數。 保留期間是透過計算持續時間類型 Count 時間取得。
例如,當 Count = 3 且 DurationType = Weeks 時,保留期間會是三周。
int
durationType 保留期間類型的保留原則。 'Days'
'Invalid'
'Month'
'Weeks'
'Years'

RetentionPolicy

名字 描述 價值
retentionPolicyType 針對 longTermRetentionPolicy 類型設定為 'LongTermRetentionPolicy'。 針對類型 SimpleRetentionPolicy,設定為 'SimpleRetentionPolicy'。 'LongTermRetentionPolicy'
'SimpleRetentionPolicy' (必要)

SchedulePolicy

名字 描述 價值
schedulePolicyType 針對 logSchedulePolicy 類型 LogSchedulePolicy設定為 'LogSchedulePolicy'。 針對 longTermSchedulePolicy LongTermSchedulePolicy 類型設定為 'LongTermSchedulePolicy',。 針對 simpleSchedulePolicy 類型設定為 'SimpleSchedulePolicy',。 針對 simpleSchedulePolicyV2 類型設定為 'SimpleSchedulePolicyV2' 'LogSchedulePolicy'
'LongTermSchedulePolicy'
'SimpleSchedulePolicy'
'SimpleSchedulePolicyV2' (必要)

設置

名字 描述 價值
isCompression 工作負載壓縮旗標。 已新增此專案,讓 'isSqlCompression'
一旦客戶端升級以考慮此旗標,將會被取代。
bool
issqlcompression SQL 壓縮旗標 bool
timeZone TimeZone 選擇性輸入做為字串。 例如:TimeZone = “Pacific Standard Time”。 字串

SimpleRetentionPolicy

名字 描述 價值
retentionDuration 保護原則的保留期間。 RetentionDuration
retentionPolicyType 這個屬性將做為決定型別多型鏈結中特定類型的歧視性。 'SimpleRetentionPolicy' (必要)

SimpleSchedulePolicy

名字 描述 價值
hourlySchedule 此原則的每小時排程 HourlySchedule
schedulePolicyType 這個屬性將做為決定型別多型鏈結中特定類型的歧視性。 'SimpleSchedulePolicy' (必要)
scheduleRunDays 此排程必須執行一周中的天數清單。 包含任何的字串數組:
'Friday'
'Monday'
'Saturday'
'Sunday'
'Thursday'
'Tuesday'
'Wednesday'
scheduleRunFrequency 此原則的排程作業頻率。 'Daily'
'Hourly'
'Invalid'
'Weekly'
scheduleRunTimes 此排程必須執行的一天時間清單。 string[]
scheduleWeeklyFrequency 此排程必須在每一周執行一次。 int

SimpleSchedulePolicyV2

名字 描述 價值
dailySchedule 此原則的每日排程 DailySchedule
hourlySchedule 此原則的每小時排程 HourlySchedule
schedulePolicyType 這個屬性將做為決定型別多型鏈結中特定類型的歧視性。 'SimpleSchedulePolicyV2' (必要)
scheduleRunFrequency 此原則的排程作業頻率。 'Daily'
'Hourly'
'Invalid'
'Weekly'
weeklySchedule 此原則的每周排程 WeeklySchedule

SnapshotBackupAdditionalDetails

名字 描述 價值
instantRPDetails 字串
instantRpRetentionRangeInDays int
userAssignedManagedIdentityDetails 使用者指派的受控識別詳細數據 UserAssignedManagedIdentityDetails

SubProtectionPolicy

名字 描述 價值
policyType 備份原則類型 'CopyOnlyFull'
'Differential'
'Full'
'Incremental'
'Invalid'
'Log'
'SnapshotCopyOnlyFull'
'SnapshotFull'
retentionPolicy 保留原則,其中包含備份複製保留範圍的詳細數據。 RetentionPolicy
schedulePolicy 備份排程指定為備份原則的一部分。 SchedulePolicy
snapshotBackupAdditionalDetails WorkloadType SaPHanaSystem 的快照集備份相關欄位 SnapshotBackupAdditionalDetails
tieringPolicy 階層處理原則,可自動將 RP 移至另一層。
機碼是目標層,定義於 RecoveryPointTierType 列舉中。
階層處理原則會指定要將 RP 移至目標層的準則。
SubProtectionPolicyTieringPolicy

SubProtectionPolicyTieringPolicy

名字 描述 價值

TieringPolicy

名字 描述 價值
期間 在階層處理之前,保留目前層中的備份天數/周/月/年數。
只有在 TieringMode 設定為 TierAfter 時才使用
int
durationType 保留期間類型:天/周/月/年
只有在 TieringMode 設定為 TierAfter 時才使用
'Days'
'Invalid'
'Month'
'Weeks'
'Years'
tieringMode 階層處理模式可控制恢復點的自動階層處理。 支援的值為:
1. TierRecommended:建議階層處理的所有恢復點階層
2. TierAfter:將固定期間之後的所有恢復點分層,如以下的 duration + durationType 中所指定。
3. DoNotTier:不要將任何恢復點分層
'DoNotTier'
'Invalid'
'TierAfter'
'TierRecommended'

UserAssignedIdentityProperties

名字 描述 價值
clientId 指派之身分識別的用戶端標識碼。 字串
principalId 指派之身分識別的主體標識碼。 字串

UserAssignedManagedIdentityDetails

名字 描述 價值
identityArmId 指派之身分識別的 ARM 識別碼。 字串
identityName 指派的身分識別名稱。 字串
userAssignedIdentityProperties 使用者指派的受控識別屬性 UserAssignedIdentityProperties

VaultRetentionPolicy

名字 描述 價值
snapshotRetentionInDays int (必要)
vaultRetention 保留原則的基類。 RetentionPolicy (必要)

WeeklyRetentionFormat

名字 描述 價值
daysOfTheWeek 星期幾的清單。 包含任何的字串數組:
'Friday'
'Monday'
'Saturday'
'Sunday'
'Thursday'
'Tuesday'
'Wednesday'
weeksOfTheMonth 月份的周清單。 包含任何的字串數組:
'First'
'Fourth'
'Invalid'
'Last'
'Second'
'Third'

WeeklyRetentionSchedule

名字 描述 價值
daysOfTheWeek 每周保留原則的星期幾清單。 包含任何的字串數組:
'Friday'
'Monday'
'Saturday'
'Sunday'
'Thursday'
'Tuesday'
'Wednesday'
retentionDuration 保留原則的保留期間。 RetentionDuration
retentionTimes 保留原則的保留時間。 string[]

WeeklySchedule

名字 描述 價值
scheduleRunDays 包含任何的字串數組:
'Friday'
'Monday'
'Saturday'
'Sunday'
'Thursday'
'Tuesday'
'Wednesday'
scheduleRunTimes 此排程必須執行的一天時間清單。 string[]

YearlyRetentionSchedule

名字 描述 價值
monthsOfYear 年度保留原則的月份清單。 包含任何的字串數組:
'April'
'August'
'December'
'February'
'Invalid'
'January'
'7 月'
'June'
'March'
'May'
'November'
'10 月'
'九月'
retentionDuration 保留原則的保留期間。 RetentionDuration
retentionScheduleDaily 每年保留原則的每日保留格式。 DailyRetentionFormat
retentionScheduleFormatType 每年保留原則的保留排程格式。 'Daily'
'Invalid'
'Weekly'
retentionScheduleWeekly 每年保留原則的每周保留格式。 WeeklyRetentionFormat
retentionTimes 保留原則的保留時間。 string[]

快速入門範例

下列快速入門範例會部署此資源類型。

Bicep 檔案 描述
Azure 虛擬機中工作負載的 Azure 備份 此範本會建立復原服務保存庫和工作負載特定的備份原則。 向備份服務和設定保護註冊 VM
使用復原服務備份現有的檔案共用 (每日) 此範本會設定現有記憶體帳戶中現有檔案共享的保護。 它會根據 set 參數值,建立新的 或使用現有的復原服務保存庫和備份原則。
使用復原服務備份現有的檔案共用 (每小時) 此範本會以每小時頻率設定現有記憶體帳戶中現有檔案共享的保護。 它會根據 set 參數值,建立新的 或使用現有的復原服務保存庫和備份原則。
使用復原服務保存庫 備份 Resource Manager VM 此範本會使用現有的復原服務保存庫和現有的備份原則,並設定多個屬於相同資源群組的 Resource Manager VM 備份
為 RS Vault 建立每日備份原則以保護 IaaSVM 此範本會建立復原服務保存庫和每日備份原則,可用來保護傳統和 ARM 型 IaaS VM。
使用備份原則建立復原服務保存庫 此範本會建立具有備份原則的復原服務保存庫,並設定選擇性功能,例如系統身分識別、備份記憶體類型、跨區域還原和診斷記錄,以及刪除鎖定。
為 RS Vault 建立每周備份原則以保護 IaaSVM 此範本會建立復原服務保存庫和每日備份原則,可用來保護傳統和 ARM 型 IaaS VM。

ARM 樣本資源定義

儲存庫/backupPolicies 資源類型可以使用目標作業來部署:

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔

資源格式

若要建立 Microsoft.RecoveryServices/vaults/backupPolicies 資源,請將下列 JSON 新增至範本。

{
  "type": "Microsoft.RecoveryServices/vaults/backupPolicies",
  "apiVersion": "2024-01-01",
  "name": "string",
  "eTag": "string",
  "location": "string",
  "properties": {
    "protectedItemsCount": "int",
    "resourceGuardOperationRequests": [ "string" ],
    "backupManagementType": "string"
    // For remaining properties, see ProtectionPolicy objects
  },
  "tags": {
    "{customized property}": "string"
  }
}

ProtectionPolicy 物件

設定backupManagementType 屬性 屬性,以指定物件的類型。

針對 AzureIaasVM,請使用:

{
  "backupManagementType": "AzureIaasVM",
  "instantRPDetails": {
    "azureBackupRGNamePrefix": "string",
    "azureBackupRGNameSuffix": "string"
  },
  "instantRpRetentionRangeInDays": "int",
  "policyType": "string",
  "retentionPolicy": {
    "retentionPolicyType": "string"
    // For remaining properties, see RetentionPolicy objects
  },
  "schedulePolicy": {
    "schedulePolicyType": "string"
    // For remaining properties, see SchedulePolicy objects
  },
  "snapshotConsistencyType": "string",
  "tieringPolicy": {
    "{customized property}": {
      "duration": "int",
      "durationType": "string",
      "tieringMode": "string"
    }
  },
  "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",
  "vaultRetentionPolicy": {
    "snapshotRetentionInDays": "int",
    "vaultRetention": {
      "retentionPolicyType": "string"
      // For remaining properties, see RetentionPolicy objects
    }
  },
  "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
      },
      "snapshotBackupAdditionalDetails": {
        "instantRPDetails": "string",
        "instantRpRetentionRangeInDays": "int",
        "userAssignedManagedIdentityDetails": {
          "identityArmId": "string",
          "identityName": "string",
          "userAssignedIdentityProperties": {
            "clientId": "string",
            "principalId": "string"
          }
        }
      },
      "tieringPolicy": {
        "{customized property}": {
          "duration": "int",
          "durationType": "string",
          "tieringMode": "string"
        }
      }
    }
  ],
  "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
      },
      "snapshotBackupAdditionalDetails": {
        "instantRPDetails": "string",
        "instantRpRetentionRangeInDays": "int",
        "userAssignedManagedIdentityDetails": {
          "identityArmId": "string",
          "identityName": "string",
          "userAssignedIdentityProperties": {
            "clientId": "string",
            "principalId": "string"
          }
        }
      },
      "tieringPolicy": {
        "{customized property}": {
          "duration": "int",
          "durationType": "string",
          "tieringMode": "string"
        }
      }
    }
  ],
  "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,請使用:

{
  "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" ]
  },
  "retentionPolicyType": "LongTermRetentionPolicy",
  "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,請使用:

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

SchedulePolicy 物件

設定 schedulePolicyType 屬性,以指定對象的類型。

針對 logSchedulePolicy,請使用:

{
  "scheduleFrequencyInMins": "int",
  "schedulePolicyType": "LogSchedulePolicy"
}

針對 LongTermSchedulePolicy,請使用:

{
  "schedulePolicyType": "LongTermSchedulePolicy"
}

針對 SimpleSchedulePolicy,請使用:

{
  "hourlySchedule": {
    "interval": "int",
    "scheduleWindowDuration": "int",
    "scheduleWindowStartTime": "string"
  },
  "schedulePolicyType": "SimpleSchedulePolicy",
  "scheduleRunDays": [ "string" ],
  "scheduleRunFrequency": "string",
  "scheduleRunTimes": [ "string" ],
  "scheduleWeeklyFrequency": "int"
}

針對 SimpleSchedulePolicyV2,請使用:

{
  "dailySchedule": {
    "scheduleRunTimes": [ "string" ]
  },
  "hourlySchedule": {
    "interval": "int",
    "scheduleWindowDuration": "int",
    "scheduleWindowStartTime": "string"
  },
  "schedulePolicyType": "SimpleSchedulePolicyV2",
  "scheduleRunFrequency": "string",
  "weeklySchedule": {
    "scheduleRunDays": [ "string" ],
    "scheduleRunTimes": [ "string" ]
  }
}

屬性值

AzureFileShareProtectionPolicy

名字 描述 價值
backupManagementType 這個屬性將做為決定型別多型鏈結中特定類型的歧視性。 'AzureStorage' (必要)
retentionPolicy 保留原則,其中包含備份複製保留範圍的詳細數據。 RetentionPolicy
schedulePolicy 備份排程指定為備份原則的一部分。 SchedulePolicy
timeZone TimeZone 選擇性輸入做為字串。 例如:TimeZone = “Pacific Standard Time”。 字串
vaultRetentionPolicy 保留原則,其中包含強化備份複製保留範圍的詳細數據。 VaultRetentionPolicy
workLoadType 備份管理的工作負載類型 'AzureFileShare'
'AzureSqlDb'
'Client'
'Exchange'
'FileFolder'
'GenericDataSource'
'Invalid'
'SAPAseDatabase'
'SAPHanaDatabase'
'SAPHanaDBInstance'
'Sharepoint'
'SQLDataBase'
'SQLDB'
'SystemState'
'VM'
'VMwareVM'

AzureIaaSVMProtectionPolicy

名字 描述 價值
backupManagementType 這個屬性將做為決定型別多型鏈結中特定類型的歧視性。 'AzureIaasVM' (必要)
instantRPDetails InstantRPAdditionalDetails
instantRpRetentionRangeInDays 立即 RP 保留原則範圍天數 int
policyType 'Invalid'
'V1'
'V2'
retentionPolicy 保留原則,其中包含備份複製保留範圍的詳細數據。 RetentionPolicy
schedulePolicy 備份排程指定為備份原則的一部分。 SchedulePolicy
snapshotConsistencyType 'OnlyCrashConsistent'
tieringPolicy 階層處理原則,可自動將 RP 移至另一層
機碼是目標層,定義於 RecoveryPointTierType 列舉中。
階層處理原則會指定要將 RP 移至目標層的準則。
AzureIaaSVMProtectionPolicyTieringPolicy
timeZone TimeZone 選擇性輸入做為字串。 例如:TimeZone = “Pacific Standard Time”。 字串

AzureIaaSVMProtectionPolicyTieringPolicy

名字 描述 價值

AzureSqlProtectionPolicy

名字 描述 價值
backupManagementType 這個屬性將做為決定型別多型鏈結中特定類型的歧視性。 'AzureSql' (必要)
retentionPolicy 保留原則詳細數據。 RetentionPolicy

AzureVmWorkloadProtectionPolicy

名字 描述 價值
backupManagementType 這個屬性將做為決定型別多型鏈結中特定類型的歧視性。 'AzureWorkload' (必要)
makePolicyConsistent 修正原則不一致 bool
設置 備份管理的常見設定 設定
subProtectionPolicy 包含排程和保留的子保護原則清單 SubProtectionPolicy[]
workLoadType 備份管理的工作負載類型 'AzureFileShare'
'AzureSqlDb'
'Client'
'Exchange'
'FileFolder'
'GenericDataSource'
'Invalid'
'SAPAseDatabase'
'SAPHanaDatabase'
'SAPHanaDBInstance'
'Sharepoint'
'SQLDataBase'
'SQLDB'
'SystemState'
'VM'
'VMwareVM'

DailyRetentionFormat

名字 描述 價值
daysOfTheMonth 月份的天數清單。 []

DailyRetentionSchedule

名字 描述 價值
retentionDuration 保留原則的保留期間。 RetentionDuration
retentionTimes 保留原則的保留時間。 string[]

DailySchedule

名字 描述 價值
scheduleRunTimes 此排程必須執行的一天時間清單。 string[]

名字 描述 價值
日期 月份的日期 int
isLast Date 是否為月份的最後一個日期 bool

GenericProtectionPolicy

名字 描述 價值
backupManagementType 這個屬性將做為決定型別多型鏈結中特定類型的歧視性。 'GenericProtectionPolicy' (必要)
fabricName 此原則網狀架構的名稱。 字串
subProtectionPolicy 包含排程和保留的子保護原則清單 SubProtectionPolicy[]
timeZone TimeZone 選擇性輸入做為字串。 例如:TimeZone = “Pacific Standard Time”。 字串

HourlySchedule

名字 描述 價值
間隔 需要觸發備份的間隔。 針對每小時的值
可以是 4/6/8/12
int
scheduleWindowDuration 若要指定備份視窗的持續時間 int
scheduleWindowStartTime 若要指定備份視窗的開始時間 字串

InstantRPAdditionalDetails

名字 描述 價值
azureBackupRGNamePrefix 字串
azureBackupRGNameSuffix 字串

LogSchedulePolicy

名字 描述 價值
scheduleFrequencyInMins 此原則的記錄排程作業頻率,以分鐘為單位。 int
schedulePolicyType 這個屬性將做為決定型別多型鏈結中特定類型的歧視性。 'LogSchedulePolicy' (必要)

LongTermRetentionPolicy

名字 描述 價值
dailySchedule 保護原則的每日保留排程。 DailyRetentionSchedule
monthlySchedule 保護原則的每月保留排程。 MonthlyRetentionSchedule
retentionPolicyType 這個屬性將做為決定型別多型鏈結中特定類型的歧視性。 'LongTermRetentionPolicy' (必要)
weeklySchedule 保護原則的每周保留排程。 WeeklyRetentionSchedule
yearlySchedule 保護原則的每年保留排程。 YearlyRetentionSchedule

LongTermSchedulePolicy

名字 描述 價值
schedulePolicyType 這個屬性將做為決定型別多型鏈結中特定類型的歧視性。 'LongTermSchedulePolicy' (必要)

MabProtectionPolicy

名字 描述 價值
backupManagementType 這個屬性將做為決定型別多型鏈結中特定類型的歧視性。 'MAB' (必要)
retentionPolicy 保留原則詳細數據。 RetentionPolicy
schedulePolicy 備份原則的備份排程。 SchedulePolicy

Microsoft.RecoveryServices/vaults/backupPolicies

名字 描述 價值
apiVersion API 版本 '2024-01-01'
eTag 選擇性 ETag。 字串
位置 資源位置。 字串
名字 資源名稱 字串 (必要)
性能 ProtectionPolicyResource 屬性 ProtectionPolicy
標籤 資源標籤 標記名稱和值的字典。 請參閱範本中的 標籤
類型 資源類型 'Microsoft.RecoveryServices/vaults/backupPolicies'

MonthlyRetentionSchedule

名字 描述 價值
retentionDuration 保留原則的保留期間。 RetentionDuration
retentionScheduleDaily 每月保留原則的每日保留格式。 DailyRetentionFormat
retentionScheduleFormatType 每月保留原則的保留排程格式類型。 'Daily'
'Invalid'
'Weekly'
retentionScheduleWeekly 每月保留原則的每周保留格式。 WeeklyRetentionFormat
retentionTimes 保留原則的保留時間。 string[]

ProtectionPolicy

名字 描述 價值
backupManagementType 針對 azureIaaSVMProtectionPolicy類型 設定為 'AzureIaasVM'。 針對 azureSqlProtectionPolicy 類型 設定為 'AzureSql',。 針對 azureFileShareProtectionPolicy 類型設定為 'AzureStorage',。 針對 azureVmWorkloadProtectionPolicy 類型 設定為 'AzureWorkload'。 針對 genericProtectionPolicy GenericProtectionPolicy 類型設定為 'GenericProtectionPolicy',。 將 類型設定為 'MAB',MabProtectionPolicy 'AzureIaasVM'
'AzureSql'
'AzureStorage'
'AzureWorkload'
'GenericProtectionPolicy'
'MAB' (必要)
protectedItemsCount 與此原則相關聯的項目數目。 int
resourceGuardOperationRequests ResourceGuard 作業要求 string[]

ResourceTags

名字 描述 價值

RetentionDuration

名字 描述 價值
計數 持續時間類型的計數。 保留期間是透過計算持續時間類型 Count 時間取得。
例如,當 Count = 3 且 DurationType = Weeks 時,保留期間會是三周。
int
durationType 保留期間類型的保留原則。 'Days'
'Invalid'
'Month'
'Weeks'
'Years'

RetentionPolicy

名字 描述 價值
retentionPolicyType 針對 longTermRetentionPolicy 類型設定為 'LongTermRetentionPolicy'。 針對類型 SimpleRetentionPolicy,設定為 'SimpleRetentionPolicy'。 'LongTermRetentionPolicy'
'SimpleRetentionPolicy' (必要)

SchedulePolicy

名字 描述 價值
schedulePolicyType 針對 logSchedulePolicy 類型 LogSchedulePolicy設定為 'LogSchedulePolicy'。 針對 longTermSchedulePolicy LongTermSchedulePolicy 類型設定為 'LongTermSchedulePolicy',。 針對 simpleSchedulePolicy 類型設定為 'SimpleSchedulePolicy',。 針對 simpleSchedulePolicyV2 類型設定為 'SimpleSchedulePolicyV2' 'LogSchedulePolicy'
'LongTermSchedulePolicy'
'SimpleSchedulePolicy'
'SimpleSchedulePolicyV2' (必要)

設置

名字 描述 價值
isCompression 工作負載壓縮旗標。 已新增此專案,讓 'isSqlCompression'
一旦客戶端升級以考慮此旗標,將會被取代。
bool
issqlcompression SQL 壓縮旗標 bool
timeZone TimeZone 選擇性輸入做為字串。 例如:TimeZone = “Pacific Standard Time”。 字串

SimpleRetentionPolicy

名字 描述 價值
retentionDuration 保護原則的保留期間。 RetentionDuration
retentionPolicyType 這個屬性將做為決定型別多型鏈結中特定類型的歧視性。 'SimpleRetentionPolicy' (必要)

SimpleSchedulePolicy

名字 描述 價值
hourlySchedule 此原則的每小時排程 HourlySchedule
schedulePolicyType 這個屬性將做為決定型別多型鏈結中特定類型的歧視性。 'SimpleSchedulePolicy' (必要)
scheduleRunDays 此排程必須執行一周中的天數清單。 包含任何的字串數組:
'Friday'
'Monday'
'Saturday'
'Sunday'
'Thursday'
'Tuesday'
'Wednesday'
scheduleRunFrequency 此原則的排程作業頻率。 'Daily'
'Hourly'
'Invalid'
'Weekly'
scheduleRunTimes 此排程必須執行的一天時間清單。 string[]
scheduleWeeklyFrequency 此排程必須在每一周執行一次。 int

SimpleSchedulePolicyV2

名字 描述 價值
dailySchedule 此原則的每日排程 DailySchedule
hourlySchedule 此原則的每小時排程 HourlySchedule
schedulePolicyType 這個屬性將做為決定型別多型鏈結中特定類型的歧視性。 'SimpleSchedulePolicyV2' (必要)
scheduleRunFrequency 此原則的排程作業頻率。 'Daily'
'Hourly'
'Invalid'
'Weekly'
weeklySchedule 此原則的每周排程 WeeklySchedule

SnapshotBackupAdditionalDetails

名字 描述 價值
instantRPDetails 字串
instantRpRetentionRangeInDays int
userAssignedManagedIdentityDetails 使用者指派的受控識別詳細數據 UserAssignedManagedIdentityDetails

SubProtectionPolicy

名字 描述 價值
policyType 備份原則類型 'CopyOnlyFull'
'Differential'
'Full'
'Incremental'
'Invalid'
'Log'
'SnapshotCopyOnlyFull'
'SnapshotFull'
retentionPolicy 保留原則,其中包含備份複製保留範圍的詳細數據。 RetentionPolicy
schedulePolicy 備份排程指定為備份原則的一部分。 SchedulePolicy
snapshotBackupAdditionalDetails WorkloadType SaPHanaSystem 的快照集備份相關欄位 SnapshotBackupAdditionalDetails
tieringPolicy 階層處理原則,可自動將 RP 移至另一層。
機碼是目標層,定義於 RecoveryPointTierType 列舉中。
階層處理原則會指定要將 RP 移至目標層的準則。
SubProtectionPolicyTieringPolicy

SubProtectionPolicyTieringPolicy

名字 描述 價值

TieringPolicy

名字 描述 價值
期間 在階層處理之前,保留目前層中的備份天數/周/月/年數。
只有在 TieringMode 設定為 TierAfter 時才使用
int
durationType 保留期間類型:天/周/月/年
只有在 TieringMode 設定為 TierAfter 時才使用
'Days'
'Invalid'
'Month'
'Weeks'
'Years'
tieringMode 階層處理模式可控制恢復點的自動階層處理。 支援的值為:
1. TierRecommended:建議階層處理的所有恢復點階層
2. TierAfter:將固定期間之後的所有恢復點分層,如以下的 duration + durationType 中所指定。
3. DoNotTier:不要將任何恢復點分層
'DoNotTier'
'Invalid'
'TierAfter'
'TierRecommended'

UserAssignedIdentityProperties

名字 描述 價值
clientId 指派之身分識別的用戶端標識碼。 字串
principalId 指派之身分識別的主體標識碼。 字串

UserAssignedManagedIdentityDetails

名字 描述 價值
identityArmId 指派之身分識別的 ARM 識別碼。 字串
identityName 指派的身分識別名稱。 字串
userAssignedIdentityProperties 使用者指派的受控識別屬性 UserAssignedIdentityProperties

VaultRetentionPolicy

名字 描述 價值
snapshotRetentionInDays int (必要)
vaultRetention 保留原則的基類。 RetentionPolicy (必要)

WeeklyRetentionFormat

名字 描述 價值
daysOfTheWeek 星期幾的清單。 包含任何的字串數組:
'Friday'
'Monday'
'Saturday'
'Sunday'
'Thursday'
'Tuesday'
'Wednesday'
weeksOfTheMonth 月份的周清單。 包含任何的字串數組:
'First'
'Fourth'
'Invalid'
'Last'
'Second'
'Third'

WeeklyRetentionSchedule

名字 描述 價值
daysOfTheWeek 每周保留原則的星期幾清單。 包含任何的字串數組:
'Friday'
'Monday'
'Saturday'
'Sunday'
'Thursday'
'Tuesday'
'Wednesday'
retentionDuration 保留原則的保留期間。 RetentionDuration
retentionTimes 保留原則的保留時間。 string[]

WeeklySchedule

名字 描述 價值
scheduleRunDays 包含任何的字串數組:
'Friday'
'Monday'
'Saturday'
'Sunday'
'Thursday'
'Tuesday'
'Wednesday'
scheduleRunTimes 此排程必須執行的一天時間清單。 string[]

YearlyRetentionSchedule

名字 描述 價值
monthsOfYear 年度保留原則的月份清單。 包含任何的字串數組:
'April'
'August'
'December'
'February'
'Invalid'
'January'
'7 月'
'June'
'March'
'May'
'November'
'10 月'
'九月'
retentionDuration 保留原則的保留期間。 RetentionDuration
retentionScheduleDaily 每年保留原則的每日保留格式。 DailyRetentionFormat
retentionScheduleFormatType 每年保留原則的保留排程格式。 'Daily'
'Invalid'
'Weekly'
retentionScheduleWeekly 每年保留原則的每周保留格式。 WeeklyRetentionFormat
retentionTimes 保留原則的保留時間。 string[]

快速入門範本

下列快速入門範本會部署此資源類型。

範本 描述
Azure 虛擬機中工作負載的 Azure 備份

部署至 Azure
此範本會建立復原服務保存庫和工作負載特定的備份原則。 向備份服務和設定保護註冊 VM
使用復原服務備份現有的檔案共用 (每日)

部署至 Azure
此範本會設定現有記憶體帳戶中現有檔案共享的保護。 它會根據 set 參數值,建立新的 或使用現有的復原服務保存庫和備份原則。
使用復原服務備份現有的檔案共用 (每小時)

部署至 Azure
此範本會以每小時頻率設定現有記憶體帳戶中現有檔案共享的保護。 它會根據 set 參數值,建立新的 或使用現有的復原服務保存庫和備份原則。
使用復原服務保存庫 備份 Resource Manager VM

部署至 Azure
此範本會使用現有的復原服務保存庫和現有的備份原則,並設定多個屬於相同資源群組的 Resource Manager VM 備份
為 RS Vault 建立每日備份原則以保護 IaaSVM

部署至 Azure
此範本會建立復原服務保存庫和每日備份原則,可用來保護傳統和 ARM 型 IaaS VM。
使用備份原則建立復原服務保存庫

部署至 Azure
此範本會建立具有備份原則的復原服務保存庫,並設定選擇性功能,例如系統身分識別、備份記憶體類型、跨區域還原和診斷記錄,以及刪除鎖定。
為 RS Vault 建立每周備份原則以保護 IaaSVM

部署至 Azure
此範本會建立復原服務保存庫和每日備份原則,可用來保護傳統和 ARM 型 IaaS VM。

Terraform (AzAPI 提供者) 資源定義

儲存庫/backupPolicies 資源類型可以使用目標作業來部署:

  • 資源群組

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔

資源格式

若要建立 Microsoft.RecoveryServices/vaults/backupPolicies 資源,請將下列 Terraform 新增至範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.RecoveryServices/vaults/backupPolicies@2024-01-01"
  name = "string"
  eTag = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      protectedItemsCount = int
      resourceGuardOperationRequests = [
        "string"
      ]
      backupManagementType = "string"
      // For remaining properties, see ProtectionPolicy objects
    }
  })
}

ProtectionPolicy 物件

設定backupManagementType 屬性 屬性,以指定物件的類型。

針對 AzureIaasVM,請使用:

{
  backupManagementType = "AzureIaasVM"
  instantRPDetails = {
    azureBackupRGNamePrefix = "string"
    azureBackupRGNameSuffix = "string"
  }
  instantRpRetentionRangeInDays = int
  policyType = "string"
  retentionPolicy = {
    retentionPolicyType = "string"
    // For remaining properties, see RetentionPolicy objects
  }
  schedulePolicy = {
    schedulePolicyType = "string"
    // For remaining properties, see SchedulePolicy objects
  }
  snapshotConsistencyType = "string"
  tieringPolicy = {
    {customized property} = {
      duration = int
      durationType = "string"
      tieringMode = "string"
    }
  }
  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"
  vaultRetentionPolicy = {
    snapshotRetentionInDays = int
    vaultRetention = {
      retentionPolicyType = "string"
      // For remaining properties, see RetentionPolicy objects
    }
  }
  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
      }
      snapshotBackupAdditionalDetails = {
        instantRPDetails = "string"
        instantRpRetentionRangeInDays = int
        userAssignedManagedIdentityDetails = {
          identityArmId = "string"
          identityName = "string"
          userAssignedIdentityProperties = {
            clientId = "string"
            principalId = "string"
          }
        }
      }
      tieringPolicy = {
        {customized property} = {
          duration = int
          durationType = "string"
          tieringMode = "string"
        }
      }
    }
  ]
  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
      }
      snapshotBackupAdditionalDetails = {
        instantRPDetails = "string"
        instantRpRetentionRangeInDays = int
        userAssignedManagedIdentityDetails = {
          identityArmId = "string"
          identityName = "string"
          userAssignedIdentityProperties = {
            clientId = "string"
            principalId = "string"
          }
        }
      }
      tieringPolicy = {
        {customized property} = {
          duration = int
          durationType = "string"
          tieringMode = "string"
        }
      }
    }
  ]
  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,請使用:

{
  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"
    ]
  }
  retentionPolicyType = "LongTermRetentionPolicy"
  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,請使用:

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

SchedulePolicy 物件

設定 schedulePolicyType 屬性,以指定對象的類型。

針對 logSchedulePolicy,請使用:

{
  scheduleFrequencyInMins = int
  schedulePolicyType = "LogSchedulePolicy"
}

針對 LongTermSchedulePolicy,請使用:

{
  schedulePolicyType = "LongTermSchedulePolicy"
}

針對 SimpleSchedulePolicy,請使用:

{
  hourlySchedule = {
    interval = int
    scheduleWindowDuration = int
    scheduleWindowStartTime = "string"
  }
  schedulePolicyType = "SimpleSchedulePolicy"
  scheduleRunDays = [
    "string"
  ]
  scheduleRunFrequency = "string"
  scheduleRunTimes = [
    "string"
  ]
  scheduleWeeklyFrequency = int
}

針對 SimpleSchedulePolicyV2,請使用:

{
  dailySchedule = {
    scheduleRunTimes = [
      "string"
    ]
  }
  hourlySchedule = {
    interval = int
    scheduleWindowDuration = int
    scheduleWindowStartTime = "string"
  }
  schedulePolicyType = "SimpleSchedulePolicyV2"
  scheduleRunFrequency = "string"
  weeklySchedule = {
    scheduleRunDays = [
      "string"
    ]
    scheduleRunTimes = [
      "string"
    ]
  }
}

屬性值

AzureFileShareProtectionPolicy

名字 描述 價值
backupManagementType 這個屬性將做為決定型別多型鏈結中特定類型的歧視性。 'AzureStorage' (必要)
retentionPolicy 保留原則,其中包含備份複製保留範圍的詳細數據。 RetentionPolicy
schedulePolicy 備份排程指定為備份原則的一部分。 SchedulePolicy
timeZone TimeZone 選擇性輸入做為字串。 例如:TimeZone = “Pacific Standard Time”。 字串
vaultRetentionPolicy 保留原則,其中包含強化備份複製保留範圍的詳細數據。 VaultRetentionPolicy
workLoadType 備份管理的工作負載類型 'AzureFileShare'
'AzureSqlDb'
'Client'
'Exchange'
'FileFolder'
'GenericDataSource'
'Invalid'
'SAPAseDatabase'
'SAPHanaDatabase'
'SAPHanaDBInstance'
'Sharepoint'
'SQLDataBase'
'SQLDB'
'SystemState'
'VM'
'VMwareVM'

AzureIaaSVMProtectionPolicy

名字 描述 價值
backupManagementType 這個屬性將做為決定型別多型鏈結中特定類型的歧視性。 'AzureIaasVM' (必要)
instantRPDetails InstantRPAdditionalDetails
instantRpRetentionRangeInDays 立即 RP 保留原則範圍天數 int
policyType 'Invalid'
'V1'
'V2'
retentionPolicy 保留原則,其中包含備份複製保留範圍的詳細數據。 RetentionPolicy
schedulePolicy 備份排程指定為備份原則的一部分。 SchedulePolicy
snapshotConsistencyType 'OnlyCrashConsistent'
tieringPolicy 階層處理原則,可自動將 RP 移至另一層
機碼是目標層,定義於 RecoveryPointTierType 列舉中。
階層處理原則會指定要將 RP 移至目標層的準則。
AzureIaaSVMProtectionPolicyTieringPolicy
timeZone TimeZone 選擇性輸入做為字串。 例如:TimeZone = “Pacific Standard Time”。 字串

AzureIaaSVMProtectionPolicyTieringPolicy

名字 描述 價值

AzureSqlProtectionPolicy

名字 描述 價值
backupManagementType 這個屬性將做為決定型別多型鏈結中特定類型的歧視性。 'AzureSql' (必要)
retentionPolicy 保留原則詳細數據。 RetentionPolicy

AzureVmWorkloadProtectionPolicy

名字 描述 價值
backupManagementType 這個屬性將做為決定型別多型鏈結中特定類型的歧視性。 'AzureWorkload' (必要)
makePolicyConsistent 修正原則不一致 bool
設置 備份管理的常見設定 設定
subProtectionPolicy 包含排程和保留的子保護原則清單 SubProtectionPolicy[]
workLoadType 備份管理的工作負載類型 'AzureFileShare'
'AzureSqlDb'
'Client'
'Exchange'
'FileFolder'
'GenericDataSource'
'Invalid'
'SAPAseDatabase'
'SAPHanaDatabase'
'SAPHanaDBInstance'
'Sharepoint'
'SQLDataBase'
'SQLDB'
'SystemState'
'VM'
'VMwareVM'

DailyRetentionFormat

名字 描述 價值
daysOfTheMonth 月份的天數清單。 []

DailyRetentionSchedule

名字 描述 價值
retentionDuration 保留原則的保留期間。 RetentionDuration
retentionTimes 保留原則的保留時間。 string[]

DailySchedule

名字 描述 價值
scheduleRunTimes 此排程必須執行的一天時間清單。 string[]

名字 描述 價值
日期 月份的日期 int
isLast Date 是否為月份的最後一個日期 bool

GenericProtectionPolicy

名字 描述 價值
backupManagementType 這個屬性將做為決定型別多型鏈結中特定類型的歧視性。 'GenericProtectionPolicy' (必要)
fabricName 此原則網狀架構的名稱。 字串
subProtectionPolicy 包含排程和保留的子保護原則清單 SubProtectionPolicy[]
timeZone TimeZone 選擇性輸入做為字串。 例如:TimeZone = “Pacific Standard Time”。 字串

HourlySchedule

名字 描述 價值
間隔 需要觸發備份的間隔。 針對每小時的值
可以是 4/6/8/12
int
scheduleWindowDuration 若要指定備份視窗的持續時間 int
scheduleWindowStartTime 若要指定備份視窗的開始時間 字串

InstantRPAdditionalDetails

名字 描述 價值
azureBackupRGNamePrefix 字串
azureBackupRGNameSuffix 字串

LogSchedulePolicy

名字 描述 價值
scheduleFrequencyInMins 此原則的記錄排程作業頻率,以分鐘為單位。 int
schedulePolicyType 這個屬性將做為決定型別多型鏈結中特定類型的歧視性。 'LogSchedulePolicy' (必要)

LongTermRetentionPolicy

名字 描述 價值
dailySchedule 保護原則的每日保留排程。 DailyRetentionSchedule
monthlySchedule 保護原則的每月保留排程。 MonthlyRetentionSchedule
retentionPolicyType 這個屬性將做為決定型別多型鏈結中特定類型的歧視性。 'LongTermRetentionPolicy' (必要)
weeklySchedule 保護原則的每周保留排程。 WeeklyRetentionSchedule
yearlySchedule 保護原則的每年保留排程。 YearlyRetentionSchedule

LongTermSchedulePolicy

名字 描述 價值
schedulePolicyType 這個屬性將做為決定型別多型鏈結中特定類型的歧視性。 'LongTermSchedulePolicy' (必要)

MabProtectionPolicy

名字 描述 價值
backupManagementType 這個屬性將做為決定型別多型鏈結中特定類型的歧視性。 'MAB' (必要)
retentionPolicy 保留原則詳細數據。 RetentionPolicy
schedulePolicy 備份原則的備份排程。 SchedulePolicy

Microsoft.RecoveryServices/vaults/backupPolicies

名字 描述 價值
eTag 選擇性 ETag。 字串
位置 資源位置。 字串
名字 資源名稱 字串 (必要)
parent_id 此資源為父系之資源的標識碼。 類型的資源標識碼:保存庫
性能 ProtectionPolicyResource 屬性 ProtectionPolicy
標籤 資源標籤 標記名稱和值的字典。
類型 資源類型 “Microsoft.RecoveryServices/vaults/backupPolicies@2024-01-01”

MonthlyRetentionSchedule

名字 描述 價值
retentionDuration 保留原則的保留期間。 RetentionDuration
retentionScheduleDaily 每月保留原則的每日保留格式。 DailyRetentionFormat
retentionScheduleFormatType 每月保留原則的保留排程格式類型。 'Daily'
'Invalid'
'Weekly'
retentionScheduleWeekly 每月保留原則的每周保留格式。 WeeklyRetentionFormat
retentionTimes 保留原則的保留時間。 string[]

ProtectionPolicy

名字 描述 價值
backupManagementType 針對 azureIaaSVMProtectionPolicy類型 設定為 'AzureIaasVM'。 針對 azureSqlProtectionPolicy 類型 設定為 'AzureSql',。 針對 azureFileShareProtectionPolicy 類型設定為 'AzureStorage',。 針對 azureVmWorkloadProtectionPolicy 類型 設定為 'AzureWorkload'。 針對 genericProtectionPolicy GenericProtectionPolicy 類型設定為 'GenericProtectionPolicy',。 將 類型設定為 'MAB',MabProtectionPolicy 'AzureIaasVM'
'AzureSql'
'AzureStorage'
'AzureWorkload'
'GenericProtectionPolicy'
'MAB' (必要)
protectedItemsCount 與此原則相關聯的項目數目。 int
resourceGuardOperationRequests ResourceGuard 作業要求 string[]

ResourceTags

名字 描述 價值

RetentionDuration

名字 描述 價值
計數 持續時間類型的計數。 保留期間是透過計算持續時間類型 Count 時間取得。
例如,當 Count = 3 且 DurationType = Weeks 時,保留期間會是三周。
int
durationType 保留期間類型的保留原則。 'Days'
'Invalid'
'Month'
'Weeks'
'Years'

RetentionPolicy

名字 描述 價值
retentionPolicyType 針對 longTermRetentionPolicy 類型設定為 'LongTermRetentionPolicy'。 針對類型 SimpleRetentionPolicy,設定為 'SimpleRetentionPolicy'。 'LongTermRetentionPolicy'
'SimpleRetentionPolicy' (必要)

SchedulePolicy

名字 描述 價值
schedulePolicyType 針對 logSchedulePolicy 類型 LogSchedulePolicy設定為 'LogSchedulePolicy'。 針對 longTermSchedulePolicy LongTermSchedulePolicy 類型設定為 'LongTermSchedulePolicy',。 針對 simpleSchedulePolicy 類型設定為 'SimpleSchedulePolicy',。 針對 simpleSchedulePolicyV2 類型設定為 'SimpleSchedulePolicyV2' 'LogSchedulePolicy'
'LongTermSchedulePolicy'
'SimpleSchedulePolicy'
'SimpleSchedulePolicyV2' (必要)

設置

名字 描述 價值
isCompression 工作負載壓縮旗標。 已新增此專案,讓 'isSqlCompression'
一旦客戶端升級以考慮此旗標,將會被取代。
bool
issqlcompression SQL 壓縮旗標 bool
timeZone TimeZone 選擇性輸入做為字串。 例如:TimeZone = “Pacific Standard Time”。 字串

SimpleRetentionPolicy

名字 描述 價值
retentionDuration 保護原則的保留期間。 RetentionDuration
retentionPolicyType 這個屬性將做為決定型別多型鏈結中特定類型的歧視性。 'SimpleRetentionPolicy' (必要)

SimpleSchedulePolicy

名字 描述 價值
hourlySchedule 此原則的每小時排程 HourlySchedule
schedulePolicyType 這個屬性將做為決定型別多型鏈結中特定類型的歧視性。 'SimpleSchedulePolicy' (必要)
scheduleRunDays 此排程必須執行一周中的天數清單。 包含任何的字串數組:
'Friday'
'Monday'
'Saturday'
'Sunday'
'Thursday'
'Tuesday'
'Wednesday'
scheduleRunFrequency 此原則的排程作業頻率。 'Daily'
'Hourly'
'Invalid'
'Weekly'
scheduleRunTimes 此排程必須執行的一天時間清單。 string[]
scheduleWeeklyFrequency 此排程必須在每一周執行一次。 int

SimpleSchedulePolicyV2

名字 描述 價值
dailySchedule 此原則的每日排程 DailySchedule
hourlySchedule 此原則的每小時排程 HourlySchedule
schedulePolicyType 這個屬性將做為決定型別多型鏈結中特定類型的歧視性。 'SimpleSchedulePolicyV2' (必要)
scheduleRunFrequency 此原則的排程作業頻率。 'Daily'
'Hourly'
'Invalid'
'Weekly'
weeklySchedule 此原則的每周排程 WeeklySchedule

SnapshotBackupAdditionalDetails

名字 描述 價值
instantRPDetails 字串
instantRpRetentionRangeInDays int
userAssignedManagedIdentityDetails 使用者指派的受控識別詳細數據 UserAssignedManagedIdentityDetails

SubProtectionPolicy

名字 描述 價值
policyType 備份原則類型 'CopyOnlyFull'
'Differential'
'Full'
'Incremental'
'Invalid'
'Log'
'SnapshotCopyOnlyFull'
'SnapshotFull'
retentionPolicy 保留原則,其中包含備份複製保留範圍的詳細數據。 RetentionPolicy
schedulePolicy 備份排程指定為備份原則的一部分。 SchedulePolicy
snapshotBackupAdditionalDetails WorkloadType SaPHanaSystem 的快照集備份相關欄位 SnapshotBackupAdditionalDetails
tieringPolicy 階層處理原則,可自動將 RP 移至另一層。
機碼是目標層,定義於 RecoveryPointTierType 列舉中。
階層處理原則會指定要將 RP 移至目標層的準則。
SubProtectionPolicyTieringPolicy

SubProtectionPolicyTieringPolicy

名字 描述 價值

TieringPolicy

名字 描述 價值
期間 在階層處理之前,保留目前層中的備份天數/周/月/年數。
只有在 TieringMode 設定為 TierAfter 時才使用
int
durationType 保留期間類型:天/周/月/年
只有在 TieringMode 設定為 TierAfter 時才使用
'Days'
'Invalid'
'Month'
'Weeks'
'Years'
tieringMode 階層處理模式可控制恢復點的自動階層處理。 支援的值為:
1. TierRecommended:建議階層處理的所有恢復點階層
2. TierAfter:將固定期間之後的所有恢復點分層,如以下的 duration + durationType 中所指定。
3. DoNotTier:不要將任何恢復點分層
'DoNotTier'
'Invalid'
'TierAfter'
'TierRecommended'

UserAssignedIdentityProperties

名字 描述 價值
clientId 指派之身分識別的用戶端標識碼。 字串
principalId 指派之身分識別的主體標識碼。 字串

UserAssignedManagedIdentityDetails

名字 描述 價值
identityArmId 指派之身分識別的 ARM 識別碼。 字串
identityName 指派的身分識別名稱。 字串
userAssignedIdentityProperties 使用者指派的受控識別屬性 UserAssignedIdentityProperties

VaultRetentionPolicy

名字 描述 價值
snapshotRetentionInDays int (必要)
vaultRetention 保留原則的基類。 RetentionPolicy (必要)

WeeklyRetentionFormat

名字 描述 價值
daysOfTheWeek 星期幾的清單。 包含任何的字串數組:
'Friday'
'Monday'
'Saturday'
'Sunday'
'Thursday'
'Tuesday'
'Wednesday'
weeksOfTheMonth 月份的周清單。 包含任何的字串數組:
'First'
'Fourth'
'Invalid'
'Last'
'Second'
'Third'

WeeklyRetentionSchedule

名字 描述 價值
daysOfTheWeek 每周保留原則的星期幾清單。 包含任何的字串數組:
'Friday'
'Monday'
'Saturday'
'Sunday'
'Thursday'
'Tuesday'
'Wednesday'
retentionDuration 保留原則的保留期間。 RetentionDuration
retentionTimes 保留原則的保留時間。 string[]

WeeklySchedule

名字 描述 價值
scheduleRunDays 包含任何的字串數組:
'Friday'
'Monday'
'Saturday'
'Sunday'
'Thursday'
'Tuesday'
'Wednesday'
scheduleRunTimes 此排程必須執行的一天時間清單。 string[]

YearlyRetentionSchedule

名字 描述 價值
monthsOfYear 年度保留原則的月份清單。 包含任何的字串數組:
'April'
'August'
'December'
'February'
'Invalid'
'January'
'7 月'
'June'
'March'
'May'
'November'
'10 月'
'九月'
retentionDuration 保留原則的保留期間。 RetentionDuration
retentionScheduleDaily 每年保留原則的每日保留格式。 DailyRetentionFormat
retentionScheduleFormatType 每年保留原則的保留排程格式。 'Daily'
'Invalid'
'Weekly'
retentionScheduleWeekly 每年保留原則的每周保留格式。 WeeklyRetentionFormat
retentionTimes 保留原則的保留時間。 string[]