Backup Workload Items - List

Service:

Recovery Services - Backup

API Version:

2025-02-01

Provides a pageable list of workload item of a specific container according to the query filter and the pagination parameters.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/items?api-version=2025-02-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/items?api-version=2025-02-01&$filter={$filter}&$skipToken={$skipToken}

URI Parameters

Name	In	Required	Type	Description
containerName	path	True	string	Name of the container.
fabricName	path	True	string	Fabric name associated with the container.
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	WorkloadItemResourceList	OK
Other Status Codes	CloudError	Error response describing why the operation failed.

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 Workload Items in Container

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.RecoveryServices/vaults/suchandr-seacan-rsv/backupFabrics/Azure/protectionContainers/VMAppContainer;Compute;bvtdtestag;sqlserver-1/items?api-version=2025-02-01&$filter=backupManagementType eq 'AzureWorkload'

Java

/**
 * Samples for BackupWorkloadItems List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2025-02-01/examples/
     * AzureWorkload/BackupWorkloadItems_List.json
     */
    /**
     * Sample code: List Workload Items in Container.
     * 
     * @param manager Entry point to RecoveryServicesBackupManager.
     */
    public static void listWorkloadItemsInContainer(
        com.azure.resourcemanager.recoveryservicesbackup.RecoveryServicesBackupManager manager) {
        manager.backupWorkloadItems().list("suchandr-seacan-rsv", "testRg", "Azure",
            "VMAppContainer;Compute;bvtdtestag;sqlserver-1", "backupManagementType eq 'AzureWorkload'", 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_workload_items_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_workload_items.list(
        vault_name="suchandr-seacan-rsv",
        resource_group_name="testRg",
        fabric_name="Azure",
        container_name="VMAppContainer;Compute;bvtdtestag;sqlserver-1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2025-02-01/examples/AzureWorkload/BackupWorkloadItems_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/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/BackupWorkloadItems_List.json
func ExampleBackupWorkloadItemsClient_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.NewBackupWorkloadItemsClient().NewListPager("suchandr-seacan-rsv", "testRg", "Azure", "VMAppContainer;Compute;bvtdtestag;sqlserver-1", &armrecoveryservicesbackup.BackupWorkloadItemsClientListOptions{Filter: to.Ptr("backupManagementType eq 'AzureWorkload'"),
		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.WorkloadItemResourceList = armrecoveryservicesbackup.WorkloadItemResourceList{
		// 	Value: []*armrecoveryservicesbackup.WorkloadItemResource{
		// 		{
		// 			Name: to.Ptr("SQLInstance;MSSQLSERVER"),
		// 			Type: to.Ptr("Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/items"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/testRg/providers/Microsoft.RecoveryServices/vaults/suchandr-seacan-rsv/backupFabrics/Azure/protectionContainers/VMAppContainer;Compute;bvtdtestag;sqlserver-1/protectableItems/SQLInstance;MSSQLSERVER"),
		// 			Properties: &armrecoveryservicesbackup.AzureVMWorkloadSQLInstanceWorkloadItem{
		// 				BackupManagementType: to.Ptr("AzureWorkload"),
		// 				FriendlyName: to.Ptr("MSSQLSERVER"),
		// 				ProtectionState: to.Ptr(armrecoveryservicesbackup.ProtectionStatusNotProtected),
		// 				WorkloadItemType: to.Ptr("SQLInstance"),
		// 				WorkloadType: to.Ptr("SQL"),
		// 				IsAutoProtectable: to.Ptr(true),
		// 				ParentName: to.Ptr("MSSQLSERVER"),
		// 				ServerName: to.Ptr("sqlserver-1.contoso.com"),
		// 				SubWorkloadItemCount: to.Ptr[int32](3),
		// 				Subinquireditemcount: to.Ptr[int32](0),
		// 				DataDirectoryPaths: []*armrecoveryservicesbackup.SQLDataDirectory{
		// 					{
		// 						Type: to.Ptr(armrecoveryservicesbackup.SQLDataDirectoryTypeData),
		// 						Path: to.Ptr("F:\\DATA\\"),
		// 					},
		// 					{
		// 						Type: to.Ptr(armrecoveryservicesbackup.SQLDataDirectoryTypeLog),
		// 						Path: to.Ptr("F:\\LOG\\"),
		// 				}},
		// 			},
		// 	}},
		// }
	}
}

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 workload item of a specific container according to the query filter and the pagination
parameters.
 *
 * @summary Provides a pageable list of workload item of a specific container according to the query filter and the pagination
parameters.
 * x-ms-original-file: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2025-02-01/examples/AzureWorkload/BackupWorkloadItems_List.json
 */
async function listWorkloadItemsInContainer() {
  const subscriptionId =
    process.env["RECOVERYSERVICESBACKUP_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const vaultName = "suchandr-seacan-rsv";
  const resourceGroupName = process.env["RECOVERYSERVICESBACKUP_RESOURCE_GROUP"] || "testRg";
  const fabricName = "Azure";
  const containerName = "VMAppContainer;Compute;bvtdtestag;sqlserver-1";
  const filter = "backupManagementType eq 'AzureWorkload'";
  const options = { filter };
  const credential = new DefaultAzureCredential();
  const client = new RecoveryServicesBackupClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.backupWorkloadItems.list(
    vaultName,
    resourceGroupName,
    fabricName,
    containerName,
    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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.RecoveryServicesBackup.Models;
using Azure.ResourceManager.RecoveryServicesBackup;

// Generated from example definition: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2025-02-01/examples/AzureWorkload/BackupWorkloadItems_List.json
// this example is just showing the usage of "BackupWorkloadItems_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 BackupProtectionContainerResource created on azure
// for more information of creating BackupProtectionContainerResource, please refer to the document of BackupProtectionContainerResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "testRg";
string vaultName = "suchandr-seacan-rsv";
string fabricName = "Azure";
string containerName = "VMAppContainer;Compute;bvtdtestag;sqlserver-1";
ResourceIdentifier backupProtectionContainerResourceId = BackupProtectionContainerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, vaultName, fabricName, containerName);
BackupProtectionContainerResource backupProtectionContainer = client.GetBackupProtectionContainerResource(backupProtectionContainerResourceId);

// invoke the operation and iterate over the result
string filter = "backupManagementType eq 'AzureWorkload'";
await foreach (WorkloadItemResource item in backupProtectionContainer.GetBackupWorkloadItemsAsync(filter: filter))
{
    Console.WriteLine($"Succeeded: {item}");
}

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/testRg/providers/Microsoft.RecoveryServices/vaults/suchandr-seacan-rsv/backupFabrics/Azure/protectionContainers/VMAppContainer;Compute;bvtdtestag;sqlserver-1/protectableItems/SQLInstance;MSSQLSERVER",
      "name": "SQLInstance;MSSQLSERVER",
      "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/items",
      "properties": {
        "dataDirectoryPaths": [
          {
            "type": "Data",
            "path": "F:\\DATA\\"
          },
          {
            "type": "Log",
            "path": "F:\\LOG\\"
          }
        ],
        "parentName": "MSSQLSERVER",
        "serverName": "sqlserver-1.contoso.com",
        "isAutoProtectable": true,
        "subinquireditemcount": 0,
        "subWorkloadItemCount": 3,
        "backupManagementType": "AzureWorkload",
        "workloadType": "SQL",
        "workloadItemType": "SQLInstance",
        "friendlyName": "MSSQLSERVER",
        "protectionState": "NotProtected"
      }
    }
  ],
  "nextLink": null
}

Definitions

Name	Description
AzureVmWorkloadItem	Azure VM workload-specific workload item.
AzureVmWorkloadSAPAseDatabaseWorkloadItem	Azure VM workload-specific workload item representing SAP ASE Database.
AzureVmWorkloadSAPAseSystemWorkloadItem	Azure VM workload-specific workload item representing SAP ASE System.
AzureVmWorkloadSAPHanaDatabaseWorkloadItem	Azure VM workload-specific workload item representing SAP HANA Database.
AzureVmWorkloadSAPHanaSystemWorkloadItem	Azure VM workload-specific workload item representing SAP HANA System.
AzureVmWorkloadSQLDatabaseWorkloadItem	Azure VM workload-specific workload item representing SQL Database.
AzureVmWorkloadSQLInstanceWorkloadItem	Azure VM workload-specific workload item representing SQL Instance.
CloudError	An error response from the Container Instance service.
CloudErrorBody	An error response from the Container Instance service.
ErrorAdditionalInfo	The resource management error additional info.
ProtectionStatus	State of the back up item.
SQLDataDirectory	SQLDataDirectory info
SQLDataDirectoryType	Type of data directory mapping
WorkloadItemResource	Base class for backup item. Workload-specific backup items are derived from this class.
WorkloadItemResourceList	List of WorkloadItem resources

AzureVmWorkloadItem

Object

Azure VM workload-specific workload item.

Name	Type	Description
backupManagementType	string	Type of backup management to backup an item.
friendlyName	string	Friendly name of the backup item.
isAutoProtectable	boolean	Indicates if workload item is auto-protectable
parentName	string	Name for instance or AG
protectionState	ProtectionStatus	State of the back up item.
serverName	string	Host/Cluster Name for instance or AG
subWorkloadItemCount	integer (int32)	For instance or AG, indicates number of DB's to be protected
subinquireditemcount	integer (int32)	For instance or AG, indicates number of DB's present
workloadItemType	string: AzureVmWorkloadItem	Type of the backup item.
workloadType	string	Type of workload for the backup management

AzureVmWorkloadSAPAseDatabaseWorkloadItem

Object

Azure VM workload-specific workload item representing SAP ASE Database.

Name	Type	Description
backupManagementType	string	Type of backup management to backup an item.
friendlyName	string	Friendly name of the backup item.
isAutoProtectable	boolean	Indicates if workload item is auto-protectable
parentName	string	Name for instance or AG
protectionState	ProtectionStatus	State of the back up item.
serverName	string	Host/Cluster Name for instance or AG
subWorkloadItemCount	integer (int32)	For instance or AG, indicates number of DB's to be protected
subinquireditemcount	integer (int32)	For instance or AG, indicates number of DB's present
workloadItemType	string: SAPAseDatabase	Type of the backup item.
workloadType	string	Type of workload for the backup management

AzureVmWorkloadSAPAseSystemWorkloadItem

Object

Azure VM workload-specific workload item representing SAP ASE System.

Name	Type	Description
backupManagementType	string	Type of backup management to backup an item.
friendlyName	string	Friendly name of the backup item.
isAutoProtectable	boolean	Indicates if workload item is auto-protectable
parentName	string	Name for instance or AG
protectionState	ProtectionStatus	State of the back up item.
serverName	string	Host/Cluster Name for instance or AG
subWorkloadItemCount	integer (int32)	For instance or AG, indicates number of DB's to be protected
subinquireditemcount	integer (int32)	For instance or AG, indicates number of DB's present
workloadItemType	string: SAPAseSystem	Type of the backup item.
workloadType	string	Type of workload for the backup management

AzureVmWorkloadSAPHanaDatabaseWorkloadItem

Object

Azure VM workload-specific workload item representing SAP HANA Database.

Name	Type	Description
backupManagementType	string	Type of backup management to backup an item.
friendlyName	string	Friendly name of the backup item.
isAutoProtectable	boolean	Indicates if workload item is auto-protectable
parentName	string	Name for instance or AG
protectionState	ProtectionStatus	State of the back up item.
serverName	string	Host/Cluster Name for instance or AG
subWorkloadItemCount	integer (int32)	For instance or AG, indicates number of DB's to be protected
subinquireditemcount	integer (int32)	For instance or AG, indicates number of DB's present
workloadItemType	string: SAPHanaDatabase	Type of the backup item.
workloadType	string	Type of workload for the backup management

AzureVmWorkloadSAPHanaSystemWorkloadItem

Object

Azure VM workload-specific workload item representing SAP HANA System.

Name	Type	Description
backupManagementType	string	Type of backup management to backup an item.
friendlyName	string	Friendly name of the backup item.
isAutoProtectable	boolean	Indicates if workload item is auto-protectable
parentName	string	Name for instance or AG
protectionState	ProtectionStatus	State of the back up item.
serverName	string	Host/Cluster Name for instance or AG
subWorkloadItemCount	integer (int32)	For instance or AG, indicates number of DB's to be protected
subinquireditemcount	integer (int32)	For instance or AG, indicates number of DB's present
workloadItemType	string: SAPHanaSystem	Type of the backup item.
workloadType	string	Type of workload for the backup management

AzureVmWorkloadSQLDatabaseWorkloadItem

Object

Azure VM workload-specific workload item representing SQL Database.

Name	Type	Description
backupManagementType	string	Type of backup management to backup an item.
friendlyName	string	Friendly name of the backup item.
isAutoProtectable	boolean	Indicates if workload item is auto-protectable
parentName	string	Name for instance or AG
protectionState	ProtectionStatus	State of the back up item.
serverName	string	Host/Cluster Name for instance or AG
subWorkloadItemCount	integer (int32)	For instance or AG, indicates number of DB's to be protected
subinquireditemcount	integer (int32)	For instance or AG, indicates number of DB's present
workloadItemType	string: SQLDataBase	Type of the backup item.
workloadType	string	Type of workload for the backup management

AzureVmWorkloadSQLInstanceWorkloadItem

Object

Azure VM workload-specific workload item representing SQL Instance.

Name	Type	Description
backupManagementType	string	Type of backup management to backup an item.
dataDirectoryPaths	SQLDataDirectory[]	Data Directory Paths for default directories
friendlyName	string	Friendly name of the backup item.
isAutoProtectable	boolean	Indicates if workload item is auto-protectable
parentName	string	Name for instance or AG
protectionState	ProtectionStatus	State of the back up item.
serverName	string	Host/Cluster Name for instance or AG
subWorkloadItemCount	integer (int32)	For instance or AG, indicates number of DB's to be protected
subinquireditemcount	integer (int32)	For instance or AG, indicates number of DB's present
workloadItemType	string: SQLInstance	Type of the backup item.
workloadType	string	Type of workload for the backup management

CloudError

Object

An error response from the Container Instance service.

Name	Type	Description
error	CloudErrorBody	The error object.

CloudErrorBody

Object

An error response from the Container Instance service.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ProtectionStatus

Enumeration

State of the back up item.

Value	Description
Invalid
NotProtected
Protecting
Protected
ProtectionFailed

SQLDataDirectory

Object

SQLDataDirectory info

Name	Type	Description
logicalName	string	Logical name of the file
path	string	File path
type	SQLDataDirectoryType	Type of data directory mapping

SQLDataDirectoryType

Enumeration

Type of data directory mapping

Value	Description
Invalid
Data
Log

WorkloadItemResource

Object

Base class for backup item. Workload-specific backup items are derived from this class.

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	WorkloadItem: AzureVmWorkloadItem AzureVmWorkloadSAPAseDatabaseWorkloadItem AzureVmWorkloadSAPAseSystemWorkloadItem AzureVmWorkloadSAPHanaDatabaseWorkloadItem AzureVmWorkloadSAPHanaSystemWorkloadItem AzureVmWorkloadSQLDatabaseWorkloadItem AzureVmWorkloadSQLInstanceWorkloadItem	WorkloadItemResource properties
tags	object	Resource tags.
type	string	Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...

WorkloadItemResourceList

Object

List of WorkloadItem 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	WorkloadItemResource[]	List of resources.