Backup Policies - List

Service:

Recovery Services - Backup

API Version:

2023-02-01

Listas de directivas de copia de seguridad asociadas al almacén de Recovery Services. La API proporciona parámetros de paginación para capturar los resultados con ámbito.

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}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string	Nombre del grupo de recursos donde está presente el almacén de Recovery Services.
subscriptionId	path	True	string	Identificador de suscripción.
vaultName	path	True	string	Nombre del almacén de Recovery Services.
api-version	query	True	string	Versión de api de cliente.
$filter	query		string	Opciones de filtro de OData.

Respuestas

Nombre	Tipo	Description
200 OK	ProtectionPolicyResourceList	Aceptar
Other Status Codes	CloudError	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

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

Scopes

Nombre	Description
user_impersonation	suplantar la cuenta de usuario.

Ejemplos

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

Definiciones

Nombre	Description
AzureFileShareProtectionPolicy	Directiva de copia de seguridad de AzureStorage.
AzureIaaSVMProtectionPolicy	Directiva de copia de seguridad específica de la carga de trabajo de vm iaaS.
AzureSqlProtectionPolicy	Azure SQL directiva de copia de seguridad específica de la carga de trabajo.
AzureVmWorkloadProtectionPolicy	Directiva de copia de seguridad específica de la carga de trabajo de máquina virtual de Azure (Mercury).
CloudError	Respuesta de error del servicio Container Instance.
CloudErrorBody	Respuesta de error del servicio Container Instance.
DailyRetentionFormat	Formato de retención diaria.
DailyRetentionSchedule	Programación de retención diaria.
DailySchedule
Day	Día de la semana.
DayOfWeek
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
GenericProtectionPolicy	Directiva de copia de seguridad específica de la carga de trabajo de máquina virtual de Azure (Mercury).
HourlySchedule
IAASVMPolicyType
InstantRPAdditionalDetails
LogSchedulePolicy	Programación de la directiva de registro.
LongTermRetentionPolicy	Directiva de retención a largo plazo.
LongTermSchedulePolicy	Programación de directivas a largo plazo.
MabProtectionPolicy	Directiva de copia de seguridad específica del contenedor de Mab.
MonthlyRetentionSchedule	Programación de retención mensual.
MonthOfYear	Lista de meses de la directiva de retención anual.
PolicyType	Tipo de directiva de copia de seguridad
ProtectionPolicyResource	Clase base para la directiva de copia de seguridad. Las directivas de copia de seguridad específicas de la carga de trabajo se derivan de esta clase.
ProtectionPolicyResourceList	Lista de recursos de ProtectionPolicy
RetentionDuration	Duración de retención.
RetentionDurationType	Tipo de duración de retención: días, semanas, meses o años Usados solo si TieringMode está establecido en TierAfter
RetentionScheduleFormat	Tipo de formato de programación de retención para la directiva de retención mensual.
ScheduleRunType	Frecuencia de la operación de programación de esta directiva.
Settings	Campo de configuración común para la administración de copias de seguridad
SimpleRetentionPolicy	Retención de directivas sencilla.
SimpleSchedulePolicy	Programación de directivas sencilla.
SimpleSchedulePolicyV2	La programación de directivas V2 para IaaS que admite copias de seguridad por hora.
SubProtectionPolicy	Directiva de subprotección que incluye programación y retención
TieringMode	Modo de niveles para controlar la clasificación automática por niveles de los puntos de recuperación. Los valores admitidos son: TierRecommended: se recomienda organizar todos los puntos de recuperación por niveles. TierAfter: tier all recovery points after a fixed period, as specified in duration + durationType below. DoNotTier: no organizar ningún punto de recuperación
TieringPolicy	Directiva de niveles para un nivel de destino. Si no se especifica la directiva para un nivel de destino determinado, el servicio conserva la directiva de niveles configurada existente para ese nivel.
WeeklyRetentionFormat	Formato de retención semanal.
WeeklyRetentionSchedule	Programación de retención semanal.
WeeklySchedule
WeekOfMonth	Lista de semanas del mes.
WorkloadType	Tipo de carga de trabajo para la administración de copias de seguridad
YearlyRetentionSchedule	Programación de retención anual.

AzureFileShareProtectionPolicy

Directiva de copia de seguridad de AzureStorage.

Nombre	Tipo	Description
backupManagementType	string: AzureStorage	Esta propiedad se usará como discriminador para decidir los tipos específicos en la cadena polimórfica de tipos.
protectedItemsCount	integer	Número de elementos asociados a esta directiva.
resourceGuardOperationRequests	string[]	Solicitudes de operación de ResourceGuard
retentionPolicy	RetentionPolicy: LongTermRetentionPolicy SimpleRetentionPolicy	Directiva de retención con los detalles sobre los intervalos de retención de copia de seguridad.
schedulePolicy	SchedulePolicy: LogSchedulePolicy LongTermSchedulePolicy SimpleSchedulePolicy SimpleSchedulePolicyV2	Programación de copia de seguridad especificada como parte de la directiva de copia de seguridad.
timeZone	string	Entrada opcional timeZone como cadena. Por ejemplo: TimeZone = "Hora estándar del Pacífico".
workLoadType	WorkloadType	Tipo de carga de trabajo para la administración de copias de seguridad

AzureIaaSVMProtectionPolicy

Directiva de copia de seguridad específica de la carga de trabajo de vm iaaS.

Nombre	Tipo	Description
backupManagementType	string: AzureIaasVM	Esta propiedad se usará como discriminador para decidir los tipos específicos en la cadena polimórfica de tipos.
instantRPDetails	InstantRPAdditionalDetails
instantRpRetentionRangeInDays	integer	Intervalo de directivas de retención instantánea de RP en días
policyType	IAASVMPolicyType
protectedItemsCount	integer	Número de elementos asociados a esta directiva.
resourceGuardOperationRequests	string[]	Solicitudes de operación de ResourceGuard
retentionPolicy	RetentionPolicy: LongTermRetentionPolicy SimpleRetentionPolicy	Directiva de retención con los detalles sobre los intervalos de retención de copia de seguridad.
schedulePolicy	SchedulePolicy: LogSchedulePolicy LongTermSchedulePolicy SimpleSchedulePolicy SimpleSchedulePolicyV2	Programación de copia de seguridad especificada como parte de la directiva de copia de seguridad.
tieringPolicy	<string,  TieringPolicy>	La directiva de niveles para mover automáticamente los RP a otra clave de nivel es el nivel de destino, definido en la enumeración RecoveryPointTierType. La directiva de niveles especifica los criterios para mover rp al nivel de destino.
timeZone	string	Entrada opcional timeZone como cadena. Por ejemplo: TimeZone = "Hora estándar del Pacífico".

AzureSqlProtectionPolicy

Azure SQL directiva de copia de seguridad específica de la carga de trabajo.

Nombre	Tipo	Description
backupManagementType	string: AzureSql	Esta propiedad se usará como discriminador para decidir los tipos específicos en la cadena polimórfica de tipos.
protectedItemsCount	integer	Número de elementos asociados a esta directiva.
resourceGuardOperationRequests	string[]	Solicitudes de operación de ResourceGuard
retentionPolicy	RetentionPolicy: LongTermRetentionPolicy SimpleRetentionPolicy	Detalles de la directiva de retención.

AzureVmWorkloadProtectionPolicy

Directiva de copia de seguridad específica de la carga de trabajo de máquina virtual de Azure (Mercury).

Nombre	Tipo	Description
backupManagementType	string: AzureWorkload	Esta propiedad se usará como discriminador para decidir los tipos específicos en la cadena polimórfica de tipos.
makePolicyConsistent	boolean	Corrección de la incoherencia de la directiva
protectedItemsCount	integer	Número de elementos asociados a esta directiva.
resourceGuardOperationRequests	string[]	Solicitudes de operación de ResourceGuard
settings	Settings	Configuración común para la administración de copias de seguridad
subProtectionPolicy	SubProtectionPolicy[]	Lista de directivas de subprotección que incluyen programación y retención
workLoadType	WorkloadType	Tipo de carga de trabajo para la administración de copias de seguridad

CloudError

Respuesta de error del servicio Container Instance.

Nombre	Tipo	Description
error	CloudErrorBody	Objeto de error.

CloudErrorBody

Respuesta de error del servicio Container Instance.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
details	CloudErrorBody[]	Lista de detalles adicionales sobre el error.
message	string	Mensaje que describe el error, diseñado para ser adecuado para su presentación en una interfaz de usuario.
target	string	Destino del error determinado. Por ejemplo, el nombre de la propiedad en error.

DailyRetentionFormat

Formato de retención diaria.

Nombre	Tipo	Description
daysOfTheMonth	Day[]	Lista de días del mes.

DailyRetentionSchedule

Programación de retención diaria.

Nombre	Tipo	Description
retentionDuration	RetentionDuration	Duración de retención de la directiva de retención.
retentionTimes	string[]	Tiempos de retención de la directiva de retención.

DailySchedule

Nombre	Tipo	Description
scheduleRunTimes	string[]	Lista de horas del día que debe ejecutarse esta programación.

Day

Día de la semana.

Nombre	Tipo	Description
date	integer	Fecha del mes
isLast	boolean	Si Date es la última fecha del mes

DayOfWeek

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

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

GenericProtectionPolicy

Directiva de copia de seguridad específica de la carga de trabajo de máquina virtual de Azure (Mercury).

Nombre	Tipo	Description
backupManagementType	string: GenericProtectionPolicy	Esta propiedad se usará como discriminador para decidir los tipos específicos en la cadena polimórfica de tipos.
fabricName	string	Nombre del tejido de esta directiva.
protectedItemsCount	integer	Número de elementos asociados a esta directiva.
resourceGuardOperationRequests	string[]	Solicitudes de operación de ResourceGuard
subProtectionPolicy	SubProtectionPolicy[]	Lista de directivas de subprotección que incluyen programación y retención
timeZone	string	Entrada opcional timeZone como cadena. Por ejemplo: TimeZone = "Hora estándar del Pacífico".

HourlySchedule

Nombre	Tipo	Description
interval	integer	Intervalo en el que se debe desencadenar la copia de seguridad. Para cada hora, el valor puede ser 4/6/8/12
scheduleWindowDuration	integer	Para especificar la duración de la ventana de copia de seguridad
scheduleWindowStartTime	string	Para especificar la hora de inicio de la ventana de copia de seguridad

IAASVMPolicyType

Nombre	Tipo	Description
Invalid	string
V1	string
V2	string

InstantRPAdditionalDetails

Nombre	Tipo	Description
azureBackupRGNamePrefix	string
azureBackupRGNameSuffix	string

LogSchedulePolicy

Programación de la directiva de registro.

Nombre	Tipo	Description
scheduleFrequencyInMins	integer	Frecuencia de la operación de programación de registro de esta directiva en minutos.
schedulePolicyType	string: LogSchedulePolicy	Esta propiedad se usará como discriminador para decidir los tipos específicos en la cadena polimórfica de tipos.

LongTermRetentionPolicy

Directiva de retención a largo plazo.

Nombre	Tipo	Description
dailySchedule	DailyRetentionSchedule	Programación de retención diaria de la directiva de protección.
monthlySchedule	MonthlyRetentionSchedule	Programación de retención mensual de la directiva de protección.
retentionPolicyType	string: LongTermRetentionPolicy	Esta propiedad se usará como discriminador para decidir los tipos específicos en la cadena polimórfica de tipos.
weeklySchedule	WeeklyRetentionSchedule	Programación de retención semanal de la directiva de protección.
yearlySchedule	YearlyRetentionSchedule	Programación de retención anual de la directiva de protección.

LongTermSchedulePolicy

Programación de directivas a largo plazo.

Nombre	Tipo	Description
schedulePolicyType	string: LongTermSchedulePolicy	Esta propiedad se usará como discriminador para decidir los tipos específicos en la cadena polimórfica de tipos.

MabProtectionPolicy

Directiva de copia de seguridad específica del contenedor de Mab.

Nombre	Tipo	Description
backupManagementType	string: MAB	Esta propiedad se usará como discriminador para decidir los tipos específicos en la cadena polimórfica de tipos.
protectedItemsCount	integer	Número de elementos asociados a esta directiva.
resourceGuardOperationRequests	string[]	Solicitudes de operación de ResourceGuard
retentionPolicy	RetentionPolicy: LongTermRetentionPolicy SimpleRetentionPolicy	Detalles de la directiva de retención.
schedulePolicy	SchedulePolicy: LogSchedulePolicy LongTermSchedulePolicy SimpleSchedulePolicy SimpleSchedulePolicyV2	Programación de copia de seguridad de la directiva de copia de seguridad.

MonthlyRetentionSchedule

Programación de retención mensual.

Nombre	Tipo	Description
retentionDuration	RetentionDuration	Duración de retención de la directiva de retención.
retentionScheduleDaily	DailyRetentionFormat	Formato de retención diaria para la directiva de retención mensual.
retentionScheduleFormatType	RetentionScheduleFormat	Tipo de formato de programación de retención para la directiva de retención mensual.
retentionScheduleWeekly	WeeklyRetentionFormat	Formato de retención semanal para la directiva de retención mensual.
retentionTimes	string[]	Tiempos de retención de la directiva de retención.

MonthOfYear

Lista de meses de la directiva de retención anual.

Nombre	Tipo	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

Tipo de directiva de copia de seguridad

Nombre	Tipo	Description
CopyOnlyFull	string
Differential	string
Full	string
Incremental	string
Invalid	string
Log	string
SnapshotCopyOnlyFull	string
SnapshotFull	string

ProtectionPolicyResource

Clase base para la directiva de copia de seguridad. Las directivas de copia de seguridad específicas de la carga de trabajo se derivan de esta clase.

Nombre	Tipo	Description
eTag	string	ETag opcional.
id	string	El identificador de recurso representa la ruta de acceso completa al recurso.
location	string	Ubicación del recurso
name	string	Nombre del recurso asociado al recurso.
properties	ProtectionPolicy: AzureFileShareProtectionPolicy AzureIaaSVMProtectionPolicy AzureSqlProtectionPolicy AzureVmWorkloadProtectionPolicy GenericProtectionPolicy MabProtectionPolicy	Propiedades de ProtectionPolicyResource
tags	object	Etiquetas del recurso.
type	string	El tipo de recurso representa la ruta de acceso completa del formulario Namespace/ResourceType/ResourceType/...

ProtectionPolicyResourceList

Lista de recursos de ProtectionPolicy

Nombre	Tipo	Description
nextLink	string	URI para capturar la página siguiente de recursos. La llamada a ListNext() captura la página siguiente de recursos.
value	ProtectionPolicyResource[]	Lista de recursos.

RetentionDuration

Duración de retención.

Nombre	Tipo	Description
count	integer	Recuento de tipos de duración. La duración de retención se obtiene mediante el recuento del tipo de duración Tiempos de recuento. Por ejemplo, cuando Count = 3 y DurationType = Weeks, la duración de la retención será de tres semanas.
durationType	RetentionDurationType	Tipo de duración de retención de la directiva de retención.

RetentionDurationType

Tipo de duración de retención: días, semanas, meses o años Usados solo si TieringMode está establecido en TierAfter

Nombre	Tipo	Description
Days	string
Invalid	string
Months	string
Weeks	string
Years	string

RetentionScheduleFormat

Tipo de formato de programación de retención para la directiva de retención mensual.

Nombre	Tipo	Description
Daily	string
Invalid	string
Weekly	string

ScheduleRunType

Frecuencia de la operación de programación de esta directiva.

Nombre	Tipo	Description
Daily	string
Hourly	string
Invalid	string
Weekly	string

Settings

Campo de configuración común para la administración de copias de seguridad

Nombre	Tipo	Description
isCompression	boolean	Marca de compresión de carga de trabajo. Esto se ha agregado para que "isSqlCompression" esté en desuso una vez que los clientes actualicen para considerar esta marca.
issqlcompression	boolean	Marca de compresión de SQL
timeZone	string	Entrada opcional timeZone como cadena. Por ejemplo: TimeZone = "Hora estándar del Pacífico".

SimpleRetentionPolicy

Retención de directivas sencilla.

Nombre	Tipo	Description
retentionDuration	RetentionDuration	Duración de la retención de la directiva de protección.
retentionPolicyType	string: SimpleRetentionPolicy	Esta propiedad se usará como discriminador para decidir los tipos específicos en la cadena polimórfica de tipos.

SimpleSchedulePolicy

Programación de directivas sencilla.

Nombre	Tipo	Description
hourlySchedule	HourlySchedule	Programación por hora de esta directiva
schedulePolicyType	string: SimpleSchedulePolicy	Esta propiedad se usará como discriminador para decidir los tipos específicos en la cadena polimórfica de tipos.
scheduleRunDays	DayOfWeek[]	Lista de días de la semana que debe ejecutarse esta programación.
scheduleRunFrequency	ScheduleRunType	Frecuencia de la operación de programación de esta directiva.
scheduleRunTimes	string[]	Lista de horas del día que debe ejecutarse esta programación.
scheduleWeeklyFrequency	integer	En cada número de semanas debe ejecutarse esta programación.

SimpleSchedulePolicyV2

La programación de directivas V2 para IaaS que admite copias de seguridad por hora.

Nombre	Tipo	Description
dailySchedule	DailySchedule	Programación diaria de esta directiva
hourlySchedule	HourlySchedule	programación por hora de esta directiva
schedulePolicyType	string: SimpleSchedulePolicyV2	Esta propiedad se usará como discriminador para decidir los tipos específicos en la cadena polimórfica de tipos.
scheduleRunFrequency	ScheduleRunType	Frecuencia de la operación de programación de esta directiva.
weeklySchedule	WeeklySchedule	Programación semanal de esta directiva

SubProtectionPolicy

Directiva de subprotección que incluye programación y retención

Nombre	Tipo	Description
policyType	PolicyType	Tipo de directiva de copia de seguridad
retentionPolicy	RetentionPolicy: LongTermRetentionPolicy SimpleRetentionPolicy	Directiva de retención con los detalles sobre los intervalos de retención de copia de seguridad.
schedulePolicy	SchedulePolicy: LogSchedulePolicy LongTermSchedulePolicy SimpleSchedulePolicy SimpleSchedulePolicyV2	Programación de copia de seguridad especificada como parte de la directiva de copia de seguridad.
tieringPolicy	<string,  TieringPolicy>	Directiva de organización por niveles para mover automáticamente los RP a otro nivel. La clave es nivel de destino, definida en la enumeración RecoveryPointTierType. La directiva de niveles especifica los criterios para mover rp al nivel de destino.

TieringMode

Modo de niveles para controlar la clasificación automática por niveles de los puntos de recuperación. Los valores admitidos son:

1. TierRecommended: se recomienda organizar todos los puntos de recuperación por niveles.
2. TierAfter: tier all recovery points after a fixed period, as specified in duration + durationType below.
3. DoNotTier: no organizar ningún punto de recuperación

Nombre	Tipo	Description
DoNotTier	string
Invalid	string
TierAfter	string
TierRecommended	string

TieringPolicy

Directiva de niveles para un nivel de destino. Si no se especifica la directiva para un nivel de destino determinado, el servicio conserva la directiva de niveles configurada existente para ese nivel.

Nombre	Tipo	Description
duration	integer	Número de días, semanas, meses o años para conservar las copias de seguridad en el nivel actual antes de la creación de niveles. Solo se usa si TieringMode está establecido en TierAfter
durationType	RetentionDurationType	Tipo de duración de retención: días,semanas,meses/años Usados solo si TieringMode está establecido en TierAfter
tieringMode	TieringMode	Modo de niveles para controlar la ordenación automática por niveles de los puntos de recuperación. Los valores admitidos son: TierRecommended: se recomienda colocar en capas todos los puntos de recuperación. TierAfter: capa todos los puntos de recuperación después de un período fijo, como se especifica en duration + durationType a continuación. DoNotTier: No organizar ningún punto de recuperación

WeeklyRetentionFormat

Formato de retención semanal.

Nombre	Tipo	Description
daysOfTheWeek	DayOfWeek[]	Lista de días de la semana.
weeksOfTheMonth	WeekOfMonth[]	Lista de semanas del mes.

WeeklyRetentionSchedule

Programación de retención semanal.

Nombre	Tipo	Description
daysOfTheWeek	DayOfWeek[]	Lista de días de la semana para la directiva de retención semanal.
retentionDuration	RetentionDuration	Duración de retención de la directiva de retención.
retentionTimes	string[]	Tiempos de retención de la directiva de retención.

WeeklySchedule

Nombre	Tipo	Description
scheduleRunDays	DayOfWeek[]
scheduleRunTimes	string[]	Lista de horas del día que debe ejecutarse esta programación.

WeekOfMonth

Lista de semanas del mes.

Nombre	Tipo	Description
First	string
Fourth	string
Invalid	string
Last	string
Second	string
Third	string

WorkloadType

Tipo de carga de trabajo para la administración de copias de seguridad

Nombre	Tipo	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

Programación de retención anual.

Nombre	Tipo	Description
monthsOfYear	MonthOfYear[]	Lista de meses de la directiva de retención anual.
retentionDuration	RetentionDuration	Duración de retención de la directiva de retención.
retentionScheduleDaily	DailyRetentionFormat	Formato de retención diaria para la directiva de retención anual.
retentionScheduleFormatType	RetentionScheduleFormat	Formato de programación de retención para la directiva de retención anual.
retentionScheduleWeekly	WeeklyRetentionFormat	Formato de retención semanal para la directiva de retención anual.
retentionTimes	string[]	Tiempos de retención de la directiva de retención.