Backup Status - Get

Reference

Service:: Recovery Services - Backup

API Version:: 2023-02-01

Get the container backup status

POST https://management.azure.com/Subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupStatus?api-version=2023-02-01

URI Parameters

Name	In	Required	Type	Description
azureRegion	path	True	string	Azure region to hit Api
subscriptionId	path	True	string	The subscription Id.
api-version	query	True	string	Client Api Version.

Request Body

Name	Type	Description
poLogicalName	string	Protectable Item Logical Name
resourceId	string	Entire ARM resource id of the resource
resourceType	DataSourceType	Container Type - VM, SQLPaaS, DPM, AzureFileShare...

Responses

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

Get Azure Virtual Machine Backup Status

Sample request

POST https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.RecoveryServices/locations/southeastasia/backupStatus?api-version=2023-02-01

{
  "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Compute/VirtualMachines/testVm",
  "resourceType": "VM"
}

import com.azure.resourcemanager.recoveryservicesbackup.models.BackupStatusRequest;
import com.azure.resourcemanager.recoveryservicesbackup.models.DataSourceType;

/** Samples for BackupStatus Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-01/examples/AzureIaasVm/GetBackupStatus.json
     */
    /**
     * Sample code: Get Azure Virtual Machine Backup Status.
     *
     * @param manager Entry point to RecoveryServicesBackupManager.
     */
    public static void getAzureVirtualMachineBackupStatus(
        com.azure.resourcemanager.recoveryservicesbackup.RecoveryServicesBackupManager manager) {
        manager
            .backupStatus()
            .getWithResponse(
                "southeastasia",
                new BackupStatusRequest()
                    .withResourceType(DataSourceType.VM)
                    .withResourceId(
                        "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Compute/VirtualMachines/testVm"),
                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

from azure.identity import DefaultAzureCredential
from azure.mgmt.recoveryservicesbackup import RecoveryServicesBackupClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-recoveryservicesbackup
# USAGE
    python get_backup_status.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_status.get(
        azure_region="southeastasia",
        parameters={
            "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Compute/VirtualMachines/testVm",
            "resourceType": "VM",
        },
    )
    print(response)


# x-ms-original-file: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-01/examples/AzureIaasVm/GetBackupStatus.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

package armrecoveryservicesbackup_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/recoveryservices/armrecoveryservicesbackup/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/a498cae6d1a93f4c33073f0747b93b22815c09b7/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-01/examples/AzureIaasVm/GetBackupStatus.json
func ExampleBackupStatusClient_Get() {
	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.NewBackupStatusClient().Get(ctx, "southeastasia", armrecoveryservicesbackup.BackupStatusRequest{
		ResourceID:   to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Compute/VirtualMachines/testVm"),
		ResourceType: to.Ptr(armrecoveryservicesbackup.DataSourceTypeVM),
	}, 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.BackupStatusResponse = armrecoveryservicesbackup.BackupStatusResponse{
	// 	ContainerName: to.Ptr("iaasvmcontainer;iaasvmcontainerv2;testRg;testVm"),
	// 	ErrorCode: to.Ptr("Success"),
	// 	ErrorMessage: to.Ptr("ErrorMessage"),
	// 	FabricName: to.Ptr(armrecoveryservicesbackup.FabricNameAzure),
	// 	PolicyName: to.Ptr("myPolicy"),
	// 	ProtectedItemName: to.Ptr("vm;iaasvmcontainerv2;testRg;testVm"),
	// 	ProtectionStatus: to.Ptr(armrecoveryservicesbackup.ProtectionStatusProtected),
	// 	VaultID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.RecoveryServices/Vaults/testVault"),
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { RecoveryServicesBackupClient } = require("@azure/arm-recoveryservicesbackup");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get the container backup status
 *
 * @summary Get the container backup status
 * x-ms-original-file: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-01/examples/AzureIaasVm/GetBackupStatus.json
 */
async function getAzureVirtualMachineBackupStatus() {
  const subscriptionId =
    process.env["RECOVERYSERVICESBACKUP_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const azureRegion = "southeastasia";
  const parameters = {
    resourceId:
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Compute/VirtualMachines/testVm",
    resourceType: "VM",
  };
  const credential = new DefaultAzureCredential();
  const client = new RecoveryServicesBackupClient(credential, subscriptionId);
  const result = await client.backupStatus.get(azureRegion, parameters);
  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

using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.RecoveryServicesBackup;
using Azure.ResourceManager.RecoveryServicesBackup.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-01/examples/AzureIaasVm/GetBackupStatus.json
// this example is just showing the usage of "BackupStatus_Get" 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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
AzureLocation location = new AzureLocation("southeastasia");
BackupStatusContent content = new BackupStatusContent()
{
    ResourceType = BackupDataSourceType.Vm,
    ResourceId = new ResourceIdentifier("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Compute/VirtualMachines/testVm"),
};
BackupStatusResult result = await subscriptionResource.GetBackupStatusAsync(location, content);

Console.WriteLine($"Succeeded: {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

{
  "protectionStatus": "Protected",
  "vaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.RecoveryServices/Vaults/testVault",
  "fabricName": "Azure",
  "containerName": "iaasvmcontainer;iaasvmcontainerv2;testRg;testVm",
  "protectedItemName": "vm;iaasvmcontainerv2;testRg;testVm",
  "policyName": "myPolicy",
  "errorCode": "Success",
  "errorMessage": "ErrorMessage"
}

Definitions

Name	Description
BackupStatusRequest	BackupStatus request.
BackupStatusResponse	BackupStatus response.
DataSourceType	Type of workload this item represents.
FabricName	Specifies the fabric name - Azure or AD
ProtectionStatus	State of the back up item.

BackupStatusRequest

BackupStatus request.

Name	Type	Description
poLogicalName	string	Protectable Item Logical Name
resourceId	string	Entire ARM resource id of the resource
resourceType	DataSourceType	Container Type - VM, SQLPaaS, DPM, AzureFileShare...

BackupStatusResponse

BackupStatus response.

Name	Type	Description
containerName	string	Specifies the product specific container name. E.g. iaasvmcontainer;iaasvmcontainer;csname;vmname.
errorCode	string	ErrorCode in case of intent failed
errorMessage	string	ErrorMessage in case of intent failed.
fabricName	FabricName	Specifies the fabric name - Azure or AD
policyName	string	Specifies the policy name which is used for protection
protectedItemName	string	Specifies the product specific ds name. E.g. vm;iaasvmcontainer;csname;vmname.
protectionStatus	ProtectionStatus	Specifies whether the container is registered or not
registrationStatus	string	Container registration status
vaultId	string	Specifies the arm resource id of the vault

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

FabricName

Specifies the fabric name - Azure or AD

Name	Type	Description
Azure	string
Invalid	string

ProtectionStatus

State of the back up item.

Name	Type	Description
Invalid	string
NotProtected	string
Protected	string
Protecting	string
ProtectionFailed	string