Backup Policies - Create Or Update

Referência

Service:: Data Protection

API Version:: 2023-01-01

Cria ou Atualizações uma política de backup que pertence a um cofre de backup

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
backupPolicyName	path	True	string	Nome da política
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string uuid	A ID da assinatura de destino. O valor deve ser um UUID.
vaultName	path	True	string	O nome do cofre de backup.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Tipo	Description
properties	BaseBackupPolicy: BackupPolicy	BaseBackupPolicy Propriedades BaseBackupPolicyResource

Respostas

Nome	Tipo	Description
200 OK	BaseBackupPolicyResource	OK
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Scopes

Nome	Description
user_impersonation	represente sua conta de usuário.

Exemplos

CreateOrUpdate BackupPolicy

Sample Request

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

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

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

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

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

Definições

Nome	Description
AbsoluteDeleteOption	AbsoluteDeleteOption
AbsoluteMarker	ele contém valores absolutos como "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" e deve fazer parte da enumeração AbsoluteMarker
AdhocBasedTaggingCriteria	AdhocBasedTaggingCriteria
AdhocBasedTriggerContext	AdhocBasedTriggerContext
AzureBackupParams	AzureBackupParams
AzureBackupRule	AzureBackupRule
AzureRetentionRule	AzureRetentionRule
BackupPolicy	BackupPolicy
BackupSchedule	BackupSchedule
BaseBackupPolicyResource	BaseBackupPolicyResource
CloudError	CloudError
CopyOnExpiryOption	CopyOnExpiryOption
createdByType	O tipo de identidade que criou o recurso.
CustomCopyOption	CustomCopyOption
DataStoreInfoBase	DataStoreInfoBase
DataStoreTypes	tipo de armazenamento de dados; Operacional/Cofre/Arquivo Morto
Day	Dia
DayOfWeek	Deve ser domingo/segunda-feira/T..../sábado
Error	A resposta de erro de gerenciamento de recursos.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ImmediateCopyOption	ImmediateCopyOption
Month	Deve ser janeiro/fevereiro/....../dezembro
RetentionTag	RetentionTag
ScheduleBasedBackupCriteria	ScheduleBasedBackupCriteria
ScheduleBasedTriggerContext	ScheduleBasedTriggerContext
SourceLifeCycle	SourceLifeCycle
systemData	Metadados relativos à criação e à última modificação do recurso.
TaggingCriteria	TaggingCriteria
TargetCopySetting	TargetCopySetting
WeekNumber	Deve ser Primeiro/Segundo/Terceiro/Quarto/Último

AbsoluteDeleteOption

Nome	Tipo	Description
duration	string	Duração da exclusão após determinado período de tempo
objectType	string: AbsoluteDeleteOption	Tipo do objeto específico – usado para desserialização

AbsoluteMarker

ele contém valores absolutos como "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" e deve fazer parte da enumeração AbsoluteMarker

Nome	Tipo	Description
AllBackup	string
FirstOfDay	string
FirstOfMonth	string
FirstOfWeek	string
FirstOfYear	string

AdhocBasedTaggingCriteria

Nome	Tipo	Description
tagInfo	RetentionTag	RetentionTag Informações da marca de retenção

AdhocBasedTriggerContext

Nome	Tipo	Description
objectType	string: AdhocBasedTriggerContext	Tipo do objeto específico – usado para desserialização
taggingCriteria	AdhocBasedTaggingCriteria	AdhocBasedTaggingCriteria Marcando critérios que contêm a marca de retenção para o backup de aduto.

AzureBackupParams

Nome	Tipo	Description
backupType	string	BackupType ; Completo/Incremental etc.
objectType	string: AzureBackupParams	Tipo do objeto específico – usado para desserialização

AzureBackupRule

Nome	Tipo	Description
backupParameters	BackupParameters: AzureBackupParams	BackupParameters Base de BackupParameters
dataStore	DataStoreInfoBase	DataStoreInfoBase Base do DataStoreInfo
name	string
objectType	string: AzureBackupRule
trigger	TriggerContext: AdhocBasedTriggerContext ScheduleBasedTriggerContext	Triggercontext Contexto do gatilho

AzureRetentionRule

Nome	Tipo	Description
isDefault	boolean
lifecycles	SourceLifeCycle[]	SourceLifeCycle Ciclo de Vida de Origem
name	string
objectType	string: AzureRetentionRule

BackupPolicy

Nome	Tipo	Description
datasourceTypes	string[]	Tipo de fonte de dados para o gerenciamento de backup
objectType	string: BackupPolicy
policyRules	BasePolicyRule[]: AzureBackupRule[] AzureRetentionRule[]	Dicionário de regras de política que contém regras para cada tipo de backup, ou seja, Completo/Incremental/Logs etc.

BackupSchedule

Nome	Tipo	Description
repeatingTimeIntervals	string[]	Formato de intervalo de tempo repetido ISO 8601
timeZone	string	Fuso horário para uma agenda. Exemplo: Hora Padrão do Pacífico Central

BaseBackupPolicyResource

Nome	Tipo	Description
id	string	A ID do recurso representa o caminho completo para o recurso.
name	string	Nome do recurso associado ao recurso.
properties	BaseBackupPolicy: BackupPolicy	BaseBackupPolicy Propriedades BaseBackupPolicyResource
systemData	systemData	Metadados relativos à criação e à última modificação do recurso.
type	string	O tipo de recurso representa o caminho completo do formulário Namespace/ResourceType/ResourceType/...

CloudError

Nome	Tipo	Description
error	Error	A resposta de erro de gerenciamento de recursos.

CopyOnExpiryOption

Nome	Tipo	Description
objectType	string: CopyOnExpiryOption	Tipo do objeto específico – usado para desserialização

createdByType

O tipo de identidade que criou o recurso.

Nome	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CustomCopyOption

Nome	Tipo	Description
duration	string	Dados copiados após determinado período de tempo
objectType	string: CustomCopyOption	Tipo do objeto específico – usado para desserialização

DataStoreInfoBase

Nome	Tipo	Description
dataStoreType	DataStoreTypes	tipo de armazenamento de dados; Operacional/Cofre/Arquivo Morto
objectType	string	Tipo de objeto Datasource, usado para inicializar o tipo herdado correto

DataStoreTypes

tipo de armazenamento de dados; Operacional/Cofre/Arquivo Morto

Nome	Tipo	Description
ArchiveStore	string
OperationalStore	string
VaultStore	string

Day

Dia

Nome	Tipo	Description
date	integer	Data do mês
isLast	boolean	Se Data é a última data do mês

DayOfWeek

Deve ser domingo/segunda-feira/T..../sábado

Nome	Tipo	Description
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

Error

A resposta de erro de gerenciamento de recursos.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	Error[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ImmediateCopyOption

Nome	Tipo	Description
objectType	string: ImmediateCopyOption	Tipo do objeto específico – usado para desserialização

Month

Deve ser janeiro/fevereiro/....../dezembro

Nome	Tipo	Description
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

Nome	Tipo	Description
eTag	string	Versão da Marca de Retenção.
id	string	Versão da Marca de Retenção.
tagName	string	Nome da Marca de Retenção para relacioná-lo à regra de retenção.

ScheduleBasedBackupCriteria

Nome	Tipo	Description
absoluteCriteria	AbsoluteMarker[]	ele contém valores absolutos como "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" e deve fazer parte da enumeração AbsoluteMarker
daysOfMonth	Day[]	Este é o dia do mês de 1 a 28 outros sábios no último mês
daysOfTheWeek	DayOfWeek[]	Deve ser domingo/segunda-feira/T..../sábado
monthsOfYear	Month[]	Deve ser janeiro/fevereiro/....../dezembro
objectType	string: ScheduleBasedBackupCriteria	Tipo do objeto específico – usado para desserializar
scheduleTimes	string[]	Lista de horários de agendamento para backup
weeksOfTheMonth	WeekNumber[]	Deve ser Primeiro/Segundo/Terceiro/Quarto/Último

ScheduleBasedTriggerContext

Nome	Tipo	Description
objectType	string: ScheduleBasedTriggerContext	Tipo do objeto específico – usado para desserialização
schedule	BackupSchedule	BackupSchedule Agendar para este backup
taggingCriteria	TaggingCriteria[]	Lista de marcas que podem ser aplicáveis para determinado agendamento.

SourceLifeCycle

Nome	Tipo	Description
deleteAfter	DeleteOption: AbsoluteDeleteOption	DeleteOption Opção Excluir
sourceDataStore	DataStoreInfoBase	DataStoreInfoBase Base do DataStoreInfo
targetDataStoreCopySettings	TargetCopySetting[]	TargetCopySetting Configurações de cópia de destino

systemData

Metadados relativos à criação e à última modificação do recurso.

Nome	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

TaggingCriteria

Nome	Tipo	Description
criteria	BackupCriteria[]: ScheduleBasedBackupCriteria[]	Critérios que decidem se a marca pode ser aplicada a um backup disparado.
isDefault	boolean	Especifica se a marca é padrão.
tagInfo	RetentionTag	RetentionTag Informações da marca de retenção
taggingPriority	integer	Prioridade da marca de retenção.

TargetCopySetting

Nome	Tipo	Description
copyAfter	CopyOption: CopyOnExpiryOption CustomCopyOption ImmediateCopyOption	CopyOption Pode ser CustomCopyOption ou ImmediateCopyOption.
dataStore	DataStoreInfoBase	DataStoreInfoBase Informações do armazenamento de dados de destino

WeekNumber

Deve ser Primeiro/Segundo/Terceiro/Quarto/Último

Nome	Tipo	Description
First	string
Fourth	string
Last	string
Second	string
Third	string

Backup Policies - Create Or Update

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

azure_auth

Scopes

Exemplos

CreateOrUpdate BackupPolicy

Sample Request

Sample Response

Definições

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

Recursos adicionais