Backup Policies - Create Or Update

Dienst:

Data Protection

API-Version:

2025-01-01

Erstellt oder aktualisiert eine Sicherungsrichtlinie, die zu einem Sicherungstresor gehört.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
backupPolicyName	path	True	string	Name der Richtlinie
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string uuid	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
vaultName	path	True	string	Der Name des Sicherungstresors.
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
properties	BaseBackupPolicy: BackupPolicy	BaseBackupPolicy BaseBackupPolicyResource-Eigenschaften

Antworten

Name	Typ	Beschreibung
200 OK	BaseBackupPolicyResource	OKAY
Other Status Codes	CloudError	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	identitätswechseln Sie Ihr Benutzerkonto.

Beispiele

CreateOrUpdate BackupPolicy

Beispielanforderung

HTTP

PUT https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PrivatePreviewVault/backupPolicies/OSSDBPolicy?api-version=2025-01-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"
  }
}

Beispiel für eine Antwort

Statuscode:

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

Definitionen

Name	Beschreibung
AbsoluteDeleteOption	AbsoluteDeleteOption
AbsoluteMarker	es enthält absolute Werte wie "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" und sollte Teil der AbsoluteMarker-Enumeration sein
AdhocBasedTaggingCriteria	AdhocBasedTaggingCriteria
AdhocBasedTriggerContext	AdhocBasedTriggerContext
AzureBackupParams	AzureBackupParams
AzureBackupRule	AzureBackupRule
AzureRetentionRule	AzureRetentionRule
BackupPolicy	BackupPolicy
BackupSchedule	BackupSchedule
BaseBackupPolicyResource	BaseBackupPolicyResource
CloudError	CloudError
CopyOnExpiryOption	CopyOnExpiryOption
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
CustomCopyOption	CustomCopyOption
DataStoreInfoBase	DataStoreInfoBase
DataStoreTypes	Art des Datenspeichers; Operational/Vault/Archive
Day	Tag
DayOfWeek	Es sollte Sonntag/Montag/T..../Samstag sein
Error	Die Fehlerantwort für die Ressourcenverwaltung.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ImmediateCopyOption	ImmediateCopyOption
Month	Es sollte Januar/Februar/....../Dezember sein
RetentionTag	RetentionTag
ScheduleBasedBackupCriteria	ScheduleBasedBackupCriteria
ScheduleBasedTriggerContext	ScheduleBasedTriggerContext
SourceLifeCycle	SourceLifeCycle
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
TaggingCriteria	TaggingCriteria
TargetCopySetting	TargetCopySetting
WeekNumber	Dies sollte "Erster/Zweiter/Dritter/Vierter/Letzter" sein.

AbsoluteDeleteOption

AbsoluteDeleteOption

Name	Typ	Beschreibung
duration	string	Dauer des Löschvorgangs nach einem bestimmten Zeitraum
objectType	string: AbsoluteDeleteOption	Typ des spezifischen Objekts – wird für die Deserialisierung verwendet

AbsoluteMarker

es enthält absolute Werte wie "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" und sollte Teil der AbsoluteMarker-Enumeration sein

Name	Typ	Beschreibung
AllBackup	string
FirstOfDay	string
FirstOfMonth	string
FirstOfWeek	string
FirstOfYear	string

AdhocBasedTaggingCriteria

AdhocBasedTaggingCriteria

Name	Typ	Beschreibung
tagInfo	RetentionTag	RetentionTag Aufbewahrungstagsinformationen

AdhocBasedTriggerContext

AdhocBasedTriggerContext

Name	Typ	Beschreibung
objectType	string: AdhocBasedTriggerContext	Typ des spezifischen Objekts – wird für die Deserialisierung verwendet
taggingCriteria	AdhocBasedTaggingCriteria	AdhocBasedTaggingCriteria Kategorisierungskriterien, die Aufbewahrungstag für adhoc-Sicherung enthalten.

AzureBackupParams

AzureBackupParams

Name	Typ	Beschreibung
backupType	string	BackupType ; Vollständig/inkrementell usw.
objectType	string: AzureBackupParams	Typ des spezifischen Objekts – wird für die Deserialisierung verwendet

AzureBackupRule

AzureBackupRule

Name	Typ	Beschreibung
backupParameters	BackupParameters: AzureBackupParams	BackupParameters BackupParameters-Basis
dataStore	DataStoreInfoBase	DataStoreInfoBase DataStoreInfo-Basis
name	string
objectType	string: AzureBackupRule
trigger	TriggerContext: AdhocBasedTriggerContext ScheduleBasedTriggerContext	TriggerContext Triggerkontext

AzureRetentionRule

AzureRetentionRule

Name	Typ	Beschreibung
isDefault	boolean
lifecycles	SourceLifeCycle[]	SourceLifeCycle Source LifeCycle
name	string
objectType	string: AzureRetentionRule

BackupPolicy

BackupPolicy

Name	Typ	Beschreibung
datasourceTypes	string[]	Typ der Datenquelle für die Sicherungsverwaltung
objectType	string: BackupPolicy
policyRules	BasePolicyRule[]: AzureBackupRule[] AzureRetentionRule[]	Richtlinienregelwörterbuch, das Regeln für jeden Sicherungstyp enthält, z. B. Vollständige/inkrementelle/Protokolle usw.

BackupSchedule

BackupSchedule

Name	Typ	Beschreibung
repeatingTimeIntervals	string[]	ISO 8601-Format für wiederholtes Zeitintervall
timeZone	string	Zeitzone für einen Zeitplan. Beispiel: Pazifische Standardzeit

BaseBackupPolicyResource

BaseBackupPolicyResource

Name	Typ	Beschreibung
id	string	Die Ressourcen-ID stellt den vollständigen Pfad zur Ressource dar.
name	string	Ressourcenname, der der Ressource zugeordnet ist.
properties	BaseBackupPolicy: BackupPolicy	BaseBackupPolicy BaseBackupPolicyResource-Eigenschaften
systemData	systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
type	string	Der Ressourcentyp stellt den vollständigen Pfad des Formulars Namespace/ResourceType/ResourceType/...

CloudError

CloudError

Name	Typ	Beschreibung
error	Error	Die Fehlerantwort für die Ressourcenverwaltung.

CopyOnExpiryOption

CopyOnExpiryOption

Name	Typ	Beschreibung
objectType	string: CopyOnExpiryOption	Typ des spezifischen Objekts – wird für die Deserialisierung verwendet

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

CustomCopyOption

CustomCopyOption

Name	Typ	Beschreibung
duration	string	Daten, die nach einem bestimmten Zeitraum kopiert wurden
objectType	string: CustomCopyOption	Typ des spezifischen Objekts – wird für die Deserialisierung verwendet

DataStoreInfoBase

DataStoreInfoBase

Name	Typ	Beschreibung
dataStoreType	DataStoreTypes	Art des Datenspeichers; Operational/Vault/Archive
objectType	string	Typ des Datasource-Objekts, der zum Initialisieren des richtigen geerbten Typs verwendet wird

DataStoreTypes

Art des Datenspeichers; Operational/Vault/Archive

Name	Typ	Beschreibung
ArchiveStore	string
OperationalStore	string
VaultStore	string

Day

Tag

Name	Typ	Beschreibung
date	integer	Datum des Monats
isLast	boolean	Gibt an, ob Datum das letzte Datum des Monats ist.

DayOfWeek

Es sollte Sonntag/Montag/T..../Samstag sein

Name	Typ	Beschreibung
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

Error

Die Fehlerantwort für die Ressourcenverwaltung.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	Error[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ImmediateCopyOption

ImmediateCopyOption

Name	Typ	Beschreibung
objectType	string: ImmediateCopyOption	Typ des spezifischen Objekts – wird für die Deserialisierung verwendet

Month

Es sollte Januar/Februar/....../Dezember sein

Name	Typ	Beschreibung
April	string
August	string
December	string
February	string
January	string
July	string
June	string
March	string
May	string
November	string
October	string
September	string

RetentionTag

RetentionTag

Name	Typ	Beschreibung
eTag	string	Aufbewahrungstag-Version.
id	string	Aufbewahrungstag-Version.
tagName	string	Aufbewahrungstagsname, um ihn mit Aufbewahrungsregel zu verknüpfen.

ScheduleBasedBackupCriteria

ScheduleBasedBackupCriteria

Name	Typ	Beschreibung
absoluteCriteria	AbsoluteMarker[]	es enthält absolute Werte wie "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" und sollte Teil der AbsoluteMarker-Enumeration sein
daysOfMonth	Day[]	Dies ist der Tag des Monats von 1 bis 28 anderen Weise letzten Monats
daysOfTheWeek	DayOfWeek[]	Es sollte Sonntag/Montag/T..../Samstag sein
monthsOfYear	Month[]	Es sollte Januar/Februar/....../Dezember sein
objectType	string: ScheduleBasedBackupCriteria	Typ des spezifischen Objekts – wird für die Deserialisierung verwendet
scheduleTimes	string[]	Liste der Zeitplanzeiten für die Sicherung
weeksOfTheMonth	WeekNumber[]	Dies sollte "Erster/Zweiter/Dritter/Vierter/Letzter" sein.

ScheduleBasedTriggerContext

ScheduleBasedTriggerContext

Name	Typ	Beschreibung
objectType	string: ScheduleBasedTriggerContext	Typ des spezifischen Objekts – wird für die Deserialisierung verwendet
schedule	BackupSchedule	BackupSchedule Planen für diese Sicherung
taggingCriteria	TaggingCriteria[]	Liste der Tags, die für einen bestimmten Zeitplan anwendbar sein können.

SourceLifeCycle

SourceLifeCycle

Name	Typ	Beschreibung
deleteAfter	DeleteOption: AbsoluteDeleteOption	DeleteOption Option "Löschen"
sourceDataStore	DataStoreInfoBase	DataStoreInfoBase DataStoreInfo-Basis
targetDataStoreCopySettings	TargetCopySetting[]	TargetCopySetting Einstellungen für Zielkopien

systemData

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

TaggingCriteria

TaggingCriteria

Name	Typ	Beschreibung
criteria	BackupCriteria[]: ScheduleBasedBackupCriteria[]	Kriterien, die entscheiden, ob das Tag auf eine ausgelöste Sicherung angewendet werden kann.
isDefault	boolean	Gibt an, ob tag standard ist.
tagInfo	RetentionTag	RetentionTag Aufbewahrungstagsinformationen
taggingPriority	integer	Priorität des Aufbewahrungstags.

TargetCopySetting

TargetCopySetting

Name	Typ	Beschreibung
copyAfter	CopyOption: CopyOnExpiryOption CustomCopyOption ImmediateCopyOption	CopyOption Dies kann "CustomCopyOption" oder "ImmediateCopyOption" sein.
dataStore	DataStoreInfoBase	DataStoreInfoBase Informationen zum Zieldatenspeicher

WeekNumber

Dies sollte "Erster/Zweiter/Dritter/Vierter/Letzter" sein.

Name	Typ	Beschreibung
First	string
Fourth	string
Last	string
Second	string
Third	string