Protected Items - Create Or Update

Service:

Recovery Services - Backup

API Version:

2023-02-01

Active la sauvegarde d’un élément ou pour modifier les informations de stratégie de sauvegarde d’un élément déjà sauvegardé. S'agissant d'une opération asynchrone, Pour connaître les status de l’opération, appelez l’API GetItemOperationResult.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
containerName	path	True	string	Nom du conteneur associé à l’élément de sauvegarde.
fabricName	path	True	string	Nom de la structure associé à l’élément de sauvegarde.
protectedItemName	path	True	string	Nom de l’élément à sauvegarder.
resourceGroupName	path	True	string	Nom du groupe de ressources dans lequel le coffre Recovery Services est présent.
subscriptionId	path	True	string	ID d’abonnement.
vaultName	path	True	string	Nom du coffre Recovery Services.
api-version	query	True	string	Version de l’API cliente.

Corps de la demande

Nom	Type	Description
eTag	string	ETag facultatif.
location	string	Emplacement de la ressource.
properties	ProtectedItem: AzureFileshareProtectedItem AzureIaaSVMProtectedItem AzureSqlProtectedItem AzureVmWorkloadProtectedItem DPMProtectedItem GenericProtectedItem MabFileFolderProtectedItem AzureVmWorkloadSAPAseDatabaseProtectedItem AzureVmWorkloadSAPHanaDatabaseProtectedItem AzureVmWorkloadSAPHanaDBInstanceProtectedItem AzureVmWorkloadSQLDatabaseProtectedItem AzureIaaSClassicComputeVMProtectedItem AzureIaaSComputeVMProtectedItem	Propriétés ProtectedItemResource
tags	object	Balises de ressource.

Réponses

Nom	Type	Description
200 OK	ProtectedItemResource	Ok
202 Accepted		Accepté
Other Status Codes	CloudError	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

Scopes

Nom	Description
user_impersonation	empruntez l’identité de votre compte d’utilisateur.

Exemples

Enable Protection on Azure IaasVm

Stop Protection with retain data on Azure IaasVm

Enable Protection on Azure IaasVm

Sample Request

HTTP

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=2023-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"
  }
}

Java

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/2023-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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.recoveryservicesbackup 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/2023-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

Go

package armrecoveryservicesbackup_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/recoveryservices/armrecoveryservicesbackup/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/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"),
		},
	}, 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.048723Z"); 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

JavaScript

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

/**
 * 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/2023-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

dotnet

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

// Generated from example definition: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-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(new AzureLocation("placeholder"))
{
    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

Sample Response

Status code:

202

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

Status code:

200

{
  "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
  }
}

Stop Protection with retain data on Azure IaasVm

Sample Request

HTTP

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=2023-02-01

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

Java

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/2023-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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.recoveryservicesbackup 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/2023-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

Go

package armrecoveryservicesbackup_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/recoveryservices/armrecoveryservicesbackup/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/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),
		},
	}, 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.048723Z"); 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

JavaScript

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

/**
 * 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/2023-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

dotnet

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

// Generated from example definition: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-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(new AzureLocation("placeholder"))
{
    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

Sample Response

Status code:

202

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

Status code:

200

{
  "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
  }
}

Définitions

Nom	Description
AzureFileshareProtectedItem	Élément de sauvegarde spécifique à la charge de travail Azure File Share.
AzureFileshareProtectedItemExtendedInfo	Informations supplémentaires sur l’élément de sauvegarde Du partage de fichiers Azure.
AzureIaaSClassicComputeVMProtectedItem	Élément de sauvegarde spécifique à la charge de travail de machine virtuelle IaaS représentant la machine virtuelle de calcul classique.
AzureIaaSComputeVMProtectedItem	Élément de sauvegarde spécifique à la charge de travail des machines virtuelles IaaS représentant la machine virtuelle Azure Resource Manager.
AzureIaaSVMHealthDetails	Détails d’intégrité spécifiques à la charge de travail des machines virtuelles IaaS Azure.
AzureIaaSVMProtectedItem	Élément de sauvegarde spécifique à la charge de travail des machines virtuelles IaaS.
AzureIaaSVMProtectedItemExtendedInfo	Informations supplémentaires sur l’élément de sauvegarde spécifique à une machine virtuelle IaaS Azure.
AzureSqlProtectedItem	Azure SQL élément de sauvegarde spécifique à la charge de travail.
AzureSqlProtectedItemExtendedInfo	Informations supplémentaires sur l’élément protégé spécifique à Azure Sql.
AzureVmWorkloadProtectedItem	Élément protégé spécifique à la charge de travail des machines virtuelles Azure.
AzureVmWorkloadProtectedItemExtendedInfo	Informations supplémentaires sur l’élément de sauvegarde spécifique à la charge de travail Azure pour SQL.
AzureVmWorkloadSAPAseDatabaseProtectedItem	Élément protégé spécifique à la charge de travail des machines virtuelles Azure représentant LA base de données SAP ASE.
AzureVmWorkloadSAPHanaDatabaseProtectedItem	Élément protégé spécifique à la charge de travail des machines virtuelles Azure représentant la base de données SAP HANA.
AzureVmWorkloadSAPHanaDBInstanceProtectedItem	Élément protégé spécifique à la charge de travail des machines virtuelles Azure représentant SAP HANA DBInstance.
AzureVmWorkloadSQLDatabaseProtectedItem	Élément protégé spécifique à la charge de travail des machines virtuelles Azure représentant SQL Database.
BackupManagementType	Type de gestion des sauvegardes pour l’élément sauvegardé.
CloudError	Réponse d’erreur du service Container Instance.
CloudErrorBody	Réponse d’erreur du service Container Instance.
CreateMode	Mode Créer pour indiquer la récupération d’une source de données supprimée de manière réversible existante ou la création d’une nouvelle source de données.
DataSourceType	Type de charge de travail que cet élément représente.
DiskExclusionProperties
DPMProtectedItem	Informations supplémentaires sur l’élément de sauvegarde spécifique au moteur de sauvegarde.
DPMProtectedItemExtendedInfo	Informations supplémentaires sur l’élément protégé DPM.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Classe Error Detail qui encapsule code, message et recommandations.
ExtendedProperties	Propriétés étendues pour sauvegarde IaasVM Azure.
GenericProtectedItem	Classe de base pour les éléments de sauvegarde.
HealthStatus	Intégrité status de l’élément protégé.
KPIResourceHealthDetails	Détails du Resource Health de l’indicateur de performance clé
LastBackupStatus	Dernière opération de sauvegarde status. Valeurs possibles : Sain, Non sain.
MabFileFolderProtectedItem	Élément de sauvegarde spécifique à la charge de travail MAB.
MabFileFolderProtectedItemExtendedInfo	Informations supplémentaires sur l’élément sauvegardé.
ProtectedItemHealthStatus	Intégrité status de l’élément de sauvegarde, évaluée en fonction de la dernière pulsation reçue
ProtectedItemResource	Classe de base pour les éléments de sauvegarde.
ProtectedItemState	État de sauvegarde de l’élément sauvegardé.
ProtectionState	État de sauvegarde de cet élément de sauvegarde.
ResourceHealthDetails	Détails d’intégrité pour les éléments de sauvegarde.
ResourceHealthStatus	État d’intégrité des ressources

AzureFileshareProtectedItem

Élément de sauvegarde spécifique à la charge de travail Azure File Share.

Nom	Type	Description
backupManagementType	BackupManagementType	Type de gestion des sauvegardes pour l’élément sauvegardé.
backupSetName	string	Nom du jeu de sauvegarde auquel appartient l’élément de sauvegarde
containerName	string	Nom unique du conteneur
createMode	CreateMode	Mode Créer pour indiquer la récupération d’une source de données supprimée de manière réversible existante ou la création d’une nouvelle source de données.
deferredDeleteTimeInUTC	string	Heure de suppression différée en UTC
deferredDeleteTimeRemaining	string	Temps restant avant que la DS marquée pour la suppression différée soit définitivement supprimée
extendedInfo	AzureFileshareProtectedItemExtendedInfo	Informations supplémentaires avec cet élément de sauvegarde.
friendlyName	string	Nom convivial du partage de fichiers représenté par cet élément de sauvegarde.
isArchiveEnabled	boolean	Indicateur permettant d’identifier si la source de données est protégée dans l’archive
isDeferredDeleteScheduleUpcoming	boolean	Indicateur permettant d’identifier si la DS supprimée différée doit être bientôt purgée
isRehydrate	boolean	Indicateur permettant d’identifier que la DS supprimée différée doit être déplacée à l’état Pause
isScheduledForDeferredDelete	boolean	Indicateur permettant d’identifier si la DS est planifiée pour une suppression différée
kpisHealths	<string,  KPIResourceHealthDetails>	Détails d’intégrité des différents indicateurs de performance clés
lastBackupStatus	string	Dernière opération de sauvegarde status. Valeurs possibles : Sain, Non sain.
lastBackupTime	string	Horodatage de la dernière opération de sauvegarde sur cet élément de sauvegarde.
lastRecoveryPoint	string	Horodatage lorsque la dernière copie de sauvegarde (la plus récente) a été créée pour cet élément de sauvegarde.
policyId	string	ID de la stratégie de sauvegarde avec laquelle cet élément est sauvegardé.
policyName	string	Nom de la stratégie utilisée pour la protection
protectedItemType	string: AzureFileShareProtectedItem	type d’élément de sauvegarde.
protectionState	ProtectionState	État de sauvegarde de cet élément de sauvegarde.
protectionStatus	string	Sauvegarde status de cet élément de sauvegarde.
resourceGuardOperationRequests	string[]	ResourceGuardOperationRequests sur lesquelles les case activée LAC seront effectuées
softDeleteRetentionPeriodInDays	integer	Période de rétention de suppression réversible en jours
sourceResourceId	string	ID ARM de la ressource à sauvegarder.
workloadType	DataSourceType	Type de charge de travail que cet élément représente.

AzureFileshareProtectedItemExtendedInfo

Informations supplémentaires sur l’élément de sauvegarde Du partage de fichiers Azure.

Nom	Type	Description
oldestRecoveryPoint	string	Copie de sauvegarde la plus ancienne disponible pour cet élément dans le service.
policyState	string	Indique la cohérence de l’objet de stratégie et de la stratégie appliquées à cet élément de sauvegarde.
recoveryPointCount	integer	Nombre de copies de sauvegarde disponibles associées à cet élément de sauvegarde.
resourceState	string	Indique l’état de cette ressource. Les valeurs possibles proviennent de l’énumération ResourceState {Invalid, Active, SoftDeleted, Deleted}
resourceStateSyncTime	string	Heure de synchronisation de l’état des ressources pour cet élément de sauvegarde.

AzureIaaSClassicComputeVMProtectedItem

Élément de sauvegarde spécifique à la charge de travail de machine virtuelle IaaS représentant la machine virtuelle de calcul classique.

Nom	Type	Description
backupManagementType	BackupManagementType	Type de gestion des sauvegardes pour l’élément sauvegardé.
backupSetName	string	Nom du jeu de sauvegarde auquel appartient l’élément de sauvegarde
containerName	string	Nom unique du conteneur
createMode	CreateMode	Mode Créer pour indiquer la récupération d’une source de données supprimée de manière réversible existante ou la création d’une nouvelle source de données.
deferredDeleteTimeInUTC	string	Heure de la suppression différée en UTC
deferredDeleteTimeRemaining	string	Temps restant avant la suppression définitive de la DS marquée pour la suppression différée
extendedInfo	AzureIaaSVMProtectedItemExtendedInfo	Informations supplémentaires pour cet élément de sauvegarde.
extendedProperties	ExtendedProperties	Propriétés étendues pour la sauvegarde IaasVM Azure.
friendlyName	string	Nom convivial de la machine virtuelle représentée par cet élément de sauvegarde.
healthDetails	AzureIaaSVMHealthDetails[]	Détails d’intégrité sur cet élément de sauvegarde.
healthStatus	HealthStatus	Intégrité status de l’élément protégé.
isArchiveEnabled	boolean	Indicateur permettant d’identifier si la source de données est protégée dans l’archive
isDeferredDeleteScheduleUpcoming	boolean	Indicateur permettant d’identifier si le DS supprimé différé doit être bientôt vidé
isRehydrate	boolean	Indicateur permettant d’identifier que le DS supprimé différé doit être déplacé dans l’état Pause
isScheduledForDeferredDelete	boolean	Indicateur permettant d’identifier si le DS est planifié pour la suppression différée
kpisHealths	<string,  KPIResourceHealthDetails>	Détails d’intégrité des différents indicateurs de performance clés
lastBackupStatus	string	Dernière opération de sauvegarde status.
lastBackupTime	string	Horodatage de la dernière opération de sauvegarde sur cet élément de sauvegarde.
lastRecoveryPoint	string	Horodatage de la création de la dernière (dernière) copie de sauvegarde pour cet élément de sauvegarde.
policyId	string	ID de la stratégie de sauvegarde avec laquelle cet élément est sauvegardé.
policyName	string	Nom de la stratégie utilisée pour la protection
protectedItemDataId	string	ID de données de l’élément protégé.
protectedItemType	string: Microsoft.ClassicCompute/virtualMachines	type d’élément de sauvegarde.
protectionState	ProtectionState	État de sauvegarde de cet élément de sauvegarde.
protectionStatus	string	Sauvegarde status de cet élément de sauvegarde.
resourceGuardOperationRequests	string[]	ResourceGuardOperationRequests sur lesquelles les case activée LAC seront effectuées
softDeleteRetentionPeriodInDays	integer	Période de rétention de suppression réversible en jours
sourceResourceId	string	ID ARM de la ressource à sauvegarder.
virtualMachineId	string	ID ARM complet de la machine virtuelle représentée par cet élément.
workloadType	DataSourceType	Type de charge de travail que cet élément représente.

AzureIaaSComputeVMProtectedItem

Élément de sauvegarde spécifique à la charge de travail des machines virtuelles IaaS représentant la machine virtuelle Azure Resource Manager.

Nom	Type	Description
backupManagementType	BackupManagementType	Type de gestion des sauvegardes pour l’élément sauvegardé.
backupSetName	string	Nom du jeu de sauvegarde auquel appartient l’élément de sauvegarde
containerName	string	Nom unique du conteneur
createMode	CreateMode	Mode Créer pour indiquer la récupération d’une source de données supprimée de manière réversible existante ou la création d’une nouvelle source de données.
deferredDeleteTimeInUTC	string	Heure de la suppression différée en UTC
deferredDeleteTimeRemaining	string	Temps restant avant la suppression définitive de la DS marquée pour la suppression différée
extendedInfo	AzureIaaSVMProtectedItemExtendedInfo	Informations supplémentaires pour cet élément de sauvegarde.
extendedProperties	ExtendedProperties	Propriétés étendues pour la sauvegarde IaasVM Azure.
friendlyName	string	Nom convivial de la machine virtuelle représentée par cet élément de sauvegarde.
healthDetails	AzureIaaSVMHealthDetails[]	Détails d’intégrité sur cet élément de sauvegarde.
healthStatus	HealthStatus	Intégrité status de l’élément protégé.
isArchiveEnabled	boolean	Indicateur permettant d’identifier si la source de données est protégée dans l’archive
isDeferredDeleteScheduleUpcoming	boolean	Indicateur permettant d’identifier si le DS supprimé différé doit être bientôt vidé
isRehydrate	boolean	Indicateur permettant d’identifier que le DS supprimé différé doit être déplacé dans l’état Pause
isScheduledForDeferredDelete	boolean	Indicateur permettant d’identifier si le DS est planifié pour la suppression différée
kpisHealths	<string,  KPIResourceHealthDetails>	Détails d’intégrité des différents indicateurs de performance clés
lastBackupStatus	string	Dernière opération de sauvegarde status.
lastBackupTime	string	Horodatage de la dernière opération de sauvegarde sur cet élément de sauvegarde.
lastRecoveryPoint	string	Horodatage de la création de la dernière (dernière) copie de sauvegarde pour cet élément de sauvegarde.
policyId	string	ID de la stratégie de sauvegarde avec laquelle cet élément est sauvegardé.
policyName	string	Nom de la stratégie utilisée pour la protection
protectedItemDataId	string	ID de données de l’élément protégé.
protectedItemType	string: Microsoft.Compute/virtualMachines	type d’élément de sauvegarde.
protectionState	ProtectionState	État de sauvegarde de cet élément de sauvegarde.
protectionStatus	string	Sauvegarde status de cet élément de sauvegarde.
resourceGuardOperationRequests	string[]	ResourceGuardOperationRequests sur lesquelles les case activée LAC seront effectuées
softDeleteRetentionPeriodInDays	integer	Période de rétention de suppression réversible en jours
sourceResourceId	string	ID ARM de la ressource à sauvegarder.
virtualMachineId	string	ID ARM complet de la machine virtuelle représentée par cet élément.
workloadType	DataSourceType	Type de charge de travail que cet élément représente.

AzureIaaSVMHealthDetails

Détails d’intégrité spécifiques à la charge de travail des machines virtuelles IaaS Azure.

Nom	Type	Description
code	integer	Code d’intégrité
message	string	Message d’intégrité
recommendations	string[]	Actions recommandées pour l’intégrité
title	string	Titre d’intégrité

AzureIaaSVMProtectedItem

Élément de sauvegarde spécifique à la charge de travail des machines virtuelles IaaS.

Nom	Type	Description
backupManagementType	BackupManagementType	Type de gestion des sauvegardes pour l’élément sauvegardé.
backupSetName	string	Nom du jeu de sauvegarde auquel appartient l’élément de sauvegarde
containerName	string	Nom unique du conteneur
createMode	CreateMode	Mode Créer pour indiquer la récupération d’une source de données supprimée de manière réversible existante ou la création d’une nouvelle source de données.
deferredDeleteTimeInUTC	string	Heure de suppression différée en UTC
deferredDeleteTimeRemaining	string	Temps restant avant que la DS marquée pour la suppression différée soit définitivement supprimée
extendedInfo	AzureIaaSVMProtectedItemExtendedInfo	Informations supplémentaires pour cet élément de sauvegarde.
extendedProperties	ExtendedProperties	Propriétés étendues pour sauvegarde IaasVM Azure.
friendlyName	string	Nom convivial de la machine virtuelle représentée par cet élément de sauvegarde.
healthDetails	AzureIaaSVMHealthDetails[]	Détails d’intégrité sur cet élément de sauvegarde.
healthStatus	HealthStatus	Intégrité status de l’élément protégé.
isArchiveEnabled	boolean	Indicateur permettant d’identifier si la source de données est protégée dans l’archive
isDeferredDeleteScheduleUpcoming	boolean	Indicateur permettant d’identifier si la DS supprimée différée doit être bientôt purgée
isRehydrate	boolean	Indicateur permettant d’identifier que la DS supprimée différée doit être déplacée à l’état Pause
isScheduledForDeferredDelete	boolean	Indicateur permettant d’identifier si la DS est planifiée pour une suppression différée
kpisHealths	<string,  KPIResourceHealthDetails>	Détails d’intégrité des différents indicateurs de performance clés
lastBackupStatus	string	Dernière opération de sauvegarde status.
lastBackupTime	string	Horodatage de la dernière opération de sauvegarde sur cet élément de sauvegarde.
lastRecoveryPoint	string	Horodatage lorsque la dernière copie de sauvegarde (la plus récente) a été créée pour cet élément de sauvegarde.
policyId	string	ID de la stratégie de sauvegarde avec laquelle cet élément est sauvegardé.
policyName	string	Nom de la stratégie utilisée pour la protection
protectedItemDataId	string	ID de données de l’élément protégé.
protectedItemType	string: AzureIaaSVMProtectedItem	type d’élément de sauvegarde.
protectionState	ProtectionState	État de sauvegarde de cet élément de sauvegarde.
protectionStatus	string	Sauvegarde status de cet élément de sauvegarde.
resourceGuardOperationRequests	string[]	ResourceGuardOperationRequests sur lesquelles les case activée LAC seront effectuées
softDeleteRetentionPeriodInDays	integer	Période de rétention de suppression réversible en jours
sourceResourceId	string	ID ARM de la ressource à sauvegarder.
virtualMachineId	string	ID ARM complet de la machine virtuelle représentée par cet élément.
workloadType	DataSourceType	Type de charge de travail que cet élément représente.

AzureIaaSVMProtectedItemExtendedInfo

Informations supplémentaires sur l’élément de sauvegarde spécifique à une machine virtuelle IaaS Azure.

Nom	Type	Description
newestRecoveryPointInArchive	string	Dernière copie de sauvegarde disponible pour cet élément de sauvegarde au niveau archive
oldestRecoveryPoint	string	Copie de sauvegarde la plus ancienne disponible pour cet élément de sauvegarde sur tous les niveaux.
oldestRecoveryPointInArchive	string	La copie de sauvegarde la plus ancienne disponible pour cet élément de sauvegarde au niveau archive
oldestRecoveryPointInVault	string	La copie de sauvegarde la plus ancienne disponible pour cet élément de sauvegarde dans le niveau coffre
policyInconsistent	boolean	Spécifie si la stratégie de sauvegarde associée à l’élément de sauvegarde est incohérente.
recoveryPointCount	integer	Nombre de copies de sauvegarde disponibles pour cet élément de sauvegarde.

AzureSqlProtectedItem

Azure SQL élément de sauvegarde spécifique à la charge de travail.

Nom	Type	Description
backupManagementType	BackupManagementType	Type de gestion des sauvegardes pour l’élément sauvegardé.
backupSetName	string	Nom du jeu de sauvegarde auquel appartient l’élément de sauvegarde
containerName	string	Nom unique du conteneur
createMode	CreateMode	Mode Créer pour indiquer la récupération d’une source de données supprimée de manière réversible existante ou la création d’une nouvelle source de données.
deferredDeleteTimeInUTC	string	Heure de suppression différée en UTC
deferredDeleteTimeRemaining	string	Temps restant avant que la DS marquée pour la suppression différée soit définitivement supprimée
extendedInfo	AzureSqlProtectedItemExtendedInfo	Informations supplémentaires pour cet élément de sauvegarde.
isArchiveEnabled	boolean	Indicateur permettant d’identifier si la source de données est protégée dans l’archive
isDeferredDeleteScheduleUpcoming	boolean	Indicateur permettant d’identifier si la DS supprimée différée doit être bientôt purgée
isRehydrate	boolean	Indicateur permettant d’identifier que la DS supprimée différée doit être déplacée à l’état Pause
isScheduledForDeferredDelete	boolean	Indicateur permettant d’identifier si la DS est planifiée pour une suppression différée
lastRecoveryPoint	string	Horodatage lorsque la dernière copie de sauvegarde (la plus récente) a été créée pour cet élément de sauvegarde.
policyId	string	ID de la stratégie de sauvegarde avec laquelle cet élément est sauvegardé.
policyName	string	Nom de la stratégie utilisée pour la protection
protectedItemDataId	string	ID interne d’un élément de sauvegarde. Utilisé par Azure SQL moteur de sauvegarde pour contacter Recovery Services.
protectedItemType	string: Microsoft.Sql/servers/databases	type d’élément de sauvegarde.
protectionState	ProtectedItemState	État de sauvegarde de l’élément sauvegardé.
resourceGuardOperationRequests	string[]	ResourceGuardOperationRequests sur lesquelles les case activée LAC seront effectuées
softDeleteRetentionPeriodInDays	integer	Période de rétention de suppression réversible en jours
sourceResourceId	string	ID ARM de la ressource à sauvegarder.
workloadType	DataSourceType	Type de charge de travail que cet élément représente.

AzureSqlProtectedItemExtendedInfo

Informations supplémentaires sur l’élément protégé spécifique à Azure Sql.

Nom	Type	Description
oldestRecoveryPoint	string	Copie de sauvegarde la plus ancienne disponible pour cet élément dans le service.
policyState	string	État de la stratégie de sauvegarde associée à cet élément de sauvegarde.
recoveryPointCount	integer	Nombre de copies de sauvegarde disponibles associées à cet élément de sauvegarde.

AzureVmWorkloadProtectedItem

Élément protégé spécifique à la charge de travail des machines virtuelles Azure.

Nom	Type	Description
backupManagementType	BackupManagementType	Type de gestion des sauvegardes pour l’élément sauvegardé.
backupSetName	string	Nom du jeu de sauvegarde auquel appartient l’élément de sauvegarde
containerName	string	Nom unique du conteneur
createMode	CreateMode	Mode Créer pour indiquer la récupération d’une source de données supprimée de manière réversible existante ou la création d’une nouvelle source de données.
deferredDeleteTimeInUTC	string	Heure de la suppression différée en UTC
deferredDeleteTimeRemaining	string	Temps restant avant la suppression définitive de la DS marquée pour la suppression différée
extendedInfo	AzureVmWorkloadProtectedItemExtendedInfo	Informations supplémentaires pour cet élément de sauvegarde.
friendlyName	string	Nom convivial de la base de données représentée par cet élément de sauvegarde.
isArchiveEnabled	boolean	Indicateur permettant d’identifier si la source de données est protégée dans l’archive
isDeferredDeleteScheduleUpcoming	boolean	Indicateur permettant d’identifier si le DS supprimé différé doit être bientôt vidé
isRehydrate	boolean	Indicateur permettant d’identifier que le DS supprimé différé doit être déplacé dans l’état Pause
isScheduledForDeferredDelete	boolean	Indicateur permettant d’identifier si le DS est planifié pour la suppression différée
kpisHealths	<string,  KPIResourceHealthDetails>	Détails d’intégrité des différents indicateurs de performance clés
lastBackupErrorDetail	ErrorDetail	Détails de l’erreur dans la dernière sauvegarde
lastBackupStatus	LastBackupStatus	Dernière opération de sauvegarde status. Valeurs possibles : Sain, Non sain.
lastBackupTime	string	Horodatage de la dernière opération de sauvegarde sur cet élément de sauvegarde.
lastRecoveryPoint	string	Horodatage de la création de la dernière (dernière) copie de sauvegarde pour cet élément de sauvegarde.
parentName	string	Nom parent de la base de données, par exemple Instance ou Groupe de disponibilité.
parentType	string	Type parent d’élément protégé, par exemple : pour une base de données, un serveur autonome ou distribué
policyId	string	ID de la stratégie de sauvegarde avec laquelle cet élément est sauvegardé.
policyName	string	Nom de la stratégie utilisée pour la protection
protectedItemDataSourceId	string	ID de données de l’élément protégé.
protectedItemHealthStatus	ProtectedItemHealthStatus	Intégrité status de l’élément de sauvegarde, évaluée en fonction de la dernière pulsation reçue
protectedItemType	string: AzureVmWorkloadProtectedItem	type d’élément de sauvegarde.
protectionState	ProtectionState	État de sauvegarde de cet élément de sauvegarde.
protectionStatus	string	Sauvegarde status de cet élément de sauvegarde.
resourceGuardOperationRequests	string[]	ResourceGuardOperationRequests sur lesquelles les case activée LAC seront effectuées
serverName	string	Nom d’hôte/de cluster pour instance ou groupe de disponibilité
softDeleteRetentionPeriodInDays	integer	Période de rétention de suppression réversible en jours
sourceResourceId	string	ID ARM de la ressource à sauvegarder.
workloadType	DataSourceType	Type de charge de travail que cet élément représente.

AzureVmWorkloadProtectedItemExtendedInfo

Informations supplémentaires sur l’élément de sauvegarde spécifique à la charge de travail Azure pour SQL.

Nom	Type	Description
newestRecoveryPointInArchive	string	Dernière copie de sauvegarde disponible pour cet élément de sauvegarde au niveau archive
oldestRecoveryPoint	string	Copie de sauvegarde la plus ancienne disponible pour cet élément de sauvegarde sur tous les niveaux.
oldestRecoveryPointInArchive	string	La copie de sauvegarde la plus ancienne disponible pour cet élément de sauvegarde au niveau archive
oldestRecoveryPointInVault	string	La copie de sauvegarde la plus ancienne disponible pour cet élément de sauvegarde dans le niveau coffre
policyState	string	Indique la cohérence de l’objet de stratégie et de la stratégie appliquées à cet élément de sauvegarde.
recoveryModel	string	Indique la cohérence de l’objet de stratégie et de la stratégie appliquées à cet élément de sauvegarde.
recoveryPointCount	integer	Nombre de copies de sauvegarde disponibles pour cet élément de sauvegarde.

AzureVmWorkloadSAPAseDatabaseProtectedItem

Élément protégé spécifique à la charge de travail des machines virtuelles Azure représentant LA base de données SAP ASE.

Nom	Type	Description
backupManagementType	BackupManagementType	Type de gestion des sauvegardes pour l’élément sauvegardé.
backupSetName	string	Nom du jeu de sauvegarde auquel appartient l’élément de sauvegarde
containerName	string	Nom unique du conteneur
createMode	CreateMode	Mode Créer pour indiquer la récupération d’une source de données supprimée de manière réversible existante ou la création d’une nouvelle source de données.
deferredDeleteTimeInUTC	string	Heure de suppression différée en UTC
deferredDeleteTimeRemaining	string	Temps restant avant que la DS marquée pour la suppression différée soit définitivement supprimée
extendedInfo	AzureVmWorkloadProtectedItemExtendedInfo	Informations supplémentaires pour cet élément de sauvegarde.
friendlyName	string	Nom convivial de la base de données représentée par cet élément de sauvegarde.
isArchiveEnabled	boolean	Indicateur permettant d’identifier si la source de données est protégée dans l’archive
isDeferredDeleteScheduleUpcoming	boolean	Indicateur permettant d’identifier si la DS supprimée différée doit être bientôt purgée
isRehydrate	boolean	Indicateur permettant d’identifier que la DS supprimée différée doit être déplacée à l’état Pause
isScheduledForDeferredDelete	boolean	Indicateur permettant d’identifier si la DS est planifiée pour une suppression différée
kpisHealths	<string,  KPIResourceHealthDetails>	Détails d’intégrité des différents indicateurs de performance clés
lastBackupErrorDetail	ErrorDetail	Détails de l’erreur dans la dernière sauvegarde
lastBackupStatus	LastBackupStatus	Dernière opération de sauvegarde status. Valeurs possibles : Sain, Non sain.
lastBackupTime	string	Horodatage de la dernière opération de sauvegarde sur cet élément de sauvegarde.
lastRecoveryPoint	string	Horodatage lorsque la dernière copie de sauvegarde (la plus récente) a été créée pour cet élément de sauvegarde.
parentName	string	Nom parent de la base de données, par exemple Instance ou Groupe de disponibilité.
parentType	string	Type parent d’élément protégé, par exemple : pour une base de données, un serveur autonome ou distribué
policyId	string	ID de la stratégie de sauvegarde avec laquelle cet élément est sauvegardé.
policyName	string	Nom de la stratégie utilisée pour la protection
protectedItemDataSourceId	string	ID de données de l’élément protégé.
protectedItemHealthStatus	ProtectedItemHealthStatus	Intégrité status de l’élément de sauvegarde, évaluée en fonction de la dernière pulsation reçue
protectedItemType	string: AzureVmWorkloadSAPAseDatabase	type d’élément de sauvegarde.
protectionState	ProtectionState	État de sauvegarde de cet élément de sauvegarde.
protectionStatus	string	Sauvegarde status de cet élément de sauvegarde.
resourceGuardOperationRequests	string[]	ResourceGuardOperationRequests sur lesquelles les case activée LAC seront effectuées
serverName	string	Nom d’hôte/de cluster pour instance ou groupe de disponibilité
softDeleteRetentionPeriodInDays	integer	Période de rétention de suppression réversible en jours
sourceResourceId	string	ID ARM de la ressource à sauvegarder.
workloadType	DataSourceType	Type de charge de travail que cet élément représente.

AzureVmWorkloadSAPHanaDatabaseProtectedItem

Élément protégé spécifique à la charge de travail des machines virtuelles Azure représentant la base de données SAP HANA.

Nom	Type	Description
backupManagementType	BackupManagementType	Type de gestion des sauvegardes pour l’élément sauvegardé.
backupSetName	string	Nom du jeu de sauvegarde auquel appartient l’élément de sauvegarde
containerName	string	Nom unique du conteneur
createMode	CreateMode	Mode Créer pour indiquer la récupération d’une source de données supprimée de manière réversible existante ou la création d’une nouvelle source de données.
deferredDeleteTimeInUTC	string	Heure de suppression différée en UTC
deferredDeleteTimeRemaining	string	Temps restant avant que la DS marquée pour la suppression différée soit définitivement supprimée
extendedInfo	AzureVmWorkloadProtectedItemExtendedInfo	Informations supplémentaires pour cet élément de sauvegarde.
friendlyName	string	Nom convivial de la base de données représentée par cet élément de sauvegarde.
isArchiveEnabled	boolean	Indicateur permettant d’identifier si la source de données est protégée dans l’archive
isDeferredDeleteScheduleUpcoming	boolean	Indicateur permettant d’identifier si la DS supprimée différée doit être bientôt purgée
isRehydrate	boolean	Indicateur permettant d’identifier que la DS supprimée différée doit être déplacée à l’état Pause
isScheduledForDeferredDelete	boolean	Indicateur permettant d’identifier si la DS est planifiée pour une suppression différée
kpisHealths	<string,  KPIResourceHealthDetails>	Détails d’intégrité des différents indicateurs de performance clés
lastBackupErrorDetail	ErrorDetail	Détails de l’erreur dans la dernière sauvegarde
lastBackupStatus	LastBackupStatus	Dernière opération de sauvegarde status. Valeurs possibles : Sain, Non sain.
lastBackupTime	string	Horodatage de la dernière opération de sauvegarde sur cet élément de sauvegarde.
lastRecoveryPoint	string	Horodatage lorsque la dernière copie de sauvegarde (la plus récente) a été créée pour cet élément de sauvegarde.
parentName	string	Nom parent de la base de données, par exemple Instance ou Groupe de disponibilité.
parentType	string	Type parent d’élément protégé, par exemple : pour une base de données, un serveur autonome ou distribué
policyId	string	ID de la stratégie de sauvegarde avec laquelle cet élément est sauvegardé.
policyName	string	Nom de la stratégie utilisée pour la protection
protectedItemDataSourceId	string	ID de données de l’élément protégé.
protectedItemHealthStatus	ProtectedItemHealthStatus	Intégrité status de l’élément de sauvegarde, évaluée en fonction de la dernière pulsation reçue
protectedItemType	string: AzureVmWorkloadSAPHanaDatabase	type d’élément de sauvegarde.
protectionState	ProtectionState	État de sauvegarde de cet élément de sauvegarde.
protectionStatus	string	Sauvegarde status de cet élément de sauvegarde.
resourceGuardOperationRequests	string[]	ResourceGuardOperationRequests sur lesquelles les case activée LAC seront effectuées
serverName	string	Nom d’hôte/de cluster pour instance ou groupe de disponibilité
softDeleteRetentionPeriodInDays	integer	Période de rétention de suppression réversible en jours
sourceResourceId	string	ID ARM de la ressource à sauvegarder.
workloadType	DataSourceType	Type de charge de travail que cet élément représente.

AzureVmWorkloadSAPHanaDBInstanceProtectedItem

Élément protégé spécifique à la charge de travail des machines virtuelles Azure représentant SAP HANA DBInstance.

Nom	Type	Description
backupManagementType	BackupManagementType	Type de gestion des sauvegardes pour l’élément sauvegardé.
backupSetName	string	Nom du jeu de sauvegarde auquel appartient l’élément de sauvegarde
containerName	string	Nom unique du conteneur
createMode	CreateMode	Mode Créer pour indiquer la récupération d’une source de données supprimée de manière réversible existante ou la création d’une nouvelle source de données.
deferredDeleteTimeInUTC	string	Heure de suppression différée en UTC
deferredDeleteTimeRemaining	string	Temps restant avant que la DS marquée pour la suppression différée soit définitivement supprimée
extendedInfo	AzureVmWorkloadProtectedItemExtendedInfo	Informations supplémentaires pour cet élément de sauvegarde.
friendlyName	string	Nom convivial de la base de données représentée par cet élément de sauvegarde.
isArchiveEnabled	boolean	Indicateur permettant d’identifier si la source de données est protégée dans l’archive
isDeferredDeleteScheduleUpcoming	boolean	Indicateur permettant d’identifier si la DS supprimée différée doit être bientôt purgée
isRehydrate	boolean	Indicateur permettant d’identifier que la DS supprimée différée doit être déplacée à l’état Pause
isScheduledForDeferredDelete	boolean	Indicateur permettant d’identifier si la DS est planifiée pour une suppression différée
kpisHealths	<string,  KPIResourceHealthDetails>	Détails d’intégrité des différents indicateurs de performance clés
lastBackupErrorDetail	ErrorDetail	Détails de l’erreur dans la dernière sauvegarde
lastBackupStatus	LastBackupStatus	Dernière opération de sauvegarde status. Valeurs possibles : Sain, Non sain.
lastBackupTime	string	Horodatage de la dernière opération de sauvegarde sur cet élément de sauvegarde.
lastRecoveryPoint	string	Horodatage lorsque la dernière copie de sauvegarde (la plus récente) a été créée pour cet élément de sauvegarde.
parentName	string	Nom parent de la base de données, par exemple Instance ou Groupe de disponibilité.
parentType	string	Type parent d’élément protégé, par exemple : pour une base de données, un serveur autonome ou distribué
policyId	string	ID de la stratégie de sauvegarde avec laquelle cet élément est sauvegardé.
policyName	string	Nom de la stratégie utilisée pour la protection
protectedItemDataSourceId	string	ID de données de l’élément protégé.
protectedItemHealthStatus	ProtectedItemHealthStatus	Intégrité status de l’élément de sauvegarde, évaluée en fonction de la dernière pulsation reçue
protectedItemType	string: AzureVmWorkloadSAPHanaDBInstance	type d’élément de sauvegarde.
protectionState	ProtectionState	État de sauvegarde de cet élément de sauvegarde.
protectionStatus	string	Sauvegarde status de cet élément de sauvegarde.
resourceGuardOperationRequests	string[]	ResourceGuardOperationRequests sur lesquelles les case activée LAC seront effectuées
serverName	string	Nom d’hôte/de cluster pour instance ou groupe de disponibilité
softDeleteRetentionPeriodInDays	integer	Période de rétention de suppression réversible en jours
sourceResourceId	string	ID ARM de la ressource à sauvegarder.
workloadType	DataSourceType	Type de charge de travail que cet élément représente.

AzureVmWorkloadSQLDatabaseProtectedItem

Élément protégé spécifique à la charge de travail des machines virtuelles Azure représentant SQL Database.

Nom	Type	Description
backupManagementType	BackupManagementType	Type de gestion des sauvegardes pour l’élément sauvegardé.
backupSetName	string	Nom du jeu de sauvegarde auquel appartient l’élément de sauvegarde
containerName	string	Nom unique du conteneur
createMode	CreateMode	Mode Créer pour indiquer la récupération d’une source de données supprimée de manière réversible existante ou la création d’une nouvelle source de données.
deferredDeleteTimeInUTC	string	Heure de la suppression différée en UTC
deferredDeleteTimeRemaining	string	Temps restant avant la suppression définitive de la DS marquée pour la suppression différée
extendedInfo	AzureVmWorkloadProtectedItemExtendedInfo	Informations supplémentaires pour cet élément de sauvegarde.
friendlyName	string	Nom convivial de la base de données représentée par cet élément de sauvegarde.
isArchiveEnabled	boolean	Indicateur permettant d’identifier si la source de données est protégée dans l’archive
isDeferredDeleteScheduleUpcoming	boolean	Indicateur permettant d’identifier si le DS supprimé différé doit être bientôt vidé
isRehydrate	boolean	Indicateur permettant d’identifier que le DS supprimé différé doit être déplacé dans l’état Pause
isScheduledForDeferredDelete	boolean	Indicateur permettant d’identifier si le DS est planifié pour la suppression différée
kpisHealths	<string,  KPIResourceHealthDetails>	Détails d’intégrité des différents indicateurs de performance clés
lastBackupErrorDetail	ErrorDetail	Détails de l’erreur dans la dernière sauvegarde
lastBackupStatus	LastBackupStatus	Dernière opération de sauvegarde status. Valeurs possibles : Sain, Non sain.
lastBackupTime	string	Horodatage de la dernière opération de sauvegarde sur cet élément de sauvegarde.
lastRecoveryPoint	string	Horodatage de la création de la dernière (dernière) copie de sauvegarde pour cet élément de sauvegarde.
parentName	string	Nom parent de la base de données, par exemple Instance ou Groupe de disponibilité.
parentType	string	Type parent de l’élément protégé, par exemple : pour une base de données, un serveur autonome ou distribué
policyId	string	ID de la stratégie de sauvegarde avec laquelle cet élément est sauvegardé.
policyName	string	Nom de la stratégie utilisée pour la protection
protectedItemDataSourceId	string	ID de données de l’élément protégé.
protectedItemHealthStatus	ProtectedItemHealthStatus	Intégrité status de l’élément de sauvegarde, évaluée en fonction de la dernière pulsation reçue
protectedItemType	string: AzureVmWorkloadSQLDatabase	type d’élément de sauvegarde.
protectionState	ProtectionState	État de sauvegarde de cet élément de sauvegarde.
protectionStatus	string	Sauvegarde status de cet élément de sauvegarde.
resourceGuardOperationRequests	string[]	ResourceGuardOperationRequests sur lesquelles les case activée LAC seront effectuées
serverName	string	Nom d’hôte/de cluster pour instance ou groupe de disponibilité
softDeleteRetentionPeriodInDays	integer	Période de rétention de suppression réversible en jours
sourceResourceId	string	ID ARM de la ressource à sauvegarder.
workloadType	DataSourceType	Type de charge de travail que cet élément représente.

BackupManagementType

Type de gestion des sauvegardes pour l’élément sauvegardé.

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

CloudError

Réponse d’erreur du service Container Instance.

Nom	Type	Description
error	CloudErrorBody	Objet d’erreur.

CloudErrorBody

Réponse d’erreur du service Container Instance.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Identificateur de l'erreur. Les codes sont invariants et sont destinés à être consommés par programmation.
details	CloudErrorBody[]	Liste de détails supplémentaires sur l’erreur.
message	string	Message décrivant l’erreur, destiné à être affiché dans une interface utilisateur.
target	string	Cible de l’erreur particulière. Par exemple, le nom de la propriété dans l’erreur.

CreateMode

Mode Créer pour indiquer la récupération d’une source de données supprimée de manière réversible existante ou la création d’une nouvelle source de données.

Nom	Type	Description
Default	string
Invalid	string
Recover	string

DataSourceType

Type de charge de travail que cet élément représente.

Nom	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

Nom	Type	Description
diskLunList	integer[]	Liste des numéros d’unité logique (LUN) des disques à utiliser pour la protection des machines virtuelles.
isInclusionList	boolean	Indicateur pour indiquer si DiskLunList doit être inclus/exclu de la sauvegarde.

DPMProtectedItem

Informations supplémentaires sur l’élément de sauvegarde spécifique au moteur de sauvegarde.

Nom	Type	Description
backupEngineName	string	Serveur d’administration de sauvegarde protégeant cet élément de sauvegarde
backupManagementType	BackupManagementType	Type de gestion des sauvegardes pour l’élément sauvegardé.
backupSetName	string	Nom du jeu de sauvegarde auquel appartient l’élément de sauvegarde
containerName	string	Nom unique du conteneur
createMode	CreateMode	Mode Créer pour indiquer la récupération d’une source de données supprimée de manière réversible existante ou la création d’une nouvelle source de données.
deferredDeleteTimeInUTC	string	Heure de la suppression différée en UTC
deferredDeleteTimeRemaining	string	Temps restant avant la suppression définitive de la DS marquée pour la suppression différée
extendedInfo	DPMProtectedItemExtendedInfo	Informations étendues de l’élément de sauvegarde.
friendlyName	string	Nom convivial de l’élément géré
isArchiveEnabled	boolean	Indicateur permettant d’identifier si la source de données est protégée dans l’archive
isDeferredDeleteScheduleUpcoming	boolean	Indicateur permettant d’identifier si le DS supprimé différé doit être bientôt vidé
isRehydrate	boolean	Indicateur permettant d’identifier que le DS supprimé différé doit être déplacé dans l’état Pause
isScheduledForDeferredDelete	boolean	Indicateur permettant d’identifier si le DS est planifié pour la suppression différée
lastRecoveryPoint	string	Horodatage de la création de la dernière (dernière) copie de sauvegarde pour cet élément de sauvegarde.
policyId	string	ID de la stratégie de sauvegarde avec laquelle cet élément est sauvegardé.
policyName	string	Nom de la stratégie utilisée pour la protection
protectedItemType	string: DPMProtectedItem	type d’élément de sauvegarde.
protectionState	ProtectedItemState	État de protection du moteur de sauvegarde
resourceGuardOperationRequests	string[]	ResourceGuardOperationRequests sur lesquelles les case activée LAC seront effectuées
softDeleteRetentionPeriodInDays	integer	Période de rétention de suppression réversible en jours
sourceResourceId	string	ID ARM de la ressource à sauvegarder.
workloadType	DataSourceType	Type de charge de travail que cet élément représente.

DPMProtectedItemExtendedInfo

Informations supplémentaires sur l’élément protégé DPM.

Nom	Type	Description
diskStorageUsedInBytes	string	Stockage sur disque utilisé en octets.
isCollocated	boolean	Pour case activée si l’élément de sauvegarde est colocalisé.
isPresentOnCloud	boolean	Pour case activée si l’élément de sauvegarde est protégé dans le cloud.
lastBackupStatus	string	La dernière sauvegarde status informations sur l’élément de sauvegarde.
lastRefreshedAt	string	Heure de la dernière actualisation de l’élément de sauvegarde.
oldestRecoveryPoint	string	Heure de point de récupération cloud la plus ancienne.
onPremiseLatestRecoveryPoint	string	heure du point de récupération de disque la plus récente.
onPremiseOldestRecoveryPoint	string	Heure du point de récupération de disque la plus ancienne.
onPremiseRecoveryPointCount	integer	nombre de points de récupération de disque.
protectableObjectLoadPath	object	Attribut pour fournir des informations sur différentes bases de données.
protected	boolean	Pour case activée si l’élément de sauvegarde est protégé sur disque.
protectionGroupName	string	Nom du groupe de protection de l’élément de sauvegarde.
recoveryPointCount	integer	nombre de points de récupération cloud.
totalDiskStorageSizeInBytes	string	total Stockage sur disque en octets.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires
type	string	Type d’informations supplémentaires.

ErrorDetail

Classe Error Detail qui encapsule code, message et recommandations.

Nom	Type	Description
code	string	Code d’erreur.
message	string	Message d’erreur lié au code.
recommendations	string[]	Liste des chaînes de recommandation.

ExtendedProperties

Propriétés étendues pour sauvegarde IaasVM Azure.

Nom	Type	Description
diskExclusionProperties	DiskExclusionProperties	Propriétés étendues pour l’exclusion de disque.
linuxVmApplicationName	string	Nom de la machine virtuelle Linux

GenericProtectedItem

Classe de base pour les éléments de sauvegarde.

Nom	Type	Description
backupManagementType	BackupManagementType	Type de gestion des sauvegardes pour l’élément sauvegardé.
backupSetName	string	Nom du jeu de sauvegarde auquel appartient l’élément de sauvegarde
containerName	string	Nom unique du conteneur
createMode	CreateMode	Mode Créer pour indiquer la récupération d’une source de données supprimée de manière réversible existante ou la création d’une nouvelle source de données.
deferredDeleteTimeInUTC	string	Heure de la suppression différée en UTC
deferredDeleteTimeRemaining	string	Temps restant avant la suppression définitive de la DS marquée pour la suppression différée
fabricName	string	Nom de l’infrastructure de cet élément de sauvegarde.
friendlyName	string	Nom convivial du conteneur.
isArchiveEnabled	boolean	Indicateur permettant d’identifier si la source de données est protégée dans l’archive
isDeferredDeleteScheduleUpcoming	boolean	Indicateur permettant d’identifier si le DS supprimé différé doit être bientôt vidé
isRehydrate	boolean	Indicateur permettant d’identifier que le DS supprimé différé doit être déplacé dans l’état Pause
isScheduledForDeferredDelete	boolean	Indicateur permettant d’identifier si le DS est planifié pour la suppression différée
lastRecoveryPoint	string	Horodatage de la création de la dernière (dernière) copie de sauvegarde pour cet élément de sauvegarde.
policyId	string	ID de la stratégie de sauvegarde avec laquelle cet élément est sauvegardé.
policyName	string	Nom de la stratégie utilisée pour la protection
policyState	string	Indique la cohérence de l’objet de stratégie et de la stratégie appliqués à cet élément de sauvegarde.
protectedItemId	integer	ID de service de plan de données de l’élément protégé.
protectedItemType	string: GenericProtectedItem	type d’élément de sauvegarde.
protectionState	ProtectionState	État de sauvegarde de cet élément de sauvegarde.
resourceGuardOperationRequests	string[]	ResourceGuardOperationRequests sur lesquelles les case activée LAC seront effectuées
softDeleteRetentionPeriodInDays	integer	Période de rétention de suppression réversible en jours
sourceAssociations	object	Associations faiblement couplées (type, valeur) (exemple - parent d’un élément protégé)
sourceResourceId	string	ID ARM de la ressource à sauvegarder.
workloadType	DataSourceType	Type de charge de travail que cet élément représente.

HealthStatus

Intégrité status de l’élément protégé.

Nom	Type	Description
ActionRequired	string
ActionSuggested	string
Invalid	string
Passed	string

KPIResourceHealthDetails

Détails du Resource Health de l’indicateur de performance clé

Nom	Type	Description
resourceHealthDetails	ResourceHealthDetails[]	État d’intégrité des ressources
resourceHealthStatus	ResourceHealthStatus	État d’intégrité des ressources

LastBackupStatus

Dernière opération de sauvegarde status. Valeurs possibles : Sain, Non sain.

Nom	Type	Description
Healthy	string
IRPending	string
Invalid	string
Unhealthy	string

MabFileFolderProtectedItem

Élément de sauvegarde spécifique à la charge de travail MAB.

Nom	Type	Description
backupManagementType	BackupManagementType	Type de gestion des sauvegardes pour l’élément sauvegardé.
backupSetName	string	Nom du jeu de sauvegarde auquel appartient l’élément de sauvegarde
computerName	string	Nom de l’ordinateur associé à cet élément de sauvegarde.
containerName	string	Nom unique du conteneur
createMode	CreateMode	Mode Créer pour indiquer la récupération d’une source de données supprimée de manière réversible existante ou la création d’une nouvelle source de données.
deferredDeleteSyncTimeInUTC	integer	Heure de synchronisation de la suppression différée en UTC
deferredDeleteTimeInUTC	string	Heure de la suppression différée en UTC
deferredDeleteTimeRemaining	string	Temps restant avant la suppression définitive de la DS marquée pour la suppression différée
extendedInfo	MabFileFolderProtectedItemExtendedInfo	Informations supplémentaires sur cet élément de sauvegarde.
friendlyName	string	Nom convivial de cet élément de sauvegarde.
isArchiveEnabled	boolean	Indicateur permettant d’identifier si la source de données est protégée dans l’archive
isDeferredDeleteScheduleUpcoming	boolean	Indicateur permettant d’identifier si le DS supprimé différé doit être bientôt vidé
isRehydrate	boolean	Indicateur permettant d’identifier que le DS supprimé différé doit être déplacé dans l’état Pause
isScheduledForDeferredDelete	boolean	Indicateur permettant d’identifier si le DS est planifié pour la suppression différée
lastBackupStatus	string	État de la dernière opération de sauvegarde.
lastBackupTime	string	Horodatage de la dernière opération de sauvegarde sur cet élément de sauvegarde.
lastRecoveryPoint	string	Horodatage de la création de la dernière (dernière) copie de sauvegarde pour cet élément de sauvegarde.
policyId	string	ID de la stratégie de sauvegarde avec laquelle cet élément est sauvegardé.
policyName	string	Nom de la stratégie utilisée pour la protection
protectedItemType	string: MabFileFolderProtectedItem	type d’élément de sauvegarde.
protectionState	string	Protected, ProtectionStopped, IRPending ou ProtectionError
resourceGuardOperationRequests	string[]	ResourceGuardOperationRequests sur lesquelles les case activée LAC seront effectuées
softDeleteRetentionPeriodInDays	integer	Période de rétention de suppression réversible en jours
sourceResourceId	string	ID ARM de la ressource à sauvegarder.
workloadType	DataSourceType	Type de charge de travail que cet élément représente.

MabFileFolderProtectedItemExtendedInfo

Informations supplémentaires sur l’élément sauvegardé.

Nom	Type	Description
lastRefreshedAt	string	Dernière heure à laquelle les données de l’agent se sont synchronisées avec le service.
oldestRecoveryPoint	string	Copie de sauvegarde la plus ancienne disponible.
recoveryPointCount	integer	Nombre de copies de sauvegarde associées à l’élément de sauvegarde.

ProtectedItemHealthStatus

Intégrité status de l’élément de sauvegarde, évaluée en fonction de la dernière pulsation reçue

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

ProtectedItemResource

Classe de base pour les éléments de sauvegarde.

Nom	Type	Description
eTag	string	ETag facultatif.
id	string	ID de ressource représente le chemin d’accès complet à la ressource.
location	string	Emplacement de la ressource.
name	string	Nom de la ressource associé à la ressource.
properties	ProtectedItem: AzureFileshareProtectedItem AzureIaaSClassicComputeVMProtectedItem AzureIaaSComputeVMProtectedItem AzureIaaSVMProtectedItem AzureSqlProtectedItem AzureVmWorkloadProtectedItem AzureVmWorkloadSAPAseDatabaseProtectedItem AzureVmWorkloadSAPHanaDBInstanceProtectedItem AzureVmWorkloadSAPHanaDatabaseProtectedItem AzureVmWorkloadSQLDatabaseProtectedItem DPMProtectedItem GenericProtectedItem MabFileFolderProtectedItem	Propriétés ProtectedItemResource
tags	object	Balises de ressource.
type	string	Le type de ressource représente le chemin d’accès complet de la forme Espace de noms/ResourceType/ResourceType/...

ProtectedItemState

État de sauvegarde de l’élément sauvegardé.

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

ProtectionState

État de sauvegarde de cet élément de sauvegarde.

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

ResourceHealthDetails

Détails d’intégrité pour les éléments de sauvegarde.

Nom	Type	Description
code	integer	Code d’intégrité
message	string	Message d’intégrité
recommendations	string[]	Actions recommandées pour l’intégrité
title	string	Titre d’intégrité

ResourceHealthStatus

État d’intégrité des ressources

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