Backup Policies - Create Or Update

服務:: Data Protection

API 版本:: 2025-09-01

建立或更新屬於備份保存庫的備份原則

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupPolicies/{backupPolicyName}?api-version=2025-09-01

URI 參數

名稱	位於	必要	類型	Description
backupPolicyName	path	True	string
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。名稱不區分大小寫。
subscriptionId	path	True	string (uuid)	目標訂用帳戶的標識碼。此值必須是 UUID。
vaultName	path	True	string	備份保存庫的名稱。
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

要求本文

名稱	類型	Description
properties	BaseBackupPolicy: BackupPolicy	BaseBackupPolicyResource 屬性

回應

名稱	類型	Description
200 OK	BaseBackupPolicyResource	資源 'BaseBackupPolicyResource' 更新作業成功
Other Status Codes	CloudError	未預期的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

CreateOrUpdate BackupPolicy

範例要求

HTTP

PUT https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PrivatePreviewVault/backupPolicies/OSSDBPolicy?api-version=2025-09-01

{
  "properties": {
    "datasourceTypes": [
      "OssDB"
    ],
    "objectType": "BackupPolicy",
    "policyRules": [
      {
        "name": "BackupWeekly",
        "backupParameters": {
          "backupType": "Full",
          "objectType": "AzureBackupParams"
        },
        "dataStore": {
          "dataStoreType": "VaultStore",
          "objectType": "DataStoreInfoBase"
        },
        "objectType": "AzureBackupRule",
        "trigger": {
          "objectType": "ScheduleBasedTriggerContext",
          "schedule": {
            "repeatingTimeIntervals": [
              "R/2019-11-20T08:00:00-08:00/P1W"
            ]
          },
          "taggingCriteria": [
            {
              "isDefault": true,
              "tagInfo": {
                "tagName": "Default"
              },
              "taggingPriority": 99
            },
            {
              "criteria": [
                {
                  "daysOfTheWeek": [
                    "Sunday"
                  ],
                  "objectType": "ScheduleBasedBackupCriteria",
                  "scheduleTimes": [
                    "2019-03-01T13:00:00Z"
                  ]
                }
              ],
              "isDefault": false,
              "tagInfo": {
                "tagName": "Weekly"
              },
              "taggingPriority": 20
            }
          ]
        }
      },
      {
        "name": "Default",
        "isDefault": true,
        "lifecycles": [
          {
            "deleteAfter": {
              "duration": "P1W",
              "objectType": "AbsoluteDeleteOption"
            },
            "sourceDataStore": {
              "dataStoreType": "VaultStore",
              "objectType": "DataStoreInfoBase"
            }
          }
        ],
        "objectType": "AzureRetentionRule"
      },
      {
        "name": "Weekly",
        "isDefault": false,
        "lifecycles": [
          {
            "deleteAfter": {
              "duration": "P12W",
              "objectType": "AbsoluteDeleteOption"
            },
            "sourceDataStore": {
              "dataStoreType": "VaultStore",
              "objectType": "DataStoreInfoBase"
            }
          }
        ],
        "objectType": "AzureRetentionRule"
      }
    ]
  }
}

範例回覆

狀態碼:: 200

{
  "name": "OSSDBPolicy",
  "type": "Microsoft.DataProtection/backupVaults/backupPolicies",
  "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PrivatePreviewVault/backupPolicies/OSSDBPolicy",
  "properties": {
    "datasourceTypes": [
      "OssDB"
    ],
    "objectType": "BackupPolicy",
    "policyRules": [
      {
        "name": "BackupWeekly",
        "backupParameters": {
          "backupType": "Full",
          "objectType": "AzureBackupParams"
        },
        "dataStore": {
          "dataStoreType": "VaultStore",
          "objectType": "DataStoreInfoBase"
        },
        "objectType": "AzureBackupRule",
        "trigger": {
          "objectType": "ScheduleBasedTriggerContext",
          "schedule": {
            "repeatingTimeIntervals": [
              "R/2019-11-20T08:00:00-08:00/P1W"
            ]
          },
          "taggingCriteria": [
            {
              "isDefault": true,
              "tagInfo": {
                "id": "Default_",
                "tagName": "Default"
              },
              "taggingPriority": 99
            },
            {
              "criteria": [
                {
                  "daysOfTheWeek": [
                    "Sunday"
                  ],
                  "objectType": "ScheduleBasedBackupCriteria",
                  "scheduleTimes": [
                    "2019-03-01T13:00:00Z"
                  ]
                }
              ],
              "isDefault": false,
              "tagInfo": {
                "id": "Weekly_",
                "tagName": "Weekly"
              },
              "taggingPriority": 20
            }
          ]
        }
      },
      {
        "name": "Default",
        "isDefault": true,
        "lifecycles": [
          {
            "deleteAfter": {
              "duration": "P1W",
              "objectType": "AbsoluteDeleteOption"
            },
            "sourceDataStore": {
              "dataStoreType": "VaultStore",
              "objectType": "DataStoreInfoBase"
            }
          }
        ],
        "objectType": "AzureRetentionRule"
      },
      {
        "name": "Weekly",
        "isDefault": false,
        "lifecycles": [
          {
            "deleteAfter": {
              "duration": "P12W",
              "objectType": "AbsoluteDeleteOption"
            },
            "sourceDataStore": {
              "dataStoreType": "VaultStore",
              "objectType": "DataStoreInfoBase"
            }
          }
        ],
        "objectType": "AzureRetentionRule"
      }
    ]
  }
}

定義

名稱	Description
AbsoluteDeleteOption	包含持續時間的刪除選項
AbsoluteMarker
AdhocBasedTaggingCriteria	Adhoc 備份標記準則
AdhocBasedTriggerContext	Adhoc 觸發程序內容
AzureBackupParams	Azure 備份參數
AzureBackupRule	Azure 備份規則
AzureRetentionRule	Azure 保留規則
BackupPolicy	以規則為基礎的備份原則
BackupSchedule	備份排程
BaseBackupPolicyResource	BaseBackupPolicy 資源
CloudError	來自 Azure 備份的錯誤回應。
CopyOnExpiryOption	複製到期選項
createdByType	建立資源的身分識別類型。
CustomCopyOption	要複製的持續時間型自定義選項
DataStoreInfoBase	DataStoreInfo 基底
DataStoreTypes	數據存放區的類型;Operational/Vault/Archive
Day	一周中的一天
DayOfWeek
Error	資源管理錯誤回應。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ImmediateCopyOption	立即複製選項
Month
RetentionTag	保留標籤
ScheduleBasedBackupCriteria	排程型備份準則
ScheduleBasedTriggerContext	排程型觸發程序內容
SourceLifeCycle	來源 LifeCycle
systemData	與建立和上次修改資源相關的元數據。
TaggingCriteria	標記條件
TargetCopySetting	目標複製設定
WeekNumber

AbsoluteDeleteOption

Object

包含持續時間的刪除選項

名稱	類型	Description
duration	string	指定時間範圍之後刪除的持續時間
objectType	string: AbsoluteDeleteOption	特定物件的類型 - 用於還原串行化

AbsoluteMarker

列舉型別

值	Description
AllBackup
FirstOfDay
FirstOfMonth
FirstOfWeek
FirstOfYear

AdhocBasedTaggingCriteria

Object

Adhoc 備份標記準則

名稱	類型	Description
tagInfo	RetentionTag	保留標記資訊

AdhocBasedTriggerContext

Object

Adhoc 觸發程序內容

名稱	類型	Description
objectType	string: AdhocBasedTriggerContext	特定物件的類型 - 用於還原串行化
taggingCriteria	AdhocBasedTaggingCriteria	標記準則，其中包含臨機作備份的保留標記。

AzureBackupParams

Object

Azure 備份參數

名稱	類型	Description
backupType	string	BackupType ;完整/累加等
objectType	string: AzureBackupParams	特定物件的類型 - 用於還原串行化

AzureBackupRule

Object

Azure 備份規則

名稱	類型	Description
backupParameters	BackupParameters: AzureBackupParams	BackupParameters 基底
dataStore	DataStoreInfoBase	DataStoreInfo 基底
name	string
objectType	string: AzureBackupRule
trigger	TriggerContext: AdhocBasedTriggerContext ScheduleBasedTriggerContext	觸發程序內容

AzureRetentionRule

Object

Azure 保留規則

名稱	類型	Description
isDefault	boolean
lifecycles	SourceLifeCycle[]	來源 LifeCycle
name	string
objectType	string: AzureRetentionRule

BackupPolicy

Object

以規則為基礎的備份原則

名稱	類型	Description
datasourceTypes	string[]	備份管理的數據源類型
objectType	string: BackupPolicy
policyRules	BasePolicyRule[]: AzureBackupRule[] AzureRetentionRule[]	原則規則字典，其中包含每個備份類型的規則，例如完整/累加/記錄等

BackupSchedule

Object

備份排程

名稱	類型	Description
repeatingTimeIntervals	string[]	重複的時間間隔，支援 ISO 8601 格式及不支援或部分支援格式。支援的 ISO 8601 時間格式以下時間格式已驗證成功解析並支援： T14：30：45.123 → Thh：mm：ss.sss（毫秒） T14：30：45 → Thh：mm：ss（標準時間格式） T14：30 → Thh：mm（僅限整點和分鐘）上述所有指標可能包含時區指示器，如「Z」、「+05：30」、「-08：00」。支援時間戳的範例： 2023-10-15T14：30：45Z 2023-10-15T14：30：45.123+05：30 2023-10-15T14：30Z 不支援或部分支援的格式： T143045.123 或 T143045（無冒號） T14.500（十進位時數） T14（僅限一小時） T14：30.500（分數） T24：00：00（無效） T23：59：60（閏秒）
timeZone	string	時區是排班表。支援的時區指標包括： 'Z' 代表 UTC '+00:00' '+05:30' '-08:00' 範例： 2023-10-15T14：30：45Z 2023-10-15T14：30：45.123+05：30 2023-10-15T14：30-08：00

名稱

類型

Description

repeatingTimeIntervals

string[]

重複的時間間隔，支援 ISO 8601 格式及不支援或部分支援格式。

支援的 ISO 8601 時間格式

以下時間格式已驗證成功解析並支援：

T14：30：45.123 → Thh：mm：ss.sss（毫秒）
T14：30：45 → Thh：mm：ss（標準時間格式）
T14：30 → Thh：mm（僅限整點和分鐘）

上述所有指標可能包含時區指示器，如「Z」、「+05：30」、「-08：00」。

支援時間戳的範例：

2023-10-15T14：30：45Z
2023-10-15T14：30：45.123+05：30
2023-10-15T14：30Z

不支援或部分支援的格式：

T143045.123 或 T143045（無冒號）
T14.500（十進位時數）
T14（僅限一小時）
T14：30.500（分數）
T24：00：00（無效）
T23：59：60（閏秒）

timeZone

string

時區是排班表。

支援的時區指標包括：

'Z' 代表 UTC
'+00:00'
'+05:30'
'-08:00'

範例：

2023-10-15T14：30：45Z
2023-10-15T14：30：45.123+05：30
2023-10-15T14：30-08：00

BaseBackupPolicyResource

Object

BaseBackupPolicy 資源

名稱	類型	Description
id	string (arm-id)	資源的完整資源標識碼。例如 “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	資源的名稱
properties	BaseBackupPolicy: BackupPolicy	BaseBackupPolicyResource 屬性
systemData	systemData	包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。
type	string	資源的類型。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

CloudError

Object

來自 Azure 備份的錯誤回應。

名稱	類型	Description
error	Error	資源管理錯誤回應。

CopyOnExpiryOption

Object

複製到期選項

名稱	類型	Description
objectType	string: CopyOnExpiryOption	特定物件的類型 - 用於還原串行化

createdByType

列舉型別

建立資源的身分識別類型。

值	Description
User
Application
ManagedIdentity
Key

CustomCopyOption

Object

要複製的持續時間型自定義選項

名稱	類型	Description
duration	string	在指定時間範圍之後複製的數據
objectType	string: CustomCopyOption	特定物件的類型 - 用於還原串行化

DataStoreInfoBase

Object

DataStoreInfo 基底

名稱	類型	Description
dataStoreType	DataStoreTypes	數據存放區的類型;Operational/Vault/Archive
objectType	string	Datasource 物件的類型，用來初始化正確的繼承類型

DataStoreTypes

列舉型別

數據存放區的類型;Operational/Vault/Archive

值	Description
OperationalStore
VaultStore
ArchiveStore

Day

Object

一周中的一天

名稱	類型	Description
date	integer (int32)	月份的日期
isLast	boolean	Date 是否為月份的最後一個日期

DayOfWeek

列舉型別

值	Description
Friday
Monday
Saturday
Sunday
Thursday
Tuesday
Wednesday

Error

Object

資源管理錯誤回應。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	Error[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ImmediateCopyOption

Object

立即複製選項

名稱	類型	Description
objectType	string: ImmediateCopyOption	特定物件的類型 - 用於還原串行化

Month

列舉型別

值	Description
April
August
December
February
January
July
June
March
May
November
October
September

RetentionTag

Object

保留標籤

名稱	類型	Description
eTag	string	保留標記版本。
id	string	保留標記版本。
tagName	string	保留標記名稱，使其與保留規則相關聯。

ScheduleBasedBackupCriteria

Object

排程型備份準則

名稱	類型	Description
absoluteCriteria	AbsoluteMarker[]	它包含絕對值，例如 “AllBackup” / “FirstOfDay” / “FirstOfWeek” / “FirstOfMonth” ，且應該是 AbsoluteMarker 列舉的一部分
daysOfMonth	Day[]	這是當月 1 到 28 日的日期，否則為上個月
daysOfTheWeek	DayOfWeek[]	應該是星期日/星期一/T..../星期六
monthsOfYear	Month[]	應該是 1 月/2 月/....../12 月
objectType	string: ScheduleBasedBackupCriteria	特定物件的類型 - 用於還原串行化
scheduleTimes	string[] (date-time)	備份的排程時間清單
weeksOfTheMonth	WeekNumber[]	應該是 First/Second/Third/Fourth/Last

ScheduleBasedTriggerContext

Object

排程型觸發程序內容

名稱	類型	Description
objectType	string: ScheduleBasedTriggerContext	特定物件的類型 - 用於還原串行化
schedule	BackupSchedule	此備份的排程
taggingCriteria	TaggingCriteria[]	適用於指定排程的標記清單。

SourceLifeCycle

Object

來源 LifeCycle

名稱	類型	Description
deleteAfter	DeleteOption: AbsoluteDeleteOption	刪除選項
sourceDataStore	DataStoreInfoBase	DataStoreInfo 基底
targetDataStoreCopySettings	TargetCopySetting[]	目標複製設定

systemData

Object

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string (date-time)	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string (date-time)	上次修改的資源時間戳（UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

TaggingCriteria

Object

標記條件

名稱	類型	Description
criteria	BackupCriteria[]: ScheduleBasedBackupCriteria[]	決定標籤是否可以套用至觸發備份的準則。
isDefault	boolean	指定標籤是否為預設值。
tagInfo	RetentionTag	保留標記資訊
taggingPriority	integer (int64)	保留標記優先順序。

TargetCopySetting

Object

目標複製設定

名稱	類型	Description
copyAfter	CopyOption: CopyOnExpiryOption CustomCopyOption ImmediateCopyOption	它可以是 CustomCopyOption 或 ImmediateCopyOption。
dataStore	DataStoreInfoBase	目標數據存放區的資訊

WeekNumber

列舉型別

值	Description
First
Fourth
Last
Second
Third

共用方式為

Backup Policies - Create Or Update

URI 參數

要求本文

回應

安全性

azure_auth

範圍

範例

CreateOrUpdate BackupPolicy

範例要求

範例回覆

定義

AbsoluteDeleteOption

AbsoluteMarker

AdhocBasedTaggingCriteria

AdhocBasedTriggerContext

AzureBackupParams

AzureBackupRule

AzureRetentionRule

BackupPolicy

BackupSchedule

BaseBackupPolicyResource

CloudError

CopyOnExpiryOption

createdByType

CustomCopyOption

DataStoreInfoBase

DataStoreTypes

Day

DayOfWeek

Error

ErrorAdditionalInfo

ImmediateCopyOption

Month

RetentionTag

ScheduleBasedBackupCriteria

ScheduleBasedTriggerContext

SourceLifeCycle

systemData

TaggingCriteria

TargetCopySetting

WeekNumber