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

Backup Policies - Create Or Update

服务:: Data Protection

API 版本:: 2025-07-01

创建或更新属于备份保管库的备份策略

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

URI 参数

名称	在	必需	类型	说明
backupPolicyName	path	True	string	策略的名称
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。此名称不区分大小写。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。该值必须是 UUID。
vaultName	path	True	string	备份保管库的名称。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。

请求正文

名称	类型	说明
properties	BaseBackupPolicy: BackupPolicy	BaseBackupPolicy 的 BaseBackupPolicyResource 属性

响应

名称	类型	说明
200 OK	BaseBackupPolicyResource	好的
Other Status Codes	CloudError	描述作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
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-07-01

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

示例响应

状态代码:: 200

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

定义

名称	说明
AbsoluteDeleteOption	AbsoluteDeleteOption
AbsoluteMarker	它包含绝对值，如“AllBackup”/“FirstOfDay”/“FirstOfWeek”/“FirstOfMonth”，应是 AbsoluteMarker 枚举的一部分
AdhocBasedTaggingCriteria	AdhocBasedTaggingCriteria
AdhocBasedTriggerContext	AdhocBasedTriggerContext
AzureBackupParams	AzureBackupParams
AzureBackupRule	AzureBackupRule
AzureRetentionRule	AzureRetentionRule
BackupPolicy	备份策略
BackupSchedule	备份计划
BaseBackupPolicyResource	BaseBackupPolicyResource
CloudError	CloudError 错误
CopyOnExpiryOption	CopyOnExpiry选项
createdByType	创建资源的标识的类型。
CustomCopyOption	CustomCopyOption
DataStoreInfoBase	数据存储信息库
DataStoreTypes	数据存储的类型;作/保管库/存档
Day	日期
DayOfWeek	它应该是星期日/星期一/T..../星期六
Error	资源管理错误响应。
ErrorAdditionalInfo	资源管理错误附加信息。
ImmediateCopyOption	ImmediateCopyOption
Month	它应为 1 月/2 月/....../12 月
RetentionTag	RetentionTag
ScheduleBasedBackupCriteria	ScheduleBasedBackupCriteria
ScheduleBasedTriggerContext	ScheduleBasedTriggerContext
SourceLifeCycle	源生命周期
systemData	与创建和上次修改资源相关的元数据。
TaggingCriteria	标记标准
TargetCopySetting	TargetCopySetting
WeekNumber	它应为 First/Second/Third/Fourth/Last

AbsoluteDeleteOption

Object

AbsoluteDeleteOption

名称	类型	说明
duration	string	给定时间跨度后删除的持续时间
objectType	string: AbsoluteDeleteOption	特定对象的类型 - 用于反序列化

AbsoluteMarker

枚举

它包含绝对值，如“AllBackup”/“FirstOfDay”/“FirstOfWeek”/“FirstOfMonth”，应是 AbsoluteMarker 枚举的一部分

值	说明
AllBackup
FirstOfDay
FirstOfMonth
FirstOfWeek
FirstOfYear

AdhocBasedTaggingCriteria

Object

AdhocBasedTaggingCriteria

名称	类型	说明
tagInfo	RetentionTag	RetentionTag 保留标记信息

AdhocBasedTriggerContext

Object

AdhocBasedTriggerContext

名称	类型	说明
objectType	string: AdhocBasedTriggerContext	特定对象的类型 - 用于反序列化
taggingCriteria	AdhocBasedTaggingCriteria	AdhocBasedTaggingCriteria 标记条件，其中包含临时备份的保留标记。

AzureBackupParams

Object

AzureBackupParams

名称	类型	说明
backupType	string	BackupType ;完整/增量等
objectType	string: AzureBackupParams	特定对象的类型 - 用于反序列化

AzureBackupRule

Object

AzureBackupRule

名称	类型	说明
backupParameters	BackupParameters: AzureBackupParams	BackupParameters BackupParameters 基础
dataStore	DataStoreInfoBase	数据存储信息库 DataStoreInfo 基础
name	string
objectType	string: AzureBackupRule
trigger	TriggerContext: AdhocBasedTriggerContext ScheduleBasedTriggerContext	TriggerContext （触发器上下文）触发器上下文

AzureRetentionRule

Object

AzureRetentionRule

名称	类型	说明
isDefault	boolean
lifecycles	SourceLifeCycle[]	源生命周期源 LifeCycle
name	string
objectType	string: AzureRetentionRule

BackupPolicy

Object

备份策略

名称	类型	说明
datasourceTypes	string[]	备份管理的数据源类型
objectType	string: BackupPolicy
policyRules	BasePolicyRule[]: AzureBackupRule[] AzureRetentionRule[]	策略规则字典，其中包含每个备份类型的规则，即完整/增量/日志等

BackupSchedule

Object

备份计划

名称	类型	说明
repeatingTimeIntervals	string[]	ISO 8601 重复时间间隔格式
timeZone	string	计划的时区。示例：太平洋标准时间

BaseBackupPolicyResource

Object

BaseBackupPolicyResource

名称	类型	说明
id	string	资源 ID 表示资源的完整路径。
name	string	与资源关联的资源名称。
properties	BaseBackupPolicy: BackupPolicy	BaseBackupPolicy 的 BaseBackupPolicyResource 属性
systemData	systemData	与创建和上次修改资源相关的元数据。
type	string	资源类型表示命名空间/ResourceType/ResourceType/...

CloudError

Object

CloudError 错误

名称	类型	说明
error	Error	资源管理错误响应。

CopyOnExpiryOption

Object

CopyOnExpiry选项

名称	类型	说明
objectType	string: CopyOnExpiryOption	特定对象的类型 - 用于反序列化

createdByType

枚举

创建资源的标识的类型。

值	说明
Application
Key
ManagedIdentity
User

CustomCopyOption

Object

CustomCopyOption

名称	类型	说明
duration	string	给定时间跨度后复制的数据
objectType	string: CustomCopyOption	特定对象的类型 - 用于反序列化

DataStoreInfoBase

Object

数据存储信息库

名称	类型	说明
dataStoreType	DataStoreTypes	数据存储的类型;作/保管库/存档
objectType	string	Datasource 对象的类型，用于初始化正确的继承类型

DataStoreTypes

枚举

数据存储的类型;作/保管库/存档

值	说明
ArchiveStore
OperationalStore
VaultStore

Day

Object

日期

名称	类型	说明
date	integer (int32)	月份的日期
isLast	boolean	日期是否为月份的最后一个日期

DayOfWeek

枚举

它应该是星期日/星期一/T..../星期六

值	说明
Friday
Monday
Saturday
Sunday
Thursday
Tuesday
Wednesday

Error

Object

资源管理错误响应。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	Error[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ImmediateCopyOption

Object

ImmediateCopyOption

名称	类型	说明
objectType	string: ImmediateCopyOption	特定对象的类型 - 用于反序列化

Month

枚举

它应为 1 月/2 月/....../12 月

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

RetentionTag

Object

RetentionTag

名称	类型	说明
eTag	string	保留标记版本。
id	string	保留标记版本。
tagName	string	保留标记名称将其与保留规则相关联。

ScheduleBasedBackupCriteria

Object

ScheduleBasedBackupCriteria

名称	类型	说明
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

ScheduleBasedTriggerContext

名称	类型	说明
objectType	string: ScheduleBasedTriggerContext	特定对象的类型 - 用于反序列化
schedule	BackupSchedule	备份计划计划此备份
taggingCriteria	TaggingCriteria[]	可用于给定计划的标记列表。

SourceLifeCycle

Object

源生命周期

名称	类型	说明
deleteAfter	DeleteOption: AbsoluteDeleteOption	DeleteOption 删除选项
sourceDataStore	DataStoreInfoBase	数据存储信息库 DataStoreInfo 基础
targetDataStoreCopySettings	TargetCopySetting[]	TargetCopySetting 目标复制设置

systemData

Object

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

TaggingCriteria

Object

标记标准

名称	类型	说明
criteria	BackupCriteria[]: ScheduleBasedBackupCriteria[]	决定是否可以将标记应用于触发的备份的条件。
isDefault	boolean	指定标记是否为默认值。
tagInfo	RetentionTag	RetentionTag 保留标记信息
taggingPriority	integer (int64)	保留标记优先级。

TargetCopySetting

Object

TargetCopySetting

名称	类型	说明
copyAfter	CopyOption: CopyOnExpiryOption CustomCopyOption ImmediateCopyOption	复制选项可以是 CustomCopyOption 或 ImmediateCopyOption。
dataStore	DataStoreInfoBase	数据存储信息库目标数据存储的信息

WeekNumber

枚举

它应为 First/Second/Third/Fourth/Last

值	说明
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