Backup Policies - Create Or Update

Service:: Data Protection

API-versie:: 2025-09-01

Hiermee maakt of werkt u een back-upbeleid bij dat hoort bij een back-upkluis

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

URI-parameters

Name	In	Vereist	Type	Description
backupPolicyName	path	True	string
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is hoofdletterongevoelig.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
vaultName	path	True	string	De naam van de back-upkluis.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Type	Description
properties	BaseBackupPolicy: BackupPolicy	Eigenschappen van BaseBackupPolicyResource

Antwoorden

Name	Type	Description
200 OK	BaseBackupPolicyResource	De updatebewerking van de resource 'BaseBackupPolicyResource' is geslaagd
Other Status Codes	CloudError	Een onverwachte foutreactie.

Beveiliging

azure_auth

OAuth2-stroom voor Azure Active Directory.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

CreateOrUpdate BackupPolicy

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
AbsoluteDeleteOption	Optie Verwijderen met duur
AbsoluteMarker
AdhocBasedTaggingCriteria	Criteria voor taggen van ad-hocback-ups
AdhocBasedTriggerContext	Context van ad-hoctrigger
AzureBackupParams	Azure Backup-parameters
AzureBackupRule	Azure Backup-regel
AzureRetentionRule	Azure-bewaarregel
BackupPolicy	Back-upbeleid op basis van regels
BackupSchedule	Planning voor back-up
BaseBackupPolicyResource	BaseBackupPolicy-resource
CloudError	Een foutreactie van Azure Backup.
CopyOnExpiryOption	Optie Kopiëren bij verlopen
createdByType	Het type identiteit waarmee de resource is gemaakt.
CustomCopyOption	Aangepaste opties op basis van duur om te kopiëren
DataStoreInfoBase	DataStoreInfo-basis
DataStoreTypes	type gegevensarchief; Operationeel/kluis/archief
Day	Dag van de week
DayOfWeek
Error	Het antwoord van het resourcebeheerfout.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ImmediateCopyOption	Directe kopieeroptie
Month
RetentionTag	Retentietag
ScheduleBasedBackupCriteria	Op schema gebaseerde back-upcriteria
ScheduleBasedTriggerContext	Triggercontext op basis van planning
SourceLifeCycle	Bronlevenscyclus
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
TaggingCriteria	Criteria voor taggen
TargetCopySetting	Instellingen voor doelkopie
WeekNumber

AbsoluteDeleteOption

Object

Optie Verwijderen met duur

Name	Type	Description
duration	string	Duur van verwijdering na opgegeven periode
objectType	string: AbsoluteDeleteOption	Type van het specifieke object dat wordt gebruikt voor deserialisatie

AbsoluteMarker

Inventarisatie

Waarde	Description
AllBackup
FirstOfDay
FirstOfMonth
FirstOfWeek
FirstOfYear

AdhocBasedTaggingCriteria

Object

Criteria voor taggen van ad-hocback-ups

Name	Type	Description
tagInfo	RetentionTag	Informatie over retentietags

AdhocBasedTriggerContext

Object

Context van ad-hoctrigger

Name	Type	Description
objectType	string: AdhocBasedTriggerContext	Type van het specifieke object dat wordt gebruikt voor deserialisatie
taggingCriteria	AdhocBasedTaggingCriteria	Tagcriteria met bewaartag voor ad-hocback-up.

AzureBackupParams

Object

Azure Backup-parameters

Name	Type	Description
backupType	string	BackupType; Volledig/incrementeel etc.
objectType	string: AzureBackupParams	Type van het specifieke object dat wordt gebruikt voor deserialisatie

AzureBackupRule

Object

Azure Backup-regel

Name	Type	Description
backupParameters	BackupParameters: AzureBackupParams	BackupParameters-basis
dataStore	DataStoreInfoBase	DataStoreInfo-basis
name	string
objectType	string: AzureBackupRule
trigger	TriggerContext: AdhocBasedTriggerContext ScheduleBasedTriggerContext	Triggercontext

AzureRetentionRule

Object

Azure-bewaarregel

Name	Type	Description
isDefault	boolean
lifecycles	SourceLifeCycle[]	Bronlevenscyclus
name	string
objectType	string: AzureRetentionRule

BackupPolicy

Object

Back-upbeleid op basis van regels

Name	Type	Description
datasourceTypes	string[]	Type gegevensbron voor back-upbeheer
objectType	string: BackupPolicy
policyRules	BasePolicyRule[]: AzureBackupRule[] AzureRetentionRule[]	Woordenlijst met beleidsregels die regels bevat voor elk back-uptype, zoals Volledig/Incrementeel/Logboeken, enzovoort

BackupSchedule

Object

Planning voor back-up

Name	Type	Description
repeatingTimeIntervals	string[]	Herhalend tijdsinterval dat alleen het volgende ISO 8601-formaat ondersteunt [R/startDateTime/Duration]. Voorbeeld: R/2007-03-01T13:00:00Z/P1Y2M10DT2H30M
timeZone	string	Tijdzone voor een schema. Bijvoorbeeld: Pacific Standard Time

BaseBackupPolicyResource

Object

BaseBackupPolicy-resource

Name	Type	Description
id	string (arm-id)	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}"
name	string	De naam van de resource
properties	BaseBackupPolicy: BackupPolicy	Eigenschappen van BaseBackupPolicyResource
systemData	systemData	Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.
type	string	Het type bron. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

CloudError

Object

Een foutreactie van Azure Backup.

Name	Type	Description
error	Error	Het antwoord van het resourcebeheerfout.

CopyOnExpiryOption

Object

Optie Kopiëren bij verlopen

Name	Type	Description
objectType	string: CopyOnExpiryOption	Type van het specifieke object dat wordt gebruikt voor deserialisatie

createdByType

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
User
Application
ManagedIdentity
Key

CustomCopyOption

Object

Aangepaste opties op basis van duur om te kopiëren

Name	Type	Description
duration	string	Gegevens gekopieerd na de opgegeven periode
objectType	string: CustomCopyOption	Type van het specifieke object dat wordt gebruikt voor deserialisatie

DataStoreInfoBase

Object

DataStoreInfo-basis

Name	Type	Description
dataStoreType	DataStoreTypes	type gegevensarchief; Operationeel/kluis/archief
objectType	string	Type gegevensbronobject, gebruikt om het overgenomen type te initialiseren

DataStoreTypes

Inventarisatie

type gegevensarchief; Operationeel/kluis/archief

Waarde	Description
OperationalStore
VaultStore
ArchiveStore

Day

Object

Dag van de week

Name	Type	Description
date	integer (int32)	Datum van de maand
isLast	boolean	Of datum de laatste datum van de maand is

DayOfWeek

Inventarisatie

Waarde	Description
Friday
Monday
Saturday
Sunday
Thursday
Tuesday
Wednesday

Error

Object

Het antwoord van het resourcebeheerfout.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	Error[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ImmediateCopyOption

Object

Directe kopieeroptie

Name	Type	Description
objectType	string: ImmediateCopyOption	Type van het specifieke object dat wordt gebruikt voor deserialisatie

Month

Inventarisatie

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

RetentionTag

Object

Retentietag

Name	Type	Description
eTag	string	Versie van retentietag.
id	string	Versie van retentietag.
tagName	string	Naam van retentietag om deze te koppelen aan bewaarregel.

ScheduleBasedBackupCriteria

Object

Op schema gebaseerde back-upcriteria

Name	Type	Description
absoluteCriteria	AbsoluteMarker[]	het bevat absolute waarden zoals "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" en moet deel uitmaken van AbsoluteMarker enum
daysOfMonth	Day[]	Dit is de dag van de maand van 1 tot 28 andere wijze laatste van de maand
daysOfTheWeek	DayOfWeek[]	Het moet zondag/maandag/T zijn..../zaterdag
monthsOfYear	Month[]	Dit moet januari/februari/....../december zijn
objectType	string: ScheduleBasedBackupCriteria	Type van het specifieke object dat wordt gebruikt voor deserialisatie
scheduleTimes	string[] (date-time)	Lijst met planningstijden voor back-up
weeksOfTheMonth	WeekNumber[]	Dit moet eerste/tweede/derde/vierde/laatste zijn

ScheduleBasedTriggerContext

Object

Triggercontext op basis van planning

Name	Type	Description
objectType	string: ScheduleBasedTriggerContext	Type van het specifieke object dat wordt gebruikt voor deserialisatie
schedule	BackupSchedule	Planning voor deze back-up
taggingCriteria	TaggingCriteria[]	Lijst met tags die van toepassing kunnen zijn op een bepaald schema.

SourceLifeCycle

Object

Bronlevenscyclus

Name	Type	Description
deleteAfter	DeleteOption: AbsoluteDeleteOption	Optie Verwijderen
sourceDataStore	DataStoreInfoBase	DataStoreInfo-basis
targetDataStoreCopySettings	TargetCopySetting[]	Instellingen voor doelkopie

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.

TaggingCriteria

Object

Criteria voor taggen

Name	Type	Description
criteria	BackupCriteria[]: ScheduleBasedBackupCriteria[]	Criteria waarmee wordt bepaald of de tag kan worden toegepast op een geactiveerde back-up.
isDefault	boolean	Hiermee geeft u op of de tag standaard is.
tagInfo	RetentionTag	Informatie over retentietags
taggingPriority	integer (int64)	Prioriteit van retentietag.

TargetCopySetting

Object

Instellingen voor doelkopie

Name	Type	Description
copyAfter	CopyOption: CopyOnExpiryOption CustomCopyOption ImmediateCopyOption	Dit kan CustomCopyOption of ImmediateCopyOption zijn.
dataStore	DataStoreInfoBase	Informatie over het doelgegevensarchief

WeekNumber

Inventarisatie

Waarde	Description
First
Fourth
Last
Second
Third

Delen via

Backup Policies - Create Or Update

URI-parameters

Aanvraagbody

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

CreateOrUpdate BackupPolicy

Voorbeeldaanvraag

Voorbeeldrespons

Definities

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