Backup Policies - Create Or Update

Tjänst:: Data Protection

API-version:: 2025-09-01

Skapar eller uppdaterar en säkerhetskopieringsprincip som tillhör ett säkerhetskopieringsvalv

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
backupPolicyName	path	True	string
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
vaultName	path	True	string	Namnet på säkerhetskopieringsvalvet.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Begärandetext

Name	Typ	Description
properties	BaseBackupPolicy: BackupPolicy	BaseBackupPolicyResource-egenskaper

Svar

Name	Typ	Description
200 OK	BaseBackupPolicyResource	Uppdateringsåtgärden för resursen "BaseBackupPolicyResource" lyckades
Other Status Codes	CloudError	Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

CreateOrUpdate BackupPolicy

Exempelbegäran

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"
      }
    ]
  }
}

Exempelsvar

Statuskod:: 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"
      }
    ]
  }
}

Definitioner

Name	Description
AbsoluteDeleteOption	Alternativet Ta bort med varaktighet
AbsoluteMarker
AdhocBasedTaggingCriteria	Villkor för adhoc-säkerhetskopieringstaggning
AdhocBasedTriggerContext	Adhoc-utlösarkontext
AzureBackupParams	Azure Backup-parametrar
AzureBackupRule	Azure Backup-regel
AzureRetentionRule	Azure-kvarhållningsregel
BackupPolicy	Princip för regelbaserad säkerhetskopiering
BackupSchedule	Schema för säkerhetskopiering
BaseBackupPolicyResource	BaseBackupPolicy-resurs
CloudError	Ett felsvar från Azure Backup.
CopyOnExpiryOption	Alternativet Kopiera vid förfallodatum
createdByType	Den typ av identitet som skapade resursen.
CustomCopyOption	Varaktighetsbaserade anpassade alternativ för kopiering
DataStoreInfoBase	DataStoreInfo-bas
DataStoreTypes	typ av datalager. Operational/Vault/Archive
Day	Veckodag
DayOfWeek
Error	Svar på resurshanteringsfel.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ImmediateCopyOption	Alternativ för omedelbar kopiering
Month
RetentionTag	Kvarhållningstagg
ScheduleBasedBackupCriteria	Schemalägg baserat säkerhetskopieringsvillkor
ScheduleBasedTriggerContext	Schemabaserad utlösarkontext
SourceLifeCycle	Källlivscykel
systemData	Metadata som rör skapande och senaste ändring av resursen.
TaggingCriteria	Taggningsvillkor
TargetCopySetting	Inställningar för målkopiering
WeekNumber

AbsoluteDeleteOption

Objekt

Alternativet Ta bort med varaktighet

Name	Typ	Description
duration	string	Varaktighet för borttagning efter angivet tidsintervall
objectType	string: AbsoluteDeleteOption	Typ av det specifika objektet – används för deserialisering

AbsoluteMarker

Uppräkning

Värde	Description
AllBackup
FirstOfDay
FirstOfMonth
FirstOfWeek
FirstOfYear

AdhocBasedTaggingCriteria

Objekt

Villkor för adhoc-säkerhetskopieringstaggning

Name	Typ	Description
tagInfo	RetentionTag	Information om kvarhållningstagg

AdhocBasedTriggerContext

Objekt

Adhoc-utlösarkontext

Name	Typ	Description
objectType	string: AdhocBasedTriggerContext	Typ av det specifika objektet – används för deserialisering
taggingCriteria	AdhocBasedTaggingCriteria	Taggningsvillkor som innehåller kvarhållningstagg för adhoc-säkerhetskopiering.

AzureBackupParams

Objekt

Azure Backup-parametrar

Name	Typ	Description
backupType	string	BackupType ; Fullständig/inkrementell osv.
objectType	string: AzureBackupParams	Typ av det specifika objektet – används för deserialisering

AzureBackupRule

Objekt

Azure Backup-regel

Name	Typ	Description
backupParameters	BackupParameters: AzureBackupParams	BackupParameters-bas
dataStore	DataStoreInfoBase	DataStoreInfo-bas
name	string
objectType	string: AzureBackupRule
trigger	TriggerContext: AdhocBasedTriggerContext ScheduleBasedTriggerContext	Utlösarkontext

AzureRetentionRule

Objekt

Azure-kvarhållningsregel

Name	Typ	Description
isDefault	boolean
lifecycles	SourceLifeCycle[]	Källlivscykel
name	string
objectType	string: AzureRetentionRule

BackupPolicy

Objekt

Princip för regelbaserad säkerhetskopiering

Name	Typ	Description
datasourceTypes	string[]	Typ av datakälla för säkerhetskopieringshantering
objectType	string: BackupPolicy
policyRules	BasePolicyRule[]: AzureBackupRule[] AzureRetentionRule[]	Principregelordlista som innehåller regler för varje säkerhetskopieringstyp, d.v.s. fullständig/inkrementell/loggar osv.

BackupSchedule

Objekt

Schema för säkerhetskopiering

Name	Typ	Description
repeatingTimeIntervals	string[]	Upprepande tidsintervall som endast stöder följande ISO 8601-format [R/startDateTime/Duration]. Exempel: R/2007-03-01T13:00:00Z/P1Y2M10DT2H30M
timeZone	string	Tidszon för ett schema. Exempel: Central Pacific, normaltid

BaseBackupPolicyResource

Objekt

BaseBackupPolicy-resurs

Name	Typ	Description
id	string (arm-id)	Fullständigt kvalificerat resurs-ID för resursen. Till exempel "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Namnet på resursen
properties	BaseBackupPolicy: BackupPolicy	BaseBackupPolicyResource-egenskaper
systemData	systemData	Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
type	string	Resurstypen. T.ex. "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

CloudError

Objekt

Ett felsvar från Azure Backup.

Name	Typ	Description
error	Error	Svar på resurshanteringsfel.

CopyOnExpiryOption

Objekt

Alternativet Kopiera vid förfallodatum

Name	Typ	Description
objectType	string: CopyOnExpiryOption	Typ av det specifika objektet – används för deserialisering

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
User
Application
ManagedIdentity
Key

CustomCopyOption

Objekt

Varaktighetsbaserade anpassade alternativ för kopiering

Name	Typ	Description
duration	string	Data kopieras efter angivet tidsintervall
objectType	string: CustomCopyOption	Typ av det specifika objektet – används för deserialisering

DataStoreInfoBase

Objekt

DataStoreInfo-bas

Name	Typ	Description
dataStoreType	DataStoreTypes	typ av datalager. Operational/Vault/Archive
objectType	string	Typ av Datasource-objekt som används för att initiera rätt ärvd typ

DataStoreTypes

Uppräkning

typ av datalager. Operational/Vault/Archive

Värde	Description
OperationalStore
VaultStore
ArchiveStore

Day

Objekt

Veckodag

Name	Typ	Description
date	integer (int32)	Datum för månaden
isLast	boolean	Om Datum är sista datumet i månaden

DayOfWeek

Uppräkning

Värde	Description
Friday
Monday
Saturday
Sunday
Thursday
Tuesday
Wednesday

Error

Objekt

Svar på resurshanteringsfel.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	Error[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ImmediateCopyOption

Objekt

Alternativ för omedelbar kopiering

Name	Typ	Description
objectType	string: ImmediateCopyOption	Typ av det specifika objektet – används för deserialisering

Month

Uppräkning

Värde	Description
April
August
December
February
January
July
June
March
May
November
October
September

RetentionTag

Objekt

Kvarhållningstagg

Name	Typ	Description
eTag	string	Kvarhållningstaggversion.
id	string	Kvarhållningstaggversion.
tagName	string	Namn på kvarhållningstagg för att relatera det till kvarhållningsregeln.

ScheduleBasedBackupCriteria

Objekt

Schemalägg baserat säkerhetskopieringsvillkor

Name	Typ	Description
absoluteCriteria	AbsoluteMarker[]	den innehåller absoluta värden som "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" och bör ingå i AbsoluteMarker-uppräkning
daysOfMonth	Day[]	Detta är dag i månaden från 1 till 28 andra kloka sista månaden
daysOfTheWeek	DayOfWeek[]	Det bör vara söndag/måndag/t..../lördag
monthsOfYear	Month[]	Det bör vara januari/februari/....../december
objectType	string: ScheduleBasedBackupCriteria	Typ av det specifika objektet – används för deserialisering
scheduleTimes	string[] (date-time)	Lista över schematider för säkerhetskopiering
weeksOfTheMonth	WeekNumber[]	Det bör vara första/andra/tredje/fjärde/sista/sista

ScheduleBasedTriggerContext

Objekt

Schemabaserad utlösarkontext

Name	Typ	Description
objectType	string: ScheduleBasedTriggerContext	Typ av det specifika objektet – används för deserialisering
schedule	BackupSchedule	Schemalägg för den här säkerhetskopieringen
taggingCriteria	TaggingCriteria[]	Lista över taggar som kan användas för angivet schema.

SourceLifeCycle

Objekt

Källlivscykel

Name	Typ	Description
deleteAfter	DeleteOption: AbsoluteDeleteOption	Ta bort alternativ
sourceDataStore	DataStoreInfoBase	DataStoreInfo-bas
targetDataStoreCopySettings	TargetCopySetting[]	Inställningar för målkopiering

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

TaggingCriteria

Objekt

Taggningsvillkor

Name	Typ	Description
criteria	BackupCriteria[]: ScheduleBasedBackupCriteria[]	Villkor som avgör om taggen kan tillämpas på en utlöst säkerhetskopia.
isDefault	boolean	Anger om taggen är standard.
tagInfo	RetentionTag	Information om kvarhållningstagg
taggingPriority	integer (int64)	Prioritet för kvarhållningstagg.

TargetCopySetting

Objekt

Inställningar för målkopiering

Name	Typ	Description
copyAfter	CopyOption: CopyOnExpiryOption CustomCopyOption ImmediateCopyOption	Det kan vara CustomCopyOption eller ImmediateCopyOption.
dataStore	DataStoreInfoBase	Information om måldatalager

WeekNumber

Uppräkning

Värde	Description
First
Fourth
Last
Second
Third

Dela via

Backup Policies - Create Or Update

URI-parametrar

Begärandetext

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

CreateOrUpdate BackupPolicy

Exempelbegäran

Exempelsvar

Definitioner

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