Protected Items - Get

Service:

Recovery Services - Backup

API Version:

2024-04-01

Provides the details of the backed up item. This is an asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.

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

With optional parameters:

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

URI Parameters

Name	In	Required	Type	Description
containerName	path	True	string	Container name associated with the backed up item.
fabricName	path	True	string	Fabric name associated with the backed up item.
protectedItemName	path	True	string	Backed up item name whose details are to be fetched.
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.

Responses

Name	Type	Description
200 OK	ProtectedItemResource	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

Get Protected Classic Virtual Machine Details

Get Protected Virtual Machine Details

Get Protected Classic Virtual Machine Details

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasvmcontainer;iaasvm-rg;iaasvm-1/protectedItems/vm;iaasvmcontainer;iaasvm-rg;iaasvm-1?api-version=2024-04-01

Java

/**
 * Samples for ProtectedItems Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/
     * AzureIaasVm/ClassicCompute_ProtectedItem_Get.json
     */
    /**
     * Sample code: Get Protected Classic Virtual Machine Details.
     * 
     * @param manager Entry point to RecoveryServicesBackupManager.
     */
    public static void getProtectedClassicVirtualMachineDetails(
        com.azure.resourcemanager.recoveryservicesbackup.RecoveryServicesBackupManager manager) {
        manager.protectedItems().getWithResponse("PySDKBackupTestRsVault", "PythonSDKBackupTestRg", "Azure",
            "iaasvmcontainer;iaasvmcontainer;iaasvm-rg;iaasvm-1", "vm;iaasvmcontainer;iaasvm-rg;iaasvm-1", 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 classic_compute_protected_item_get.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.protected_items.get(
        vault_name="PySDKBackupTestRsVault",
        resource_group_name="PythonSDKBackupTestRg",
        fabric_name="Azure",
        container_name="iaasvmcontainer;iaasvmcontainer;iaasvm-rg;iaasvm-1",
        protected_item_name="vm;iaasvmcontainer;iaasvm-rg;iaasvm-1",
    )
    print(response)


# x-ms-original-file: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/AzureIaasVm/ClassicCompute_ProtectedItem_Get.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/33c4457b1d13f83965f4fe3367dca4a6df898100/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/AzureIaasVm/ClassicCompute_ProtectedItem_Get.json
func ExampleProtectedItemsClient_Get_getProtectedClassicVirtualMachineDetails() {
	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)
	}
	res, err := clientFactory.NewProtectedItemsClient().Get(ctx, "PySDKBackupTestRsVault", "PythonSDKBackupTestRg", "Azure", "iaasvmcontainer;iaasvmcontainer;iaasvm-rg;iaasvm-1", "vm;iaasvmcontainer;iaasvm-rg;iaasvm-1", &armrecoveryservicesbackup.ProtectedItemsClientGetOptions{Filter: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ProtectedItemResource = armrecoveryservicesbackup.ProtectedItemResource{
	// 	Name: to.Ptr("VM;iaasvmcontainer;iaasvm-rg;iaasvm-1"),
	// 	Type: to.Ptr("Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainer;iaasvm-rg;iaasvm-1/protectedItems/VM;iaasvmcontainer;iaasvm-rg;iaasvm-1"),
	// 	Properties: &armrecoveryservicesbackup.AzureIaaSClassicComputeVMProtectedItem{
	// 		BackupManagementType: to.Ptr(armrecoveryservicesbackup.BackupManagementTypeAzureIaasVM),
	// 		ContainerName: to.Ptr("iaasvmcontainer;iaasvm-rg;iaasvm-1"),
	// 		LastRecoveryPoint: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-22T12:25:32.048Z"); return t}()),
	// 		PolicyID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupPolicies/testPolicy1"),
	// 		ProtectedItemType: to.Ptr("Microsoft.ClassicCompute/virtualMachines"),
	// 		SourceResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/providers/Microsoft.ClassicCompute/virtualMachines/iaasvm-1"),
	// 		WorkloadType: to.Ptr(armrecoveryservicesbackup.DataSourceTypeVM),
	// 		FriendlyName: to.Ptr("iaasvm-1"),
	// 		HealthStatus: to.Ptr(armrecoveryservicesbackup.HealthStatusPassed),
	// 		LastBackupStatus: to.Ptr("Completed"),
	// 		LastBackupTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-22T12:25:32.048Z"); return t}()),
	// 		ProtectedItemDataID: to.Ptr("636482643132986882"),
	// 		ProtectionState: to.Ptr(armrecoveryservicesbackup.ProtectionStateProtected),
	// 		ProtectionStatus: to.Ptr("Healthy"),
	// 		VirtualMachineID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/providers/Microsoft.ClassicCompute/virtualMachines/iaasvm-1"),
	// 	},
	// }
}

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 Provides the details of the backed up item. This is an asynchronous operation. To know the status of the operation,
call the GetItemOperationResult API.
 *
 * @summary Provides the details of the backed up item. This is an asynchronous operation. To know the status of the operation,
call the GetItemOperationResult API.
 * x-ms-original-file: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/AzureIaasVm/ClassicCompute_ProtectedItem_Get.json
 */
async function getProtectedClassicVirtualMachineDetails() {
  const subscriptionId =
    process.env["RECOVERYSERVICESBACKUP_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const vaultName = "PySDKBackupTestRsVault";
  const resourceGroupName =
    process.env["RECOVERYSERVICESBACKUP_RESOURCE_GROUP"] || "PythonSDKBackupTestRg";
  const fabricName = "Azure";
  const containerName = "iaasvmcontainer;iaasvmcontainer;iaasvm-rg;iaasvm-1";
  const protectedItemName = "vm;iaasvmcontainer;iaasvm-rg;iaasvm-1";
  const credential = new DefaultAzureCredential();
  const client = new RecoveryServicesBackupClient(credential, subscriptionId);
  const result = await client.protectedItems.get(
    vaultName,
    resourceGroupName,
    fabricName,
    containerName,
    protectedItemName,
  );
  console.log(result);
}

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

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainer;iaasvm-rg;iaasvm-1/protectedItems/VM;iaasvmcontainer;iaasvm-rg;iaasvm-1",
  "name": "VM;iaasvmcontainer;iaasvm-rg;iaasvm-1",
  "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems",
  "properties": {
    "friendlyName": "iaasvm-1",
    "virtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/providers/Microsoft.ClassicCompute/virtualMachines/iaasvm-1",
    "protectionStatus": "Healthy",
    "protectionState": "Protected",
    "healthStatus": "Passed",
    "lastBackupStatus": "Completed",
    "lastBackupTime": "2018-01-22T12:25:32.048723Z",
    "protectedItemDataId": "636482643132986882",
    "protectedItemType": "Microsoft.ClassicCompute/virtualMachines",
    "backupManagementType": "AzureIaasVM",
    "workloadType": "VM",
    "containerName": "iaasvmcontainer;iaasvm-rg;iaasvm-1",
    "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/providers/Microsoft.ClassicCompute/virtualMachines/iaasvm-1",
    "policyId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupPolicies/testPolicy1",
    "lastRecoveryPoint": "2017-11-22T12:25:32.048723Z"
  }
}

Get Protected Virtual Machine Details

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasvmcontainerv2;iaasvm-rg;iaasvm-1/protectedItems/vm;iaasvmcontainerv2;iaasvm-rg;iaasvm-1?api-version=2024-04-01

Java

/**
 * Samples for ProtectedItems Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/
     * AzureIaasVm/Compute_ProtectedItem_Get.json
     */
    /**
     * Sample code: Get Protected Virtual Machine Details.
     * 
     * @param manager Entry point to RecoveryServicesBackupManager.
     */
    public static void getProtectedVirtualMachineDetails(
        com.azure.resourcemanager.recoveryservicesbackup.RecoveryServicesBackupManager manager) {
        manager.protectedItems().getWithResponse("PySDKBackupTestRsVault", "PythonSDKBackupTestRg", "Azure",
            "iaasvmcontainer;iaasvmcontainerv2;iaasvm-rg;iaasvm-1", "vm;iaasvmcontainerv2;iaasvm-rg;iaasvm-1", 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 compute_protected_item_get.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.protected_items.get(
        vault_name="PySDKBackupTestRsVault",
        resource_group_name="PythonSDKBackupTestRg",
        fabric_name="Azure",
        container_name="iaasvmcontainer;iaasvmcontainerv2;iaasvm-rg;iaasvm-1",
        protected_item_name="vm;iaasvmcontainerv2;iaasvm-rg;iaasvm-1",
    )
    print(response)


# x-ms-original-file: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/AzureIaasVm/Compute_ProtectedItem_Get.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/33c4457b1d13f83965f4fe3367dca4a6df898100/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/AzureIaasVm/Compute_ProtectedItem_Get.json
func ExampleProtectedItemsClient_Get_getProtectedVirtualMachineDetails() {
	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)
	}
	res, err := clientFactory.NewProtectedItemsClient().Get(ctx, "PySDKBackupTestRsVault", "PythonSDKBackupTestRg", "Azure", "iaasvmcontainer;iaasvmcontainerv2;iaasvm-rg;iaasvm-1", "vm;iaasvmcontainerv2;iaasvm-rg;iaasvm-1", &armrecoveryservicesbackup.ProtectedItemsClientGetOptions{Filter: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ProtectedItemResource = armrecoveryservicesbackup.ProtectedItemResource{
	// 	Name: to.Ptr("VM;iaasvmcontainerv2;iaasvm-rg;iaasvm-1"),
	// 	Type: to.Ptr("Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;iaasvm-rg;iaasvm-1/protectedItems/VM;iaasvmcontainerv2;iaasvm-rg;iaasvm-1"),
	// 	Properties: &armrecoveryservicesbackup.AzureIaaSComputeVMProtectedItem{
	// 		BackupManagementType: to.Ptr(armrecoveryservicesbackup.BackupManagementTypeAzureIaasVM),
	// 		ContainerName: to.Ptr("iaasvmcontainerv2;iaasvm-rg;iaasvm-1"),
	// 		LastRecoveryPoint: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-22T12:25:32.048Z"); return t}()),
	// 		PolicyID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupPolicies/testPolicy1"),
	// 		ProtectedItemType: to.Ptr("Microsoft.Compute/virtualMachines"),
	// 		SourceResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/providers/Microsoft.Compute/virtualMachines/iaasvm-1"),
	// 		WorkloadType: to.Ptr(armrecoveryservicesbackup.DataSourceTypeVM),
	// 		FriendlyName: to.Ptr("iaasvm-1"),
	// 		HealthStatus: to.Ptr(armrecoveryservicesbackup.HealthStatusPassed),
	// 		LastBackupStatus: to.Ptr("Completed"),
	// 		LastBackupTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-22T12:25:32.048Z"); return t}()),
	// 		ProtectedItemDataID: to.Ptr("636482643132986882"),
	// 		ProtectionState: to.Ptr(armrecoveryservicesbackup.ProtectionStateProtected),
	// 		ProtectionStatus: to.Ptr("Healthy"),
	// 		VirtualMachineID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/providers/Microsoft.Compute/virtualMachines/iaasvm-1"),
	// 	},
	// }
}

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 Provides the details of the backed up item. This is an asynchronous operation. To know the status of the operation,
call the GetItemOperationResult API.
 *
 * @summary Provides the details of the backed up item. This is an asynchronous operation. To know the status of the operation,
call the GetItemOperationResult API.
 * x-ms-original-file: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/AzureIaasVm/Compute_ProtectedItem_Get.json
 */
async function getProtectedVirtualMachineDetails() {
  const subscriptionId =
    process.env["RECOVERYSERVICESBACKUP_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const vaultName = "PySDKBackupTestRsVault";
  const resourceGroupName =
    process.env["RECOVERYSERVICESBACKUP_RESOURCE_GROUP"] || "PythonSDKBackupTestRg";
  const fabricName = "Azure";
  const containerName = "iaasvmcontainer;iaasvmcontainerv2;iaasvm-rg;iaasvm-1";
  const protectedItemName = "vm;iaasvmcontainerv2;iaasvm-rg;iaasvm-1";
  const credential = new DefaultAzureCredential();
  const client = new RecoveryServicesBackupClient(credential, subscriptionId);
  const result = await client.protectedItems.get(
    vaultName,
    resourceGroupName,
    fabricName,
    containerName,
    protectedItemName,
  );
  console.log(result);
}

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

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;iaasvm-rg;iaasvm-1/protectedItems/VM;iaasvmcontainerv2;iaasvm-rg;iaasvm-1",
  "name": "VM;iaasvmcontainerv2;iaasvm-rg;iaasvm-1",
  "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems",
  "properties": {
    "friendlyName": "iaasvm-1",
    "virtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/providers/Microsoft.Compute/virtualMachines/iaasvm-1",
    "protectionStatus": "Healthy",
    "protectionState": "Protected",
    "healthStatus": "Passed",
    "lastBackupStatus": "Completed",
    "lastBackupTime": "2018-01-22T12:25:32.048723Z",
    "protectedItemDataId": "636482643132986882",
    "protectedItemType": "Microsoft.Compute/virtualMachines",
    "backupManagementType": "AzureIaasVM",
    "workloadType": "VM",
    "containerName": "iaasvmcontainerv2;iaasvm-rg;iaasvm-1",
    "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/providers/Microsoft.Compute/virtualMachines/iaasvm-1",
    "policyId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupPolicies/testPolicy1",
    "lastRecoveryPoint": "2017-11-22T12:25:32.048723Z"
  }
}

Definitions

Name	Description
AzureFileshareProtectedItem	Azure File Share workload-specific backup item.
AzureFileshareProtectedItemExtendedInfo	Additional information about Azure File Share backup item.
AzureIaaSClassicComputeVMProtectedItem	IaaS VM workload-specific backup item representing the Classic Compute VM.
AzureIaaSComputeVMProtectedItem	IaaS VM workload-specific backup item representing the Azure Resource Manager VM.
AzureIaaSVMHealthDetails	Azure IaaS VM workload-specific Health Details.
AzureIaaSVMProtectedItem	IaaS VM workload-specific backup item.
AzureIaaSVMProtectedItemExtendedInfo	Additional information on Azure IaaS VM specific backup item.
AzureSqlProtectedItem	Azure SQL workload-specific backup item.
AzureSqlProtectedItemExtendedInfo	Additional information on Azure Sql specific protected item.
AzureVmWorkloadProtectedItem	Azure VM workload-specific protected item.
AzureVmWorkloadProtectedItemExtendedInfo	Additional information on Azure Workload for SQL specific backup item.
AzureVmWorkloadSAPAseDatabaseProtectedItem	Azure VM workload-specific protected item representing SAP ASE Database.
AzureVmWorkloadSAPHanaDatabaseProtectedItem	Azure VM workload-specific protected item representing SAP HANA Database.
AzureVmWorkloadSAPHanaDBInstanceProtectedItem	Azure VM workload-specific protected item representing SAP HANA DBInstance.
AzureVmWorkloadSQLDatabaseProtectedItem	Azure VM workload-specific protected item representing SQL Database.
BackupManagementType	Type of backup management for the backed up item.
CloudError	An error response from the Container Instance service.
CloudErrorBody	An error response from the Container Instance service.
CreateMode	Create mode to indicate recovery of existing soft deleted data source or creation of new data source.
DataSourceType	Type of workload this item represents.
DiskExclusionProperties
DistributedNodesInfo	This is used to represent the various nodes of the distributed container.
DPMProtectedItem	Additional information on Backup engine specific backup item.
DPMProtectedItemExtendedInfo	Additional information of DPM Protected item.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	Error Detail class which encapsulates Code, Message and Recommendations.
ExtendedProperties	Extended Properties for Azure IaasVM Backup.
GenericProtectedItem	Base class for backup items.
HealthStatus	Health status of protected item.
KPIResourceHealthDetails	KPI Resource Health Details
LastBackupStatus	Last backup operation status. Possible values: Healthy, Unhealthy.
MabFileFolderProtectedItem	MAB workload-specific backup item.
MabFileFolderProtectedItemExtendedInfo	Additional information on the backed up item.
ProtectedItemHealthStatus	Health status of the backup item, evaluated based on last heartbeat received
ProtectedItemResource	Base class for backup items.
ProtectedItemState	Backup state of the backed up item.
ProtectionState	Backup state of this backup item.
ResourceHealthDetails	Health Details for backup items.
ResourceHealthStatus	Resource Health Status

AzureFileshareProtectedItem

Azure File Share workload-specific backup item.

Name	Type	Description
backupManagementType	BackupManagementType	Type of backup management for the backed up item.
backupSetName	string	Name of the backup set the backup item belongs to
containerName	string	Unique name of container
createMode	CreateMode	Create mode to indicate recovery of existing soft deleted data source or creation of new data source.
deferredDeleteTimeInUTC	string	Time for deferred deletion in UTC
deferredDeleteTimeRemaining	string	Time remaining before the DS marked for deferred delete is permanently deleted
extendedInfo	AzureFileshareProtectedItemExtendedInfo	Additional information with this backup item.
friendlyName	string	Friendly name of the fileshare represented by this backup item.
isArchiveEnabled	boolean	Flag to identify whether datasource is protected in archive
isDeferredDeleteScheduleUpcoming	boolean	Flag to identify whether the deferred deleted DS is to be purged soon
isRehydrate	boolean	Flag to identify that deferred deleted DS is to be moved into Pause state
isScheduledForDeferredDelete	boolean	Flag to identify whether the DS is scheduled for deferred delete
kpisHealths	<string,  KPIResourceHealthDetails>	Health details of different KPIs
lastBackupStatus	string	Last backup operation status. Possible values: Healthy, Unhealthy.
lastBackupTime	string	Timestamp of the last backup operation on this backup item.
lastRecoveryPoint	string	Timestamp when the last (latest) backup copy was created for this backup item.
policyId	string	ID of the backup policy with which this item is backed up.
policyName	string	Name of the policy used for protection
protectedItemType	string: AzureFileShareProtectedItem	backup item type.
protectionState	ProtectionState	Backup state of this backup item.
protectionStatus	string	Backup status of this backup item.
resourceGuardOperationRequests	string[]	ResourceGuardOperationRequests on which LAC check will be performed
softDeleteRetentionPeriodInDays	integer	Soft delete retention period in days
sourceResourceId	string	ARM ID of the resource to be backed up.
vaultId	string	ID of the vault which protects this item
workloadType	DataSourceType	Type of workload this item represents.

AzureFileshareProtectedItemExtendedInfo

Additional information about Azure File Share backup item.

Name	Type	Description
oldestRecoveryPoint	string	The oldest backup copy available for this item in the service.
policyState	string	Indicates consistency of policy object and policy applied to this backup item.
recoveryPointCount	integer	Number of available backup copies associated with this backup item.
resourceState	string	Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted}
resourceStateSyncTime	string	The resource state sync time for this backup item.

AzureIaaSClassicComputeVMProtectedItem

IaaS VM workload-specific backup item representing the Classic Compute VM.

Name	Type	Description
backupManagementType	BackupManagementType	Type of backup management for the backed up item.
backupSetName	string	Name of the backup set the backup item belongs to
containerName	string	Unique name of container
createMode	CreateMode	Create mode to indicate recovery of existing soft deleted data source or creation of new data source.
deferredDeleteTimeInUTC	string	Time for deferred deletion in UTC
deferredDeleteTimeRemaining	string	Time remaining before the DS marked for deferred delete is permanently deleted
extendedInfo	AzureIaaSVMProtectedItemExtendedInfo	Additional information for this backup item.
extendedProperties	ExtendedProperties	Extended Properties for Azure IaasVM Backup.
friendlyName	string	Friendly name of the VM represented by this backup item.
healthDetails	AzureIaaSVMHealthDetails[]	Health details on this backup item.
healthStatus	HealthStatus	Health status of protected item.
isArchiveEnabled	boolean	Flag to identify whether datasource is protected in archive
isDeferredDeleteScheduleUpcoming	boolean	Flag to identify whether the deferred deleted DS is to be purged soon
isRehydrate	boolean	Flag to identify that deferred deleted DS is to be moved into Pause state
isScheduledForDeferredDelete	boolean	Flag to identify whether the DS is scheduled for deferred delete
kpisHealths	<string,  KPIResourceHealthDetails>	Health details of different KPIs
lastBackupStatus	string	Last backup operation status.
lastBackupTime	string	Timestamp of the last backup operation on this backup item.
lastRecoveryPoint	string	Timestamp when the last (latest) backup copy was created for this backup item.
policyId	string	ID of the backup policy with which this item is backed up.
policyName	string	Name of the policy used for protection
protectedItemDataId	string	Data ID of the protected item.
protectedItemType	string: Microsoft.ClassicCompute/virtualMachines	backup item type.
protectionState	ProtectionState	Backup state of this backup item.
protectionStatus	string	Backup status of this backup item.
resourceGuardOperationRequests	string[]	ResourceGuardOperationRequests on which LAC check will be performed
softDeleteRetentionPeriodInDays	integer	Soft delete retention period in days
sourceResourceId	string	ARM ID of the resource to be backed up.
vaultId	string	ID of the vault which protects this item
virtualMachineId	string	Fully qualified ARM ID of the virtual machine represented by this item.
workloadType	DataSourceType	Type of workload this item represents.

AzureIaaSComputeVMProtectedItem

IaaS VM workload-specific backup item representing the Azure Resource Manager VM.

Name	Type	Description
backupManagementType	BackupManagementType	Type of backup management for the backed up item.
backupSetName	string	Name of the backup set the backup item belongs to
containerName	string	Unique name of container
createMode	CreateMode	Create mode to indicate recovery of existing soft deleted data source or creation of new data source.
deferredDeleteTimeInUTC	string	Time for deferred deletion in UTC
deferredDeleteTimeRemaining	string	Time remaining before the DS marked for deferred delete is permanently deleted
extendedInfo	AzureIaaSVMProtectedItemExtendedInfo	Additional information for this backup item.
extendedProperties	ExtendedProperties	Extended Properties for Azure IaasVM Backup.
friendlyName	string	Friendly name of the VM represented by this backup item.
healthDetails	AzureIaaSVMHealthDetails[]	Health details on this backup item.
healthStatus	HealthStatus	Health status of protected item.
isArchiveEnabled	boolean	Flag to identify whether datasource is protected in archive
isDeferredDeleteScheduleUpcoming	boolean	Flag to identify whether the deferred deleted DS is to be purged soon
isRehydrate	boolean	Flag to identify that deferred deleted DS is to be moved into Pause state
isScheduledForDeferredDelete	boolean	Flag to identify whether the DS is scheduled for deferred delete
kpisHealths	<string,  KPIResourceHealthDetails>	Health details of different KPIs
lastBackupStatus	string	Last backup operation status.
lastBackupTime	string	Timestamp of the last backup operation on this backup item.
lastRecoveryPoint	string	Timestamp when the last (latest) backup copy was created for this backup item.
policyId	string	ID of the backup policy with which this item is backed up.
policyName	string	Name of the policy used for protection
protectedItemDataId	string	Data ID of the protected item.
protectedItemType	string: Microsoft.Compute/virtualMachines	backup item type.
protectionState	ProtectionState	Backup state of this backup item.
protectionStatus	string	Backup status of this backup item.
resourceGuardOperationRequests	string[]	ResourceGuardOperationRequests on which LAC check will be performed
softDeleteRetentionPeriodInDays	integer	Soft delete retention period in days
sourceResourceId	string	ARM ID of the resource to be backed up.
vaultId	string	ID of the vault which protects this item
virtualMachineId	string	Fully qualified ARM ID of the virtual machine represented by this item.
workloadType	DataSourceType	Type of workload this item represents.

AzureIaaSVMHealthDetails

Azure IaaS VM workload-specific Health Details.

Name	Type	Description
code	integer	Health Code
message	string	Health Message
recommendations	string[]	Health Recommended Actions
title	string	Health Title

AzureIaaSVMProtectedItem

IaaS VM workload-specific backup item.

Name	Type	Description
backupManagementType	BackupManagementType	Type of backup management for the backed up item.
backupSetName	string	Name of the backup set the backup item belongs to
containerName	string	Unique name of container
createMode	CreateMode	Create mode to indicate recovery of existing soft deleted data source or creation of new data source.
deferredDeleteTimeInUTC	string	Time for deferred deletion in UTC
deferredDeleteTimeRemaining	string	Time remaining before the DS marked for deferred delete is permanently deleted
extendedInfo	AzureIaaSVMProtectedItemExtendedInfo	Additional information for this backup item.
extendedProperties	ExtendedProperties	Extended Properties for Azure IaasVM Backup.
friendlyName	string	Friendly name of the VM represented by this backup item.
healthDetails	AzureIaaSVMHealthDetails[]	Health details on this backup item.
healthStatus	HealthStatus	Health status of protected item.
isArchiveEnabled	boolean	Flag to identify whether datasource is protected in archive
isDeferredDeleteScheduleUpcoming	boolean	Flag to identify whether the deferred deleted DS is to be purged soon
isRehydrate	boolean	Flag to identify that deferred deleted DS is to be moved into Pause state
isScheduledForDeferredDelete	boolean	Flag to identify whether the DS is scheduled for deferred delete
kpisHealths	<string,  KPIResourceHealthDetails>	Health details of different KPIs
lastBackupStatus	string	Last backup operation status.
lastBackupTime	string	Timestamp of the last backup operation on this backup item.
lastRecoveryPoint	string	Timestamp when the last (latest) backup copy was created for this backup item.
policyId	string	ID of the backup policy with which this item is backed up.
policyName	string	Name of the policy used for protection
protectedItemDataId	string	Data ID of the protected item.
protectedItemType	string: AzureIaaSVMProtectedItem	backup item type.
protectionState	ProtectionState	Backup state of this backup item.
protectionStatus	string	Backup status of this backup item.
resourceGuardOperationRequests	string[]	ResourceGuardOperationRequests on which LAC check will be performed
softDeleteRetentionPeriodInDays	integer	Soft delete retention period in days
sourceResourceId	string	ARM ID of the resource to be backed up.
vaultId	string	ID of the vault which protects this item
virtualMachineId	string	Fully qualified ARM ID of the virtual machine represented by this item.
workloadType	DataSourceType	Type of workload this item represents.

AzureIaaSVMProtectedItemExtendedInfo

Additional information on Azure IaaS VM specific backup item.

Name	Type	Description
newestRecoveryPointInArchive	string	The latest backup copy available for this backup item in archive tier
oldestRecoveryPoint	string	The oldest backup copy available for this backup item across all tiers.
oldestRecoveryPointInArchive	string	The oldest backup copy available for this backup item in archive tier
oldestRecoveryPointInVault	string	The oldest backup copy available for this backup item in vault tier
policyInconsistent	boolean	Specifies if backup policy associated with the backup item is inconsistent.
recoveryPointCount	integer	Number of backup copies available for this backup item.

AzureSqlProtectedItem

Azure SQL workload-specific backup item.

Name	Type	Description
backupManagementType	BackupManagementType	Type of backup management for the backed up item.
backupSetName	string	Name of the backup set the backup item belongs to
containerName	string	Unique name of container
createMode	CreateMode	Create mode to indicate recovery of existing soft deleted data source or creation of new data source.
deferredDeleteTimeInUTC	string	Time for deferred deletion in UTC
deferredDeleteTimeRemaining	string	Time remaining before the DS marked for deferred delete is permanently deleted
extendedInfo	AzureSqlProtectedItemExtendedInfo	Additional information for this backup item.
isArchiveEnabled	boolean	Flag to identify whether datasource is protected in archive
isDeferredDeleteScheduleUpcoming	boolean	Flag to identify whether the deferred deleted DS is to be purged soon
isRehydrate	boolean	Flag to identify that deferred deleted DS is to be moved into Pause state
isScheduledForDeferredDelete	boolean	Flag to identify whether the DS is scheduled for deferred delete
lastRecoveryPoint	string	Timestamp when the last (latest) backup copy was created for this backup item.
policyId	string	ID of the backup policy with which this item is backed up.
policyName	string	Name of the policy used for protection
protectedItemDataId	string	Internal ID of a backup item. Used by Azure SQL Backup engine to contact Recovery Services.
protectedItemType	string: Microsoft.Sql/servers/databases	backup item type.
protectionState	ProtectedItemState	Backup state of the backed up item.
resourceGuardOperationRequests	string[]	ResourceGuardOperationRequests on which LAC check will be performed
softDeleteRetentionPeriodInDays	integer	Soft delete retention period in days
sourceResourceId	string	ARM ID of the resource to be backed up.
vaultId	string	ID of the vault which protects this item
workloadType	DataSourceType	Type of workload this item represents.

AzureSqlProtectedItemExtendedInfo

Additional information on Azure Sql specific protected item.

Name	Type	Description
oldestRecoveryPoint	string	The oldest backup copy available for this item in the service.
policyState	string	State of the backup policy associated with this backup item.
recoveryPointCount	integer	Number of available backup copies associated with this backup item.

AzureVmWorkloadProtectedItem

Azure VM workload-specific protected item.

Name	Type	Description
backupManagementType	BackupManagementType	Type of backup management for the backed up item.
backupSetName	string	Name of the backup set the backup item belongs to
containerName	string	Unique name of container
createMode	CreateMode	Create mode to indicate recovery of existing soft deleted data source or creation of new data source.
deferredDeleteTimeInUTC	string	Time for deferred deletion in UTC
deferredDeleteTimeRemaining	string	Time remaining before the DS marked for deferred delete is permanently deleted
extendedInfo	AzureVmWorkloadProtectedItemExtendedInfo	Additional information for this backup item.
friendlyName	string	Friendly name of the DB represented by this backup item.
isArchiveEnabled	boolean	Flag to identify whether datasource is protected in archive
isDeferredDeleteScheduleUpcoming	boolean	Flag to identify whether the deferred deleted DS is to be purged soon
isRehydrate	boolean	Flag to identify that deferred deleted DS is to be moved into Pause state
isScheduledForDeferredDelete	boolean	Flag to identify whether the DS is scheduled for deferred delete
kpisHealths	<string,  KPIResourceHealthDetails>	Health details of different KPIs
lastBackupErrorDetail	ErrorDetail	Error details in last backup
lastBackupStatus	LastBackupStatus	Last backup operation status. Possible values: Healthy, Unhealthy.
lastBackupTime	string	Timestamp of the last backup operation on this backup item.
lastRecoveryPoint	string	Timestamp when the last (latest) backup copy was created for this backup item.
nodesList	DistributedNodesInfo[]	List of the nodes in case of distributed container.
parentName	string	Parent name of the DB such as Instance or Availability Group.
parentType	string	Parent type of protected item, example: for a DB, standalone server or distributed
policyId	string	ID of the backup policy with which this item is backed up.
policyName	string	Name of the policy used for protection
protectedItemDataSourceId	string	Data ID of the protected item.
protectedItemHealthStatus	ProtectedItemHealthStatus	Health status of the backup item, evaluated based on last heartbeat received
protectedItemType	string: AzureVmWorkloadProtectedItem	backup item type.
protectionState	ProtectionState	Backup state of this backup item.
protectionStatus	string	Backup status of this backup item.
resourceGuardOperationRequests	string[]	ResourceGuardOperationRequests on which LAC check will be performed
serverName	string	Host/Cluster Name for instance or AG
softDeleteRetentionPeriodInDays	integer	Soft delete retention period in days
sourceResourceId	string	ARM ID of the resource to be backed up.
vaultId	string	ID of the vault which protects this item
workloadType	DataSourceType	Type of workload this item represents.

AzureVmWorkloadProtectedItemExtendedInfo

Additional information on Azure Workload for SQL specific backup item.

Name	Type	Description
newestRecoveryPointInArchive	string	The latest backup copy available for this backup item in archive tier
oldestRecoveryPoint	string	The oldest backup copy available for this backup item across all tiers.
oldestRecoveryPointInArchive	string	The oldest backup copy available for this backup item in archive tier
oldestRecoveryPointInVault	string	The oldest backup copy available for this backup item in vault tier
policyState	string	Indicates consistency of policy object and policy applied to this backup item.
recoveryModel	string	Indicates consistency of policy object and policy applied to this backup item.
recoveryPointCount	integer	Number of backup copies available for this backup item.

AzureVmWorkloadSAPAseDatabaseProtectedItem

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

Name	Type	Description
backupManagementType	BackupManagementType	Type of backup management for the backed up item.
backupSetName	string	Name of the backup set the backup item belongs to
containerName	string	Unique name of container
createMode	CreateMode	Create mode to indicate recovery of existing soft deleted data source or creation of new data source.
deferredDeleteTimeInUTC	string	Time for deferred deletion in UTC
deferredDeleteTimeRemaining	string	Time remaining before the DS marked for deferred delete is permanently deleted
extendedInfo	AzureVmWorkloadProtectedItemExtendedInfo	Additional information for this backup item.
friendlyName	string	Friendly name of the DB represented by this backup item.
isArchiveEnabled	boolean	Flag to identify whether datasource is protected in archive
isDeferredDeleteScheduleUpcoming	boolean	Flag to identify whether the deferred deleted DS is to be purged soon
isRehydrate	boolean	Flag to identify that deferred deleted DS is to be moved into Pause state
isScheduledForDeferredDelete	boolean	Flag to identify whether the DS is scheduled for deferred delete
kpisHealths	<string,  KPIResourceHealthDetails>	Health details of different KPIs
lastBackupErrorDetail	ErrorDetail	Error details in last backup
lastBackupStatus	LastBackupStatus	Last backup operation status. Possible values: Healthy, Unhealthy.
lastBackupTime	string	Timestamp of the last backup operation on this backup item.
lastRecoveryPoint	string	Timestamp when the last (latest) backup copy was created for this backup item.
nodesList	DistributedNodesInfo[]	List of the nodes in case of distributed container.
parentName	string	Parent name of the DB such as Instance or Availability Group.
parentType	string	Parent type of protected item, example: for a DB, standalone server or distributed
policyId	string	ID of the backup policy with which this item is backed up.
policyName	string	Name of the policy used for protection
protectedItemDataSourceId	string	Data ID of the protected item.
protectedItemHealthStatus	ProtectedItemHealthStatus	Health status of the backup item, evaluated based on last heartbeat received
protectedItemType	string: AzureVmWorkloadSAPAseDatabase	backup item type.
protectionState	ProtectionState	Backup state of this backup item.
protectionStatus	string	Backup status of this backup item.
resourceGuardOperationRequests	string[]	ResourceGuardOperationRequests on which LAC check will be performed
serverName	string	Host/Cluster Name for instance or AG
softDeleteRetentionPeriodInDays	integer	Soft delete retention period in days
sourceResourceId	string	ARM ID of the resource to be backed up.
vaultId	string	ID of the vault which protects this item
workloadType	DataSourceType	Type of workload this item represents.

AzureVmWorkloadSAPHanaDatabaseProtectedItem

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

Name	Type	Description
backupManagementType	BackupManagementType	Type of backup management for the backed up item.
backupSetName	string	Name of the backup set the backup item belongs to
containerName	string	Unique name of container
createMode	CreateMode	Create mode to indicate recovery of existing soft deleted data source or creation of new data source.
deferredDeleteTimeInUTC	string	Time for deferred deletion in UTC
deferredDeleteTimeRemaining	string	Time remaining before the DS marked for deferred delete is permanently deleted
extendedInfo	AzureVmWorkloadProtectedItemExtendedInfo	Additional information for this backup item.
friendlyName	string	Friendly name of the DB represented by this backup item.
isArchiveEnabled	boolean	Flag to identify whether datasource is protected in archive
isDeferredDeleteScheduleUpcoming	boolean	Flag to identify whether the deferred deleted DS is to be purged soon
isRehydrate	boolean	Flag to identify that deferred deleted DS is to be moved into Pause state
isScheduledForDeferredDelete	boolean	Flag to identify whether the DS is scheduled for deferred delete
kpisHealths	<string,  KPIResourceHealthDetails>	Health details of different KPIs
lastBackupErrorDetail	ErrorDetail	Error details in last backup
lastBackupStatus	LastBackupStatus	Last backup operation status. Possible values: Healthy, Unhealthy.
lastBackupTime	string	Timestamp of the last backup operation on this backup item.
lastRecoveryPoint	string	Timestamp when the last (latest) backup copy was created for this backup item.
nodesList	DistributedNodesInfo[]	List of the nodes in case of distributed container.
parentName	string	Parent name of the DB such as Instance or Availability Group.
parentType	string	Parent type of protected item, example: for a DB, standalone server or distributed
policyId	string	ID of the backup policy with which this item is backed up.
policyName	string	Name of the policy used for protection
protectedItemDataSourceId	string	Data ID of the protected item.
protectedItemHealthStatus	ProtectedItemHealthStatus	Health status of the backup item, evaluated based on last heartbeat received
protectedItemType	string: AzureVmWorkloadSAPHanaDatabase	backup item type.
protectionState	ProtectionState	Backup state of this backup item.
protectionStatus	string	Backup status of this backup item.
resourceGuardOperationRequests	string[]	ResourceGuardOperationRequests on which LAC check will be performed
serverName	string	Host/Cluster Name for instance or AG
softDeleteRetentionPeriodInDays	integer	Soft delete retention period in days
sourceResourceId	string	ARM ID of the resource to be backed up.
vaultId	string	ID of the vault which protects this item
workloadType	DataSourceType	Type of workload this item represents.

AzureVmWorkloadSAPHanaDBInstanceProtectedItem

Azure VM workload-specific protected item representing SAP HANA DBInstance.

Name	Type	Description
backupManagementType	BackupManagementType	Type of backup management for the backed up item.
backupSetName	string	Name of the backup set the backup item belongs to
containerName	string	Unique name of container
createMode	CreateMode	Create mode to indicate recovery of existing soft deleted data source or creation of new data source.
deferredDeleteTimeInUTC	string	Time for deferred deletion in UTC
deferredDeleteTimeRemaining	string	Time remaining before the DS marked for deferred delete is permanently deleted
extendedInfo	AzureVmWorkloadProtectedItemExtendedInfo	Additional information for this backup item.
friendlyName	string	Friendly name of the DB represented by this backup item.
isArchiveEnabled	boolean	Flag to identify whether datasource is protected in archive
isDeferredDeleteScheduleUpcoming	boolean	Flag to identify whether the deferred deleted DS is to be purged soon
isRehydrate	boolean	Flag to identify that deferred deleted DS is to be moved into Pause state
isScheduledForDeferredDelete	boolean	Flag to identify whether the DS is scheduled for deferred delete
kpisHealths	<string,  KPIResourceHealthDetails>	Health details of different KPIs
lastBackupErrorDetail	ErrorDetail	Error details in last backup
lastBackupStatus	LastBackupStatus	Last backup operation status. Possible values: Healthy, Unhealthy.
lastBackupTime	string	Timestamp of the last backup operation on this backup item.
lastRecoveryPoint	string	Timestamp when the last (latest) backup copy was created for this backup item.
nodesList	DistributedNodesInfo[]	List of the nodes in case of distributed container.
parentName	string	Parent name of the DB such as Instance or Availability Group.
parentType	string	Parent type of protected item, example: for a DB, standalone server or distributed
policyId	string	ID of the backup policy with which this item is backed up.
policyName	string	Name of the policy used for protection
protectedItemDataSourceId	string	Data ID of the protected item.
protectedItemHealthStatus	ProtectedItemHealthStatus	Health status of the backup item, evaluated based on last heartbeat received
protectedItemType	string: AzureVmWorkloadSAPHanaDBInstance	backup item type.
protectionState	ProtectionState	Backup state of this backup item.
protectionStatus	string	Backup status of this backup item.
resourceGuardOperationRequests	string[]	ResourceGuardOperationRequests on which LAC check will be performed
serverName	string	Host/Cluster Name for instance or AG
softDeleteRetentionPeriodInDays	integer	Soft delete retention period in days
sourceResourceId	string	ARM ID of the resource to be backed up.
vaultId	string	ID of the vault which protects this item
workloadType	DataSourceType	Type of workload this item represents.

AzureVmWorkloadSQLDatabaseProtectedItem

Azure VM workload-specific protected item representing SQL Database.

Name	Type	Description
backupManagementType	BackupManagementType	Type of backup management for the backed up item.
backupSetName	string	Name of the backup set the backup item belongs to
containerName	string	Unique name of container
createMode	CreateMode	Create mode to indicate recovery of existing soft deleted data source or creation of new data source.
deferredDeleteTimeInUTC	string	Time for deferred deletion in UTC
deferredDeleteTimeRemaining	string	Time remaining before the DS marked for deferred delete is permanently deleted
extendedInfo	AzureVmWorkloadProtectedItemExtendedInfo	Additional information for this backup item.
friendlyName	string	Friendly name of the DB represented by this backup item.
isArchiveEnabled	boolean	Flag to identify whether datasource is protected in archive
isDeferredDeleteScheduleUpcoming	boolean	Flag to identify whether the deferred deleted DS is to be purged soon
isRehydrate	boolean	Flag to identify that deferred deleted DS is to be moved into Pause state
isScheduledForDeferredDelete	boolean	Flag to identify whether the DS is scheduled for deferred delete
kpisHealths	<string,  KPIResourceHealthDetails>	Health details of different KPIs
lastBackupErrorDetail	ErrorDetail	Error details in last backup
lastBackupStatus	LastBackupStatus	Last backup operation status. Possible values: Healthy, Unhealthy.
lastBackupTime	string	Timestamp of the last backup operation on this backup item.
lastRecoveryPoint	string	Timestamp when the last (latest) backup copy was created for this backup item.
nodesList	DistributedNodesInfo[]	List of the nodes in case of distributed container.
parentName	string	Parent name of the DB such as Instance or Availability Group.
parentType	string	Parent type of protected item, example: for a DB, standalone server or distributed
policyId	string	ID of the backup policy with which this item is backed up.
policyName	string	Name of the policy used for protection
protectedItemDataSourceId	string	Data ID of the protected item.
protectedItemHealthStatus	ProtectedItemHealthStatus	Health status of the backup item, evaluated based on last heartbeat received
protectedItemType	string: AzureVmWorkloadSQLDatabase	backup item type.
protectionState	ProtectionState	Backup state of this backup item.
protectionStatus	string	Backup status of this backup item.
resourceGuardOperationRequests	string[]	ResourceGuardOperationRequests on which LAC check will be performed
serverName	string	Host/Cluster Name for instance or AG
softDeleteRetentionPeriodInDays	integer	Soft delete retention period in days
sourceResourceId	string	ARM ID of the resource to be backed up.
vaultId	string	ID of the vault which protects this item
workloadType	DataSourceType	Type of workload this item represents.

BackupManagementType

Type of backup management for the backed up item.

Name	Type	Description
AzureBackupServer	string
AzureIaasVM	string
AzureSql	string
AzureStorage	string
AzureWorkload	string
DPM	string
DefaultBackup	string
Invalid	string
MAB	string

CloudError

An error response from the Container Instance service.

Name	Type	Description
error	CloudErrorBody	The error object.

CloudErrorBody

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.

CreateMode

Create mode to indicate recovery of existing soft deleted data source or creation of new data source.

Name	Type	Description
Default	string
Invalid	string
Recover	string

DataSourceType

Type of workload this item represents.

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

DiskExclusionProperties

Name	Type	Description
diskLunList	integer[]	List of Disks' Logical Unit Numbers (LUN) to be used for VM Protection.
isInclusionList	boolean	Flag to indicate whether DiskLunList is to be included/ excluded from backup.

DistributedNodesInfo

This is used to represent the various nodes of the distributed container.

Name	Type	Description
errorDetail	ErrorDetail	Error Details if the Status is non-success.
nodeName	string	Name of the node under a distributed container.
sourceResourceId	string	ARM resource id of the node
status	string	Status of this Node. Failed | Succeeded

DPMProtectedItem

Additional information on Backup engine specific backup item.

Name	Type	Description
backupEngineName	string	Backup Management server protecting this backup item
backupManagementType	BackupManagementType	Type of backup management for the backed up item.
backupSetName	string	Name of the backup set the backup item belongs to
containerName	string	Unique name of container
createMode	CreateMode	Create mode to indicate recovery of existing soft deleted data source or creation of new data source.
deferredDeleteTimeInUTC	string	Time for deferred deletion in UTC
deferredDeleteTimeRemaining	string	Time remaining before the DS marked for deferred delete is permanently deleted
extendedInfo	DPMProtectedItemExtendedInfo	Extended info of the backup item.
friendlyName	string	Friendly name of the managed item
isArchiveEnabled	boolean	Flag to identify whether datasource is protected in archive
isDeferredDeleteScheduleUpcoming	boolean	Flag to identify whether the deferred deleted DS is to be purged soon
isRehydrate	boolean	Flag to identify that deferred deleted DS is to be moved into Pause state
isScheduledForDeferredDelete	boolean	Flag to identify whether the DS is scheduled for deferred delete
lastRecoveryPoint	string	Timestamp when the last (latest) backup copy was created for this backup item.
policyId	string	ID of the backup policy with which this item is backed up.
policyName	string	Name of the policy used for protection
protectedItemType	string: DPMProtectedItem	backup item type.
protectionState	ProtectedItemState	Protection state of the backup engine
resourceGuardOperationRequests	string[]	ResourceGuardOperationRequests on which LAC check will be performed
softDeleteRetentionPeriodInDays	integer	Soft delete retention period in days
sourceResourceId	string	ARM ID of the resource to be backed up.
vaultId	string	ID of the vault which protects this item
workloadType	DataSourceType	Type of workload this item represents.

DPMProtectedItemExtendedInfo

Additional information of DPM Protected item.

Name	Type	Description
diskStorageUsedInBytes	string	Used Disk storage in bytes.
isCollocated	boolean	To check if backup item is collocated.
isPresentOnCloud	boolean	To check if backup item is cloud protected.
lastBackupStatus	string	Last backup status information on backup item.
lastRefreshedAt	string	Last refresh time on backup item.
oldestRecoveryPoint	string	Oldest cloud recovery point time.
onPremiseLatestRecoveryPoint	string	latest disk recovery point time.
onPremiseOldestRecoveryPoint	string	Oldest disk recovery point time.
onPremiseRecoveryPointCount	integer	disk recovery point count.
protectableObjectLoadPath	object	Attribute to provide information on various DBs.
protected	boolean	To check if backup item is disk protected.
protectionGroupName	string	Protection group name of the backup item.
recoveryPointCount	integer	cloud recovery point count.
totalDiskStorageSizeInBytes	string	total Disk storage in bytes.

ErrorAdditionalInfo

The resource management error additional info.

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

ErrorDetail

Error Detail class which encapsulates Code, Message and Recommendations.

Name	Type	Description
code	string	Error code.
message	string	Error Message related to the Code.
recommendations	string[]	List of recommendation strings.

ExtendedProperties

Extended Properties for Azure IaasVM Backup.

Name	Type	Description
diskExclusionProperties	DiskExclusionProperties	Extended Properties for Disk Exclusion.
linuxVmApplicationName	string	Linux VM name

GenericProtectedItem

Base class for backup items.

Name	Type	Description
backupManagementType	BackupManagementType	Type of backup management for the backed up item.
backupSetName	string	Name of the backup set the backup item belongs to
containerName	string	Unique name of container
createMode	CreateMode	Create mode to indicate recovery of existing soft deleted data source or creation of new data source.
deferredDeleteTimeInUTC	string	Time for deferred deletion in UTC
deferredDeleteTimeRemaining	string	Time remaining before the DS marked for deferred delete is permanently deleted
fabricName	string	Name of this backup item's fabric.
friendlyName	string	Friendly name of the container.
isArchiveEnabled	boolean	Flag to identify whether datasource is protected in archive
isDeferredDeleteScheduleUpcoming	boolean	Flag to identify whether the deferred deleted DS is to be purged soon
isRehydrate	boolean	Flag to identify that deferred deleted DS is to be moved into Pause state
isScheduledForDeferredDelete	boolean	Flag to identify whether the DS is scheduled for deferred delete
lastRecoveryPoint	string	Timestamp when the last (latest) backup copy was created for this backup item.
policyId	string	ID of the backup policy with which this item is backed up.
policyName	string	Name of the policy used for protection
policyState	string	Indicates consistency of policy object and policy applied to this backup item.
protectedItemId	integer	Data Plane Service ID of the protected item.
protectedItemType	string: GenericProtectedItem	backup item type.
protectionState	ProtectionState	Backup state of this backup item.
resourceGuardOperationRequests	string[]	ResourceGuardOperationRequests on which LAC check will be performed
softDeleteRetentionPeriodInDays	integer	Soft delete retention period in days
sourceAssociations	object	Loosely coupled (type, value) associations (example - parent of a protected item)
sourceResourceId	string	ARM ID of the resource to be backed up.
vaultId	string	ID of the vault which protects this item
workloadType	DataSourceType	Type of workload this item represents.

HealthStatus

Health status of protected item.

Name	Type	Description
ActionRequired	string
ActionSuggested	string
Invalid	string
Passed	string

KPIResourceHealthDetails

KPI Resource Health Details

Name	Type	Description
resourceHealthDetails	ResourceHealthDetails[]	Resource Health Status
resourceHealthStatus	ResourceHealthStatus	Resource Health Status

LastBackupStatus

Last backup operation status. Possible values: Healthy, Unhealthy.

Name	Type	Description
Healthy	string
IRPending	string
Invalid	string
Unhealthy	string

MabFileFolderProtectedItem

MAB workload-specific backup item.

Name	Type	Description
backupManagementType	BackupManagementType	Type of backup management for the backed up item.
backupSetName	string	Name of the backup set the backup item belongs to
computerName	string	Name of the computer associated with this backup item.
containerName	string	Unique name of container
createMode	CreateMode	Create mode to indicate recovery of existing soft deleted data source or creation of new data source.
deferredDeleteSyncTimeInUTC	integer	Sync time for deferred deletion in UTC
deferredDeleteTimeInUTC	string	Time for deferred deletion in UTC
deferredDeleteTimeRemaining	string	Time remaining before the DS marked for deferred delete is permanently deleted
extendedInfo	MabFileFolderProtectedItemExtendedInfo	Additional information with this backup item.
friendlyName	string	Friendly name of this backup item.
isArchiveEnabled	boolean	Flag to identify whether datasource is protected in archive
isDeferredDeleteScheduleUpcoming	boolean	Flag to identify whether the deferred deleted DS is to be purged soon
isRehydrate	boolean	Flag to identify that deferred deleted DS is to be moved into Pause state
isScheduledForDeferredDelete	boolean	Flag to identify whether the DS is scheduled for deferred delete
lastBackupStatus	string	Status of last backup operation.
lastBackupTime	string	Timestamp of the last backup operation on this backup item.
lastRecoveryPoint	string	Timestamp when the last (latest) backup copy was created for this backup item.
policyId	string	ID of the backup policy with which this item is backed up.
policyName	string	Name of the policy used for protection
protectedItemType	string: MabFileFolderProtectedItem	backup item type.
protectionState	string	Protected, ProtectionStopped, IRPending or ProtectionError
resourceGuardOperationRequests	string[]	ResourceGuardOperationRequests on which LAC check will be performed
softDeleteRetentionPeriodInDays	integer	Soft delete retention period in days
sourceResourceId	string	ARM ID of the resource to be backed up.
vaultId	string	ID of the vault which protects this item
workloadType	DataSourceType	Type of workload this item represents.

MabFileFolderProtectedItemExtendedInfo

Additional information on the backed up item.

Name	Type	Description
lastRefreshedAt	string	Last time when the agent data synced to service.
oldestRecoveryPoint	string	The oldest backup copy available.
recoveryPointCount	integer	Number of backup copies associated with the backup item.

ProtectedItemHealthStatus

Health status of the backup item, evaluated based on last heartbeat received

Name	Type	Description
Healthy	string
IRPending	string
Invalid	string
NotReachable	string
Unhealthy	string

ProtectedItemResource

Base class for backup items.

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	ProtectedItem: AzureFileshareProtectedItem AzureIaaSClassicComputeVMProtectedItem AzureIaaSComputeVMProtectedItem AzureIaaSVMProtectedItem AzureSqlProtectedItem AzureVmWorkloadProtectedItem AzureVmWorkloadSAPAseDatabaseProtectedItem AzureVmWorkloadSAPHanaDBInstanceProtectedItem AzureVmWorkloadSAPHanaDatabaseProtectedItem AzureVmWorkloadSQLDatabaseProtectedItem DPMProtectedItem GenericProtectedItem MabFileFolderProtectedItem	ProtectedItemResource properties
tags	object	Resource tags.
type	string	Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...

ProtectedItemState

Backup state of the backed up item.

Name	Type	Description
BackupsSuspended	string
IRPending	string
Invalid	string
Protected	string
ProtectionError	string
ProtectionPaused	string
ProtectionStopped	string

ProtectionState

Backup state of this backup item.

Name	Type	Description
BackupsSuspended	string
IRPending	string
Invalid	string
Protected	string
ProtectionError	string
ProtectionPaused	string
ProtectionStopped	string

ResourceHealthDetails

Health Details for backup items.

Name	Type	Description
code	integer	Health Code
message	string	Health Message
recommendations	string[]	Health Recommended Actions
title	string	Health Title

ResourceHealthStatus

Resource Health Status

Name	Type	Description
Healthy	string
Invalid	string
PersistentDegraded	string
PersistentUnhealthy	string
TransientDegraded	string
TransientUnhealthy	string