Backup Policies - Create Or Update

Service:

Data Protection

API Version:

2023-01-01

Создание или Обновления политики резервного копирования, принадлежащей хранилищу резервных копий

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
backupPolicyName	path	True	string	Имя политики
resourceGroupName	path	True	string	Имя группы ресурсов. Регистр букв в имени не учитывается.
subscriptionId	path	True	string uuid	Идентификатор целевой подписки. Значение должно быть UUID.
vaultName	path	True	string	Имя хранилища резервных копий.
api-version	query	True	string	Версия API, используемая для данной операции.

Текст запроса

Имя	Тип	Описание
properties	BaseBackupPolicy: BackupPolicy	BaseBackupPolicy Свойства BaseBackupPolicyResource

Ответы

Имя	Тип	Описание
200 OK	BaseBackupPolicyResource	ОК
Other Status Codes	CloudError	Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя.

Примеры

CreateOrUpdate BackupPolicy

Sample Request

HTTP

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

Java

import com.azure.resourcemanager.dataprotection.models.AbsoluteDeleteOption;
import com.azure.resourcemanager.dataprotection.models.AzureBackupParams;
import com.azure.resourcemanager.dataprotection.models.AzureBackupRule;
import com.azure.resourcemanager.dataprotection.models.AzureRetentionRule;
import com.azure.resourcemanager.dataprotection.models.BackupPolicy;
import com.azure.resourcemanager.dataprotection.models.BackupSchedule;
import com.azure.resourcemanager.dataprotection.models.DataStoreInfoBase;
import com.azure.resourcemanager.dataprotection.models.DataStoreTypes;
import com.azure.resourcemanager.dataprotection.models.DayOfWeek;
import com.azure.resourcemanager.dataprotection.models.RetentionTag;
import com.azure.resourcemanager.dataprotection.models.ScheduleBasedBackupCriteria;
import com.azure.resourcemanager.dataprotection.models.ScheduleBasedTriggerContext;
import com.azure.resourcemanager.dataprotection.models.SourceLifeCycle;
import com.azure.resourcemanager.dataprotection.models.TaggingCriteria;
import java.time.OffsetDateTime;
import java.util.Arrays;

/** Samples for BackupPolicies CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/PolicyCRUD/CreateOrUpdateBackupPolicy.json
     */
    /**
     * Sample code: CreateOrUpdate BackupPolicy.
     *
     * @param manager Entry point to DataProtectionManager.
     */
    public static void createOrUpdateBackupPolicy(
        com.azure.resourcemanager.dataprotection.DataProtectionManager manager) {
        manager
            .backupPolicies()
            .define("OSSDBPolicy")
            .withExistingBackupVault("000pikumar", "PrivatePreviewVault")
            .withProperties(
                new BackupPolicy()
                    .withDatasourceTypes(Arrays.asList("OssDB"))
                    .withPolicyRules(
                        Arrays
                            .asList(
                                new AzureBackupRule()
                                    .withName("BackupWeekly")
                                    .withBackupParameters(new AzureBackupParams().withBackupType("Full"))
                                    .withDataStore(
                                        new DataStoreInfoBase()
                                            .withDataStoreType(DataStoreTypes.VAULT_STORE)
                                            .withObjectType("DataStoreInfoBase"))
                                    .withTrigger(
                                        new ScheduleBasedTriggerContext()
                                            .withSchedule(
                                                new BackupSchedule()
                                                    .withRepeatingTimeIntervals(
                                                        Arrays.asList("R/2019-11-20T08:00:00-08:00/P1W")))
                                            .withTaggingCriteria(
                                                Arrays
                                                    .asList(
                                                        new TaggingCriteria()
                                                            .withIsDefault(true)
                                                            .withTaggingPriority(99L)
                                                            .withTagInfo(new RetentionTag().withTagName("Default")),
                                                        new TaggingCriteria()
                                                            .withCriteria(
                                                                Arrays
                                                                    .asList(
                                                                        new ScheduleBasedBackupCriteria()
                                                                            .withDaysOfTheWeek(
                                                                                Arrays.asList(DayOfWeek.SUNDAY))
                                                                            .withScheduleTimes(
                                                                                Arrays
                                                                                    .asList(
                                                                                        OffsetDateTime
                                                                                            .parse(
                                                                                                "2019-03-01T13:00:00Z")))))
                                                            .withIsDefault(false)
                                                            .withTaggingPriority(20L)
                                                            .withTagInfo(new RetentionTag().withTagName("Weekly"))))),
                                new AzureRetentionRule()
                                    .withName("Default")
                                    .withIsDefault(true)
                                    .withLifecycles(
                                        Arrays
                                            .asList(
                                                new SourceLifeCycle()
                                                    .withDeleteAfter(new AbsoluteDeleteOption().withDuration("P1W"))
                                                    .withSourceDataStore(
                                                        new DataStoreInfoBase()
                                                            .withDataStoreType(DataStoreTypes.VAULT_STORE)
                                                            .withObjectType("DataStoreInfoBase")))),
                                new AzureRetentionRule()
                                    .withName("Weekly")
                                    .withIsDefault(false)
                                    .withLifecycles(
                                        Arrays
                                            .asList(
                                                new SourceLifeCycle()
                                                    .withDeleteAfter(new AbsoluteDeleteOption().withDuration("P12W"))
                                                    .withSourceDataStore(
                                                        new DataStoreInfoBase()
                                                            .withDataStoreType(DataStoreTypes.VAULT_STORE)
                                                            .withObjectType("DataStoreInfoBase")))))))
            .create();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.dataprotection import DataProtectionMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-dataprotection
# USAGE
    python create_or_update_backup_policy.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DataProtectionMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="04cf684a-d41f-4550-9f70-7708a3a2283b",
    )

    response = client.backup_policies.create_or_update(
        resource_group_name="000pikumar",
        vault_name="PrivatePreviewVault",
        backup_policy_name="OSSDBPolicy",
        parameters={
            "properties": {
                "datasourceTypes": ["OssDB"],
                "objectType": "BackupPolicy",
                "policyRules": [
                    {
                        "backupParameters": {"backupType": "Full", "objectType": "AzureBackupParams"},
                        "dataStore": {"dataStoreType": "VaultStore", "objectType": "DataStoreInfoBase"},
                        "name": "BackupWeekly",
                        "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,
                                },
                            ],
                        },
                    },
                    {
                        "isDefault": True,
                        "lifecycles": [
                            {
                                "deleteAfter": {"duration": "P1W", "objectType": "AbsoluteDeleteOption"},
                                "sourceDataStore": {"dataStoreType": "VaultStore", "objectType": "DataStoreInfoBase"},
                            }
                        ],
                        "name": "Default",
                        "objectType": "AzureRetentionRule",
                    },
                    {
                        "isDefault": False,
                        "lifecycles": [
                            {
                                "deleteAfter": {"duration": "P12W", "objectType": "AbsoluteDeleteOption"},
                                "sourceDataStore": {"dataStoreType": "VaultStore", "objectType": "DataStoreInfoBase"},
                            }
                        ],
                        "name": "Weekly",
                        "objectType": "AzureRetentionRule",
                    },
                ],
            }
        },
    )
    print(response)


# x-ms-original-file: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/PolicyCRUD/CreateOrUpdateBackupPolicy.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armdataprotection_test

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/dataprotection/armdataprotection/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1b33e81bbdc28fcd6644a1315b8d7b1b6d030590/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/PolicyCRUD/CreateOrUpdateBackupPolicy.json
func ExampleBackupPoliciesClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewBackupPoliciesClient().CreateOrUpdate(ctx, "000pikumar", "PrivatePreviewVault", "OSSDBPolicy", armdataprotection.BaseBackupPolicyResource{
		Properties: &armdataprotection.BackupPolicy{
			DatasourceTypes: []*string{
				to.Ptr("OssDB")},
			ObjectType: to.Ptr("BackupPolicy"),
			PolicyRules: []armdataprotection.BasePolicyRuleClassification{
				&armdataprotection.AzureBackupRule{
					Name:       to.Ptr("BackupWeekly"),
					ObjectType: to.Ptr("AzureBackupRule"),
					BackupParameters: &armdataprotection.AzureBackupParams{
						ObjectType: to.Ptr("AzureBackupParams"),
						BackupType: to.Ptr("Full"),
					},
					DataStore: &armdataprotection.DataStoreInfoBase{
						DataStoreType: to.Ptr(armdataprotection.DataStoreTypesVaultStore),
						ObjectType:    to.Ptr("DataStoreInfoBase"),
					},
					Trigger: &armdataprotection.ScheduleBasedTriggerContext{
						ObjectType: to.Ptr("ScheduleBasedTriggerContext"),
						Schedule: &armdataprotection.BackupSchedule{
							RepeatingTimeIntervals: []*string{
								to.Ptr("R/2019-11-20T08:00:00-08:00/P1W")},
						},
						TaggingCriteria: []*armdataprotection.TaggingCriteria{
							{
								IsDefault: to.Ptr(true),
								TagInfo: &armdataprotection.RetentionTag{
									TagName: to.Ptr("Default"),
								},
								TaggingPriority: to.Ptr[int64](99),
							},
							{
								Criteria: []armdataprotection.BackupCriteriaClassification{
									&armdataprotection.ScheduleBasedBackupCriteria{
										ObjectType: to.Ptr("ScheduleBasedBackupCriteria"),
										DaysOfTheWeek: []*armdataprotection.DayOfWeek{
											to.Ptr(armdataprotection.DayOfWeekSunday)},
										ScheduleTimes: []*time.Time{
											to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-03-01T13:00:00Z"); return t }())},
									}},
								IsDefault: to.Ptr(false),
								TagInfo: &armdataprotection.RetentionTag{
									TagName: to.Ptr("Weekly"),
								},
								TaggingPriority: to.Ptr[int64](20),
							}},
					},
				},
				&armdataprotection.AzureRetentionRule{
					Name:       to.Ptr("Default"),
					ObjectType: to.Ptr("AzureRetentionRule"),
					IsDefault:  to.Ptr(true),
					Lifecycles: []*armdataprotection.SourceLifeCycle{
						{
							DeleteAfter: &armdataprotection.AbsoluteDeleteOption{
								Duration:   to.Ptr("P1W"),
								ObjectType: to.Ptr("AbsoluteDeleteOption"),
							},
							SourceDataStore: &armdataprotection.DataStoreInfoBase{
								DataStoreType: to.Ptr(armdataprotection.DataStoreTypesVaultStore),
								ObjectType:    to.Ptr("DataStoreInfoBase"),
							},
						}},
				},
				&armdataprotection.AzureRetentionRule{
					Name:       to.Ptr("Weekly"),
					ObjectType: to.Ptr("AzureRetentionRule"),
					IsDefault:  to.Ptr(false),
					Lifecycles: []*armdataprotection.SourceLifeCycle{
						{
							DeleteAfter: &armdataprotection.AbsoluteDeleteOption{
								Duration:   to.Ptr("P12W"),
								ObjectType: to.Ptr("AbsoluteDeleteOption"),
							},
							SourceDataStore: &armdataprotection.DataStoreInfoBase{
								DataStoreType: to.Ptr(armdataprotection.DataStoreTypesVaultStore),
								ObjectType:    to.Ptr("DataStoreInfoBase"),
							},
						}},
				}},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.BaseBackupPolicyResource = armdataprotection.BaseBackupPolicyResource{
	// 	Name: to.Ptr("OSSDBPolicy"),
	// 	Type: to.Ptr("Microsoft.DataProtection/backupVaults/backupPolicies"),
	// 	ID: to.Ptr("/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PrivatePreviewVault/backupPolicies/OSSDBPolicy"),
	// 	Properties: &armdataprotection.BackupPolicy{
	// 		DatasourceTypes: []*string{
	// 			to.Ptr("OssDB")},
	// 			ObjectType: to.Ptr("BackupPolicy"),
	// 			PolicyRules: []armdataprotection.BasePolicyRuleClassification{
	// 				&armdataprotection.AzureBackupRule{
	// 					Name: to.Ptr("BackupWeekly"),
	// 					ObjectType: to.Ptr("AzureBackupRule"),
	// 					BackupParameters: &armdataprotection.AzureBackupParams{
	// 						ObjectType: to.Ptr("AzureBackupParams"),
	// 						BackupType: to.Ptr("Full"),
	// 					},
	// 					DataStore: &armdataprotection.DataStoreInfoBase{
	// 						DataStoreType: to.Ptr(armdataprotection.DataStoreTypesVaultStore),
	// 						ObjectType: to.Ptr("DataStoreInfoBase"),
	// 					},
	// 					Trigger: &armdataprotection.ScheduleBasedTriggerContext{
	// 						ObjectType: to.Ptr("ScheduleBasedTriggerContext"),
	// 						Schedule: &armdataprotection.BackupSchedule{
	// 							RepeatingTimeIntervals: []*string{
	// 								to.Ptr("R/2019-11-20T08:00:00-08:00/P1W")},
	// 							},
	// 							TaggingCriteria: []*armdataprotection.TaggingCriteria{
	// 								{
	// 									IsDefault: to.Ptr(true),
	// 									TagInfo: &armdataprotection.RetentionTag{
	// 										ID: to.Ptr("Default_"),
	// 										TagName: to.Ptr("Default"),
	// 									},
	// 									TaggingPriority: to.Ptr[int64](99),
	// 								},
	// 								{
	// 									Criteria: []armdataprotection.BackupCriteriaClassification{
	// 										&armdataprotection.ScheduleBasedBackupCriteria{
	// 											ObjectType: to.Ptr("ScheduleBasedBackupCriteria"),
	// 											DaysOfTheWeek: []*armdataprotection.DayOfWeek{
	// 												to.Ptr(armdataprotection.DayOfWeekSunday)},
	// 												ScheduleTimes: []*time.Time{
	// 													to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-03-01T13:00:00Z"); return t}())},
	// 											}},
	// 											IsDefault: to.Ptr(false),
	// 											TagInfo: &armdataprotection.RetentionTag{
	// 												ID: to.Ptr("Weekly_"),
	// 												TagName: to.Ptr("Weekly"),
	// 											},
	// 											TaggingPriority: to.Ptr[int64](20),
	// 									}},
	// 								},
	// 							},
	// 							&armdataprotection.AzureRetentionRule{
	// 								Name: to.Ptr("Default"),
	// 								ObjectType: to.Ptr("AzureRetentionRule"),
	// 								IsDefault: to.Ptr(true),
	// 								Lifecycles: []*armdataprotection.SourceLifeCycle{
	// 									{
	// 										DeleteAfter: &armdataprotection.AbsoluteDeleteOption{
	// 											Duration: to.Ptr("P1W"),
	// 											ObjectType: to.Ptr("AbsoluteDeleteOption"),
	// 										},
	// 										SourceDataStore: &armdataprotection.DataStoreInfoBase{
	// 											DataStoreType: to.Ptr(armdataprotection.DataStoreTypesVaultStore),
	// 											ObjectType: to.Ptr("DataStoreInfoBase"),
	// 										},
	// 								}},
	// 							},
	// 							&armdataprotection.AzureRetentionRule{
	// 								Name: to.Ptr("Weekly"),
	// 								ObjectType: to.Ptr("AzureRetentionRule"),
	// 								IsDefault: to.Ptr(false),
	// 								Lifecycles: []*armdataprotection.SourceLifeCycle{
	// 									{
	// 										DeleteAfter: &armdataprotection.AbsoluteDeleteOption{
	// 											Duration: to.Ptr("P12W"),
	// 											ObjectType: to.Ptr("AbsoluteDeleteOption"),
	// 										},
	// 										SourceDataStore: &armdataprotection.DataStoreInfoBase{
	// 											DataStoreType: to.Ptr(armdataprotection.DataStoreTypesVaultStore),
	// 											ObjectType: to.Ptr("DataStoreInfoBase"),
	// 										},
	// 								}},
	// 						}},
	// 					},
	// 				}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { DataProtectionClient } = require("@azure/arm-dataprotection");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates or Updates a backup policy belonging to a backup vault
 *
 * @summary Creates or Updates a backup policy belonging to a backup vault
 * x-ms-original-file: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/PolicyCRUD/CreateOrUpdateBackupPolicy.json
 */
async function createOrUpdateBackupPolicy() {
  const subscriptionId =
    process.env["DATAPROTECTION_SUBSCRIPTION_ID"] || "04cf684a-d41f-4550-9f70-7708a3a2283b";
  const resourceGroupName = process.env["DATAPROTECTION_RESOURCE_GROUP"] || "000pikumar";
  const vaultName = "PrivatePreviewVault";
  const backupPolicyName = "OSSDBPolicy";
  const parameters = {
    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: [new Date("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",
        },
      ],
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new DataProtectionClient(credential, subscriptionId);
  const result = await client.backupPolicies.createOrUpdate(
    resourceGroupName,
    vaultName,
    backupPolicyName,
    parameters
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

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	BackupPolicy
BackupSchedule	BackupSchedule
BaseBackupPolicyResource	BaseBackupPolicyResource
CloudError	CloudError
CopyOnExpiryOption	CopyOnExpiryOption
createdByType	Тип удостоверения, создавшего ресурс.
CustomCopyOption	CustomCopyOption
DataStoreInfoBase	DataStoreInfoBase
DataStoreTypes	тип хранилища данных; Рабочая/Хранилище/Архивная
Day	День
DayOfWeek	Это должно быть воскресенье/понедельник/T..../Суббота
Error	Ответ об ошибке управления ресурсами.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ImmediateCopyOption	ImmediateCopyOption
Month	Это должно быть январь,февраль/....../декабрь
RetentionTag	Метка хранения
ScheduleBasedBackupCriteria	ScheduleBasedBackupCriteria
ScheduleBasedTriggerContext	ScheduleBasedTriggerContext
SourceLifeCycle	SourceLifeCycle
systemData	Метаданные, относящиеся к созданию и последнему изменению ресурса.
TaggingCriteria	TaggingCriteria
TargetCopySetting	TargetCopySetting
WeekNumber	Он должен быть первым, вторым, третьим, четвертым и последним.

AbsoluteDeleteOption

AbsoluteDeleteOption

Имя	Тип	Описание
duration	string	Длительность удаления после заданного интервала времени
objectType	string: AbsoluteDeleteOption	Тип конкретного объекта , используемый для десериализации

AbsoluteMarker

он содержит абсолютные значения, такие как AllBackup/FirstOfDay/FirstOfWeek/FirstOfMonth, и должен быть частью перечисления AbsoluteMarker.

Имя	Тип	Описание
AllBackup	string
FirstOfDay	string
FirstOfMonth	string
FirstOfWeek	string
FirstOfYear	string

AdhocBasedTaggingCriteria

AdhocBasedTaggingCriteria

Имя	Тип	Описание
tagInfo	RetentionTag	Метка хранения Сведения о теге хранения

AdhocBasedTriggerContext

AdhocBasedTriggerContext

Имя	Тип	Описание
objectType	string: AdhocBasedTriggerContext	Тип конкретного объекта , используемый для десериализации
taggingCriteria	AdhocBasedTaggingCriteria	AdhocBasedTaggingCriteria Критерии добавления тегов, содержащие тег хранения для резервного копирования.

AzureBackupParams

AzureBackupParams

Имя	Тип	Описание
backupType	string	BackupType ; Полный или добавочный и т. д.
objectType	string: AzureBackupParams	Тип конкретного объекта , используемый для десериализации

AzureBackupRule

AzureBackupRule

Имя	Тип	Описание
backupParameters	BackupParameters: AzureBackupParams	BackupParameters Базовый параметр BackupParameters
dataStore	DataStoreInfoBase	DataStoreInfoBase База DataStoreInfo
name	string
objectType	string: AzureBackupRule
trigger	TriggerContext: AdhocBasedTriggerContext ScheduleBasedTriggerContext	TriggerContext Контекст триггера

AzureRetentionRule

AzureRetentionRule

Имя	Тип	Описание
isDefault	boolean
lifecycles	SourceLifeCycle[]	SourceLifeCycle Source LifeCycle
name	string
objectType	string: AzureRetentionRule

BackupPolicy

BackupPolicy

Имя	Тип	Описание
datasourceTypes	string[]	Тип источника данных для управления резервным копированием
objectType	string: BackupPolicy
policyRules	BasePolicyRule[]: AzureBackupRule[] AzureRetentionRule[]	Словарь правил политики, содержащий правила для каждого типа резервной копии, т. е. полный, добавочный, журнал и т. д.

BackupSchedule

BackupSchedule

Имя	Тип	Описание
repeatingTimeIntervals	string[]	Формат повторяющегося интервала времени ISO 8601
timeZone	string	Часовой пояс для расписания. (например, стандартное тихоокеанское время);

BaseBackupPolicyResource

BaseBackupPolicyResource

Имя	Тип	Описание
id	string	Идентификатор ресурса представляет полный путь к ресурсу.
name	string	Имя ресурса, связанное с ресурсом.
properties	BaseBackupPolicy: BackupPolicy	BaseBackupPolicy Свойства BaseBackupPolicyResource
systemData	systemData	Метаданные, относящиеся к созданию и последнему изменению ресурса.
type	string	Тип ресурса представляет полный путь к форме Namespace/ResourceType/ResourceType/...

CloudError

CloudError

Имя	Тип	Описание
error	Error	Ответ об ошибке управления ресурсами.

CopyOnExpiryOption

CopyOnExpiryOption

Имя	Тип	Описание
objectType	string: CopyOnExpiryOption	Тип конкретного объекта , используемый для десериализации

createdByType

Тип удостоверения, создавшего ресурс.

Имя	Тип	Описание
Application	string
Key	string
ManagedIdentity	string
User	string

CustomCopyOption

CustomCopyOption

Имя	Тип	Описание
duration	string	Данные, скопированные после заданного интервала времени
objectType	string: CustomCopyOption	Тип конкретного объекта , используемый для десериализации

DataStoreInfoBase

DataStoreInfoBase

Имя	Тип	Описание
dataStoreType	DataStoreTypes	тип хранилища данных; Рабочая/Хранилище/Архивная
objectType	string	Тип объекта Datasource, используемый для инициализации правонаследуемого типа

DataStoreTypes

тип хранилища данных; Рабочая/Хранилище/Архивная

Имя	Тип	Описание
ArchiveStore	string
OperationalStore	string
VaultStore	string

Day

День

Имя	Тип	Описание
date	integer	Дата месяца
isLast	boolean	Указывает, является ли date последней датой месяца

DayOfWeek

Это должно быть воскресенье/понедельник/T..../Суббота

Имя	Тип	Описание
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

Error

Ответ об ошибке управления ресурсами.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	Error[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Тип дополнительных сведений.

ImmediateCopyOption

ImmediateCopyOption

Имя	Тип	Описание
objectType	string: ImmediateCopyOption	Тип конкретного объекта , используемый для десериализации

Month

Это должно быть январь,февраль/....../декабрь

Имя	Тип	Описание
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

Метка хранения

Имя	Тип	Описание
eTag	string	Версия тега хранения.
id	string	Версия тега хранения.
tagName	string	Имя тега хранения, чтобы связать его с правилом хранения.

ScheduleBasedBackupCriteria

ScheduleBasedBackupCriteria

Имя	Тип	Описание
absoluteCriteria	AbsoluteMarker[]	он содержит абсолютные значения, такие как AllBackup/FirstOfDay/FirstOfWeek/FirstOfMonth, и должен быть частью перечисления AbsoluteMarker.
daysOfMonth	Day[]	Это день месяца от 1 до 28 других мудрых последних месяцев
daysOfTheWeek	DayOfWeek[]	Это должно быть воскресенье/понедельник/T..../Суббота
monthsOfYear	Month[]	Это должно быть январь,февраль/....../декабрь
objectType	string: ScheduleBasedBackupCriteria	Тип конкретного объекта , используемый для десериализации
scheduleTimes	string[]	Список расписаний для резервного копирования
weeksOfTheMonth	WeekNumber[]	Он должен быть первым, вторым, третьим, четвертым и последним.

ScheduleBasedTriggerContext

ScheduleBasedTriggerContext

Имя	Тип	Описание
objectType	string: ScheduleBasedTriggerContext	Тип конкретного объекта , используемый для десериализации
schedule	BackupSchedule	BackupSchedule Планирование резервного копирования
taggingCriteria	TaggingCriteria[]	Список тегов, которые могут быть применимы для заданного расписания.

SourceLifeCycle

SourceLifeCycle

Имя	Тип	Описание
deleteAfter	DeleteOption: AbsoluteDeleteOption	DeleteOption Параметр "Удалить"
sourceDataStore	DataStoreInfoBase	DataStoreInfoBase База DataStoreInfo
targetDataStoreCopySettings	TargetCopySetting[]	TargetCopySetting Параметры целевого копирования

systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

Имя	Тип	Описание
createdAt	string	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Удостоверение, которое последним изменял ресурс.
lastModifiedByType	createdByType	Тип удостоверения, которое последним изменял ресурс.

TaggingCriteria

TaggingCriteria

Имя	Тип	Описание
criteria	BackupCriteria[]: ScheduleBasedBackupCriteria[]	Критерии, определяющие, можно ли применить тег к активированной резервной копии.
isDefault	boolean	Указывает, имеет ли тег значение по умолчанию.
tagInfo	RetentionTag	Метка хранения Сведения о теге хранения
taggingPriority	integer	Приоритет тега хранения.

TargetCopySetting

TargetCopySetting

Имя	Тип	Описание
copyAfter	CopyOption: CopyOnExpiryOption CustomCopyOption ImmediateCopyOption	CopyOption Это может быть CustomCopyOption или ImmediateCopyOption.
dataStore	DataStoreInfoBase	DataStoreInfoBase Сведения о целевом хранилище данных

WeekNumber

Он должен быть первым, вторым, третьим, четвертым и последним.

Имя	Тип	Описание
First	string
Fourth	string
Last	string
Second	string
Third	string