Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://learn.microsoft.com/en-us/rest/api/backup/protected-items/create-or-update below:

Protected Items - Create Or Update - REST API (Azure Recovery Services - Backup)

Enables backup of an item or to modifies the backup policy information of an already backed up item. This is an asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.

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

containerName

string

Container name associated with the backup item.

fabricName

string

Fabric name associated with the backup item.

protectedItemName

string

Item name to be backed up.

resourceGroupName

string

The name of the resource group where the recovery services vault is present.

subscriptionId

string

The subscription Id.

vaultName

string

The name of the recovery services vault.

api-version

string

Client Api Version.

string

ProtectedItemResource

OK

Accepted

CloudError

Error response describing why the operation failed.

Azure Active Directory OAuth2 Flow

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

• HTTP
• Java
• Python
• Go
• JavaScript
• dotnet

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1?api-version=2025-02-01

{
  "properties": {
    "protectedItemType": "Microsoft.Compute/virtualMachines",
    "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1",
    "policyId": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/DefaultPolicy"
  }
}

import com.azure.resourcemanager.recoveryservicesbackup.models.AzureIaaSComputeVMProtectedItem;

/**
 * Samples for ProtectedItems CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2025-02-01/examples/
     * AzureIaasVm/ConfigureProtection.json
     */
    /**
     * Sample code: Enable Protection on Azure IaasVm.
     * 
     * @param manager Entry point to RecoveryServicesBackupManager.
     */
    public static void enableProtectionOnAzureIaasVm(
        com.azure.resourcemanager.recoveryservicesbackup.RecoveryServicesBackupManager manager) {
        manager.protectedItems().define("VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1").withRegion((String) null)
            .withExistingProtectionContainer("NetSDKTestRsVault", "SwaggerTestRg", "Azure",
                "IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1")
            .withProperties(new AzureIaaSComputeVMProtectedItem().withSourceResourceId(
                "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1")
                .withPolicyId(
                    "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/DefaultPolicy"))
            .create();
    }
}

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.activestamp import RecoveryServicesBackupClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-recoveryservicesbackup
# USAGE
    python configure_protection.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.create_or_update(
        vault_name="NetSDKTestRsVault",
        resource_group_name="SwaggerTestRg",
        fabric_name="Azure",
        container_name="IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
        protected_item_name="VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
        parameters={
            "properties": {
                "policyId": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/DefaultPolicy",
                "protectedItemType": "Microsoft.Compute/virtualMachines",
                "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1",
            }
        },
    )
    print(response)


# x-ms-original-file: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2025-02-01/examples/AzureIaasVm/ConfigureProtection.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/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/AzureIaasVm/ConfigureProtection.json
func ExampleProtectedItemsClient_CreateOrUpdate_enableProtectionOnAzureIaasVm() {
	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().CreateOrUpdate(ctx, "NetSDKTestRsVault", "SwaggerTestRg", "Azure", "IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", armrecoveryservicesbackup.ProtectedItemResource{
		Properties: &armrecoveryservicesbackup.AzureIaaSComputeVMProtectedItem{
			PolicyID:          to.Ptr("/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/DefaultPolicy"),
			ProtectedItemType: to.Ptr("Microsoft.Compute/virtualMachines"),
			SourceResourceID:  to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1"),
		},
	}, &armrecoveryservicesbackup.ProtectedItemsClientCreateOrUpdateOptions{XMSAuthorizationAuxiliary: 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;netsdktestrg;netvmtestv2vm1"),
	// 	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;netsdktestrg;netvmtestv2vm1/protectedItems/VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1"),
	// 	Properties: &armrecoveryservicesbackup.AzureIaaSComputeVMProtectedItem{
	// 		BackupManagementType: to.Ptr(armrecoveryservicesbackup.BackupManagementTypeAzureIaasVM),
	// 		ContainerName: to.Ptr("iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1"),
	// 		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/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1"),
	// 		WorkloadType: to.Ptr(armrecoveryservicesbackup.DataSourceTypeVM),
	// 		FriendlyName: to.Ptr("netvmtestv2vm1"),
	// 		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/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1"),
	// 	},
	// }
}

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

/**
 * This sample demonstrates how to Enables backup of an item or to modifies the backup policy information of an already backed up item. This is an
asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.
 *
 * @summary Enables backup of an item or to modifies the backup policy information of an already 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/2025-02-01/examples/AzureIaasVm/ConfigureProtection.json
 */
async function enableProtectionOnAzureIaasVM() {
  const subscriptionId =
    process.env["RECOVERYSERVICESBACKUP_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const vaultName = "NetSDKTestRsVault";
  const resourceGroupName = process.env["RECOVERYSERVICESBACKUP_RESOURCE_GROUP"] || "SwaggerTestRg";
  const fabricName = "Azure";
  const containerName = "IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1";
  const protectedItemName = "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1";
  const parameters = {
    properties: {
      policyId:
        "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/DefaultPolicy",
      protectedItemType: "Microsoft.Compute/virtualMachines",
      sourceResourceId:
        "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new RecoveryServicesBackupClient(credential, subscriptionId);
  const result = await client.protectedItems.createOrUpdate(
    vaultName,
    resourceGroupName,
    fabricName,
    containerName,
    protectedItemName,
    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 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/AzureIaasVm/ConfigureProtection.json
// this example is just showing the usage of "ProtectedItems_CreateOrUpdate" 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 BackupProtectedItemResource created on azure
// for more information of creating BackupProtectedItemResource, please refer to the document of BackupProtectedItemResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "SwaggerTestRg";
string vaultName = "NetSDKTestRsVault";
string fabricName = "Azure";
string containerName = "IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1";
string protectedItemName = "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1";
ResourceIdentifier backupProtectedItemResourceId = BackupProtectedItemResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, vaultName, fabricName, containerName, protectedItemName);
BackupProtectedItemResource backupProtectedItem = client.GetBackupProtectedItemResource(backupProtectedItemResourceId);

// invoke the operation
BackupProtectedItemData data = new BackupProtectedItemData(default)
{
    Properties = new IaasComputeVmProtectedItem
    {
        SourceResourceId = new ResourceIdentifier("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1"),
        PolicyId = new ResourceIdentifier("/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/DefaultPolicy"),
    },
};
ArmOperation<BackupProtectedItemResource> lro = await backupProtectedItem.UpdateAsync(WaitUntil.Completed, data);
BackupProtectedItemResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
BackupProtectedItemData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Location: https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2016-12-01
Azure-AsyncOperation: https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2016-12-01
Retry-After: 60

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
  "name": "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
  "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems",
  "properties": {
    "friendlyName": "netvmtestv2vm1",
    "virtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1",
    "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;netsdktestrg;netvmtestv2vm1",
    "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1",
    "policyId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupPolicies/testPolicy1",
    "lastRecoveryPoint": null
  }
}

• HTTP
• Java
• Python
• Go
• JavaScript
• dotnet

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1?api-version=2025-02-01

{
  "properties": {
    "protectedItemType": "Microsoft.Compute/virtualMachines",
    "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1",
    "protectionState": "ProtectionStopped"
  }
}

import com.azure.resourcemanager.recoveryservicesbackup.models.AzureIaaSComputeVMProtectedItem;
import com.azure.resourcemanager.recoveryservicesbackup.models.ProtectionState;

/**
 * Samples for ProtectedItems CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2025-02-01/examples/
     * AzureIaasVm/StopProtection.json
     */
    /**
     * Sample code: Stop Protection with retain data on Azure IaasVm.
     * 
     * @param manager Entry point to RecoveryServicesBackupManager.
     */
    public static void stopProtectionWithRetainDataOnAzureIaasVm(
        com.azure.resourcemanager.recoveryservicesbackup.RecoveryServicesBackupManager manager) {
        manager.protectedItems().define("VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1").withRegion((String) null)
            .withExistingProtectionContainer("NetSDKTestRsVault", "SwaggerTestRg", "Azure",
                "IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1")
            .withProperties(new AzureIaaSComputeVMProtectedItem().withSourceResourceId(
                "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1")
                .withProtectionState(ProtectionState.PROTECTION_STOPPED))
            .create();
    }
}

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.activestamp import RecoveryServicesBackupClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-recoveryservicesbackup
# USAGE
    python stop_protection.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.create_or_update(
        vault_name="NetSDKTestRsVault",
        resource_group_name="SwaggerTestRg",
        fabric_name="Azure",
        container_name="IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
        protected_item_name="VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
        parameters={
            "properties": {
                "protectedItemType": "Microsoft.Compute/virtualMachines",
                "protectionState": "ProtectionStopped",
                "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1",
            }
        },
    )
    print(response)


# x-ms-original-file: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2025-02-01/examples/AzureIaasVm/StopProtection.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/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/AzureIaasVm/StopProtection.json
func ExampleProtectedItemsClient_CreateOrUpdate_stopProtectionWithRetainDataOnAzureIaasVm() {
	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().CreateOrUpdate(ctx, "NetSDKTestRsVault", "SwaggerTestRg", "Azure", "IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", armrecoveryservicesbackup.ProtectedItemResource{
		Properties: &armrecoveryservicesbackup.AzureIaaSComputeVMProtectedItem{
			ProtectedItemType: to.Ptr("Microsoft.Compute/virtualMachines"),
			SourceResourceID:  to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1"),
			ProtectionState:   to.Ptr(armrecoveryservicesbackup.ProtectionStateProtectionStopped),
		},
	}, &armrecoveryservicesbackup.ProtectedItemsClientCreateOrUpdateOptions{XMSAuthorizationAuxiliary: 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;netsdktestrg;netvmtestv2vm1"),
	// 	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;netsdktestrg;netvmtestv2vm1/protectedItems/VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1"),
	// 	Properties: &armrecoveryservicesbackup.AzureIaaSComputeVMProtectedItem{
	// 		BackupManagementType: to.Ptr(armrecoveryservicesbackup.BackupManagementTypeAzureIaasVM),
	// 		ContainerName: to.Ptr("iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1"),
	// 		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/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1"),
	// 		WorkloadType: to.Ptr(armrecoveryservicesbackup.DataSourceTypeVM),
	// 		FriendlyName: to.Ptr("netvmtestv2vm1"),
	// 		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.ProtectionStateProtectionStopped),
	// 		ProtectionStatus: to.Ptr("Healthy"),
	// 		VirtualMachineID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1"),
	// 	},
	// }
}

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

/**
 * This sample demonstrates how to Enables backup of an item or to modifies the backup policy information of an already backed up item. This is an
asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.
 *
 * @summary Enables backup of an item or to modifies the backup policy information of an already 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/2025-02-01/examples/AzureIaasVm/StopProtection.json
 */
async function stopProtectionWithRetainDataOnAzureIaasVM() {
  const subscriptionId =
    process.env["RECOVERYSERVICESBACKUP_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const vaultName = "NetSDKTestRsVault";
  const resourceGroupName = process.env["RECOVERYSERVICESBACKUP_RESOURCE_GROUP"] || "SwaggerTestRg";
  const fabricName = "Azure";
  const containerName = "IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1";
  const protectedItemName = "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1";
  const parameters = {
    properties: {
      protectedItemType: "Microsoft.Compute/virtualMachines",
      protectionState: "ProtectionStopped",
      sourceResourceId:
        "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new RecoveryServicesBackupClient(credential, subscriptionId);
  const result = await client.protectedItems.createOrUpdate(
    vaultName,
    resourceGroupName,
    fabricName,
    containerName,
    protectedItemName,
    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 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/AzureIaasVm/StopProtection.json
// this example is just showing the usage of "ProtectedItems_CreateOrUpdate" 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 BackupProtectedItemResource created on azure
// for more information of creating BackupProtectedItemResource, please refer to the document of BackupProtectedItemResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "SwaggerTestRg";
string vaultName = "NetSDKTestRsVault";
string fabricName = "Azure";
string containerName = "IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1";
string protectedItemName = "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1";
ResourceIdentifier backupProtectedItemResourceId = BackupProtectedItemResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, vaultName, fabricName, containerName, protectedItemName);
BackupProtectedItemResource backupProtectedItem = client.GetBackupProtectedItemResource(backupProtectedItemResourceId);

// invoke the operation
BackupProtectedItemData data = new BackupProtectedItemData(default)
{
    Properties = new IaasComputeVmProtectedItem
    {
        ProtectionState = BackupProtectionState.ProtectionStopped,
        SourceResourceId = new ResourceIdentifier("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1"),
    },
};
ArmOperation<BackupProtectedItemResource> lro = await backupProtectedItem.UpdateAsync(WaitUntil.Completed, data);
BackupProtectedItemResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
BackupProtectedItemData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Location: https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2016-12-01
Azure-AsyncOperation: https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2016-12-01
Retry-After: 60

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

Object

Azure File Share workload-specific backup item.

BackupManagementType

Type of backup management for the backed up item.

string

Name of the backup set the backup item belongs to

string

Unique name of container

CreateMode

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

string (date-time)

Time for deferred deletion in UTC

string

Time remaining before the DS marked for deferred delete is permanently deleted

AzureFileshareProtectedItemExtendedInfo

Additional information with this backup item.

string

Friendly name of the fileshare represented by this backup item.

boolean

Flag to identify whether datasource is protected in archive

boolean

Flag to identify whether the deferred deleted DS is to be purged soon

boolean

Flag to identify that deferred deleted DS is to be moved into Pause state

boolean

Flag to identify whether the DS is scheduled for deferred delete

<string,  KPIResourceHealthDetails>

Health details of different KPIs

string

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

string (date-time)

Timestamp of the last backup operation on this backup item.

string (date-time)

Timestamp when the last (latest) backup copy was created for this backup item.

string

ID of the backup policy with which this item is backed up.

string

Name of the policy used for protection

AzureFileShareProtectedItem

backup item type.

ProtectionState

Backup state of this backup item.

string

Backup status of this backup item.

string[]

ResourceGuardOperationRequests on which LAC check will be performed

integer (int32)

Soft delete retention period in days

string

ARM ID of the resource to be backed up.

string

ID of the vault which protects this item

DataSourceType

Type of workload this item represents.

Object

Additional information about Azure File Share backup item.

string (date-time)

The oldest backup copy available for this item in the service.

string

Indicates consistency of policy object and policy applied to this backup item.

integer (int32)

Number of available backup copies associated with this backup item.

string

Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted}

string (date-time)

The resource state sync time for this backup item.

Object

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

BackupManagementType

Type of backup management for the backed up item.

string

Name of the backup set the backup item belongs to

string

Unique name of container

CreateMode

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

string (date-time)

Time for deferred deletion in UTC

string

Time remaining before the DS marked for deferred delete is permanently deleted

AzureIaaSVMProtectedItemExtendedInfo

Additional information for this backup item.

ExtendedProperties

Extended Properties for Azure IaasVM Backup.

string

Friendly name of the VM represented by this backup item.

AzureIaaSVMHealthDetails[]

Health details on this backup item.

HealthStatus

Health status of protected item.

boolean

Flag to identify whether datasource is protected in archive

boolean

Flag to identify whether the deferred deleted DS is to be purged soon

boolean

Flag to identify that deferred deleted DS is to be moved into Pause state

boolean

Flag to identify whether the DS is scheduled for deferred delete

<string,  KPIResourceHealthDetails>

Health details of different KPIs

string

Last backup operation status.

string (date-time)

Timestamp of the last backup operation on this backup item.

string (date-time)

Timestamp when the last (latest) backup copy was created for this backup item.

string

ID of the backup policy with which this item is backed up.

string

Name of the policy used for protection

string

Type of the policy used for protection

string

Data ID of the protected item.

Microsoft.ClassicCompute/virtualMachines

backup item type.

ProtectionState

Backup state of this backup item.

string

Backup status of this backup item.

string[]

ResourceGuardOperationRequests on which LAC check will be performed

integer (int32)

Soft delete retention period in days

string

ARM ID of the resource to be backed up.

string

ID of the vault which protects this item

string

Fully qualified ARM ID of the virtual machine represented by this item.

DataSourceType

Type of workload this item represents.

Object

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

BackupManagementType

Type of backup management for the backed up item.

string

Name of the backup set the backup item belongs to

string

Unique name of container

CreateMode

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

string (date-time)

Time for deferred deletion in UTC

string

Time remaining before the DS marked for deferred delete is permanently deleted

AzureIaaSVMProtectedItemExtendedInfo

Additional information for this backup item.

ExtendedProperties

Extended Properties for Azure IaasVM Backup.

string

Friendly name of the VM represented by this backup item.

AzureIaaSVMHealthDetails[]

Health details on this backup item.

HealthStatus

Health status of protected item.

boolean

Flag to identify whether datasource is protected in archive

boolean

Flag to identify whether the deferred deleted DS is to be purged soon

boolean

Flag to identify that deferred deleted DS is to be moved into Pause state

boolean

Flag to identify whether the DS is scheduled for deferred delete

<string,  KPIResourceHealthDetails>

Health details of different KPIs

string

Last backup operation status.

string (date-time)

Timestamp of the last backup operation on this backup item.

string (date-time)

Timestamp when the last (latest) backup copy was created for this backup item.

string

ID of the backup policy with which this item is backed up.

string

Name of the policy used for protection

string

Type of the policy used for protection

string

Data ID of the protected item.

Microsoft.Compute/virtualMachines

backup item type.

ProtectionState

Backup state of this backup item.

string

Backup status of this backup item.

string[]

ResourceGuardOperationRequests on which LAC check will be performed

integer (int32)

Soft delete retention period in days

string

ARM ID of the resource to be backed up.

string

ID of the vault which protects this item

string

Fully qualified ARM ID of the virtual machine represented by this item.

DataSourceType

Type of workload this item represents.

Object

Azure IaaS VM workload-specific Health Details.

integer (int32)

Health Code

string

Health Message

string[]

Health Recommended Actions

string

Health Title

Object

IaaS VM workload-specific backup item.

BackupManagementType

Type of backup management for the backed up item.

string

Name of the backup set the backup item belongs to

string

Unique name of container

CreateMode

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

string (date-time)

Time for deferred deletion in UTC

string

Time remaining before the DS marked for deferred delete is permanently deleted

AzureIaaSVMProtectedItemExtendedInfo

Additional information for this backup item.

ExtendedProperties

Extended Properties for Azure IaasVM Backup.

string

Friendly name of the VM represented by this backup item.

AzureIaaSVMHealthDetails[]

Health details on this backup item.

HealthStatus

Health status of protected item.

boolean

Flag to identify whether datasource is protected in archive

boolean

Flag to identify whether the deferred deleted DS is to be purged soon

boolean

Flag to identify that deferred deleted DS is to be moved into Pause state

boolean

Flag to identify whether the DS is scheduled for deferred delete

<string,  KPIResourceHealthDetails>

Health details of different KPIs

string

Last backup operation status.

string (date-time)

Timestamp of the last backup operation on this backup item.

string (date-time)

Timestamp when the last (latest) backup copy was created for this backup item.

string

ID of the backup policy with which this item is backed up.

string

Name of the policy used for protection

string

Type of the policy used for protection

string

Data ID of the protected item.

AzureIaaSVMProtectedItem

backup item type.

ProtectionState

Backup state of this backup item.

string

Backup status of this backup item.

string[]

ResourceGuardOperationRequests on which LAC check will be performed

integer (int32)

Soft delete retention period in days

string

ARM ID of the resource to be backed up.

string

ID of the vault which protects this item

string

Fully qualified ARM ID of the virtual machine represented by this item.

DataSourceType

Type of workload this item represents.

Object

Additional information on Azure IaaS VM specific backup item.

string (date-time)

The latest backup copy available for this backup item in archive tier

string (date-time)

The oldest backup copy available for this backup item across all tiers.

string (date-time)

The oldest backup copy available for this backup item in archive tier

string (date-time)

The oldest backup copy available for this backup item in vault tier

boolean

Specifies if backup policy associated with the backup item is inconsistent.

integer (int32)

Number of backup copies available for this backup item.

Object

Azure SQL workload-specific backup item.

BackupManagementType

Type of backup management for the backed up item.

string

Name of the backup set the backup item belongs to

string

Unique name of container

CreateMode

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

string (date-time)

Time for deferred deletion in UTC

string

Time remaining before the DS marked for deferred delete is permanently deleted

AzureSqlProtectedItemExtendedInfo

Additional information for this backup item.

boolean

Flag to identify whether datasource is protected in archive

boolean

Flag to identify whether the deferred deleted DS is to be purged soon

boolean

Flag to identify that deferred deleted DS is to be moved into Pause state

boolean

Flag to identify whether the DS is scheduled for deferred delete

string (date-time)

Timestamp when the last (latest) backup copy was created for this backup item.

string

ID of the backup policy with which this item is backed up.

string

Name of the policy used for protection

string

Internal ID of a backup item. Used by Azure SQL Backup engine to contact Recovery Services.

Microsoft.Sql/servers/databases

backup item type.

ProtectedItemState

Backup state of the backed up item.

string[]

ResourceGuardOperationRequests on which LAC check will be performed

integer (int32)

Soft delete retention period in days

string

ARM ID of the resource to be backed up.

string

ID of the vault which protects this item

DataSourceType

Type of workload this item represents.

Object

Additional information on Azure Sql specific protected item.

string (date-time)

The oldest backup copy available for this item in the service.

string

State of the backup policy associated with this backup item.

integer (int32)

Number of available backup copies associated with this backup item.

Object

Azure VM workload-specific protected item.

BackupManagementType

Type of backup management for the backed up item.

string

Name of the backup set the backup item belongs to

string

Unique name of container

CreateMode

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

string (date-time)

Time for deferred deletion in UTC

string

Time remaining before the DS marked for deferred delete is permanently deleted

AzureVmWorkloadProtectedItemExtendedInfo

Additional information for this backup item.

string

Friendly name of the DB represented by this backup item.

boolean

Flag to identify whether datasource is protected in archive

boolean

Flag to identify whether the deferred deleted DS is to be purged soon

boolean

Flag to identify that deferred deleted DS is to be moved into Pause state

boolean

Flag to identify whether the DS is scheduled for deferred delete

<string,  KPIResourceHealthDetails>

Health details of different KPIs

ErrorDetail

Error details in last backup

LastBackupStatus

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

string (date-time)

Timestamp of the last backup operation on this backup item.

string (date-time)

Timestamp when the last (latest) backup copy was created for this backup item.

DistributedNodesInfo[]

List of the nodes in case of distributed container.

string

Parent name of the DB such as Instance or Availability Group.

string

Parent type of protected item, example: for a DB, standalone server or distributed

string

ID of the backup policy with which this item is backed up.

string

Name of the policy used for protection

string

Data ID of the protected item.

ProtectedItemHealthStatus

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

AzureVmWorkloadProtectedItem

backup item type.

ProtectionState

Backup state of this backup item.

string

Backup status of this backup item.

string[]

ResourceGuardOperationRequests on which LAC check will be performed

string

Host/Cluster Name for instance or AG

integer (int32)

Soft delete retention period in days

string

ARM ID of the resource to be backed up.

string

ID of the vault which protects this item

DataSourceType

Type of workload this item represents.

Object

Additional information on Azure Workload for SQL specific backup item.

string (date-time)

The latest backup copy available for this backup item in archive tier

string (date-time)

The oldest backup copy available for this backup item across all tiers.

string (date-time)

The oldest backup copy available for this backup item in archive tier

string (date-time)

The oldest backup copy available for this backup item in vault tier

string

Indicates consistency of policy object and policy applied to this backup item.

string

Indicates consistency of policy object and policy applied to this backup item.

integer (int32)

Number of backup copies available for this backup item.

Object

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

BackupManagementType

Type of backup management for the backed up item.

string

Name of the backup set the backup item belongs to

string

Unique name of container

CreateMode

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

string (date-time)

Time for deferred deletion in UTC

string

Time remaining before the DS marked for deferred delete is permanently deleted

AzureVmWorkloadProtectedItemExtendedInfo

Additional information for this backup item.

string

Friendly name of the DB represented by this backup item.

boolean

Flag to identify whether datasource is protected in archive

boolean

Flag to identify whether the deferred deleted DS is to be purged soon

boolean

Flag to identify that deferred deleted DS is to be moved into Pause state

boolean

Flag to identify whether the DS is scheduled for deferred delete

<string,  KPIResourceHealthDetails>

Health details of different KPIs

ErrorDetail

Error details in last backup

LastBackupStatus

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

string (date-time)

Timestamp of the last backup operation on this backup item.

string (date-time)

Timestamp when the last (latest) backup copy was created for this backup item.

DistributedNodesInfo[]

List of the nodes in case of distributed container.

string

Parent name of the DB such as Instance or Availability Group.

string

Parent type of protected item, example: for a DB, standalone server or distributed

string

ID of the backup policy with which this item is backed up.

string

Name of the policy used for protection

string

Data ID of the protected item.

ProtectedItemHealthStatus

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

AzureVmWorkloadSAPAseDatabase

backup item type.

ProtectionState

Backup state of this backup item.

string

Backup status of this backup item.

string[]

ResourceGuardOperationRequests on which LAC check will be performed

string

Host/Cluster Name for instance or AG

integer (int32)

Soft delete retention period in days

string

ARM ID of the resource to be backed up.

string

ID of the vault which protects this item

DataSourceType

Type of workload this item represents.

Object

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

BackupManagementType

Type of backup management for the backed up item.

string

Name of the backup set the backup item belongs to

string

Unique name of container

CreateMode

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

string (date-time)

Time for deferred deletion in UTC

string

Time remaining before the DS marked for deferred delete is permanently deleted

AzureVmWorkloadProtectedItemExtendedInfo

Additional information for this backup item.

string

Friendly name of the DB represented by this backup item.

boolean

Flag to identify whether datasource is protected in archive

boolean

Flag to identify whether the deferred deleted DS is to be purged soon

boolean

Flag to identify that deferred deleted DS is to be moved into Pause state

boolean

Flag to identify whether the DS is scheduled for deferred delete

<string,  KPIResourceHealthDetails>

Health details of different KPIs

ErrorDetail

Error details in last backup

LastBackupStatus

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

string (date-time)

Timestamp of the last backup operation on this backup item.

string (date-time)

Timestamp when the last (latest) backup copy was created for this backup item.

DistributedNodesInfo[]

List of the nodes in case of distributed container.

string

Parent name of the DB such as Instance or Availability Group.

string

Parent type of protected item, example: for a DB, standalone server or distributed

string

ID of the backup policy with which this item is backed up.

string

Name of the policy used for protection

string

Data ID of the protected item.

ProtectedItemHealthStatus

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

AzureVmWorkloadSAPHanaDatabase

backup item type.

ProtectionState

Backup state of this backup item.

string

Backup status of this backup item.

string[]

ResourceGuardOperationRequests on which LAC check will be performed

string

Host/Cluster Name for instance or AG

integer (int32)

Soft delete retention period in days

string

ARM ID of the resource to be backed up.

string

ID of the vault which protects this item

DataSourceType

Type of workload this item represents.

Object

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

BackupManagementType

Type of backup management for the backed up item.

string

Name of the backup set the backup item belongs to

string

Unique name of container

CreateMode

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

string (date-time)

Time for deferred deletion in UTC

string

Time remaining before the DS marked for deferred delete is permanently deleted

AzureVmWorkloadProtectedItemExtendedInfo

Additional information for this backup item.

string

Friendly name of the DB represented by this backup item.

boolean

Flag to identify whether datasource is protected in archive

boolean

Flag to identify whether the deferred deleted DS is to be purged soon

boolean

Flag to identify that deferred deleted DS is to be moved into Pause state

boolean

Flag to identify whether the DS is scheduled for deferred delete

<string,  KPIResourceHealthDetails>

Health details of different KPIs

ErrorDetail

Error details in last backup

LastBackupStatus

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

string (date-time)

Timestamp of the last backup operation on this backup item.

string (date-time)

Timestamp when the last (latest) backup copy was created for this backup item.

DistributedNodesInfo[]

List of the nodes in case of distributed container.

string

Parent name of the DB such as Instance or Availability Group.

string

Parent type of protected item, example: for a DB, standalone server or distributed

string

ID of the backup policy with which this item is backed up.

string

Name of the policy used for protection

string

Data ID of the protected item.

ProtectedItemHealthStatus

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

AzureVmWorkloadSAPHanaDBInstance

backup item type.

ProtectionState

Backup state of this backup item.

string

Backup status of this backup item.

string[]

ResourceGuardOperationRequests on which LAC check will be performed

string

Host/Cluster Name for instance or AG

integer (int32)

Soft delete retention period in days

string

ARM ID of the resource to be backed up.

string

ID of the vault which protects this item

DataSourceType

Type of workload this item represents.

Object

Azure VM workload-specific protected item representing SQL Database.

BackupManagementType

Type of backup management for the backed up item.

string

Name of the backup set the backup item belongs to

string

Unique name of container

CreateMode

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

string (date-time)

Time for deferred deletion in UTC

string

Time remaining before the DS marked for deferred delete is permanently deleted

AzureVmWorkloadProtectedItemExtendedInfo

Additional information for this backup item.

string

Friendly name of the DB represented by this backup item.

boolean

Flag to identify whether datasource is protected in archive

boolean

Flag to identify whether the deferred deleted DS is to be purged soon

boolean

Flag to identify that deferred deleted DS is to be moved into Pause state

boolean

Flag to identify whether the DS is scheduled for deferred delete

<string,  KPIResourceHealthDetails>

Health details of different KPIs

ErrorDetail

Error details in last backup

LastBackupStatus

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

string (date-time)

Timestamp of the last backup operation on this backup item.

string (date-time)

Timestamp when the last (latest) backup copy was created for this backup item.

DistributedNodesInfo[]

List of the nodes in case of distributed container.

string

Parent name of the DB such as Instance or Availability Group.

string

Parent type of protected item, example: for a DB, standalone server or distributed

string

ID of the backup policy with which this item is backed up.

string

Name of the policy used for protection

string

Data ID of the protected item.

ProtectedItemHealthStatus

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

AzureVmWorkloadSQLDatabase

backup item type.

ProtectionState

Backup state of this backup item.

string

Backup status of this backup item.

string[]

ResourceGuardOperationRequests on which LAC check will be performed

string

Host/Cluster Name for instance or AG

integer (int32)

Soft delete retention period in days

string

ARM ID of the resource to be backed up.

string

ID of the vault which protects this item

DataSourceType

Type of workload this item represents.

Enumeration

Type of backup management for the backed up item.

Object

An error response from the Container Instance service.

Object

An error response from the Container Instance service.

ErrorAdditionalInfo[]

The error additional info.

string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

CloudErrorBody[]

A list of additional details about the error.

string

A message describing the error, intended to be suitable for display in a user interface.

string

The target of the particular error. For example, the name of the property in error.

Enumeration

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

Enumeration

Type of workload this item represents.

Object

integer[] (int32)

List of Disks' Logical Unit Numbers (LUN) to be used for VM Protection.

boolean

Flag to indicate whether DiskLunList is to be included/ excluded from backup.

Object

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

ErrorDetail

Error Details if the Status is non-success.

string

Name of the node under a distributed container.

string

ARM resource id of the node

string

Status of this Node. Failed | Succeeded

Object

Additional information on Backup engine specific backup item.

string

Backup Management server protecting this backup item

BackupManagementType

Type of backup management for the backed up item.

string

Name of the backup set the backup item belongs to

string

Unique name of container

CreateMode

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

string (date-time)

Time for deferred deletion in UTC

string

Time remaining before the DS marked for deferred delete is permanently deleted

DPMProtectedItemExtendedInfo

Extended info of the backup item.

string

Friendly name of the managed item

boolean

Flag to identify whether datasource is protected in archive

boolean

Flag to identify whether the deferred deleted DS is to be purged soon

boolean

Flag to identify that deferred deleted DS is to be moved into Pause state

boolean

Flag to identify whether the DS is scheduled for deferred delete

string (date-time)

Timestamp when the last (latest) backup copy was created for this backup item.

string

ID of the backup policy with which this item is backed up.

string

Name of the policy used for protection

DPMProtectedItem

backup item type.

ProtectedItemState

Protection state of the backup engine

string[]

ResourceGuardOperationRequests on which LAC check will be performed

integer (int32)

Soft delete retention period in days

string

ARM ID of the resource to be backed up.

string

ID of the vault which protects this item

DataSourceType

Type of workload this item represents.

Object

Additional information of DPM Protected item.

string

Used Disk storage in bytes.

boolean

To check if backup item is collocated.

boolean

To check if backup item is cloud protected.

string

Last backup status information on backup item.

string (date-time)

Last refresh time on backup item.

string (date-time)

Oldest cloud recovery point time.

string (date-time)

latest disk recovery point time.

string (date-time)

Oldest disk recovery point time.

integer (int32)

disk recovery point count.

object

Attribute to provide information on various DBs.

boolean

To check if backup item is disk protected.

string

Protection group name of the backup item.

integer (int32)

cloud recovery point count.

string

total Disk storage in bytes.

Object

The resource management error additional info.

object

The additional info.

string

The additional info type.

Object

Error Detail class which encapsulates Code, Message and Recommendations.

string

Error code.

string

Error Message related to the Code.

string[]

List of recommendation strings.

Object

Extended Properties for Azure IaasVM Backup.

DiskExclusionProperties

Extended Properties for Disk Exclusion.

string

Linux VM name

Object

Base class for backup items.

BackupManagementType

Type of backup management for the backed up item.

string

Name of the backup set the backup item belongs to

string

Unique name of container

CreateMode

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

string (date-time)

Time for deferred deletion in UTC

string

Time remaining before the DS marked for deferred delete is permanently deleted

string

Name of this backup item's fabric.

string

Friendly name of the container.

boolean

Flag to identify whether datasource is protected in archive

boolean

Flag to identify whether the deferred deleted DS is to be purged soon

boolean

Flag to identify that deferred deleted DS is to be moved into Pause state

boolean

Flag to identify whether the DS is scheduled for deferred delete

string (date-time)

Timestamp when the last (latest) backup copy was created for this backup item.

string

ID of the backup policy with which this item is backed up.

string

Name of the policy used for protection

string

Indicates consistency of policy object and policy applied to this backup item.

integer (int64)

Data Plane Service ID of the protected item.

GenericProtectedItem

backup item type.

ProtectionState

Backup state of this backup item.

string[]

ResourceGuardOperationRequests on which LAC check will be performed

integer (int32)

Soft delete retention period in days

object

Loosely coupled (type, value) associations (example - parent of a protected item)

string

ARM ID of the resource to be backed up.

string

ID of the vault which protects this item

DataSourceType

Type of workload this item represents.

Enumeration

Health status of protected item.

Object

KPI Resource Health Details

Enumeration

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

Object

MAB workload-specific backup item.

BackupManagementType

Type of backup management for the backed up item.

string

Name of the backup set the backup item belongs to

string

Name of the computer associated with this backup item.

string

Unique name of container

CreateMode

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

integer (int64)

Sync time for deferred deletion in UTC

string (date-time)

Time for deferred deletion in UTC

string

Time remaining before the DS marked for deferred delete is permanently deleted

MabFileFolderProtectedItemExtendedInfo

Additional information with this backup item.

string

Friendly name of this backup item.

boolean

Flag to identify whether datasource is protected in archive

boolean

Flag to identify whether the deferred deleted DS is to be purged soon

boolean

Flag to identify that deferred deleted DS is to be moved into Pause state

boolean

Flag to identify whether the DS is scheduled for deferred delete

string

Status of last backup operation.

string (date-time)

Timestamp of the last backup operation on this backup item.

string (date-time)

Timestamp when the last (latest) backup copy was created for this backup item.

string

ID of the backup policy with which this item is backed up.

string

Name of the policy used for protection

MabFileFolderProtectedItem

backup item type.

string

Protected, ProtectionStopped, IRPending or ProtectionError

string[]

ResourceGuardOperationRequests on which LAC check will be performed

integer (int32)

Soft delete retention period in days

string

ARM ID of the resource to be backed up.

string

ID of the vault which protects this item

DataSourceType

Type of workload this item represents.

Object

Additional information on the backed up item.

string (date-time)

Last time when the agent data synced to service.

string (date-time)

The oldest backup copy available.

integer (int32)

Number of backup copies associated with the backup item.

Enumeration

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

Object

Base class for backup items.

Enumeration

Backup state of the backed up item.

Enumeration

Backup state of this backup item.

Object

Health Details for backup items.

integer (int32)

Health Code

string

Health Message

string[]

Health Recommended Actions

string

Health Title

Enumeration

Resource Health Status

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4