Backup Policies - List

Service:

Recovery Services - Backup

API Version:

2023-02-01

Listas de políticas de backup associadas ao Cofre dos Serviços de Recuperação. A API fornece parâmetros de paginação para buscar resultados com escopo.

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 URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos em que o cofre dos serviços de recuperação está presente.
subscriptionId	path	True	string	A ID da assinatura.
vaultName	path	True	string	O nome do cofre dos serviços de recuperação.
api-version	query	True	string	Versão da API do cliente.
$filter	query		string	Opções de filtro OData.

Respostas

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

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Scopes

Nome	Description
user_impersonation	represente sua conta de usuário.

Exemplos

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

Definições

Nome	Description
AzureFileShareProtectionPolicy	Política de backup do AzureStorage.
AzureIaaSVMProtectionPolicy	Política de backup específica da carga de trabalho da VM iaaS.
AzureSqlProtectionPolicy	SQL do Azure política de backup específica da carga de trabalho.
AzureVmWorkloadProtectionPolicy	Política de backup específica da carga de trabalho da VM do Azure (Mercury).
CloudError	Uma resposta de erro do serviço da Instância de Contêiner.
CloudErrorBody	Uma resposta de erro do serviço da Instância de Contêiner.
DailyRetentionFormat	Formato de retenção diária.
DailyRetentionSchedule	Agendamento de retenção diário.
DailySchedule
Day	Dia da semana.
DayOfWeek
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
GenericProtectionPolicy	Política de backup específica da carga de trabalho da VM do Azure (Mercury).
HourlySchedule
IAASVMPolicyType
InstantRPAdditionalDetails
LogSchedulePolicy	Agendamento da política de log.
LongTermRetentionPolicy	Política de retenção de longo prazo.
LongTermSchedulePolicy	Agendamento de política de longo prazo.
MabProtectionPolicy	Política de backup específica do contêiner do Mab.
MonthlyRetentionSchedule	Agendamento de retenção mensal.
MonthOfYear	Lista de meses do ano da política de retenção anual.
PolicyType	Tipo de tipo de política de backup
ProtectionPolicyResource	Classe base para política de backup. As políticas de backup específicas da carga de trabalho são derivadas dessa classe.
ProtectionPolicyResourceList	Lista de recursos protectionPolicy
RetentionDuration	Duração da retenção.
RetentionDurationType	Tipo de duração de retenção: dias/semanas/meses/anos Usado somente se TieringMode estiver definido como TierAfter
RetentionScheduleFormat	Tipo de formato de agendamento de retenção para a política de retenção mensal.
ScheduleRunType	Frequência da operação de agendamento dessa política.
Settings	Campo de configurações comuns para gerenciamento de backup
SimpleRetentionPolicy	Retenção de política simples.
SimpleSchedulePolicy	Agendamento de política simples.
SimpleSchedulePolicyV2	O agendamento da política V2 para IaaS que dá suporte a backups por hora.
SubProtectionPolicy	Política de subproteção que inclui agendamento e retenção
TieringMode	Modo de camada para controlar a camada automática de pontos de recuperação. Os valores com suporte são: TierRecommended: camada todos os pontos de recuperação recomendados para serem em camadas TierAfter: camada todos os pontos de recuperação após um período fixo, conforme especificado em duration + durationType abaixo. DoNotTier: não camada nenhum ponto de recuperação
TieringPolicy	Política de camadas para uma camada de destino. Se a política não for especificada para uma determinada camada de destino, o serviço manterá a política de camada configurada existente para essa camada
WeeklyRetentionFormat	Formato de retenção semanal.
WeeklyRetentionSchedule	Agendamento de retenção semanal.
WeeklySchedule
WeekOfMonth	Lista de semanas de mês.
WorkloadType	Tipo de carga de trabalho para o gerenciamento de backup
YearlyRetentionSchedule	Agendamento de retenção anual.

AzureFileShareProtectionPolicy

Política de backup do AzureStorage.

Nome	Tipo	Description
backupManagementType	string: AzureStorage	Essa propriedade será usada como discriminadora para decidir os tipos específicos na cadeia polimórfica de tipos.
protectedItemsCount	integer	Número de itens associados a essa política.
resourceGuardOperationRequests	string[]	Solicitações de operação do ResourceGuard
retentionPolicy	RetentionPolicy: LongTermRetentionPolicy SimpleRetentionPolicy	Política de retenção com os detalhes sobre intervalos de retenção de cópia de backup.
schedulePolicy	SchedulePolicy: LogSchedulePolicy LongTermSchedulePolicy SimpleSchedulePolicy SimpleSchedulePolicyV2	Agendamento de backup especificado como parte da política de backup.
timeZone	string	Entrada opcional de Fuso Horário como cadeia de caracteres. Por exemplo: Fuso Horário = "Hora Padrão do Pacífico".
workLoadType	WorkloadType	Tipo de carga de trabalho para o gerenciamento de backup

AzureIaaSVMProtectionPolicy

Política de backup específica da carga de trabalho da VM iaaS.

Nome	Tipo	Description
backupManagementType	string: AzureIaasVM	Essa propriedade será usada como discriminadora para decidir os tipos específicos na cadeia polimórfica de tipos.
instantRPDetails	InstantRPAdditionalDetails
instantRpRetentionRangeInDays	integer	Intervalo de política de retenção de RP instantâneo em dias
policyType	IAASVMPolicyType
protectedItemsCount	integer	Número de itens associados a essa política.
resourceGuardOperationRequests	string[]	Solicitações de operação do ResourceGuard
retentionPolicy	RetentionPolicy: LongTermRetentionPolicy SimpleRetentionPolicy	Política de retenção com os detalhes sobre intervalos de retenção de cópia de backup.
schedulePolicy	SchedulePolicy: LogSchedulePolicy LongTermSchedulePolicy SimpleSchedulePolicy SimpleSchedulePolicyV2	Agendamento de backup especificado como parte da política de backup.
tieringPolicy	<string,  TieringPolicy>	A política de camadas para mover RPs automaticamente para outra camada Key é a Camada de Destino, definida na enumeração RecoveryPointTierType. A política de camadas especifica os critérios para mover RP para a camada de destino.
timeZone	string	Entrada opcional de Fuso Horário como cadeia de caracteres. Por exemplo: Fuso Horário = "Hora Padrão do Pacífico".

AzureSqlProtectionPolicy

SQL do Azure política de backup específica da carga de trabalho.

Nome	Tipo	Description
backupManagementType	string: AzureSql	Essa propriedade será usada como discriminadora para decidir os tipos específicos na cadeia polimórfica de tipos.
protectedItemsCount	integer	Número de itens associados a essa política.
resourceGuardOperationRequests	string[]	Solicitações de operação do ResourceGuard
retentionPolicy	RetentionPolicy: LongTermRetentionPolicy SimpleRetentionPolicy	Detalhes da política de retenção.

AzureVmWorkloadProtectionPolicy

Política de backup específica da carga de trabalho da VM do Azure (Mercury).

Nome	Tipo	Description
backupManagementType	string: AzureWorkload	Essa propriedade será usada como discriminadora para decidir os tipos específicos na cadeia polimórfica de tipos.
makePolicyConsistent	boolean	Corrigir a inconsistência da política
protectedItemsCount	integer	Número de itens associados a essa política.
resourceGuardOperationRequests	string[]	Solicitações de operação do ResourceGuard
settings	Settings	Configurações comuns para o gerenciamento de backup
subProtectionPolicy	SubProtectionPolicy[]	Lista de políticas de subproteção que inclui agendamento e retenção
workLoadType	WorkloadType	Tipo de carga de trabalho para o gerenciamento de backup

CloudError

Uma resposta de erro do serviço da Instância de Contêiner.

Nome	Tipo	Description
error	CloudErrorBody	O objeto de erro.

CloudErrorBody

Uma resposta de erro do serviço da Instância de Contêiner.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.
details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.
target	string	O destino do erro específico. Por exemplo, o nome da propriedade em erro.

DailyRetentionFormat

Formato de retenção diária.

Nome	Tipo	Description
daysOfTheMonth	Day[]	Lista de dias do mês.

DailyRetentionSchedule

Agendamento de retenção diário.

Nome	Tipo	Description
retentionDuration	RetentionDuration	Duração da retenção da Política de retenção.
retentionTimes	string[]	Tempos de retenção da política de retenção.

DailySchedule

Nome	Tipo	Description
scheduleRunTimes	string[]	Lista de horários do dia em que esse agendamento deve ser executado.

Day

Dia da semana.

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

DayOfWeek

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

ErrorAdditionalInfo

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

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

GenericProtectionPolicy

Política de backup específica da carga de trabalho da VM do Azure (Mercury).

Nome	Tipo	Description
backupManagementType	string: GenericProtectionPolicy	Essa propriedade será usada como discriminadora para decidir os tipos específicos na cadeia polimórfica de tipos.
fabricName	string	Nome da malha desta política.
protectedItemsCount	integer	Número de itens associados a essa política.
resourceGuardOperationRequests	string[]	Solicitações de operação do ResourceGuard
subProtectionPolicy	SubProtectionPolicy[]	Lista de políticas de subproteção que inclui agendamento e retenção
timeZone	string	Entrada opcional de Fuso Horário como cadeia de caracteres. Por exemplo: Fuso Horário = "Hora Padrão do Pacífico".

HourlySchedule

Nome	Tipo	Description
interval	integer	Intervalo no qual o backup precisa ser disparado. Por hora, o valor pode ser 4/6/8/12
scheduleWindowDuration	integer	Para especificar a duração da janela de backup
scheduleWindowStartTime	string	Para especificar a hora de início da janela de backup

IAASVMPolicyType

Nome	Tipo	Description
Invalid	string
V1	string
V2	string

InstantRPAdditionalDetails

Nome	Tipo	Description
azureBackupRGNamePrefix	string
azureBackupRGNameSuffix	string

LogSchedulePolicy

Agendamento da política de log.

Nome	Tipo	Description
scheduleFrequencyInMins	integer	Frequência da operação de agendamento de log dessa política em minutos.
schedulePolicyType	string: LogSchedulePolicy	Essa propriedade será usada como discriminadora para decidir os tipos específicos na cadeia polimórfica de tipos.

LongTermRetentionPolicy

Política de retenção de longo prazo.

Nome	Tipo	Description
dailySchedule	DailyRetentionSchedule	Agendamento de retenção diária da política de proteção.
monthlySchedule	MonthlyRetentionSchedule	Agendamento de retenção mensal da política de proteção.
retentionPolicyType	string: LongTermRetentionPolicy	Essa propriedade será usada como discriminadora para decidir os tipos específicos na cadeia polimórfica de tipos.
weeklySchedule	WeeklyRetentionSchedule	Agendamento de retenção semanal da política de proteção.
yearlySchedule	YearlyRetentionSchedule	Agendamento anual de retenção da política de proteção.

LongTermSchedulePolicy

Agendamento de política de longo prazo.

Nome	Tipo	Description
schedulePolicyType	string: LongTermSchedulePolicy	Essa propriedade será usada como discriminadora para decidir os tipos específicos na cadeia polimórfica de tipos.

MabProtectionPolicy

Política de backup específica do contêiner do Mab.

Nome	Tipo	Description
backupManagementType	string: MAB	Essa propriedade será usada como discriminadora para decidir os tipos específicos na cadeia polimórfica de tipos.
protectedItemsCount	integer	Número de itens associados a essa política.
resourceGuardOperationRequests	string[]	Solicitações de operação do ResourceGuard
retentionPolicy	RetentionPolicy: LongTermRetentionPolicy SimpleRetentionPolicy	Detalhes da política de retenção.
schedulePolicy	SchedulePolicy: LogSchedulePolicy LongTermSchedulePolicy SimpleSchedulePolicy SimpleSchedulePolicyV2	Agendamento de backup da política de backup.

MonthlyRetentionSchedule

Agendamento de retenção mensal.

Nome	Tipo	Description
retentionDuration	RetentionDuration	Duração da retenção da Política de retenção.
retentionScheduleDaily	DailyRetentionFormat	Formato de retenção diária para a política de retenção mensal.
retentionScheduleFormatType	RetentionScheduleFormat	Tipo de formato de agendamento de retenção para a política de retenção mensal.
retentionScheduleWeekly	WeeklyRetentionFormat	Formato de retenção semanal para a política de retenção mensal.
retentionTimes	string[]	Tempos de retenção da política de retenção.

MonthOfYear

Lista de meses do ano da política de retenção anual.

Nome	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 tipo de política de backup

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

ProtectionPolicyResource

Classe base para política de backup. As políticas de backup específicas da carga de trabalho são derivadas dessa classe.

Nome	Tipo	Description
eTag	string	ETag opcional.
id	string	A ID do recurso representa o caminho completo para o recurso.
location	string	Local do recurso.
name	string	Nome do recurso associado ao recurso.
properties	ProtectionPolicy: AzureFileShareProtectionPolicy AzureIaaSVMProtectionPolicy AzureSqlProtectionPolicy AzureVmWorkloadProtectionPolicy GenericProtectionPolicy MabProtectionPolicy	Propriedades de ProtectionPolicyResource
tags	object	Marcas de recurso.
type	string	O tipo de recurso representa o caminho completo do formulário Namespace/ResourceType/ResourceType/...

ProtectionPolicyResourceList

Lista de recursos protectionPolicy

Nome	Tipo	Description
nextLink	string	O uri para buscar a próxima página de recursos. A lista de chamadasNext() busca a próxima página de recursos.
value	ProtectionPolicyResource[]	Lista de recursos.

RetentionDuration

Duração da retenção.

Nome	Tipo	Description
count	integer	Contagem de tipos de duração. A duração da retenção é obtida pela contagem do tipo de duração Contagem de tempos. Por exemplo, quando Count = 3 e DurationType = Weeks, a duração da retenção será de três semanas.
durationType	RetentionDurationType	Tipo de duração de retenção da política de retenção.

RetentionDurationType

Tipo de duração de retenção: dias/semanas/meses/anos Usado somente se TieringMode estiver definido como TierAfter

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

RetentionScheduleFormat

Tipo de formato de agendamento de retenção para a política de retenção mensal.

Nome	Tipo	Description
Daily	string
Invalid	string
Weekly	string

ScheduleRunType

Frequência da operação de agendamento dessa política.

Nome	Tipo	Description
Daily	string
Hourly	string
Invalid	string
Weekly	string

Settings

Campo de configurações comuns para gerenciamento de backup

Nome	Tipo	Description
isCompression	boolean	Sinalizador de compactação de carga de trabalho. Isso foi adicionado para que 'isSqlCompression' seja preterido depois que os clientes atualizarem para considerar esse sinalizador.
issqlcompression	boolean	Sinalizador de compactação SQL
timeZone	string	Entrada opcional de Fuso Horário como cadeia de caracteres. Por exemplo: Fuso Horário = "Hora Padrão do Pacífico".

SimpleRetentionPolicy

Retenção de política simples.

Nome	Tipo	Description
retentionDuration	RetentionDuration	Duração da retenção da política de proteção.
retentionPolicyType	string: SimpleRetentionPolicy	Essa propriedade será usada como discriminadora para decidir os tipos específicos na cadeia polimórfica de tipos.

SimpleSchedulePolicy

Agendamento de política simples.

Nome	Tipo	Description
hourlySchedule	HourlySchedule	Agendamento por hora desta Política
schedulePolicyType	string: SimpleSchedulePolicy	Essa propriedade será usada como discriminadora para decidir os tipos específicos na cadeia polimórfica de tipos.
scheduleRunDays	DayOfWeek[]	Lista de dias da semana em que esse agendamento deve ser executado.
scheduleRunFrequency	ScheduleRunType	Frequência da operação de agendamento dessa política.
scheduleRunTimes	string[]	Lista de horários do dia em que esse agendamento deve ser executado.
scheduleWeeklyFrequency	integer	A cada número de semanas, esse agendamento deve ser executado.

SimpleSchedulePolicyV2

O agendamento da política V2 para IaaS que dá suporte a backups por hora.

Nome	Tipo	Description
dailySchedule	DailySchedule	Agendamento diário desta política
hourlySchedule	HourlySchedule	agendamento por hora desta política
schedulePolicyType	string: SimpleSchedulePolicyV2	Essa propriedade será usada como discriminadora para decidir os tipos específicos na cadeia polimórfica de tipos.
scheduleRunFrequency	ScheduleRunType	Frequência da operação de agendamento dessa política.
weeklySchedule	WeeklySchedule	Agenda semanal desta política

SubProtectionPolicy

Política de subproteção que inclui agendamento e retenção

Nome	Tipo	Description
policyType	PolicyType	Tipo de tipo de política de backup
retentionPolicy	RetentionPolicy: LongTermRetentionPolicy SimpleRetentionPolicy	Política de retenção com os detalhes sobre intervalos de retenção de cópia de backup.
schedulePolicy	SchedulePolicy: LogSchedulePolicy LongTermSchedulePolicy SimpleSchedulePolicy SimpleSchedulePolicyV2	Agendamento de backup especificado como parte da política de backup.
tieringPolicy	<string,  TieringPolicy>	Política de camadas para mover automaticamente RPs para outra camada. A chave é a Camada de Destino, definida na enumeração RecoveryPointTierType. A política de camadas especifica os critérios para mover RP para a camada de destino.

TieringMode

Modo de camada para controlar a camada automática de pontos de recuperação. Os valores com suporte são:

1. TierRecommended: camada todos os pontos de recuperação recomendados para serem em camadas
2. TierAfter: camada todos os pontos de recuperação após um período fixo, conforme especificado em duration + durationType abaixo.
3. DoNotTier: não camada nenhum ponto de recuperação

Nome	Tipo	Description
DoNotTier	string
Invalid	string
TierAfter	string
TierRecommended	string

TieringPolicy

Política de camadas para uma camada de destino. Se a política não for especificada para uma determinada camada de destino, o serviço manterá a política de camada configurada existente para essa camada

Nome	Tipo	Description
duration	integer	Número de dias/semanas/meses/anos para reter backups na camada atual antes da camada. Usado somente se TieringMode estiver definido como TierAfter
durationType	RetentionDurationType	Tipo de duração de retenção: dias/semanas/meses/anos Usado somente se TieringMode estiver definido como TierAfter
tieringMode	TieringMode	Modo de camadas para controlar a camada automática de pontos de recuperação. Os valores com suporte são: TierRecommended: Camada todos os pontos de recuperação recomendados para serem em camadas TierAfter: camada todos os pontos de recuperação após um período fixo, conforme especificado em duration + durationType abaixo. DoNotTier: não camada nenhum ponto de recuperação

WeeklyRetentionFormat

Formato de retenção semanal.

Nome	Tipo	Description
daysOfTheWeek	DayOfWeek[]	Lista de dias da semana.
weeksOfTheMonth	WeekOfMonth[]	Lista de semanas de mês.

WeeklyRetentionSchedule

Agendamento de retenção semanal.

Nome	Tipo	Description
daysOfTheWeek	DayOfWeek[]	Lista de dias da semana para a política de retenção semanal.
retentionDuration	RetentionDuration	Duração da retenção da Política de retenção.
retentionTimes	string[]	Tempos de retenção da política de retenção.

WeeklySchedule

Nome	Tipo	Description
scheduleRunDays	DayOfWeek[]
scheduleRunTimes	string[]	Lista de horários do dia em que esse agendamento deve ser executado.

WeekOfMonth

Lista de semanas de mês.

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

WorkloadType

Tipo de carga de trabalho para o gerenciamento de backup

Nome	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

Agendamento de retenção anual.

Nome	Tipo	Description
monthsOfYear	MonthOfYear[]	Lista de meses do ano da política de retenção anual.
retentionDuration	RetentionDuration	Duração da retenção da Política de retenção.
retentionScheduleDaily	DailyRetentionFormat	Formato de retenção diária para a política de retenção anual.
retentionScheduleFormatType	RetentionScheduleFormat	Formato de agendamento de retenção para a política de retenção anual.
retentionScheduleWeekly	WeeklyRetentionFormat	Formato de retenção semanal para a política de retenção anual.
retentionTimes	string[]	Tempos de retenção da política de retenção.