Backup Policies - List

Service:

Recovery Services - Backup

API Version:

2023-02-01

Lijsten met back-upbeleidsregels die zijn gekoppeld aan Recovery Services-kluis. API biedt pagineringsparameters om resultaten binnen het bereik op te halen.

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}

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string	De naam van de resourcegroep waarin de Recovery Services-kluis aanwezig is.
subscriptionId	path	True	string	De abonnements-id.
vaultName	path	True	string	De naam van de Recovery Services-kluis.
api-version	query	True	string	Client-API-versie.
$filter	query		string	OData-filteropties.

Antwoorden

Name	Type	Description
200 OK	ProtectionPolicyResourceList	OK
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

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

Scopes

Name	Description
user_impersonation	Imiteer uw gebruikersaccount.

Voorbeelden

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

Definities

Name	Description
AzureFileShareProtectionPolicy	Back-upbeleid voor AzureStorage.
AzureIaaSVMProtectionPolicy	Workloadspecifiek back-upbeleid voor IaaS-VM's.
AzureSqlProtectionPolicy	Azure SQL workloadspecifiek back-upbeleid.
AzureVmWorkloadProtectionPolicy	Workloadspecifiek back-upbeleid voor Azure VM (Mercury).
CloudError	Een foutreactie van de Container Instance-service.
CloudErrorBody	Een foutreactie van de Container Instance-service.
DailyRetentionFormat	Indeling voor dagelijkse retentie.
DailyRetentionSchedule	Dagelijks bewaarschema.
DailySchedule
Day	Dag van de week.
DayOfWeek
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
GenericProtectionPolicy	Workloadspecifiek back-upbeleid voor Azure VM (Mercury).
HourlySchedule
IAASVMPolicyType
InstantRPAdditionalDetails
LogSchedulePolicy	Logboekbeleidsschema.
LongTermRetentionPolicy	Langetermijnretentiebeleid.
LongTermSchedulePolicy	Langetermijnbeleidsplanning.
MabProtectionPolicy	Mab-containerspecifiek back-upbeleid.
MonthlyRetentionSchedule	Maandelijks bewaarschema.
MonthOfYear	Lijst met maanden van jaar van jaarlijks bewaarbeleid.
PolicyType	Type back-upbeleid
ProtectionPolicyResource	Basisklasse voor back-upbeleid. Workloadspecifiek back-upbeleid wordt afgeleid van deze klasse.
ProtectionPolicyResourceList	Lijst met ProtectionPolicy-resources
RetentionDuration	Retentieduur.
RetentionDurationType	Type retentieduur: dagen/weken/maanden/jaren Alleen gebruikt als TieringMode is ingesteld op TierAfter
RetentionScheduleFormat	Indelingstype bewaarschema voor maandelijks bewaarbeleid.
ScheduleRunType	Frequentie van de planningsbewerking van dit beleid.
Settings	Veld Algemene instellingen voor back-upbeheer
SimpleRetentionPolicy	Eenvoudige beleidsretentie.
SimpleSchedulePolicy	Eenvoudig beleidsschema.
SimpleSchedulePolicyV2	Het V2-beleidsschema voor IaaS dat ondersteuning biedt voor back-ups per uur.
SubProtectionPolicy	Subbeveiligingsbeleid dat planning en retentie omvat
TieringMode	Tiering-modus voor het beheren van automatische lagen van herstelpunten. Ondersteunde waarden zijn: TierRecaanbevelded: Alle herstelpunten worden aanbevolen om gelaagd te worden TierAfter: maak een laag voor alle herstelpunten na een vaste periode, zoals opgegeven in duration + durationType hieronder. DoNotTier: herstelpunten niet tieren
TieringPolicy	Beleid voor lagen voor een doellaag. Als het beleid niet is opgegeven voor een bepaalde doellaag, behoudt de service het bestaande geconfigureerde lagenbeleid voor die laag
WeeklyRetentionFormat	Indeling voor wekelijkse retentie.
WeeklyRetentionSchedule	Wekelijks bewaarschema.
WeeklySchedule
WeekOfMonth	Lijst met weken van maand.
WorkloadType	Type workload voor back-upbeheer
YearlyRetentionSchedule	Jaarlijks bewaarschema.

AzureFileShareProtectionPolicy

Back-upbeleid voor AzureStorage.

Name	Type	Description
backupManagementType	string: AzureStorage	Deze eigenschap wordt gebruikt als de discriminator voor het bepalen van de specifieke typen in de polymorfe keten van typen.
protectedItemsCount	integer	Aantal items dat aan dit beleid is gekoppeld.
resourceGuardOperationRequests	string[]	ResourceGuard-bewerkingsaanvragen
retentionPolicy	RetentionPolicy: LongTermRetentionPolicy SimpleRetentionPolicy	Bewaarbeleid met de details over bewaarbereiken voor back-upkopie.
schedulePolicy	SchedulePolicy: LogSchedulePolicy LongTermSchedulePolicy SimpleSchedulePolicy SimpleSchedulePolicyV2	Back-upschema dat is opgegeven als onderdeel van het back-upbeleid.
timeZone	string	TimeZone optionele invoer als tekenreeks. Bijvoorbeeld: TimeZone = "Pacific Standard Time".
workLoadType	WorkloadType	Type workload voor back-upbeheer

AzureIaaSVMProtectionPolicy

Workloadspecifiek back-upbeleid voor IaaS-VM's.

Name	Type	Description
backupManagementType	string: AzureIaasVM	Deze eigenschap wordt gebruikt als de discriminator voor het bepalen van de specifieke typen in de polymorfe keten van typen.
instantRPDetails	InstantRPAdditionalDetails
instantRpRetentionRangeInDays	integer	Bereik van direct RP-bewaarbeleid in dagen
policyType	IAASVMPolicyType
protectedItemsCount	integer	Aantal items dat aan dit beleid is gekoppeld.
resourceGuardOperationRequests	string[]	ResourceGuard-bewerkingsaanvragen
retentionPolicy	RetentionPolicy: LongTermRetentionPolicy SimpleRetentionPolicy	Bewaarbeleid met de details over bewaarbereiken voor back-upkopie.
schedulePolicy	SchedulePolicy: LogSchedulePolicy LongTermSchedulePolicy SimpleSchedulePolicy SimpleSchedulePolicyV2	Back-upschema dat is opgegeven als onderdeel van het back-upbeleid.
tieringPolicy	<string,  TieringPolicy>	Opslagbeleid voor het automatisch verplaatsen van RPs naar een andere laag Sleutel is Doellaag, gedefinieerd in recoveryPointTierType enum. Beleid voor lagen specificeert de criteria voor het verplaatsen van RP naar de doellaag.
timeZone	string	TimeZone optionele invoer als tekenreeks. Bijvoorbeeld: TimeZone = "Pacific Standard Time".

AzureSqlProtectionPolicy

Azure SQL workloadspecifiek back-upbeleid.

Name	Type	Description
backupManagementType	string: AzureSql	Deze eigenschap wordt gebruikt als de discriminator voor het bepalen van de specifieke typen in de polymorfe keten van typen.
protectedItemsCount	integer	Aantal items dat aan dit beleid is gekoppeld.
resourceGuardOperationRequests	string[]	ResourceGuard-bewerkingsaanvragen
retentionPolicy	RetentionPolicy: LongTermRetentionPolicy SimpleRetentionPolicy	Details van bewaarbeleid.

AzureVmWorkloadProtectionPolicy

Workloadspecifiek back-upbeleid voor Azure VM (Mercury).

Name	Type	Description
backupManagementType	string: AzureWorkload	Deze eigenschap wordt gebruikt als de discriminator voor het bepalen van de specifieke typen in de polymorfe keten van typen.
makePolicyConsistent	boolean	De inconsistentie van het beleid oplossen
protectedItemsCount	integer	Aantal items dat aan dit beleid is gekoppeld.
resourceGuardOperationRequests	string[]	ResourceGuard-bewerkingsaanvragen
settings	Settings	Algemene instellingen voor back-upbeheer
subProtectionPolicy	SubProtectionPolicy[]	Lijst met subbeveiligingsbeleid met planning en retentie
workLoadType	WorkloadType	Type workload voor back-upbeheer

CloudError

Een foutreactie van de Container Instance-service.

Name	Type	Description
error	CloudErrorBody	Het foutobject.

CloudErrorBody

Een foutreactie van de Container Instance-service.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout aanvullende informatie.
code	string	Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
details	CloudErrorBody[]	Een lijst met aanvullende informatie over de fout.
message	string	Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
target	string	Het doel van de specifieke fout. Bijvoorbeeld de naam van de eigenschap fout.

DailyRetentionFormat

Indeling voor dagelijkse retentie.

Name	Type	Description
daysOfTheMonth	Day[]	Lijst met dagen van de maand.

DailyRetentionSchedule

Dagelijks bewaarschema.

Name	Type	Description
retentionDuration	RetentionDuration	Retentieduur van bewaarbeleid.
retentionTimes	string[]	Bewaartijden van bewaarbeleid.

DailySchedule

Name	Type	Description
scheduleRunTimes	string[]	Lijst met tijden van de dag dat dit schema moet worden uitgevoerd.

Day

Dag van de week.

Name	Type	Description
date	integer	Datum van de maand
isLast	boolean	Of datum de laatste datum van de maand is

DayOfWeek

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

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het type aanvullende informatie.

GenericProtectionPolicy

Workloadspecifiek back-upbeleid voor Azure VM (Mercury).

Name	Type	Description
backupManagementType	string: GenericProtectionPolicy	Deze eigenschap wordt gebruikt als de discriminator voor het bepalen van de specifieke typen in de polymorfe keten van typen.
fabricName	string	Naam van de infrastructuur van dit beleid.
protectedItemsCount	integer	Aantal items dat aan dit beleid is gekoppeld.
resourceGuardOperationRequests	string[]	ResourceGuard-bewerkingsaanvragen
subProtectionPolicy	SubProtectionPolicy[]	Lijst met subbeveiligingsbeleid met planning en retentie
timeZone	string	TimeZone optionele invoer als tekenreeks. Bijvoorbeeld: TimeZone = "Pacific Standard Time".

HourlySchedule

Name	Type	Description
interval	integer	Interval waarmee back-up moet worden geactiveerd. Voor elk uur kan de waarde 4/6/8/12 zijn
scheduleWindowDuration	integer	De duur van het back-upvenster opgeven
scheduleWindowStartTime	string	Begintijd van het back-upvenster opgeven

IAASVMPolicyType

Name	Type	Description
Invalid	string
V1	string
V2	string

InstantRPAdditionalDetails

Name	Type	Description
azureBackupRGNamePrefix	string
azureBackupRGNameSuffix	string

LogSchedulePolicy

Logboekbeleidsschema.

Name	Type	Description
scheduleFrequencyInMins	integer	Frequentie van de logboekplanningsbewerking van dit beleid in minuten.
schedulePolicyType	string: LogSchedulePolicy	Deze eigenschap wordt gebruikt als de discriminator voor het bepalen van de specifieke typen in de polymorfe keten van typen.

LongTermRetentionPolicy

Langetermijnretentiebeleid.

Name	Type	Description
dailySchedule	DailyRetentionSchedule	Dagelijks bewaarschema van het beveiligingsbeleid.
monthlySchedule	MonthlyRetentionSchedule	Maandelijks bewaarschema van het beveiligingsbeleid.
retentionPolicyType	string: LongTermRetentionPolicy	Deze eigenschap wordt gebruikt als de discriminator voor het bepalen van de specifieke typen in de polymorfe keten van typen.
weeklySchedule	WeeklyRetentionSchedule	Wekelijks bewaarschema van het beveiligingsbeleid.
yearlySchedule	YearlyRetentionSchedule	Jaarlijks bewaarschema van het beveiligingsbeleid.

LongTermSchedulePolicy

Langetermijnbeleidsplanning.

Name	Type	Description
schedulePolicyType	string: LongTermSchedulePolicy	Deze eigenschap wordt gebruikt als de discriminator voor het bepalen van de specifieke typen in de polymorfe keten van typen.

MabProtectionPolicy

Mab-containerspecifiek back-upbeleid.

Name	Type	Description
backupManagementType	string: MAB	Deze eigenschap wordt gebruikt als de discriminator voor het bepalen van de specifieke typen in de polymorfe keten van typen.
protectedItemsCount	integer	Aantal items dat aan dit beleid is gekoppeld.
resourceGuardOperationRequests	string[]	ResourceGuard-bewerkingsaanvragen
retentionPolicy	RetentionPolicy: LongTermRetentionPolicy SimpleRetentionPolicy	Details van bewaarbeleid.
schedulePolicy	SchedulePolicy: LogSchedulePolicy LongTermSchedulePolicy SimpleSchedulePolicy SimpleSchedulePolicyV2	Back-upschema van back-upbeleid.

MonthlyRetentionSchedule

Maandelijks bewaarschema.

Name	Type	Description
retentionDuration	RetentionDuration	Retentieduur van bewaarbeleid.
retentionScheduleDaily	DailyRetentionFormat	Dagelijkse retentie-indeling voor maandelijks bewaarbeleid.
retentionScheduleFormatType	RetentionScheduleFormat	Indelingstype bewaarschema voor maandelijks bewaarbeleid.
retentionScheduleWeekly	WeeklyRetentionFormat	Wekelijkse retentie-indeling voor maandelijks bewaarbeleid.
retentionTimes	string[]	Bewaartijden van bewaarbeleid.

MonthOfYear

Lijst met maanden van jaar van jaarlijks bewaarbeleid.

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

PolicyType

Type back-upbeleid

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

ProtectionPolicyResource

Basisklasse voor back-upbeleid. Workloadspecifiek back-upbeleid wordt afgeleid van deze klasse.

Name	Type	Description
eTag	string	Optionele ETag.
id	string	Resource-id vertegenwoordigt het volledige pad naar de resource.
location	string	Resourcelocatie.
name	string	Resourcenaam die is gekoppeld aan de resource.
properties	ProtectionPolicy: AzureFileShareProtectionPolicy AzureIaaSVMProtectionPolicy AzureSqlProtectionPolicy AzureVmWorkloadProtectionPolicy GenericProtectionPolicy MabProtectionPolicy	ProtectionPolicyResource-eigenschappen
tags	object	Resourcetags.
type	string	Resourcetype vertegenwoordigt het volledige pad van het formulier Namespace/ResourceType/ResourceType/...

ProtectionPolicyResourceList

Lijst met ProtectionPolicy-resources

Name	Type	Description
nextLink	string	De URI om de volgende pagina met resources op te halen. Lijst met aanroepenVolgende() haalt de volgende pagina met resources op.
value	ProtectionPolicyResource[]	Lijst met resources.

RetentionDuration

Retentieduur.

Name	Type	Description
count	integer	Aantal duurtypen. Retentieduur wordt verkregen door het tellen van het duurtype Aantal tijden. Als Count = 3 en DurationType = Weeks zijn, is de retentieduur bijvoorbeeld drie weken.
durationType	RetentionDurationType	Type bewaarperiode van bewaarbeleid.

RetentionDurationType

Type retentieduur: dagen/weken/maanden/jaren Alleen gebruikt als TieringMode is ingesteld op TierAfter

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

RetentionScheduleFormat

Indelingstype bewaarschema voor maandelijks bewaarbeleid.

Name	Type	Description
Daily	string
Invalid	string
Weekly	string

ScheduleRunType

Frequentie van de planningsbewerking van dit beleid.

Name	Type	Description
Daily	string
Hourly	string
Invalid	string
Weekly	string

Settings

Veld Algemene instellingen voor back-upbeheer

Name	Type	Description
isCompression	boolean	Vlag voor workloadcompressie. Dit is toegevoegd zodat 'isSqlCompression' wordt afgeschaft zodra clients upgraden om deze vlag te overwegen.
issqlcompression	boolean	SQL-compressievlag
timeZone	string	TimeZone optionele invoer als tekenreeks. Bijvoorbeeld: TimeZone = "Pacific Standard Time".

SimpleRetentionPolicy

Eenvoudige beleidsretentie.

Name	Type	Description
retentionDuration	RetentionDuration	Retentieduur van het beveiligingsbeleid.
retentionPolicyType	string: SimpleRetentionPolicy	Deze eigenschap wordt gebruikt als de discriminator voor het bepalen van de specifieke typen in de polymorfe keten van typen.

SimpleSchedulePolicy

Eenvoudig beleidsschema.

Name	Type	Description
hourlySchedule	HourlySchedule	Schema per uur van dit beleid
schedulePolicyType	string: SimpleSchedulePolicy	Deze eigenschap wordt gebruikt als de discriminator voor het bepalen van de specifieke typen in de polymorfe keten van typen.
scheduleRunDays	DayOfWeek[]	Lijst met dagen van de week die deze planning moet worden uitgevoerd.
scheduleRunFrequency	ScheduleRunType	Frequentie van de planningsbewerking van dit beleid.
scheduleRunTimes	string[]	Lijst met tijden van de dag dat dit schema moet worden uitgevoerd.
scheduleWeeklyFrequency	integer	Bij elk aantal weken moet dit schema worden uitgevoerd.

SimpleSchedulePolicyV2

Het V2-beleidsschema voor IaaS dat ondersteuning biedt voor back-ups per uur.

Name	Type	Description
dailySchedule	DailySchedule	Dagelijkse planning van dit beleid
hourlySchedule	HourlySchedule	uurplanning van dit beleid
schedulePolicyType	string: SimpleSchedulePolicyV2	Deze eigenschap wordt gebruikt als de discriminator voor het bepalen van de specifieke typen in de polymorfe keten van typen.
scheduleRunFrequency	ScheduleRunType	Frequentie van de planningsbewerking van dit beleid.
weeklySchedule	WeeklySchedule	Wekelijkse planning van dit beleid

SubProtectionPolicy

Subbeveiligingsbeleid dat planning en retentie omvat

Name	Type	Description
policyType	PolicyType	Type back-upbeleid
retentionPolicy	RetentionPolicy: LongTermRetentionPolicy SimpleRetentionPolicy	Bewaarbeleid met de details over bewaarbereiken voor back-upkopie.
schedulePolicy	SchedulePolicy: LogSchedulePolicy LongTermSchedulePolicy SimpleSchedulePolicy SimpleSchedulePolicyV2	Back-upschema dat is opgegeven als onderdeel van het back-upbeleid.
tieringPolicy	<string,  TieringPolicy>	Beleid voor opslaglagen om RP's automatisch naar een andere laag te verplaatsen. De sleutel is de doellaag, gedefinieerd in de opsomming RecoveryPointTierType. Beleid voor lagen specificeert de criteria voor het verplaatsen van RP naar de doellaag.

TieringMode

Tiering-modus voor het beheren van automatische lagen van herstelpunten. Ondersteunde waarden zijn:

1. TierRecaanbevelded: Alle herstelpunten worden aanbevolen om gelaagd te worden
2. TierAfter: maak een laag voor alle herstelpunten na een vaste periode, zoals opgegeven in duration + durationType hieronder.
3. DoNotTier: herstelpunten niet tieren

Name	Type	Description
DoNotTier	string
Invalid	string
TierAfter	string
TierRecommended	string

TieringPolicy

Beleid voor lagen voor een doellaag. Als het beleid niet is opgegeven voor een bepaalde doellaag, behoudt de service het bestaande geconfigureerde lagenbeleid voor die laag

Name	Type	Description
duration	integer	Aantal dagen/weken/maanden/jaren om back-ups in de huidige laag te bewaren voordat u de opslag in lagen opgeeft. Alleen gebruikt als TieringMode is ingesteld op TierAfter
durationType	RetentionDurationType	Type retentieduur: dagen/weken/maanden/jaren Alleen gebruikt als TieringMode is ingesteld op TierAfter
tieringMode	TieringMode	Tiering-modus voor het beheren van automatische lagen van herstelpunten. Ondersteunde waarden zijn: TierRecaanbevelded: Alle herstelpunten worden aanbevolen om gelaagd te worden TierAfter: maak een laag voor alle herstelpunten na een vaste periode, zoals opgegeven in duration + durationType hieronder. DoNotTier: herstelpunten niet tieren

WeeklyRetentionFormat

Indeling voor wekelijkse retentie.

Name	Type	Description
daysOfTheWeek	DayOfWeek[]	Lijst met dagen van de week.
weeksOfTheMonth	WeekOfMonth[]	Lijst met weken van maand.

WeeklyRetentionSchedule

Wekelijks bewaarschema.

Name	Type	Description
daysOfTheWeek	DayOfWeek[]	Lijst met dagen van de week voor wekelijks bewaarbeleid.
retentionDuration	RetentionDuration	Retentieduur van bewaarbeleid.
retentionTimes	string[]	Bewaartijden van bewaarbeleid.

WeeklySchedule

Name	Type	Description
scheduleRunDays	DayOfWeek[]
scheduleRunTimes	string[]	Lijst met tijden van de dag dat dit schema moet worden uitgevoerd.

WeekOfMonth

Lijst met weken van maand.

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

WorkloadType

Type workload voor back-upbeheer

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

YearlyRetentionSchedule

Jaarlijks bewaarschema.

Name	Type	Description
monthsOfYear	MonthOfYear[]	Lijst met maanden van jaar van jaarlijks bewaarbeleid.
retentionDuration	RetentionDuration	Retentieduur van bewaarbeleid.
retentionScheduleDaily	DailyRetentionFormat	Dagelijkse retentie-indeling voor jaarlijks bewaarbeleid.
retentionScheduleFormatType	RetentionScheduleFormat	Retentieschema-indeling voor jaarlijks bewaarbeleid.
retentionScheduleWeekly	WeeklyRetentionFormat	Wekelijkse retentie-indeling voor jaarlijks bewaarbeleid.
retentionTimes	string[]	Bewaartijden van bewaarbeleid.