Backup Protection Intent - List

Service:

Recovery Services - Backup

API Version:

2025-02-01

Provides a pageable list of all intents that are present within a vault.

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

With optional parameters:

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

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group where the recovery services vault is present.
subscriptionId	path	True	string	The subscription Id.
vaultName	path	True	string	The name of the recovery services vault.
api-version	query	True	string	Client Api Version.
$filter	query		string	OData filter options.
$skipToken	query		string	skipToken Filter.

Responses

Name	Type	Description
200 OK	ProtectionIntentResourceList	OK

Security

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	impersonate your user account.

Examples

List protection intent with backupManagementType filter

Sample request

HTTP

GET https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.RecoveryServices/vaults/myVault/backupProtectionIntents?api-version=2025-02-01

Java

/**
 * Samples for BackupProtectionIntent List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2025-02-01/examples/
     * AzureWorkload/BackupProtectionIntent_List.json
     */
    /**
     * Sample code: List protection intent with backupManagementType filter.
     * 
     * @param manager Entry point to RecoveryServicesBackupManager.
     */
    public static void listProtectionIntentWithBackupManagementTypeFilter(
        com.azure.resourcemanager.recoveryservicesbackup.RecoveryServicesBackupManager manager) {
        manager.backupProtectionIntents().list("myVault", "myRG", null, null, 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.activestamp import RecoveryServicesBackupClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-recoveryservicesbackup
# USAGE
    python backup_protection_intent_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_protection_intent.list(
        vault_name="myVault",
        resource_group_name="myRG",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2025-02-01/examples/AzureWorkload/BackupProtectionIntent_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/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/recoveryservices/armrecoveryservicesbackup/v4"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/148c3b0b44f7789ced94859992493fafd0072f83/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2025-02-01/examples/AzureWorkload/BackupProtectionIntent_List.json
func ExampleBackupProtectionIntentClient_NewListPager() {
	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.NewBackupProtectionIntentClient().NewListPager("myVault", "myRG", &armrecoveryservicesbackup.BackupProtectionIntentClientListOptions{Filter: nil,
		SkipToken: nil,
	})
	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.ProtectionIntentResourceList = armrecoveryservicesbackup.ProtectionIntentResourceList{
		// 	Value: []*armrecoveryservicesbackup.ProtectionIntentResource{
		// 		{
		// 			Name: to.Ptr("249D9B07-D2EF-4202-AA64-65F35418564E"),
		// 			Type: to.Ptr("Microsoft.RecoveryServices/vaults/backupProtectionIntent"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.RecoveryServices/vaults/myVault/backupFabrics/Azure/backupProtectionIntent/249D9B07-D2EF-4202-AA64-65F35418564E"),
		// 			Properties: &armrecoveryservicesbackup.AzureWorkloadContainerAutoProtectionIntent{
		// 				BackupManagementType: to.Ptr(armrecoveryservicesbackup.BackupManagementTypeAzureWorkload),
		// 				ItemID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.RecoveryServices/vaults/myVault/backupProtectionContainer/VMAppContainer;Compute;testVmName/backupProtectableItems/SQLInstance;MSSQLSERVER"),
		// 				PolicyID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.RecoveryServices/vaults/myVault/backupPolicies/myPolicy"),
		// 				ProtectionIntentItemType: to.Ptr(armrecoveryservicesbackup.ProtectionIntentItemTypeAzureWorkloadContainerAutoProtectionIntent),
		// 			},
		// 	}},
		// }
	}
}

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");
require("dotenv/config");

/**
 * This sample demonstrates how to Provides a pageable list of all intents that are present within a vault.
 *
 * @summary Provides a pageable list of all intents that are present within a vault.
 * x-ms-original-file: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2025-02-01/examples/AzureWorkload/BackupProtectionIntent_List.json
 */
async function listProtectionIntentWithBackupManagementTypeFilter() {
  const subscriptionId =
    process.env["RECOVERYSERVICESBACKUP_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const vaultName = "myVault";
  const resourceGroupName = process.env["RECOVERYSERVICESBACKUP_RESOURCE_GROUP"] || "myRG";
  const credential = new DefaultAzureCredential();
  const client = new RecoveryServicesBackupClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.backupProtectionIntent.list(vaultName, resourceGroupName)) {
    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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.RecoveryServicesBackup.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.RecoveryServicesBackup;

// Generated from example definition: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2025-02-01/examples/AzureWorkload/BackupProtectionIntent_List.json
// this example is just showing the usage of "BackupProtectionIntent_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 = "myRG";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// invoke the operation and iterate over the result
string vaultName = "myVault";
await foreach (BackupProtectionIntentResource item in resourceGroupResource.GetBackupProtectionIntentsAsync(vaultName))
{
    // 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
    BackupProtectionIntentData 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/myRG/providers/Microsoft.RecoveryServices/vaults/myVault/backupFabrics/Azure/backupProtectionIntent/249D9B07-D2EF-4202-AA64-65F35418564E",
      "name": "249D9B07-D2EF-4202-AA64-65F35418564E",
      "type": "Microsoft.RecoveryServices/vaults/backupProtectionIntent",
      "properties": {
        "protectionIntentItemType": "AzureWorkloadContainerAutoProtectionIntent",
        "backupManagementType": "AzureWorkload",
        "policyId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.RecoveryServices/vaults/myVault/backupPolicies/myPolicy",
        "itemId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.RecoveryServices/vaults/myVault/backupProtectionContainer/VMAppContainer;Compute;testVmName/backupProtectableItems/SQLInstance;MSSQLSERVER"
      }
    }
  ]
}

Definitions

Name	Description
AzureRecoveryServiceVaultProtectionIntent	Azure Recovery Services Vault specific protection intent item.
AzureResourceProtectionIntent	IaaS VM specific backup protection intent item.
AzureWorkloadAutoProtectionIntent	Azure Recovery Services Vault specific protection intent item.
AzureWorkloadContainerAutoProtectionIntent	Azure workload specific protection intent item.
AzureWorkloadSQLAutoProtectionIntent	Azure Workload SQL Auto Protection intent item.
BackupManagementType	Type of backup management for the backed up item.
ProtectionIntentResource	Base class for backup ProtectionIntent.
ProtectionIntentResourceList	List of ProtectionIntent resources
ProtectionStatus	State of the back up item.
WorkloadItemType	Workload item type of the item for which intent is to be set

AzureRecoveryServiceVaultProtectionIntent

Object

Azure Recovery Services Vault specific protection intent item.

Name	Type	Description
backupManagementType	BackupManagementType	Type of backup management for the backed up item.
itemId	string	ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
policyId	string	ID of the backup policy with which this item is backed up.
protectionIntentItemType	string: RecoveryServiceVaultItem	backup protectionIntent type.
protectionState	ProtectionStatus	Backup state of this backup item.
sourceResourceId	string	ARM ID of the resource to be backed up.

AzureResourceProtectionIntent

Object

IaaS VM specific backup protection intent item.

Name	Type	Description
backupManagementType	BackupManagementType	Type of backup management for the backed up item.
friendlyName	string	Friendly name of the VM represented by this backup item.
itemId	string	ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
policyId	string	ID of the backup policy with which this item is backed up.
protectionIntentItemType	string: AzureResourceItem	backup protectionIntent type.
protectionState	ProtectionStatus	Backup state of this backup item.
sourceResourceId	string	ARM ID of the resource to be backed up.

AzureWorkloadAutoProtectionIntent

Object

Azure Recovery Services Vault specific protection intent item.

Name	Type	Description
backupManagementType	BackupManagementType	Type of backup management for the backed up item.
itemId	string	ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
policyId	string	ID of the backup policy with which this item is backed up.
protectionIntentItemType	string: AzureWorkloadAutoProtectionIntent	backup protectionIntent type.
protectionState	ProtectionStatus	Backup state of this backup item.
sourceResourceId	string	ARM ID of the resource to be backed up.

AzureWorkloadContainerAutoProtectionIntent

Object

Azure workload specific protection intent item.

Name	Type	Description
backupManagementType	BackupManagementType	Type of backup management for the backed up item.
itemId	string	ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
policyId	string	ID of the backup policy with which this item is backed up.
protectionIntentItemType	string: AzureWorkloadContainerAutoProtectionIntent	backup protectionIntent type.
protectionState	ProtectionStatus	Backup state of this backup item.
sourceResourceId	string	ARM ID of the resource to be backed up.

AzureWorkloadSQLAutoProtectionIntent

Object

Azure Workload SQL Auto Protection intent item.

Name	Type	Description
backupManagementType	BackupManagementType	Type of backup management for the backed up item.
itemId	string	ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
policyId	string	ID of the backup policy with which this item is backed up.
protectionIntentItemType	string: AzureWorkloadSQLAutoProtectionIntent	backup protectionIntent type.
protectionState	ProtectionStatus	Backup state of this backup item.
sourceResourceId	string	ARM ID of the resource to be backed up.
workloadItemType	WorkloadItemType	Workload item type of the item for which intent is to be set

BackupManagementType

Enumeration

Type of backup management for the backed up item.

Value	Description
Invalid
AzureIaasVM
MAB
DPM
AzureBackupServer
AzureSql
AzureStorage
AzureWorkload
DefaultBackup

ProtectionIntentResource

Object

Base class for backup ProtectionIntent.

Name	Type	Description
eTag	string	Optional ETag.
id	string	Resource Id represents the complete path to the resource.
location	string	Resource location.
name	string	Resource name associated with the resource.
properties	ProtectionIntent: AzureRecoveryServiceVaultProtectionIntent AzureResourceProtectionIntent AzureWorkloadAutoProtectionIntent AzureWorkloadContainerAutoProtectionIntent AzureWorkloadSQLAutoProtectionIntent	ProtectionIntentResource properties
tags	object	Resource tags.
type	string	Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...

ProtectionIntentResourceList

Object

List of ProtectionIntent resources

Name	Type	Description
nextLink	string	The URI to fetch the next page of resources, with each API call returning up to 200 resources per page. Use ListNext() to fetch the next page if the total number of resources exceeds 200.
value	ProtectionIntentResource[]	List of resources.

ProtectionStatus

Enumeration

State of the back up item.

Value	Description
Invalid
NotProtected
Protecting
Protected
ProtectionFailed

WorkloadItemType

Enumeration

Workload item type of the item for which intent is to be set

Value	Description
Invalid
SQLInstance
SQLDataBase
SAPHanaSystem
SAPHanaDatabase
SAPAseSystem
SAPAseDatabase
SAPHanaDBInstance