Backup Policies - List

Service:

Recovery Services - Backup

API Version:

2023-02-01

Listes de stratégies de sauvegarde associées à Recovery Services Vault. L’API fournit des paramètres de pagination pour extraire les résultats délimités.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies?api-version=2023-02-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies?api-version=2023-02-01&$filter={$filter}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string	Nom du groupe de ressources dans lequel le coffre Recovery Services est présent.
subscriptionId	path	True	string	ID d’abonnement.
vaultName	path	True	string	Nom du coffre Recovery Services.
api-version	query	True	string	Version de l’API cliente.
$filter	query		string	Options de filtre OData.

Réponses

Nom	Type	Description
200 OK	ProtectionPolicyResourceList	Ok
Other Status Codes	CloudError	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

Scopes

Nom	Description
user_impersonation	empruntez l’identité de votre compte d’utilisateur.

Exemples

List protection policies with backupManagementType filter as AzureIaasVm

List protection policies with backupManagementType filter as AzureIaasVm with both V1 and V2 policies

List protection policies with backupManagementType filter as AzureWorkload

List protection policies with backupManagementType filter as AzureIaasVm

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies?api-version=2023-02-01&$filter=backupManagementType eq 'AzureIaasVM'

Java

/** Samples for BackupPolicies List. */
public final class Main {
    /*
     * x-ms-original-file: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-01/examples/AzureIaasVm/BackupPolicies_List.json
     */
    /**
     * Sample code: List protection policies with backupManagementType filter as AzureIaasVm.
     *
     * @param manager Entry point to RecoveryServicesBackupManager.
     */
    public static void listProtectionPoliciesWithBackupManagementTypeFilterAsAzureIaasVm(
        com.azure.resourcemanager.recoveryservicesbackup.RecoveryServicesBackupManager manager) {
        manager
            .backupPolicies()
            .list(
                "NetSDKTestRsVault",
                "SwaggerTestRg",
                "backupManagementType eq 'AzureIaasVM'",
                com.azure.core.util.Context.NONE);
    }
}

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.recoveryservicesbackup import RecoveryServicesBackupClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-recoveryservicesbackup
# USAGE
    python backup_policies_list.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 = RecoveryServicesBackupClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.backup_policies.list(
        vault_name="NetSDKTestRsVault",
        resource_group_name="SwaggerTestRg",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-01/examples/AzureIaasVm/BackupPolicies_List.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 armrecoveryservicesbackup_test

import (
	"context"
	"log"

	"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/recoveryservices/armrecoveryservicesbackup/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/a498cae6d1a93f4c33073f0747b93b22815c09b7/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-01/examples/AzureIaasVm/BackupPolicies_List.json
func ExampleBackupPoliciesClient_NewListPager_listProtectionPoliciesWithBackupManagementTypeFilterAsAzureIaasVm() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armrecoveryservicesbackup.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewBackupPoliciesClient().NewListPager("NetSDKTestRsVault", "SwaggerTestRg", &armrecoveryservicesbackup.BackupPoliciesClientListOptions{Filter: to.Ptr("backupManagementType eq 'AzureIaasVM'")})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ProtectionPolicyResourceList = armrecoveryservicesbackup.ProtectionPolicyResourceList{
		// 	Value: []*armrecoveryservicesbackup.ProtectionPolicyResource{
		// 		{
		// 			Name: to.Ptr("DefaultPolicy"),
		// 			Type: to.Ptr("Microsoft.RecoveryServices/vaults/backupPolicies"),
		// 			ID: to.Ptr("/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/DefaultPolicy"),
		// 			Properties: &armrecoveryservicesbackup.AzureIaaSVMProtectionPolicy{
		// 				BackupManagementType: to.Ptr("AzureIaasVM"),
		// 				ProtectedItemsCount: to.Ptr[int32](0),
		// 				RetentionPolicy: &armrecoveryservicesbackup.LongTermRetentionPolicy{
		// 					RetentionPolicyType: to.Ptr("LongTermRetentionPolicy"),
		// 					DailySchedule: &armrecoveryservicesbackup.DailyRetentionSchedule{
		// 						RetentionDuration: &armrecoveryservicesbackup.RetentionDuration{
		// 							Count: to.Ptr[int32](30),
		// 							DurationType: to.Ptr(armrecoveryservicesbackup.RetentionDurationTypeDays),
		// 						},
		// 						RetentionTimes: []*time.Time{
		// 							to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-12-05T19:00:00Z"); return t}())},
		// 						},
		// 					},
		// 					SchedulePolicy: &armrecoveryservicesbackup.SimpleSchedulePolicy{
		// 						SchedulePolicyType: to.Ptr("SimpleSchedulePolicy"),
		// 						ScheduleRunFrequency: to.Ptr(armrecoveryservicesbackup.ScheduleRunTypeDaily),
		// 						ScheduleRunTimes: []*time.Time{
		// 							to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-12-05T19:00:00Z"); return t}())},
		// 							ScheduleWeeklyFrequency: to.Ptr[int32](0),
		// 						},
		// 					},
		// 				},
		// 				{
		// 					Name: to.Ptr("testPolicy1"),
		// 					Type: to.Ptr("Microsoft.RecoveryServices/vaults/backupPolicies"),
		// 					ID: to.Ptr("/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/testPolicy1"),
		// 					Properties: &armrecoveryservicesbackup.AzureIaaSVMProtectionPolicy{
		// 						BackupManagementType: to.Ptr("AzureIaasVM"),
		// 						ProtectedItemsCount: to.Ptr[int32](0),
		// 						RetentionPolicy: &armrecoveryservicesbackup.LongTermRetentionPolicy{
		// 							RetentionPolicyType: to.Ptr("LongTermRetentionPolicy"),
		// 							DailySchedule: &armrecoveryservicesbackup.DailyRetentionSchedule{
		// 								RetentionDuration: &armrecoveryservicesbackup.RetentionDuration{
		// 									Count: to.Ptr[int32](1),
		// 									DurationType: to.Ptr(armrecoveryservicesbackup.RetentionDurationTypeDays),
		// 								},
		// 								RetentionTimes: []*time.Time{
		// 									to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-24T02:00:00Z"); return t}())},
		// 								},
		// 							},
		// 							SchedulePolicy: &armrecoveryservicesbackup.SimpleSchedulePolicy{
		// 								SchedulePolicyType: to.Ptr("SimpleSchedulePolicy"),
		// 								ScheduleRunFrequency: to.Ptr(armrecoveryservicesbackup.ScheduleRunTypeDaily),
		// 								ScheduleRunTimes: []*time.Time{
		// 									to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-24T02:00:00Z"); return t}())},
		// 									ScheduleWeeklyFrequency: to.Ptr[int32](0),
		// 								},
		// 								TimeZone: to.Ptr("Pacific Standard Time"),
		// 							},
		// 					}},
		// 				}
	}
}

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 { RecoveryServicesBackupClient } = require("@azure/arm-recoveryservicesbackup");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists of backup policies associated with Recovery Services Vault. API provides pagination parameters to fetch
scoped results.
 *
 * @summary Lists of backup policies associated with Recovery Services Vault. API provides pagination parameters to fetch
scoped results.
 * x-ms-original-file: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-01/examples/AzureIaasVm/BackupPolicies_List.json
 */
async function listProtectionPoliciesWithBackupManagementTypeFilterAsAzureIaasVM() {
  const subscriptionId =
    process.env["RECOVERYSERVICESBACKUP_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const vaultName = "NetSDKTestRsVault";
  const resourceGroupName = process.env["RECOVERYSERVICESBACKUP_RESOURCE_GROUP"] || "SwaggerTestRg";
  const filter = "backupManagementType eq 'AzureIaasVM'";
  const options = { filter };
  const credential = new DefaultAzureCredential();
  const client = new RecoveryServicesBackupClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.backupPolicies.list(vaultName, resourceGroupName, options)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.RecoveryServicesBackup;
using Azure.ResourceManager.RecoveryServicesBackup.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-01/examples/AzureIaasVm/BackupPolicies_List.json
// this example is just showing the usage of "BackupPolicies_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "SwaggerTestRg";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this BackupProtectionPolicyResource
string vaultName = "NetSDKTestRsVault";
BackupProtectionPolicyCollection collection = resourceGroupResource.GetBackupProtectionPolicies(vaultName);

// invoke the operation and iterate over the result
string filter = "backupManagementType eq 'AzureIaasVM'";
await foreach (BackupProtectionPolicyResource item in collection.GetAllAsync(filter: filter))
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    BackupProtectionPolicyData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

{
  "value": [
    {
      "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/DefaultPolicy",
      "name": "DefaultPolicy",
      "type": "Microsoft.RecoveryServices/vaults/backupPolicies",
      "properties": {
        "backupManagementType": "AzureIaasVM",
        "schedulePolicy": {
          "schedulePolicyType": "SimpleSchedulePolicy",
          "scheduleRunFrequency": "Daily",
          "scheduleRunTimes": [
            "2017-12-05T19:00:00Z"
          ],
          "scheduleWeeklyFrequency": 0
        },
        "retentionPolicy": {
          "retentionPolicyType": "LongTermRetentionPolicy",
          "dailySchedule": {
            "retentionTimes": [
              "2017-12-05T19:00:00Z"
            ],
            "retentionDuration": {
              "count": 30,
              "durationType": "Days"
            }
          }
        },
        "protectedItemsCount": 0
      }
    },
    {
      "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/testPolicy1",
      "name": "testPolicy1",
      "type": "Microsoft.RecoveryServices/vaults/backupPolicies",
      "properties": {
        "backupManagementType": "AzureIaasVM",
        "schedulePolicy": {
          "schedulePolicyType": "SimpleSchedulePolicy",
          "scheduleRunFrequency": "Daily",
          "scheduleRunTimes": [
            "2018-01-24T02:00:00Z"
          ],
          "scheduleWeeklyFrequency": 0
        },
        "retentionPolicy": {
          "retentionPolicyType": "LongTermRetentionPolicy",
          "dailySchedule": {
            "retentionTimes": [
              "2018-01-24T02:00:00Z"
            ],
            "retentionDuration": {
              "count": 1,
              "durationType": "Days"
            }
          }
        },
        "timeZone": "Pacific Standard Time",
        "protectedItemsCount": 0
      }
    }
  ]
}

List protection policies with backupManagementType filter as AzureIaasVm with both V1 and V2 policies

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies?api-version=2023-02-01&$filter=backupManagementType eq 'AzureIaasVM'

Java

/** Samples for BackupPolicies List. */
public final class Main {
    /*
     * x-ms-original-file: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-01/examples/AzureIaasVm/V2Policy/v2-List-Policies.json
     */
    /**
     * Sample code: List protection policies with backupManagementType filter as AzureIaasVm with both V1 and V2
     * policies.
     *
     * @param manager Entry point to RecoveryServicesBackupManager.
     */
    public static void listProtectionPoliciesWithBackupManagementTypeFilterAsAzureIaasVmWithBothV1AndV2Policies(
        com.azure.resourcemanager.recoveryservicesbackup.RecoveryServicesBackupManager manager) {
        manager
            .backupPolicies()
            .list(
                "NetSDKTestRsVault",
                "SwaggerTestRg",
                "backupManagementType eq 'AzureIaasVM'",
                com.azure.core.util.Context.NONE);
    }
}

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.recoveryservicesbackup import RecoveryServicesBackupClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-recoveryservicesbackup
# USAGE
    python v2_list_policies.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 = RecoveryServicesBackupClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.backup_policies.list(
        vault_name="NetSDKTestRsVault",
        resource_group_name="SwaggerTestRg",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-01/examples/AzureIaasVm/V2Policy/v2-List-Policies.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 armrecoveryservicesbackup_test

import (
	"context"
	"log"

	"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/recoveryservices/armrecoveryservicesbackup/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/a498cae6d1a93f4c33073f0747b93b22815c09b7/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-01/examples/AzureIaasVm/V2Policy/v2-List-Policies.json
func ExampleBackupPoliciesClient_NewListPager_listProtectionPoliciesWithBackupManagementTypeFilterAsAzureIaasVmWithBothV1AndV2Policies() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armrecoveryservicesbackup.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewBackupPoliciesClient().NewListPager("NetSDKTestRsVault", "SwaggerTestRg", &armrecoveryservicesbackup.BackupPoliciesClientListOptions{Filter: to.Ptr("backupManagementType eq 'AzureIaasVM'")})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ProtectionPolicyResourceList = armrecoveryservicesbackup.ProtectionPolicyResourceList{
		// 	Value: []*armrecoveryservicesbackup.ProtectionPolicyResource{
		// 		{
		// 			Name: to.Ptr("DefaultPolicy"),
		// 			Type: to.Ptr("Microsoft.RecoveryServices/vaults/backupPolicies"),
		// 			ID: to.Ptr("/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/DefaultPolicy"),
		// 			Properties: &armrecoveryservicesbackup.AzureIaaSVMProtectionPolicy{
		// 				BackupManagementType: to.Ptr("AzureIaasVM"),
		// 				ProtectedItemsCount: to.Ptr[int32](0),
		// 				RetentionPolicy: &armrecoveryservicesbackup.LongTermRetentionPolicy{
		// 					RetentionPolicyType: to.Ptr("LongTermRetentionPolicy"),
		// 					DailySchedule: &armrecoveryservicesbackup.DailyRetentionSchedule{
		// 						RetentionDuration: &armrecoveryservicesbackup.RetentionDuration{
		// 							Count: to.Ptr[int32](30),
		// 							DurationType: to.Ptr(armrecoveryservicesbackup.RetentionDurationTypeDays),
		// 						},
		// 						RetentionTimes: []*time.Time{
		// 							to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-12-05T19:00:00Z"); return t}())},
		// 						},
		// 					},
		// 					SchedulePolicy: &armrecoveryservicesbackup.SimpleSchedulePolicy{
		// 						SchedulePolicyType: to.Ptr("SimpleSchedulePolicy"),
		// 						ScheduleRunFrequency: to.Ptr(armrecoveryservicesbackup.ScheduleRunTypeDaily),
		// 						ScheduleRunTimes: []*time.Time{
		// 							to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-12-05T19:00:00Z"); return t}())},
		// 							ScheduleWeeklyFrequency: to.Ptr[int32](0),
		// 						},
		// 					},
		// 				},
		// 				{
		// 					Name: to.Ptr("testPolicy1"),
		// 					Type: to.Ptr("Microsoft.RecoveryServices/vaults/backupPolicies"),
		// 					ID: to.Ptr("/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/testPolicy1"),
		// 					Properties: &armrecoveryservicesbackup.AzureIaaSVMProtectionPolicy{
		// 						BackupManagementType: to.Ptr("AzureIaasVM"),
		// 						ProtectedItemsCount: to.Ptr[int32](0),
		// 						RetentionPolicy: &armrecoveryservicesbackup.LongTermRetentionPolicy{
		// 							RetentionPolicyType: to.Ptr("LongTermRetentionPolicy"),
		// 							DailySchedule: &armrecoveryservicesbackup.DailyRetentionSchedule{
		// 								RetentionDuration: &armrecoveryservicesbackup.RetentionDuration{
		// 									Count: to.Ptr[int32](1),
		// 									DurationType: to.Ptr(armrecoveryservicesbackup.RetentionDurationTypeDays),
		// 								},
		// 								RetentionTimes: []*time.Time{
		// 									to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-24T02:00:00Z"); return t}())},
		// 								},
		// 							},
		// 							SchedulePolicy: &armrecoveryservicesbackup.SimpleSchedulePolicy{
		// 								SchedulePolicyType: to.Ptr("SimpleSchedulePolicy"),
		// 								ScheduleRunFrequency: to.Ptr(armrecoveryservicesbackup.ScheduleRunTypeDaily),
		// 								ScheduleRunTimes: []*time.Time{
		// 									to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-24T02:00:00Z"); return t}())},
		// 									ScheduleWeeklyFrequency: to.Ptr[int32](0),
		// 								},
		// 								TimeZone: to.Ptr("Pacific Standard Time"),
		// 							},
		// 						},
		// 						{
		// 							Name: to.Ptr("v2-daily-policy"),
		// 							Type: to.Ptr("Microsoft.RecoveryServices/vaults/backupPolicies"),
		// 							ID: to.Ptr("/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/v2-daily-policy"),
		// 							Properties: &armrecoveryservicesbackup.AzureIaaSVMProtectionPolicy{
		// 								BackupManagementType: to.Ptr("AzureIaasVM"),
		// 								ProtectedItemsCount: to.Ptr[int32](0),
		// 								RetentionPolicy: &armrecoveryservicesbackup.LongTermRetentionPolicy{
		// 									RetentionPolicyType: to.Ptr("LongTermRetentionPolicy"),
		// 									DailySchedule: &armrecoveryservicesbackup.DailyRetentionSchedule{
		// 										RetentionDuration: &armrecoveryservicesbackup.RetentionDuration{
		// 											Count: to.Ptr[int32](1),
		// 											DurationType: to.Ptr(armrecoveryservicesbackup.RetentionDurationTypeDays),
		// 										},
		// 										RetentionTimes: []*time.Time{
		// 											to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-24T02:00:00Z"); return t}())},
		// 										},
		// 									},
		// 									SchedulePolicy: &armrecoveryservicesbackup.SimpleSchedulePolicyV2{
		// 										SchedulePolicyType: to.Ptr("SimpleSchedulePolicyV2"),
		// 										DailySchedule: &armrecoveryservicesbackup.DailySchedule{
		// 											ScheduleRunTimes: []*time.Time{
		// 												to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-24T10:00:00Z"); return t}())},
		// 											},
		// 											ScheduleRunFrequency: to.Ptr(armrecoveryservicesbackup.ScheduleRunTypeDaily),
		// 										},
		// 										TimeZone: to.Ptr("Pacific Standard Time"),
		// 									},
		// 							}},
		// 						}
	}
}

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 { RecoveryServicesBackupClient } = require("@azure/arm-recoveryservicesbackup");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists of backup policies associated with Recovery Services Vault. API provides pagination parameters to fetch
scoped results.
 *
 * @summary Lists of backup policies associated with Recovery Services Vault. API provides pagination parameters to fetch
scoped results.
 * x-ms-original-file: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-01/examples/AzureIaasVm/V2Policy/v2-List-Policies.json
 */
async function listProtectionPoliciesWithBackupManagementTypeFilterAsAzureIaasVMWithBothV1AndV2Policies() {
  const subscriptionId =
    process.env["RECOVERYSERVICESBACKUP_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const vaultName = "NetSDKTestRsVault";
  const resourceGroupName = process.env["RECOVERYSERVICESBACKUP_RESOURCE_GROUP"] || "SwaggerTestRg";
  const filter = "backupManagementType eq 'AzureIaasVM'";
  const options = { filter };
  const credential = new DefaultAzureCredential();
  const client = new RecoveryServicesBackupClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.backupPolicies.list(vaultName, resourceGroupName, options)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.RecoveryServicesBackup;
using Azure.ResourceManager.RecoveryServicesBackup.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-01/examples/AzureIaasVm/V2Policy/v2-List-Policies.json
// this example is just showing the usage of "BackupPolicies_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "SwaggerTestRg";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this BackupProtectionPolicyResource
string vaultName = "NetSDKTestRsVault";
BackupProtectionPolicyCollection collection = resourceGroupResource.GetBackupProtectionPolicies(vaultName);

// invoke the operation and iterate over the result
string filter = "backupManagementType eq 'AzureIaasVM'";
await foreach (BackupProtectionPolicyResource item in collection.GetAllAsync(filter: filter))
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    BackupProtectionPolicyData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

{
  "value": [
    {
      "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/DefaultPolicy",
      "name": "DefaultPolicy",
      "type": "Microsoft.RecoveryServices/vaults/backupPolicies",
      "properties": {
        "backupManagementType": "AzureIaasVM",
        "schedulePolicy": {
          "schedulePolicyType": "SimpleSchedulePolicy",
          "scheduleRunFrequency": "Daily",
          "scheduleRunTimes": [
            "2017-12-05T19:00:00Z"
          ],
          "scheduleWeeklyFrequency": 0
        },
        "retentionPolicy": {
          "retentionPolicyType": "LongTermRetentionPolicy",
          "dailySchedule": {
            "retentionTimes": [
              "2017-12-05T19:00:00Z"
            ],
            "retentionDuration": {
              "count": 30,
              "durationType": "Days"
            }
          }
        },
        "protectedItemsCount": 0
      }
    },
    {
      "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/testPolicy1",
      "name": "testPolicy1",
      "type": "Microsoft.RecoveryServices/vaults/backupPolicies",
      "properties": {
        "backupManagementType": "AzureIaasVM",
        "schedulePolicy": {
          "schedulePolicyType": "SimpleSchedulePolicy",
          "scheduleRunFrequency": "Daily",
          "scheduleRunTimes": [
            "2018-01-24T02:00:00Z"
          ],
          "scheduleWeeklyFrequency": 0
        },
        "retentionPolicy": {
          "retentionPolicyType": "LongTermRetentionPolicy",
          "dailySchedule": {
            "retentionTimes": [
              "2018-01-24T02:00:00Z"
            ],
            "retentionDuration": {
              "count": 1,
              "durationType": "Days"
            }
          }
        },
        "timeZone": "Pacific Standard Time",
        "protectedItemsCount": 0
      }
    },
    {
      "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/v2-daily-policy",
      "name": "v2-daily-policy",
      "type": "Microsoft.RecoveryServices/vaults/backupPolicies",
      "properties": {
        "backupManagementType": "AzureIaasVM",
        "schedulePolicy": {
          "schedulePolicyType": "SimpleSchedulePolicyV2",
          "scheduleRunFrequency": "Daily",
          "dailySchedule": {
            "scheduleRunTimes": [
              "2018-01-24T10:00:00Z"
            ]
          }
        },
        "retentionPolicy": {
          "retentionPolicyType": "LongTermRetentionPolicy",
          "dailySchedule": {
            "retentionTimes": [
              "2018-01-24T02:00:00Z"
            ],
            "retentionDuration": {
              "count": 1,
              "durationType": "Days"
            }
          }
        },
        "timeZone": "Pacific Standard Time",
        "protectedItemsCount": 0
      }
    }
  ]
}

List protection policies with backupManagementType filter as AzureWorkload

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies?api-version=2023-02-01&$filter=backupManagementType eq 'AzureWorkload'

Java

/** Samples for BackupPolicies List. */
public final class Main {
    /*
     * x-ms-original-file: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-01/examples/AzureWorkload/BackupPolicies_List.json
     */
    /**
     * Sample code: List protection policies with backupManagementType filter as AzureWorkload.
     *
     * @param manager Entry point to RecoveryServicesBackupManager.
     */
    public static void listProtectionPoliciesWithBackupManagementTypeFilterAsAzureWorkload(
        com.azure.resourcemanager.recoveryservicesbackup.RecoveryServicesBackupManager manager) {
        manager
            .backupPolicies()
            .list(
                "NetSDKTestRsVault",
                "SwaggerTestRg",
                "backupManagementType eq 'AzureWorkload'",
                com.azure.core.util.Context.NONE);
    }
}

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

Python

No code sample is available. To request a code sample, open a GitHub issue

Go

package armrecoveryservicesbackup_test

import (
	"context"
	"log"

	"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/recoveryservices/armrecoveryservicesbackup/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/a498cae6d1a93f4c33073f0747b93b22815c09b7/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-01/examples/AzureWorkload/BackupPolicies_List.json
func ExampleBackupPoliciesClient_NewListPager_listProtectionPoliciesWithBackupManagementTypeFilterAsAzureWorkload() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armrecoveryservicesbackup.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewBackupPoliciesClient().NewListPager("NetSDKTestRsVault", "SwaggerTestRg", &armrecoveryservicesbackup.BackupPoliciesClientListOptions{Filter: to.Ptr("backupManagementType eq 'AzureWorkload'")})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ProtectionPolicyResourceList = armrecoveryservicesbackup.ProtectionPolicyResourceList{
		// 	Value: []*armrecoveryservicesbackup.ProtectionPolicyResource{
		// 		{
		// 			Name: to.Ptr("HourlyLogBackup"),
		// 			Type: to.Ptr("Microsoft.RecoveryServices/vaults/backupPolicies"),
		// 			ID: to.Ptr("/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/HourlyLogBackup"),
		// 			Properties: &armrecoveryservicesbackup.AzureVMWorkloadProtectionPolicy{
		// 				BackupManagementType: to.Ptr("AzureWorkload"),
		// 				ProtectedItemsCount: to.Ptr[int32](0),
		// 				Settings: &armrecoveryservicesbackup.Settings{
		// 					Issqlcompression: to.Ptr(false),
		// 					TimeZone: to.Ptr("UTC"),
		// 				},
		// 				SubProtectionPolicy: []*armrecoveryservicesbackup.SubProtectionPolicy{
		// 					{
		// 						PolicyType: to.Ptr(armrecoveryservicesbackup.PolicyTypeFull),
		// 						RetentionPolicy: &armrecoveryservicesbackup.LongTermRetentionPolicy{
		// 							RetentionPolicyType: to.Ptr("LongTermRetentionPolicy"),
		// 							DailySchedule: &armrecoveryservicesbackup.DailyRetentionSchedule{
		// 								RetentionDuration: &armrecoveryservicesbackup.RetentionDuration{
		// 									Count: to.Ptr[int32](30),
		// 									DurationType: to.Ptr(armrecoveryservicesbackup.RetentionDurationTypeDays),
		// 								},
		// 								RetentionTimes: []*time.Time{
		// 									to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-12-05T19:00:00Z"); return t}())},
		// 								},
		// 							},
		// 							SchedulePolicy: &armrecoveryservicesbackup.SimpleSchedulePolicy{
		// 								SchedulePolicyType: to.Ptr("SimpleSchedulePolicy"),
		// 								ScheduleRunFrequency: to.Ptr(armrecoveryservicesbackup.ScheduleRunTypeDaily),
		// 								ScheduleRunTimes: []*time.Time{
		// 									to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-12-05T19:00:00Z"); return t}())},
		// 									ScheduleWeeklyFrequency: to.Ptr[int32](0),
		// 								},
		// 							},
		// 							{
		// 								PolicyType: to.Ptr(armrecoveryservicesbackup.PolicyTypeLog),
		// 								RetentionPolicy: &armrecoveryservicesbackup.SimpleRetentionPolicy{
		// 									RetentionPolicyType: to.Ptr("SimpleRetentionPolicy"),
		// 									RetentionDuration: &armrecoveryservicesbackup.RetentionDuration{
		// 										Count: to.Ptr[int32](30),
		// 										DurationType: to.Ptr(armrecoveryservicesbackup.RetentionDurationTypeDays),
		// 									},
		// 								},
		// 								SchedulePolicy: &armrecoveryservicesbackup.LogSchedulePolicy{
		// 									SchedulePolicyType: to.Ptr("LogSchedulePolicy"),
		// 									ScheduleFrequencyInMins: to.Ptr[int32](60),
		// 								},
		// 						}},
		// 						WorkLoadType: to.Ptr(armrecoveryservicesbackup.WorkloadTypeSQLDataBase),
		// 					},
		// 			}},
		// 		}
	}
}

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 { RecoveryServicesBackupClient } = require("@azure/arm-recoveryservicesbackup");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists of backup policies associated with Recovery Services Vault. API provides pagination parameters to fetch
scoped results.
 *
 * @summary Lists of backup policies associated with Recovery Services Vault. API provides pagination parameters to fetch
scoped results.
 * x-ms-original-file: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-01/examples/AzureWorkload/BackupPolicies_List.json
 */
async function listProtectionPoliciesWithBackupManagementTypeFilterAsAzureWorkload() {
  const subscriptionId =
    process.env["RECOVERYSERVICESBACKUP_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const vaultName = "NetSDKTestRsVault";
  const resourceGroupName = process.env["RECOVERYSERVICESBACKUP_RESOURCE_GROUP"] || "SwaggerTestRg";
  const filter = "backupManagementType eq 'AzureWorkload'";
  const options = { filter };
  const credential = new DefaultAzureCredential();
  const client = new RecoveryServicesBackupClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.backupPolicies.list(vaultName, resourceGroupName, options)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.RecoveryServicesBackup;
using Azure.ResourceManager.RecoveryServicesBackup.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-01/examples/AzureWorkload/BackupPolicies_List.json
// this example is just showing the usage of "BackupPolicies_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "SwaggerTestRg";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this BackupProtectionPolicyResource
string vaultName = "NetSDKTestRsVault";
BackupProtectionPolicyCollection collection = resourceGroupResource.GetBackupProtectionPolicies(vaultName);

// invoke the operation and iterate over the result
string filter = "backupManagementType eq 'AzureWorkload'";
await foreach (BackupProtectionPolicyResource item in collection.GetAllAsync(filter: filter))
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    BackupProtectionPolicyData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

{
  "value": [
    {
      "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/HourlyLogBackup",
      "name": "HourlyLogBackup",
      "type": "Microsoft.RecoveryServices/vaults/backupPolicies",
      "properties": {
        "backupManagementType": "AzureWorkload",
        "workLoadType": "SQLDataBase",
        "settings": {
          "timeZone": "UTC",
          "issqlcompression": false
        },
        "subProtectionPolicy": [
          {
            "policyType": "Full",
            "schedulePolicy": {
              "schedulePolicyType": "SimpleSchedulePolicy",
              "scheduleRunFrequency": "Daily",
              "scheduleRunTimes": [
                "2017-12-05T19:00:00Z"
              ],
              "scheduleWeeklyFrequency": 0
            },
            "retentionPolicy": {
              "retentionPolicyType": "LongTermRetentionPolicy",
              "dailySchedule": {
                "retentionTimes": [
                  "2017-12-05T19:00:00Z"
                ],
                "retentionDuration": {
                  "count": 30,
                  "durationType": "Days"
                }
              }
            }
          },
          {
            "policyType": "Log",
            "schedulePolicy": {
              "schedulePolicyType": "LogSchedulePolicy",
              "scheduleFrequencyInMins": 60
            },
            "retentionPolicy": {
              "retentionPolicyType": "SimpleRetentionPolicy",
              "retentionDuration": {
                "count": 30,
                "durationType": "Days"
              }
            }
          }
        ],
        "protectedItemsCount": 0
      }
    }
  ]
}

Définitions

Nom	Description
AzureFileShareProtectionPolicy	Stratégie de sauvegarde AzureStorage.
AzureIaaSVMProtectionPolicy	Stratégie de sauvegarde spécifique à la charge de travail des machines virtuelles IaaS.
AzureSqlProtectionPolicy	Azure SQL stratégie de sauvegarde spécifique à la charge de travail.
AzureVmWorkloadProtectionPolicy	Stratégie de sauvegarde propre à la charge de travail des machines virtuelles Azure (Mercury).
CloudError	Réponse d’erreur du service Container Instance.
CloudErrorBody	Réponse d’erreur du service Container Instance.
DailyRetentionFormat	Format de rétention quotidien.
DailyRetentionSchedule	Planification quotidienne de la rétention.
DailySchedule
Day	Jour de la semaine.
DayOfWeek
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
GenericProtectionPolicy	Stratégie de sauvegarde propre à la charge de travail des machines virtuelles Azure (Mercury).
HourlySchedule
IAASVMPolicyType
InstantRPAdditionalDetails
LogSchedulePolicy	Planification de la stratégie de journalisation.
LongTermRetentionPolicy	Stratégie de rétention à long terme.
LongTermSchedulePolicy	Planification de stratégie à long terme.
MabProtectionPolicy	Stratégie de sauvegarde spécifique au conteneur Mab.
MonthlyRetentionSchedule	Planification de rétention mensuelle.
MonthOfYear	Liste des mois de l’année de la stratégie de rétention annuelle.
PolicyType	Type de type de stratégie de sauvegarde
ProtectionPolicyResource	Classe de base pour la stratégie de sauvegarde. Les stratégies de sauvegarde spécifiques à la charge de travail sont dérivées de cette classe.
ProtectionPolicyResourceList	Liste des ressources ProtectionPolicy
RetentionDuration	Durée de rétention.
RetentionDurationType	Type de durée de rétention : jours/semaines/mois/années Utilisé uniquement si TieringMode est défini sur TierAfter
RetentionScheduleFormat	Type de format de planification de rétention pour la stratégie de rétention mensuelle.
ScheduleRunType	Fréquence de l’opération de planification de cette stratégie.
Settings	Champ Paramètres courants pour la gestion des sauvegardes
SimpleRetentionPolicy	Rétention de stratégie simple.
SimpleSchedulePolicy	Planification de stratégie simple.
SimpleSchedulePolicyV2	Planification de stratégie V2 pour IaaS qui prend en charge les sauvegardes horaires.
SubProtectionPolicy	Stratégie de sous-protection qui inclut la planification et la rétention
TieringMode	Mode hiérarchisation pour contrôler la hiérarchisation automatique des points de récupération. Les valeurs prises en charge sont les suivantes : TierRecommended : hiérarchisation de tous les points de récupération recommandés TierAfter : hiérarchisation de tous les points de récupération après une période fixe, comme spécifié dans durée + durationType ci-dessous. DoNotTier : ne hiérarchisation d’aucun point de récupération
TieringPolicy	Stratégie de hiérarchisation pour un niveau cible. Si la stratégie n’est pas spécifiée pour un niveau cible donné, le service conserve la stratégie de hiérarchisation configurée existante pour ce niveau
WeeklyRetentionFormat	Format de rétention hebdomadaire.
WeeklyRetentionSchedule	Planification de la rétention hebdomadaire.
WeeklySchedule
WeekOfMonth	Liste des semaines du mois.
WorkloadType	Type de charge de travail pour la gestion des sauvegardes
YearlyRetentionSchedule	Planification de rétention annuelle.

AzureFileShareProtectionPolicy

Stratégie de sauvegarde AzureStorage.

Nom	Type	Description
backupManagementType	string: AzureStorage	Cette propriété sera utilisée comme discriminateur pour décider des types spécifiques dans la chaîne polymorphe de types.
protectedItemsCount	integer	Nombre d’éléments associés à cette stratégie.
resourceGuardOperationRequests	string[]	Demandes d’opération ResourceGuard
retentionPolicy	RetentionPolicy: LongTermRetentionPolicy SimpleRetentionPolicy	Stratégie de rétention avec les détails sur les plages de rétention de copie de sauvegarde.
schedulePolicy	SchedulePolicy: LogSchedulePolicy LongTermSchedulePolicy SimpleSchedulePolicy SimpleSchedulePolicyV2	Planification de sauvegarde spécifiée dans le cadre de la stratégie de sauvegarde.
timeZone	string	Entrée facultative TimeZone en tant que chaîne. Par exemple : TimeZone = « Pacific Standard Time ».
workLoadType	WorkloadType	Type de charge de travail pour la gestion des sauvegardes

AzureIaaSVMProtectionPolicy

Stratégie de sauvegarde spécifique à la charge de travail des machines virtuelles IaaS.

Nom	Type	Description
backupManagementType	string: AzureIaasVM	Cette propriété sera utilisée comme discriminateur pour décider des types spécifiques dans la chaîne polymorphe de types.
instantRPDetails	InstantRPAdditionalDetails
instantRpRetentionRangeInDays	integer	Plage de stratégie de rétention de rp instantanée en jours
policyType	IAASVMPolicyType
protectedItemsCount	integer	Nombre d’éléments associés à cette stratégie.
resourceGuardOperationRequests	string[]	Demandes d’opération ResourceGuard
retentionPolicy	RetentionPolicy: LongTermRetentionPolicy SimpleRetentionPolicy	Stratégie de rétention avec les détails sur les plages de rétention de copie de sauvegarde.
schedulePolicy	SchedulePolicy: LogSchedulePolicy LongTermSchedulePolicy SimpleSchedulePolicy SimpleSchedulePolicyV2	Planification de sauvegarde spécifiée dans le cadre de la stratégie de sauvegarde.
tieringPolicy	<string,  TieringPolicy>	Stratégie de hiérarchisation pour déplacer automatiquement les fournisseurs de services vers un autre niveau La clé est Le niveau cible, défini dans l’énumération RecoveryPointTierType. La stratégie de hiérarchisation spécifie les critères pour déplacer le rp vers le niveau cible.
timeZone	string	Entrée facultative TimeZone en tant que chaîne. Par exemple : TimeZone = « Pacific Standard Time ».

AzureSqlProtectionPolicy

Azure SQL stratégie de sauvegarde spécifique à la charge de travail.

Nom	Type	Description
backupManagementType	string: AzureSql	Cette propriété sera utilisée comme discriminateur pour décider des types spécifiques dans la chaîne polymorphe de types.
protectedItemsCount	integer	Nombre d’éléments associés à cette stratégie.
resourceGuardOperationRequests	string[]	Demandes d’opération ResourceGuard
retentionPolicy	RetentionPolicy: LongTermRetentionPolicy SimpleRetentionPolicy	Détails de la stratégie de rétention.

AzureVmWorkloadProtectionPolicy

Stratégie de sauvegarde propre à la charge de travail des machines virtuelles Azure (Mercury).

Nom	Type	Description
backupManagementType	string: AzureWorkload	Cette propriété sera utilisée comme discriminateur pour décider des types spécifiques dans la chaîne polymorphe de types.
makePolicyConsistent	boolean	Corriger l’incohérence de la stratégie
protectedItemsCount	integer	Nombre d’éléments associés à cette stratégie.
resourceGuardOperationRequests	string[]	Demandes d’opération ResourceGuard
settings	Settings	Paramètres courants pour la gestion des sauvegardes
subProtectionPolicy	SubProtectionPolicy[]	Liste des stratégies de sous-protection incluant la planification et la rétention
workLoadType	WorkloadType	Type de charge de travail pour la gestion des sauvegardes

CloudError

Réponse d’erreur du service Container Instance.

Nom	Type	Description
error	CloudErrorBody	Objet error.

CloudErrorBody

Réponse d’erreur du service Container Instance.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Identificateur de l'erreur. Les codes sont invariants et sont destinés à être consommés par programmation.
details	CloudErrorBody[]	Liste des détails supplémentaires sur l’erreur.
message	string	Message décrivant l’erreur, destiné à être affiché dans une interface utilisateur.
target	string	Cible de l’erreur particulière. Par exemple, le nom de la propriété dans l’erreur.

DailyRetentionFormat

Format de rétention quotidien.

Nom	Type	Description
daysOfTheMonth	Day[]	Liste des jours du mois.

DailyRetentionSchedule

Planification quotidienne de la rétention.

Nom	Type	Description
retentionDuration	RetentionDuration	Durée de rétention de la stratégie de rétention.
retentionTimes	string[]	Durées de rétention de la stratégie de rétention.

DailySchedule

Nom	Type	Description
scheduleRunTimes	string[]	Liste des heures de la journée où cette planification doit être exécutée.

Day

Jour de la semaine.

Nom	Type	Description
date	integer	Date du mois
isLast	boolean	Si Date est la dernière date du mois

DayOfWeek

Nom	Type	Description
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires
type	string	Type d’informations supplémentaires.

GenericProtectionPolicy

Stratégie de sauvegarde propre à la charge de travail des machines virtuelles Azure (Mercury).

Nom	Type	Description
backupManagementType	string: GenericProtectionPolicy	Cette propriété sera utilisée comme discriminateur pour décider des types spécifiques dans la chaîne polymorphe de types.
fabricName	string	Nom de l’infrastructure de cette stratégie.
protectedItemsCount	integer	Nombre d’éléments associés à cette stratégie.
resourceGuardOperationRequests	string[]	Demandes d’opération ResourceGuard
subProtectionPolicy	SubProtectionPolicy[]	Liste des stratégies de sous-protection incluant la planification et la rétention
timeZone	string	Entrée facultative TimeZone en tant que chaîne. Par exemple : TimeZone = « Pacific Standard Time ».

HourlySchedule

Nom	Type	Description
interval	integer	Intervalle auquel la sauvegarde doit être déclenchée. Pour une heure, la valeur peut être 4/6/8/12
scheduleWindowDuration	integer	Pour spécifier la durée de la fenêtre de sauvegarde
scheduleWindowStartTime	string	Pour spécifier l’heure de début de la fenêtre de sauvegarde

IAASVMPolicyType

Nom	Type	Description
Invalid	string
V1	string
V2	string

InstantRPAdditionalDetails

Nom	Type	Description
azureBackupRGNamePrefix	string
azureBackupRGNameSuffix	string

LogSchedulePolicy

Planification de la stratégie de journalisation.

Nom	Type	Description
scheduleFrequencyInMins	integer	Fréquence de l’opération de planification des journaux de cette stratégie en minutes.
schedulePolicyType	string: LogSchedulePolicy	Cette propriété sera utilisée comme discriminateur pour décider des types spécifiques dans la chaîne polymorphe de types.

LongTermRetentionPolicy

Stratégie de rétention à long terme.

Nom	Type	Description
dailySchedule	DailyRetentionSchedule	Planification de rétention quotidienne de la stratégie de protection.
monthlySchedule	MonthlyRetentionSchedule	Planification de rétention mensuelle de la stratégie de protection.
retentionPolicyType	string: LongTermRetentionPolicy	Cette propriété sera utilisée comme discriminateur pour décider des types spécifiques dans la chaîne polymorphe de types.
weeklySchedule	WeeklyRetentionSchedule	Planification de rétention hebdomadaire de la stratégie de protection.
yearlySchedule	YearlyRetentionSchedule	Planification de rétention annuelle de la stratégie de protection.

LongTermSchedulePolicy

Planification de stratégie à long terme.

Nom	Type	Description
schedulePolicyType	string: LongTermSchedulePolicy	Cette propriété sera utilisée comme discriminateur pour décider des types spécifiques dans la chaîne polymorphe de types.

MabProtectionPolicy

Stratégie de sauvegarde spécifique au conteneur Mab.

Nom	Type	Description
backupManagementType	string: MAB	Cette propriété sera utilisée comme discriminateur pour décider des types spécifiques dans la chaîne polymorphe de types.
protectedItemsCount	integer	Nombre d’éléments associés à cette stratégie.
resourceGuardOperationRequests	string[]	Demandes d’opération ResourceGuard
retentionPolicy	RetentionPolicy: LongTermRetentionPolicy SimpleRetentionPolicy	Détails de la stratégie de rétention.
schedulePolicy	SchedulePolicy: LogSchedulePolicy LongTermSchedulePolicy SimpleSchedulePolicy SimpleSchedulePolicyV2	Planification de sauvegarde de la stratégie de sauvegarde.

MonthlyRetentionSchedule

Planification de rétention mensuelle.

Nom	Type	Description
retentionDuration	RetentionDuration	Durée de rétention de la stratégie de rétention.
retentionScheduleDaily	DailyRetentionFormat	Format de rétention quotidien pour la stratégie de rétention mensuelle.
retentionScheduleFormatType	RetentionScheduleFormat	Type de format de planification de rétention pour la stratégie de rétention mensuelle.
retentionScheduleWeekly	WeeklyRetentionFormat	Format de rétention hebdomadaire pour la stratégie de rétention mensuelle.
retentionTimes	string[]	Durées de rétention de la stratégie de rétention.

MonthOfYear

Liste des mois de l’année de la stratégie de rétention annuelle.

Nom	Type	Description
April	string
August	string
December	string
February	string
Invalid	string
January	string
July	string
June	string
March	string
May	string
November	string
October	string
September	string

PolicyType

Type de type de stratégie de sauvegarde

Nom	Type	Description
CopyOnlyFull	string
Differential	string
Full	string
Incremental	string
Invalid	string
Log	string
SnapshotCopyOnlyFull	string
SnapshotFull	string

ProtectionPolicyResource

Classe de base pour la stratégie de sauvegarde. Les stratégies de sauvegarde spécifiques à la charge de travail sont dérivées de cette classe.

Nom	Type	Description
eTag	string	ETag facultatif.
id	string	Id de ressource représente le chemin d’accès complet à la ressource.
location	string	Emplacement de la ressource.
name	string	Nom de la ressource associé à la ressource.
properties	ProtectionPolicy: AzureFileShareProtectionPolicy AzureIaaSVMProtectionPolicy AzureSqlProtectionPolicy AzureVmWorkloadProtectionPolicy GenericProtectionPolicy MabProtectionPolicy	Propriétés de ProtectionPolicyResource
tags	object	Balises de ressource.
type	string	Le type de ressource représente le chemin d’accès complet sous la forme Namespace/ResourceType/ResourceType/...

ProtectionPolicyResourceList

Liste des ressources ProtectionPolicy

Nom	Type	Description
nextLink	string	URI permettant d’extraire la page de ressources suivante. L’appel ListNext() extrait la page suivante de ressources.
value	ProtectionPolicyResource[]	Liste des ressources.

RetentionDuration

Durée de rétention.

Nom	Type	Description
count	integer	Nombre de types de durée. La durée de rétention est obtenue en comptant le type de durée Nombre d’heures. Par exemple, lorsque Count = 3 et DurationType = Semaines, la durée de rétention est de trois semaines.
durationType	RetentionDurationType	Type de durée de rétention de la stratégie de rétention.

RetentionDurationType

Type de durée de rétention : jours/semaines/mois/années Utilisé uniquement si TieringMode est défini sur TierAfter

Nom	Type	Description
Days	string
Invalid	string
Months	string
Weeks	string
Years	string

RetentionScheduleFormat

Type de format de planification de rétention pour la stratégie de rétention mensuelle.

Nom	Type	Description
Daily	string
Invalid	string
Weekly	string

ScheduleRunType

Fréquence de l’opération de planification de cette stratégie.

Nom	Type	Description
Daily	string
Hourly	string
Invalid	string
Weekly	string

Settings

Champ Paramètres courants pour la gestion des sauvegardes

Nom	Type	Description
isCompression	boolean	Indicateur de compression de charge de travail. Cela a été ajouté afin que « isSqlCompression » soit déprécié une fois que les clients ont effectué la mise à niveau pour prendre en compte cet indicateur.
issqlcompression	boolean	Indicateur de compression SQL
timeZone	string	Entrée facultative TimeZone en tant que chaîne. Par exemple : TimeZone = « Pacific Standard Time ».

SimpleRetentionPolicy

Rétention de stratégie simple.

Nom	Type	Description
retentionDuration	RetentionDuration	Durée de conservation de la stratégie de protection.
retentionPolicyType	string: SimpleRetentionPolicy	Cette propriété sera utilisée comme discriminateur pour décider des types spécifiques dans la chaîne polymorphe de types.

SimpleSchedulePolicy

Planification de stratégie simple.

Nom	Type	Description
hourlySchedule	HourlySchedule	Planification horaire de cette stratégie
schedulePolicyType	string: SimpleSchedulePolicy	Cette propriété sera utilisée comme discriminateur pour décider des types spécifiques dans la chaîne polymorphe de types.
scheduleRunDays	DayOfWeek[]	Liste des jours de la semaine où cette planification doit être exécutée.
scheduleRunFrequency	ScheduleRunType	Fréquence de l’opération de planification de cette stratégie.
scheduleRunTimes	string[]	Liste des heures de la journée où cette planification doit être exécutée.
scheduleWeeklyFrequency	integer	À chaque semaine de nombre, cette planification doit être exécutée.

SimpleSchedulePolicyV2

Planification de stratégie V2 pour IaaS qui prend en charge les sauvegardes horaires.

Nom	Type	Description
dailySchedule	DailySchedule	Planification quotidienne de cette stratégie
hourlySchedule	HourlySchedule	Planification horaire de cette stratégie
schedulePolicyType	string: SimpleSchedulePolicyV2	Cette propriété sera utilisée comme discriminateur pour décider des types spécifiques dans la chaîne polymorphe de types.
scheduleRunFrequency	ScheduleRunType	Fréquence de l’opération de planification de cette stratégie.
weeklySchedule	WeeklySchedule	Planification hebdomadaire de cette stratégie

SubProtectionPolicy

Stratégie de sous-protection qui inclut la planification et la rétention

Nom	Type	Description
policyType	PolicyType	Type de type de stratégie de sauvegarde
retentionPolicy	RetentionPolicy: LongTermRetentionPolicy SimpleRetentionPolicy	Stratégie de rétention avec les détails sur les plages de rétention de copie de sauvegarde.
schedulePolicy	SchedulePolicy: LogSchedulePolicy LongTermSchedulePolicy SimpleSchedulePolicy SimpleSchedulePolicyV2	Planification de sauvegarde spécifiée dans le cadre de la stratégie de sauvegarde.
tieringPolicy	<string,  TieringPolicy>	Stratégie de hiérarchisation pour déplacer automatiquement les programmes de requête vers un autre niveau. La clé est le niveau cible, défini dans l’énumération RecoveryPointTierType. La stratégie de hiérarchisation spécifie les critères pour déplacer le rp vers le niveau cible.

TieringMode

Mode hiérarchisation pour contrôler la hiérarchisation automatique des points de récupération. Les valeurs prises en charge sont les suivantes :

1. TierRecommended : hiérarchisation de tous les points de récupération recommandés
2. TierAfter : hiérarchisation de tous les points de récupération après une période fixe, comme spécifié dans durée + durationType ci-dessous.
3. DoNotTier : ne hiérarchisation d’aucun point de récupération

Nom	Type	Description
DoNotTier	string
Invalid	string
TierAfter	string
TierRecommended	string

TieringPolicy

Stratégie de hiérarchisation pour un niveau cible. Si la stratégie n’est pas spécifiée pour un niveau cible donné, le service conserve la stratégie de hiérarchisation configurée existante pour ce niveau

Nom	Type	Description
duration	integer	Nombre de jours/semaines/mois/années pour conserver les sauvegardes au niveau actuel avant la hiérarchisation. Utilisé uniquement si TieringMode est défini sur TierAfter
durationType	RetentionDurationType	Type de durée de rétention : jours/semaines/mois/années Utilisé uniquement si TieringMode est défini sur TierAfter
tieringMode	TieringMode	Mode hiérarchisation pour contrôler la hiérarchisation automatique des points de récupération. Les valeurs prises en charge sont les suivantes : TierRecommended : hiérarchisation de tous les points de récupération recommandés TierAfter : hiérarchisation de tous les points de récupération après une période fixe, comme spécifié dans duration + durationType ci-dessous. DoNotTier : Ne hiérarchisation des points de récupération

WeeklyRetentionFormat

Format de rétention hebdomadaire.

Nom	Type	Description
daysOfTheWeek	DayOfWeek[]	Liste des jours de la semaine.
weeksOfTheMonth	WeekOfMonth[]	Liste des semaines du mois.

WeeklyRetentionSchedule

Planification de la rétention hebdomadaire.

Nom	Type	Description
daysOfTheWeek	DayOfWeek[]	Liste des jours de la semaine pour la stratégie de rétention hebdomadaire.
retentionDuration	RetentionDuration	Durée de rétention de la stratégie de rétention.
retentionTimes	string[]	Durées de rétention de la stratégie de rétention.

WeeklySchedule

Nom	Type	Description
scheduleRunDays	DayOfWeek[]
scheduleRunTimes	string[]	Liste des heures de la journée où cette planification doit être exécutée.

WeekOfMonth

Liste des semaines du mois.

Nom	Type	Description
First	string
Fourth	string
Invalid	string
Last	string
Second	string
Third	string

WorkloadType

Type de charge de travail pour la gestion des sauvegardes

Nom	Type	Description
AzureFileShare	string
AzureSqlDb	string
Client	string
Exchange	string
FileFolder	string
GenericDataSource	string
Invalid	string
SAPAseDatabase	string
SAPHanaDBInstance	string
SAPHanaDatabase	string
SQLDB	string
SQLDataBase	string
Sharepoint	string
SystemState	string
VM	string
VMwareVM	string

YearlyRetentionSchedule

Planification de rétention annuelle.

Nom	Type	Description
monthsOfYear	MonthOfYear[]	Liste des mois de l’année de la stratégie de rétention annuelle.
retentionDuration	RetentionDuration	Durée de rétention de la stratégie de rétention.
retentionScheduleDaily	DailyRetentionFormat	Format de rétention quotidien pour la stratégie de rétention annuelle.
retentionScheduleFormatType	RetentionScheduleFormat	Format de planification de rétention pour la stratégie de rétention annuelle.
retentionScheduleWeekly	WeeklyRetentionFormat	Format de rétention hebdomadaire pour la stratégie de rétention annuelle.
retentionTimes	string[]	Durées de rétention de la stratégie de rétention.