Backup Policies - Create Or Update
バックアップ コンテナーに属するバックアップ ポリシーを作成または更新します
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupPolicies/{backupPolicyName}?api-version=2025-07-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
backup
|
path | True |
string |
ポリシーの名前 |
resource
|
path | True |
string minLength: 1maxLength: 90 |
リソース グループの名前。 名前は大文字と小文字が区別されます。 |
subscription
|
path | True |
string (uuid) |
ターゲット サブスクリプションの ID。 値は UUID である必要があります。 |
vault
|
path | True |
string |
バックアップ コンテナーの名前。 |
api-version
|
query | True |
string minLength: 1 |
この操作に使用する API バージョン。 |
要求本文
名前 | 型 | 説明 |
---|---|---|
properties | BaseBackupPolicy: |
BaseBackupPolicy (英語) |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
[OK] |
|
Other Status Codes |
操作が失敗した理由を説明するエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントを偽装します。 |
例
CreateOrUpdate BackupPolicy
要求のサンプル
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"
}
}
応答のサンプル
{
"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"
}
}
定義
名前 | 説明 |
---|---|
Absolute |
AbsoluteDeleteオプション |
Absolute |
"AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" などの絶対値が含まれており、AbsoluteMarker 列挙型の一部である必要があります |
Adhoc |
AdhocBasedTaggingCriteria (アドホック ベースのタグ付け基準) |
Adhoc |
アドホックベースのトリガーコンテキスト |
Azure |
AzureBackupParams |
Azure |
AzureBackupRule |
Azure |
AzureRetentionRule |
Backup |
バックアップポリシー |
Backup |
バックアップスケジュール |
Base |
BaseBackupPolicyリソース |
Cloud |
クラウドエラー |
Copy |
CopyOnExpiryオプション |
created |
リソースを作成した ID の種類。 |
Custom |
カスタムコピーオプション |
Data |
データストア情報ベース |
Data |
データストアの種類。Operational/Vault/Archive |
Day |
一日 |
Day |
日曜日/月曜日/T..../土曜日にする必要があります |
Error |
リソース管理エラー応答。 |
Error |
リソース管理エラーの追加情報。 |
Immediate |
イミディエイトコピーオプション |
Month |
1 月/2 月/....../12 月にする必要があります |
Retention |
リテンションタグ |
Schedule |
ScheduleBasedBackupCriteria (スケジュールベースのバックアップ基準) |
Schedule |
スケジュールベーストリガーコンテキスト |
Source |
ソースライフサイクル |
system |
リソースの作成と最後の変更に関連するメタデータ。 |
Tagging |
タグ付け基準 |
Target |
TargetCopySetting (ターゲットコピー設定) |
Week |
最初/2/3/4/最後にする必要があります |
AbsoluteDeleteOption
AbsoluteDeleteオプション
名前 | 型 | 説明 |
---|---|---|
duration |
string |
指定された期間が経過した後の削除期間 |
objectType | string: |
特定のオブジェクトの型 - 逆シリアル化に使用されます |
AbsoluteMarker
"AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" などの絶対値が含まれており、AbsoluteMarker 列挙型の一部である必要があります
値 | 説明 |
---|---|
AllBackup | |
FirstOfDay | |
FirstOfMonth | |
FirstOfWeek | |
FirstOfYear |
AdhocBasedTaggingCriteria
AdhocBasedTaggingCriteria (アドホック ベースのタグ付け基準)
名前 | 型 | 説明 |
---|---|---|
tagInfo |
リテンションタグ |
AdhocBasedTriggerContext
アドホックベースのトリガーコンテキスト
名前 | 型 | 説明 |
---|---|---|
objectType | string: |
特定のオブジェクトの型 - 逆シリアル化に使用されます |
taggingCriteria |
AdhocBasedTaggingCriteria (アドホック ベースのタグ付け基準) |
AzureBackupParams
AzureBackupParams
名前 | 型 | 説明 |
---|---|---|
backupType |
string |
BackupType ;フル/インクリメンタルなど |
objectType | string: |
特定のオブジェクトの型 - 逆シリアル化に使用されます |
AzureBackupRule
AzureBackupRule
名前 | 型 | 説明 |
---|---|---|
backupParameters | BackupParameters: |
バックアップパラメータ |
dataStore |
データストア情報ベース |
|
name |
string |
|
objectType | string: | |
trigger | TriggerContext: |
トリガーコンテキスト |
AzureRetentionRule
AzureRetentionRule
名前 | 型 | 説明 |
---|---|---|
isDefault |
boolean |
|
lifecycles |
ソースライフサイクル |
|
name |
string |
|
objectType | string: |
BackupPolicy
バックアップポリシー
名前 | 型 | 説明 |
---|---|---|
datasourceTypes |
string[] |
バックアップ管理のデータソースの種類 |
objectType | string: | |
policyRules | BasePolicyRule[]: |
各バックアップタイプのルール (完全/増分/ログなど) を含むポリシー ルール ディクショナリ |
BackupSchedule
バックアップスケジュール
名前 | 型 | 説明 |
---|---|---|
repeatingTimeIntervals |
string[] |
ISO 8601 の繰り返し時間間隔形式 |
timeZone |
string |
スケジュールのタイム ゾーン。 例: 太平洋標準時 |
BaseBackupPolicyResource
BaseBackupPolicyリソース
名前 | 型 | 説明 |
---|---|---|
id |
string |
リソース ID は、リソースへの完全なパスを表します。 |
name |
string |
リソースに関連付けられているリソース名。 |
properties | BaseBackupPolicy: |
BaseBackupPolicy (英語) |
systemData |
リソースの作成と最後の変更に関連するメタデータ。 |
|
type |
string |
リソースの種類は、Namespace/ResourceType/ResourceType/..フォームの完全なパスを表します。 |
CloudError
クラウドエラー
名前 | 型 | 説明 |
---|---|---|
error |
リソース管理エラー応答。 |
CopyOnExpiryOption
CopyOnExpiryオプション
名前 | 型 | 説明 |
---|---|---|
objectType | string: |
特定のオブジェクトの型 - 逆シリアル化に使用されます |
createdByType
リソースを作成した ID の種類。
値 | 説明 |
---|---|
User | |
Application | |
ManagedIdentity | |
Key |
CustomCopyOption
カスタムコピーオプション
名前 | 型 | 説明 |
---|---|---|
duration |
string |
指定された期間の後にコピーされたデータ |
objectType | string: |
特定のオブジェクトの型 - 逆シリアル化に使用されます |
DataStoreInfoBase
データストア情報ベース
名前 | 型 | 説明 |
---|---|---|
dataStoreType |
データストアの種類。Operational/Vault/Archive |
|
objectType |
string |
右の継承型を初期化するために使用される Datasource オブジェクトの型 |
DataStoreTypes
データストアの種類。Operational/Vault/Archive
値 | 説明 |
---|---|
OperationalStore | |
VaultStore | |
ArchiveStore |
Day
一日
名前 | 型 | 説明 |
---|---|---|
date |
integer (int32) |
月の日付 |
isLast |
boolean |
日付が月の最後の日付かどうか |
DayOfWeek
日曜日/月曜日/T..../土曜日にする必要があります
値 | 説明 |
---|---|
Friday | |
Monday | |
Saturday | |
Sunday | |
Thursday | |
Tuesday | |
Wednesday |
Error
リソース管理エラー応答。
名前 | 型 | 説明 |
---|---|---|
additionalInfo |
エラーの追加情報。 |
|
code |
string |
エラー コード。 |
details |
Error[] |
エラーの詳細。 |
message |
string |
エラー メッセージ。 |
target |
string |
エラーターゲット。 |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
名前 | 型 | 説明 |
---|---|---|
info |
object |
追加情報。 |
type |
string |
追加情報の種類。 |
ImmediateCopyOption
イミディエイトコピーオプション
名前 | 型 | 説明 |
---|---|---|
objectType | string: |
特定のオブジェクトの型 - 逆シリアル化に使用されます |
Month
1 月/2 月/....../12 月にする必要があります
値 | 説明 |
---|---|
April | |
August | |
December | |
February | |
January | |
July | |
June | |
March | |
May | |
November | |
October | |
September |
RetentionTag
リテンションタグ
名前 | 型 | 説明 |
---|---|---|
eTag |
string |
保持タグのバージョン。 |
id |
string |
保持タグのバージョン。 |
tagName |
string |
保持タグ名を保持ルールに関連付けます。 |
ScheduleBasedBackupCriteria
ScheduleBasedBackupCriteria (スケジュールベースのバックアップ基準)
名前 | 型 | 説明 |
---|---|---|
absoluteCriteria |
"AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" などの絶対値が含まれており、AbsoluteMarker 列挙型の一部である必要があります |
|
daysOfMonth |
Day[] |
これは、月の最後の 1 から 28 の他の賢明な月の日です |
daysOfTheWeek |
日曜日/月曜日/T..../土曜日にする必要があります |
|
monthsOfYear |
Month[] |
1 月/2 月/....../12 月にする必要があります |
objectType | string: |
特定のオブジェクトの型 - 逆シリアル化に使用されます |
scheduleTimes |
string[] (date-time) |
バックアップのスケジュール時刻の一覧 |
weeksOfTheMonth |
最初/2/3/4/最後にする必要があります |
ScheduleBasedTriggerContext
スケジュールベーストリガーコンテキスト
名前 | 型 | 説明 |
---|---|---|
objectType | string: |
特定のオブジェクトの型 - 逆シリアル化に使用されます |
schedule |
バックアップスケジュール |
|
taggingCriteria |
指定されたスケジュールに適用できるタグの一覧。 |
SourceLifeCycle
ソースライフサイクル
名前 | 型 | 説明 |
---|---|---|
deleteAfter | DeleteOption: |
削除オプション |
sourceDataStore |
データストア情報ベース |
|
targetDataStoreCopySettings |
TargetCopySetting (ターゲットコピー設定) |
systemData
リソースの作成と最後の変更に関連するメタデータ。
名前 | 型 | 説明 |
---|---|---|
createdAt |
string (date-time) |
リソース作成のタイムスタンプ (UTC)。 |
createdBy |
string |
リソースを作成した ID。 |
createdByType |
リソースを作成した ID の種類。 |
|
lastModifiedAt |
string (date-time) |
リソースの最終変更のタイムスタンプ (UTC) |
lastModifiedBy |
string |
リソースを最後に変更した ID。 |
lastModifiedByType |
リソースを最後に変更した ID の種類。 |
TaggingCriteria
タグ付け基準
名前 | 型 | 説明 |
---|---|---|
criteria | BackupCriteria[]: |
トリガーされたバックアップにタグを適用できるかどうかを決定する条件。 |
isDefault |
boolean |
タグが既定かどうかを指定します。 |
tagInfo |
リテンションタグ |
|
taggingPriority |
integer (int64) |
保持タグの優先度。 |
TargetCopySetting
TargetCopySetting (ターゲットコピー設定)
名前 | 型 | 説明 |
---|---|---|
copyAfter | CopyOption: |
コピーオプション |
dataStore |
データストア情報ベース |
WeekNumber
最初/2/3/4/最後にする必要があります
値 | 説明 |
---|---|
First | |
Fourth | |
Last | |
Second | |
Third |