Backup Instances - Trigger Restore

Service:

Data Protection

API Version:

2023-01-01

Attiva il ripristino per un backupInstance

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/restore?api-version=2023-01-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
backupInstanceName	path	True	string	Nome dell'istanza di backup.
resourceGroupName	path	True	string	Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
subscriptionId	path	True	string uuid	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
vaultName	path	True	string	Nome dell'insieme di credenziali di backup.
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Il corpo della richiesta può essere uno dei seguenti:

Nome	Descrizione
AzureBackupRecoveryPointBasedRestoreRequest	Richiesta di ripristino basato su Backup di Azure
AzureBackupRecoveryTimeBasedRestoreRequest	Richiesta di ripristino basato su AzureBackupPointTime
AzureBackupRestoreWithRehydrationRequest	Ripristino di AzureBackup con richiesta di riattivazione

AzureBackupRecoveryPointBasedRestoreRequest

Richiesta di ripristino basato su Backup di Azure

Nome	Necessario	Tipo	Descrizione
objectType	True	string: AzureBackupRecoveryPointBasedRestoreRequest
recoveryPointId	True	string
restoreTargetInfo	True	RestoreTargetInfoBase: ItemLevelRestoreTargetInfo RestoreFilesTargetInfo RestoreTargetInfo	Ottiene o imposta le informazioni di destinazione di ripristino.
sourceDataStoreType	True	SourceDataStoreType	Ottiene o imposta il tipo dell'archivio dati di origine.
sourceResourceId		string	ID completo di Azure Resource Manager dell'origine dati che viene ripristinata.

AzureBackupRecoveryTimeBasedRestoreRequest

Richiesta di ripristino basato su AzureBackupPointTime

Nome	Necessario	Tipo	Descrizione
objectType	True	string: AzureBackupRecoveryTimeBasedRestoreRequest
recoveryPointTime	True	string	Il tempo di ripristino nel formato ISO 8601 - 2020-08-14T17:30:00.000000000Z.
restoreTargetInfo	True	RestoreTargetInfoBase: ItemLevelRestoreTargetInfo RestoreFilesTargetInfo RestoreTargetInfo	Ottiene o imposta le informazioni di destinazione di ripristino.
sourceDataStoreType	True	SourceDataStoreType	Ottiene o imposta il tipo dell'archivio dati di origine.
sourceResourceId		string	ID completo di Azure Resource Manager dell'origine dati che viene ripristinata.

AzureBackupRestoreWithRehydrationRequest

Ripristino di AzureBackup con richiesta di riattivazione

Nome	Necessario	Tipo	Descrizione
objectType	True	string: AzureBackupRestoreWithRehydrationRequest
recoveryPointId	True	string
rehydrationPriority	True	RehydrationPriority	Priorità da usare per la reidratazione. Valori elevati o standard
rehydrationRetentionDuration	True	string	Durata di conservazione nel formato ISO 8601, ad esempio P10D.
restoreTargetInfo	True	RestoreTargetInfoBase: ItemLevelRestoreTargetInfo RestoreFilesTargetInfo RestoreTargetInfo	Ottiene o imposta le informazioni di destinazione di ripristino.
sourceDataStoreType	True	SourceDataStoreType	Ottiene o imposta il tipo dell'archivio dati di origine.
sourceResourceId		string	ID completo di Azure Resource Manager dell'origine dati che viene ripristinata.

Risposte

Nome	Tipo	Descrizione
200 OK	OperationJobExtendedInfo	Contiene informazioni aggiuntive come ID processo
202 Accepted		L'operazione verrà completata in modo asincrono. Headers Location: string Azure-AsyncOperation: string Retry-After: integer
Other Status Codes	CloudError	Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente.

Esempio

Trigger Restore

Trigger Restore As Files

Trigger Restore With Rehydration

Trigger Restore

Sample Request

HTTP

POST https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/testInstance1/restore?api-version=2023-01-01

{
  "objectType": "AzureBackupRecoveryPointBasedRestoreRequest",
  "recoveryPointId": "hardcodedRP",
  "sourceDataStoreType": "VaultStore",
  "sourceResourceId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
  "restoreTargetInfo": {
    "objectType": "RestoreTargetInfo",
    "recoveryOption": "FailIfExists",
    "datasourceSetInfo": {
      "objectType": "DatasourceSet",
      "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
      "resourceName": "viveksipgtest",
      "resourceType": "Microsoft.DBforPostgreSQL/servers",
      "resourceUri": "",
      "resourceLocation": "",
      "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases"
    },
    "datasourceInfo": {
      "objectType": "Datasource",
      "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/targetdb",
      "resourceName": "targetdb",
      "resourceType": "Microsoft.DBforPostgreSQL/servers/databases",
      "resourceUri": "",
      "resourceLocation": "",
      "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases"
    },
    "datasourceAuthCredentials": {
      "secretStoreResource": {
        "uri": "https://samplevault.vault.azure.net/secrets/credentials",
        "secretStoreType": "AzureKeyVault"
      },
      "objectType": "SecretStoreBasedAuthCredentials"
    },
    "restoreLocation": "southeastasia"
  }
}

Java

import com.azure.resourcemanager.dataprotection.models.AzureBackupRecoveryPointBasedRestoreRequest;
import com.azure.resourcemanager.dataprotection.models.Datasource;
import com.azure.resourcemanager.dataprotection.models.DatasourceSet;
import com.azure.resourcemanager.dataprotection.models.RecoveryOption;
import com.azure.resourcemanager.dataprotection.models.RestoreTargetInfo;
import com.azure.resourcemanager.dataprotection.models.SecretStoreBasedAuthCredentials;
import com.azure.resourcemanager.dataprotection.models.SecretStoreResource;
import com.azure.resourcemanager.dataprotection.models.SecretStoreType;
import com.azure.resourcemanager.dataprotection.models.SourceDataStoreType;

/** Samples for BackupInstances TriggerRestore. */
public final class Main {
    /*
     * x-ms-original-file: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/TriggerRestore.json
     */
    /**
     * Sample code: Trigger Restore.
     *
     * @param manager Entry point to DataProtectionManager.
     */
    public static void triggerRestore(com.azure.resourcemanager.dataprotection.DataProtectionManager manager) {
        manager
            .backupInstances()
            .triggerRestore(
                "000pikumar",
                "PratikPrivatePreviewVault1",
                "testInstance1",
                new AzureBackupRecoveryPointBasedRestoreRequest()
                    .withRestoreTargetInfo(
                        new RestoreTargetInfo()
                            .withRecoveryOption(RecoveryOption.FAIL_IF_EXISTS)
                            .withRestoreLocation("southeastasia")
                            .withDatasourceInfo(
                                new Datasource()
                                    .withDatasourceType("Microsoft.DBforPostgreSQL/servers/databases")
                                    .withObjectType("Datasource")
                                    .withResourceId(
                                        "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/targetdb")
                                    .withResourceLocation("")
                                    .withResourceName("targetdb")
                                    .withResourceType("Microsoft.DBforPostgreSQL/servers/databases")
                                    .withResourceUri(""))
                            .withDatasourceSetInfo(
                                new DatasourceSet()
                                    .withDatasourceType("Microsoft.DBforPostgreSQL/servers/databases")
                                    .withObjectType("DatasourceSet")
                                    .withResourceId(
                                        "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest")
                                    .withResourceLocation("")
                                    .withResourceName("viveksipgtest")
                                    .withResourceType("Microsoft.DBforPostgreSQL/servers")
                                    .withResourceUri(""))
                            .withDatasourceAuthCredentials(
                                new SecretStoreBasedAuthCredentials()
                                    .withSecretStoreResource(
                                        new SecretStoreResource()
                                            .withUri("https://samplevault.vault.azure.net/secrets/credentials")
                                            .withSecretStoreType(SecretStoreType.AZURE_KEY_VAULT))))
                    .withSourceDataStoreType(SourceDataStoreType.VAULT_STORE)
                    .withSourceResourceId(
                        "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb")
                    .withRecoveryPointId("hardcodedRP"),
                com.azure.core.util.Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.dataprotection import DataProtectionMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-dataprotection
# USAGE
    python trigger_restore.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 = DataProtectionMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="04cf684a-d41f-4550-9f70-7708a3a2283b",
    )

    response = client.backup_instances.begin_trigger_restore(
        resource_group_name="000pikumar",
        vault_name="PratikPrivatePreviewVault1",
        backup_instance_name="testInstance1",
        parameters={
            "objectType": "AzureBackupRecoveryPointBasedRestoreRequest",
            "recoveryPointId": "hardcodedRP",
            "restoreTargetInfo": {
                "datasourceAuthCredentials": {
                    "objectType": "SecretStoreBasedAuthCredentials",
                    "secretStoreResource": {
                        "secretStoreType": "AzureKeyVault",
                        "uri": "https://samplevault.vault.azure.net/secrets/credentials",
                    },
                },
                "datasourceInfo": {
                    "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases",
                    "objectType": "Datasource",
                    "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/targetdb",
                    "resourceLocation": "",
                    "resourceName": "targetdb",
                    "resourceType": "Microsoft.DBforPostgreSQL/servers/databases",
                    "resourceUri": "",
                },
                "datasourceSetInfo": {
                    "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases",
                    "objectType": "DatasourceSet",
                    "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
                    "resourceLocation": "",
                    "resourceName": "viveksipgtest",
                    "resourceType": "Microsoft.DBforPostgreSQL/servers",
                    "resourceUri": "",
                },
                "objectType": "RestoreTargetInfo",
                "recoveryOption": "FailIfExists",
                "restoreLocation": "southeastasia",
            },
            "sourceDataStoreType": "VaultStore",
            "sourceResourceId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
        },
    ).result()
    print(response)


# x-ms-original-file: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/TriggerRestore.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 armdataprotection_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/dataprotection/armdataprotection/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1b33e81bbdc28fcd6644a1315b8d7b1b6d030590/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/TriggerRestore.json
func ExampleBackupInstancesClient_BeginTriggerRestore_triggerRestore() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewBackupInstancesClient().BeginTriggerRestore(ctx, "000pikumar", "PratikPrivatePreviewVault1", "testInstance1", &armdataprotection.AzureBackupRecoveryPointBasedRestoreRequest{
		ObjectType: to.Ptr("AzureBackupRecoveryPointBasedRestoreRequest"),
		RestoreTargetInfo: &armdataprotection.RestoreTargetInfo{
			ObjectType:      to.Ptr("RestoreTargetInfo"),
			RecoveryOption:  to.Ptr(armdataprotection.RecoveryOptionFailIfExists),
			RestoreLocation: to.Ptr("southeastasia"),
			DatasourceAuthCredentials: &armdataprotection.SecretStoreBasedAuthCredentials{
				ObjectType: to.Ptr("SecretStoreBasedAuthCredentials"),
				SecretStoreResource: &armdataprotection.SecretStoreResource{
					SecretStoreType: to.Ptr(armdataprotection.SecretStoreTypeAzureKeyVault),
					URI:             to.Ptr("https://samplevault.vault.azure.net/secrets/credentials"),
				},
			},
			DatasourceInfo: &armdataprotection.Datasource{
				DatasourceType:   to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
				ObjectType:       to.Ptr("Datasource"),
				ResourceID:       to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/targetdb"),
				ResourceLocation: to.Ptr(""),
				ResourceName:     to.Ptr("targetdb"),
				ResourceType:     to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
				ResourceURI:      to.Ptr(""),
			},
			DatasourceSetInfo: &armdataprotection.DatasourceSet{
				DatasourceType:   to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
				ObjectType:       to.Ptr("DatasourceSet"),
				ResourceID:       to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest"),
				ResourceLocation: to.Ptr(""),
				ResourceName:     to.Ptr("viveksipgtest"),
				ResourceType:     to.Ptr("Microsoft.DBforPostgreSQL/servers"),
				ResourceURI:      to.Ptr(""),
			},
		},
		SourceDataStoreType: to.Ptr(armdataprotection.SourceDataStoreTypeVaultStore),
		SourceResourceID:    to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb"),
		RecoveryPointID:     to.Ptr("hardcodedRP"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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.OperationJobExtendedInfo = armdataprotection.OperationJobExtendedInfo{
	// 	ObjectType: to.Ptr("OperationJobExtendedInfo"),
	// 	JobID: to.Ptr("c60cb49-63e8-4b21-b9bd-26277b3fdfae"),
	// }
}

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 { DataProtectionClient } = require("@azure/arm-dataprotection");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Triggers restore for a BackupInstance
 *
 * @summary Triggers restore for a BackupInstance
 * x-ms-original-file: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/TriggerRestore.json
 */
async function triggerRestore() {
  const subscriptionId =
    process.env["DATAPROTECTION_SUBSCRIPTION_ID"] || "04cf684a-d41f-4550-9f70-7708a3a2283b";
  const resourceGroupName = process.env["DATAPROTECTION_RESOURCE_GROUP"] || "000pikumar";
  const vaultName = "PratikPrivatePreviewVault1";
  const backupInstanceName = "testInstance1";
  const parameters = {
    objectType: "AzureBackupRecoveryPointBasedRestoreRequest",
    recoveryPointId: "hardcodedRP",
    restoreTargetInfo: {
      datasourceAuthCredentials: {
        objectType: "SecretStoreBasedAuthCredentials",
        secretStoreResource: {
          secretStoreType: "AzureKeyVault",
          uri: "https://samplevault.vault.azure.net/secrets/credentials",
        },
      },
      datasourceInfo: {
        datasourceType: "Microsoft.DBforPostgreSQL/servers/databases",
        objectType: "Datasource",
        resourceID:
          "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/targetdb",
        resourceLocation: "",
        resourceName: "targetdb",
        resourceType: "Microsoft.DBforPostgreSQL/servers/databases",
        resourceUri: "",
      },
      datasourceSetInfo: {
        datasourceType: "Microsoft.DBforPostgreSQL/servers/databases",
        objectType: "DatasourceSet",
        resourceID:
          "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
        resourceLocation: "",
        resourceName: "viveksipgtest",
        resourceType: "Microsoft.DBforPostgreSQL/servers",
        resourceUri: "",
      },
      objectType: "RestoreTargetInfo",
      recoveryOption: "FailIfExists",
      restoreLocation: "southeastasia",
    },
    sourceDataStoreType: "VaultStore",
    sourceResourceId:
      "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
  };
  const credential = new DefaultAzureCredential();
  const client = new DataProtectionClient(credential, subscriptionId);
  const result = await client.backupInstances.beginTriggerRestoreAndWait(
    resourceGroupName,
    vaultName,
    backupInstanceName,
    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

Sample Response

Status code:

202

Location: https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01
Azure-AsyncOperation: https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01
Retry-After: 60

Status code:

200

{
  "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae",
  "objectType": "OperationJobExtendedInfo"
}

Trigger Restore As Files

Sample Request

HTTP

POST https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PrivatePreviewVault1/backupInstances/testInstance1/restore?api-version=2023-01-01

{
  "objectType": "AzureBackupRecoveryPointBasedRestoreRequest",
  "recoveryPointId": "hardcodedRP",
  "sourceDataStoreType": "VaultStore",
  "sourceResourceId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
  "restoreTargetInfo": {
    "targetDetails": {
      "url": "https://teststorage.blob.core.windows.net/restoretest",
      "filePrefix": "restoredblob",
      "restoreTargetLocationType": "AzureBlobs"
    },
    "restoreLocation": "southeastasia",
    "recoveryOption": "FailIfExists",
    "objectType": "RestoreFilesTargetInfo"
  }
}

Java

import com.azure.resourcemanager.dataprotection.models.AzureBackupRecoveryPointBasedRestoreRequest;
import com.azure.resourcemanager.dataprotection.models.RecoveryOption;
import com.azure.resourcemanager.dataprotection.models.RestoreFilesTargetInfo;
import com.azure.resourcemanager.dataprotection.models.RestoreTargetLocationType;
import com.azure.resourcemanager.dataprotection.models.SourceDataStoreType;
import com.azure.resourcemanager.dataprotection.models.TargetDetails;

/** Samples for BackupInstances TriggerRestore. */
public final class Main {
    /*
     * x-ms-original-file: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/TriggerRestoreAsFiles.json
     */
    /**
     * Sample code: Trigger Restore As Files.
     *
     * @param manager Entry point to DataProtectionManager.
     */
    public static void triggerRestoreAsFiles(com.azure.resourcemanager.dataprotection.DataProtectionManager manager) {
        manager
            .backupInstances()
            .triggerRestore(
                "000pikumar",
                "PrivatePreviewVault1",
                "testInstance1",
                new AzureBackupRecoveryPointBasedRestoreRequest()
                    .withRestoreTargetInfo(
                        new RestoreFilesTargetInfo()
                            .withRecoveryOption(RecoveryOption.FAIL_IF_EXISTS)
                            .withRestoreLocation("southeastasia")
                            .withTargetDetails(
                                new TargetDetails()
                                    .withFilePrefix("restoredblob")
                                    .withRestoreTargetLocationType(RestoreTargetLocationType.AZURE_BLOBS)
                                    .withUrl("https://teststorage.blob.core.windows.net/restoretest")))
                    .withSourceDataStoreType(SourceDataStoreType.VAULT_STORE)
                    .withSourceResourceId(
                        "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb")
                    .withRecoveryPointId("hardcodedRP"),
                com.azure.core.util.Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.dataprotection import DataProtectionMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-dataprotection
# USAGE
    python trigger_restore_as_files.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 = DataProtectionMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="04cf684a-d41f-4550-9f70-7708a3a2283b",
    )

    response = client.backup_instances.begin_trigger_restore(
        resource_group_name="000pikumar",
        vault_name="PrivatePreviewVault1",
        backup_instance_name="testInstance1",
        parameters={
            "objectType": "AzureBackupRecoveryPointBasedRestoreRequest",
            "recoveryPointId": "hardcodedRP",
            "restoreTargetInfo": {
                "objectType": "RestoreFilesTargetInfo",
                "recoveryOption": "FailIfExists",
                "restoreLocation": "southeastasia",
                "targetDetails": {
                    "filePrefix": "restoredblob",
                    "restoreTargetLocationType": "AzureBlobs",
                    "url": "https://teststorage.blob.core.windows.net/restoretest",
                },
            },
            "sourceDataStoreType": "VaultStore",
            "sourceResourceId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
        },
    ).result()
    print(response)


# x-ms-original-file: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/TriggerRestoreAsFiles.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 armdataprotection_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/dataprotection/armdataprotection/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1b33e81bbdc28fcd6644a1315b8d7b1b6d030590/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/TriggerRestoreAsFiles.json
func ExampleBackupInstancesClient_BeginTriggerRestore_triggerRestoreAsFiles() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewBackupInstancesClient().BeginTriggerRestore(ctx, "000pikumar", "PrivatePreviewVault1", "testInstance1", &armdataprotection.AzureBackupRecoveryPointBasedRestoreRequest{
		ObjectType: to.Ptr("AzureBackupRecoveryPointBasedRestoreRequest"),
		RestoreTargetInfo: &armdataprotection.RestoreFilesTargetInfo{
			ObjectType:      to.Ptr("RestoreFilesTargetInfo"),
			RecoveryOption:  to.Ptr(armdataprotection.RecoveryOptionFailIfExists),
			RestoreLocation: to.Ptr("southeastasia"),
			TargetDetails: &armdataprotection.TargetDetails{
				FilePrefix:                to.Ptr("restoredblob"),
				RestoreTargetLocationType: to.Ptr(armdataprotection.RestoreTargetLocationTypeAzureBlobs),
				URL:                       to.Ptr("https://teststorage.blob.core.windows.net/restoretest"),
			},
		},
		SourceDataStoreType: to.Ptr(armdataprotection.SourceDataStoreTypeVaultStore),
		SourceResourceID:    to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb"),
		RecoveryPointID:     to.Ptr("hardcodedRP"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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.OperationJobExtendedInfo = armdataprotection.OperationJobExtendedInfo{
	// 	ObjectType: to.Ptr("OperationJobExtendedInfo"),
	// 	JobID: to.Ptr("c60cb49-63e8-4b21-b9bd-26277b3fdfae"),
	// }
}

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 { DataProtectionClient } = require("@azure/arm-dataprotection");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Triggers restore for a BackupInstance
 *
 * @summary Triggers restore for a BackupInstance
 * x-ms-original-file: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/TriggerRestoreAsFiles.json
 */
async function triggerRestoreAsFiles() {
  const subscriptionId =
    process.env["DATAPROTECTION_SUBSCRIPTION_ID"] || "04cf684a-d41f-4550-9f70-7708a3a2283b";
  const resourceGroupName = process.env["DATAPROTECTION_RESOURCE_GROUP"] || "000pikumar";
  const vaultName = "PrivatePreviewVault1";
  const backupInstanceName = "testInstance1";
  const parameters = {
    objectType: "AzureBackupRecoveryPointBasedRestoreRequest",
    recoveryPointId: "hardcodedRP",
    restoreTargetInfo: {
      objectType: "RestoreFilesTargetInfo",
      recoveryOption: "FailIfExists",
      restoreLocation: "southeastasia",
      targetDetails: {
        filePrefix: "restoredblob",
        restoreTargetLocationType: "AzureBlobs",
        url: "https://teststorage.blob.core.windows.net/restoretest",
      },
    },
    sourceDataStoreType: "VaultStore",
    sourceResourceId:
      "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
  };
  const credential = new DefaultAzureCredential();
  const client = new DataProtectionClient(credential, subscriptionId);
  const result = await client.backupInstances.beginTriggerRestoreAndWait(
    resourceGroupName,
    vaultName,
    backupInstanceName,
    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

Sample Response

Status code:

202

Location: https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/testInstance1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01
Azure-AsyncOperation: https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01
Retry-After: 60

Status code:

200

{
  "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae",
  "objectType": "OperationJobExtendedInfo"
}

Trigger Restore With Rehydration

Sample Request

HTTP

POST https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/testInstance1/restore?api-version=2023-01-01

{
  "objectType": "AzureBackupRestoreWithRehydrationRequest",
  "recoveryPointId": "hardcodedRP",
  "rehydrationRetentionDuration": "7D",
  "rehydrationPriority": "High",
  "sourceDataStoreType": "VaultStore",
  "sourceResourceId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
  "restoreTargetInfo": {
    "objectType": "RestoreTargetInfo",
    "recoveryOption": "FailIfExists",
    "datasourceSetInfo": {
      "objectType": "DatasourceSet",
      "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
      "resourceName": "viveksipgtest",
      "resourceType": "Microsoft.DBforPostgreSQL/servers",
      "resourceUri": "",
      "resourceLocation": "",
      "datasourceType": "OssDB"
    },
    "datasourceInfo": {
      "objectType": "Datasource",
      "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
      "resourceName": "testdb",
      "resourceType": "Microsoft.DBforPostgreSQL/servers/databases",
      "resourceUri": "",
      "resourceLocation": "",
      "datasourceType": "OssDB"
    },
    "restoreLocation": "southeastasia"
  }
}

Java

import com.azure.resourcemanager.dataprotection.models.AzureBackupRestoreWithRehydrationRequest;
import com.azure.resourcemanager.dataprotection.models.Datasource;
import com.azure.resourcemanager.dataprotection.models.DatasourceSet;
import com.azure.resourcemanager.dataprotection.models.RecoveryOption;
import com.azure.resourcemanager.dataprotection.models.RehydrationPriority;
import com.azure.resourcemanager.dataprotection.models.RestoreTargetInfo;
import com.azure.resourcemanager.dataprotection.models.SourceDataStoreType;

/** Samples for BackupInstances TriggerRestore. */
public final class Main {
    /*
     * x-ms-original-file: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/TriggerRestoreWithRehydration.json
     */
    /**
     * Sample code: Trigger Restore With Rehydration.
     *
     * @param manager Entry point to DataProtectionManager.
     */
    public static void triggerRestoreWithRehydration(
        com.azure.resourcemanager.dataprotection.DataProtectionManager manager) {
        manager
            .backupInstances()
            .triggerRestore(
                "000pikumar",
                "PratikPrivatePreviewVault1",
                "testInstance1",
                new AzureBackupRestoreWithRehydrationRequest()
                    .withRestoreTargetInfo(
                        new RestoreTargetInfo()
                            .withRecoveryOption(RecoveryOption.FAIL_IF_EXISTS)
                            .withRestoreLocation("southeastasia")
                            .withDatasourceInfo(
                                new Datasource()
                                    .withDatasourceType("OssDB")
                                    .withObjectType("Datasource")
                                    .withResourceId(
                                        "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb")
                                    .withResourceLocation("")
                                    .withResourceName("testdb")
                                    .withResourceType("Microsoft.DBforPostgreSQL/servers/databases")
                                    .withResourceUri(""))
                            .withDatasourceSetInfo(
                                new DatasourceSet()
                                    .withDatasourceType("OssDB")
                                    .withObjectType("DatasourceSet")
                                    .withResourceId(
                                        "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest")
                                    .withResourceLocation("")
                                    .withResourceName("viveksipgtest")
                                    .withResourceType("Microsoft.DBforPostgreSQL/servers")
                                    .withResourceUri("")))
                    .withSourceDataStoreType(SourceDataStoreType.VAULT_STORE)
                    .withSourceResourceId(
                        "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb")
                    .withRecoveryPointId("hardcodedRP")
                    .withRehydrationPriority(RehydrationPriority.HIGH)
                    .withRehydrationRetentionDuration("7D"),
                com.azure.core.util.Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.dataprotection import DataProtectionMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-dataprotection
# USAGE
    python trigger_restore_with_rehydration.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 = DataProtectionMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="04cf684a-d41f-4550-9f70-7708a3a2283b",
    )

    response = client.backup_instances.begin_trigger_restore(
        resource_group_name="000pikumar",
        vault_name="PratikPrivatePreviewVault1",
        backup_instance_name="testInstance1",
        parameters={
            "objectType": "AzureBackupRestoreWithRehydrationRequest",
            "recoveryPointId": "hardcodedRP",
            "rehydrationPriority": "High",
            "rehydrationRetentionDuration": "7D",
            "restoreTargetInfo": {
                "datasourceInfo": {
                    "datasourceType": "OssDB",
                    "objectType": "Datasource",
                    "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
                    "resourceLocation": "",
                    "resourceName": "testdb",
                    "resourceType": "Microsoft.DBforPostgreSQL/servers/databases",
                    "resourceUri": "",
                },
                "datasourceSetInfo": {
                    "datasourceType": "OssDB",
                    "objectType": "DatasourceSet",
                    "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
                    "resourceLocation": "",
                    "resourceName": "viveksipgtest",
                    "resourceType": "Microsoft.DBforPostgreSQL/servers",
                    "resourceUri": "",
                },
                "objectType": "RestoreTargetInfo",
                "recoveryOption": "FailIfExists",
                "restoreLocation": "southeastasia",
            },
            "sourceDataStoreType": "VaultStore",
            "sourceResourceId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
        },
    ).result()
    print(response)


# x-ms-original-file: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/TriggerRestoreWithRehydration.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 armdataprotection_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/dataprotection/armdataprotection/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1b33e81bbdc28fcd6644a1315b8d7b1b6d030590/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/TriggerRestoreWithRehydration.json
func ExampleBackupInstancesClient_BeginTriggerRestore_triggerRestoreWithRehydration() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewBackupInstancesClient().BeginTriggerRestore(ctx, "000pikumar", "PratikPrivatePreviewVault1", "testInstance1", &armdataprotection.AzureBackupRestoreWithRehydrationRequest{
		ObjectType: to.Ptr("AzureBackupRestoreWithRehydrationRequest"),
		RestoreTargetInfo: &armdataprotection.RestoreTargetInfo{
			ObjectType:      to.Ptr("RestoreTargetInfo"),
			RecoveryOption:  to.Ptr(armdataprotection.RecoveryOptionFailIfExists),
			RestoreLocation: to.Ptr("southeastasia"),
			DatasourceInfo: &armdataprotection.Datasource{
				DatasourceType:   to.Ptr("OssDB"),
				ObjectType:       to.Ptr("Datasource"),
				ResourceID:       to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb"),
				ResourceLocation: to.Ptr(""),
				ResourceName:     to.Ptr("testdb"),
				ResourceType:     to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
				ResourceURI:      to.Ptr(""),
			},
			DatasourceSetInfo: &armdataprotection.DatasourceSet{
				DatasourceType:   to.Ptr("OssDB"),
				ObjectType:       to.Ptr("DatasourceSet"),
				ResourceID:       to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest"),
				ResourceLocation: to.Ptr(""),
				ResourceName:     to.Ptr("viveksipgtest"),
				ResourceType:     to.Ptr("Microsoft.DBforPostgreSQL/servers"),
				ResourceURI:      to.Ptr(""),
			},
		},
		SourceDataStoreType:          to.Ptr(armdataprotection.SourceDataStoreTypeVaultStore),
		SourceResourceID:             to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb"),
		RecoveryPointID:              to.Ptr("hardcodedRP"),
		RehydrationPriority:          to.Ptr(armdataprotection.RehydrationPriorityHigh),
		RehydrationRetentionDuration: to.Ptr("7D"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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.OperationJobExtendedInfo = armdataprotection.OperationJobExtendedInfo{
	// 	ObjectType: to.Ptr("OperationJobExtendedInfo"),
	// 	JobID: to.Ptr("c60cb49-63e8-4b21-b9bd-26277b3fdfae"),
	// }
}

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 { DataProtectionClient } = require("@azure/arm-dataprotection");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Triggers restore for a BackupInstance
 *
 * @summary Triggers restore for a BackupInstance
 * x-ms-original-file: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/TriggerRestoreWithRehydration.json
 */
async function triggerRestoreWithRehydration() {
  const subscriptionId =
    process.env["DATAPROTECTION_SUBSCRIPTION_ID"] || "04cf684a-d41f-4550-9f70-7708a3a2283b";
  const resourceGroupName = process.env["DATAPROTECTION_RESOURCE_GROUP"] || "000pikumar";
  const vaultName = "PratikPrivatePreviewVault1";
  const backupInstanceName = "testInstance1";
  const parameters = {
    objectType: "AzureBackupRestoreWithRehydrationRequest",
    recoveryPointId: "hardcodedRP",
    rehydrationPriority: "High",
    rehydrationRetentionDuration: "7D",
    restoreTargetInfo: {
      datasourceInfo: {
        datasourceType: "OssDB",
        objectType: "Datasource",
        resourceID:
          "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
        resourceLocation: "",
        resourceName: "testdb",
        resourceType: "Microsoft.DBforPostgreSQL/servers/databases",
        resourceUri: "",
      },
      datasourceSetInfo: {
        datasourceType: "OssDB",
        objectType: "DatasourceSet",
        resourceID:
          "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
        resourceLocation: "",
        resourceName: "viveksipgtest",
        resourceType: "Microsoft.DBforPostgreSQL/servers",
        resourceUri: "",
      },
      objectType: "RestoreTargetInfo",
      recoveryOption: "FailIfExists",
      restoreLocation: "southeastasia",
    },
    sourceDataStoreType: "VaultStore",
    sourceResourceId:
      "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
  };
  const credential = new DefaultAzureCredential();
  const client = new DataProtectionClient(credential, subscriptionId);
  const result = await client.backupInstances.beginTriggerRestoreAndWait(
    resourceGroupName,
    vaultName,
    backupInstanceName,
    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

Sample Response

Status code:

202

Location: https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01
Azure-AsyncOperation: https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01
Retry-After: 60

Status code:

200

{
  "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae",
  "objectType": "OperationJobExtendedInfo"
}

Definizioni

Nome	Descrizione
AzureBackupRecoveryPointBasedRestoreRequest	AzureBackupRecoveryPointBasedRestoreRequest
AzureBackupRecoveryTimeBasedRestoreRequest	AzureBackupRecoveryTimeBasedRestoreRequest
AzureBackupRestoreWithRehydrationRequest	AzureBackupRestoreWithRehydrationRequest
CloudError	CloudError
Datasource	Origine dati
DatasourceSet	DatasourceSet
Error	Risposta all'errore di gestione delle risorse.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ExistingResourcePolicy	Ottiene o imposta la proprietà Conflict Policy. Questa proprietà imposta i criteri durante il conflitto delle risorse durante il ripristino.
ItemLevelRestoreTargetInfo	Ripristinare le informazioni di destinazione per l'operazione di ripristino a livello di elemento
ItemPathBasedRestoreCriteria	Criteri di prefisso da usare per durante il ripristino
KubernetesClusterRestoreCriteria	Informazioni di destinazione del backup del cluster kubernetes per l'operazione di ripristino
KubernetesPVRestoreCriteria	Informazioni sulla destinazione del volume persistente a livello di elemento per l'operazione di ripristino
KubernetesStorageClassRestoreCriteria	Informazioni sulla destinazione della classe di archiviazione kubernetes a livello di elemento per l'operazione di ripristino
OperationJobExtendedInfo	OperationJobExtendedInfo
PersistentVolumeRestoreMode	Ottiene o imposta la proprietà Modalità di ripristino pv (volume persistente). Questa proprietà imposta se i volumi devono essere ripristinati.
RangeBasedItemLevelRestoreCriteria	Informazioni di destinazione a livello di elemento per l'operazione di ripristino
RecoveryOption	Opzione di ripristino
RehydrationPriority	Priorità da usare per la riattivazione. Valori elevati o standard
RestoreFilesTargetInfo	Classe che incapsula il ripristino come parametri di destinazione dei file
RestoreTargetInfo	Classe che incapsula i parametri di destinazione del ripristino
RestoreTargetLocationType	Indica il percorso di destinazione in cui verranno ripristinati i dati, il valore stringa per l'enumerazione {Microsoft.Internal.AzureBackup.DataProtection.Common.Interface.RestoreTargetLocationType}
SecretStoreBasedAuthCredentials	Credenziali di autenticazione basate sull'archivio segreto.
SecretStoreResource	Classe che rappresenta una risorsa dell'archivio segreto.
SecretStoreType	Ottiene o imposta il tipo di archivio segreto
SourceDataStoreType	Ottiene o imposta il tipo dell'archivio dati di origine.
TargetDetails	Classe che incapsula i dettagli di destinazione, usato dove la destinazione non è un'origine dati

AzureBackupRecoveryPointBasedRestoreRequest

AzureBackupRecoveryPointBasedRestoreRequest

Nome	Tipo	Descrizione
objectType	string: AzureBackupRecoveryPointBasedRestoreRequest
recoveryPointId	string
restoreTargetInfo	RestoreTargetInfoBase: ItemLevelRestoreTargetInfo RestoreFilesTargetInfo RestoreTargetInfo	Ottiene o imposta le informazioni sulla destinazione di ripristino.
sourceDataStoreType	SourceDataStoreType	Ottiene o imposta il tipo dell'archivio dati di origine.
sourceResourceId	string	ID completo di Azure Resource Manager dell'origine dati da ripristinare.

AzureBackupRecoveryTimeBasedRestoreRequest

AzureBackupRecoveryTimeBasedRestoreRequest

Nome	Tipo	Descrizione
objectType	string: AzureBackupRecoveryTimeBasedRestoreRequest
recoveryPointTime	string	Esempio di tempo di recupero in formato ISO 8601 - 2020-08-14T17:30:00.0000000Z.
restoreTargetInfo	RestoreTargetInfoBase: ItemLevelRestoreTargetInfo RestoreFilesTargetInfo RestoreTargetInfo	Ottiene o imposta le informazioni sulla destinazione di ripristino.
sourceDataStoreType	SourceDataStoreType	Ottiene o imposta il tipo dell'archivio dati di origine.
sourceResourceId	string	ID completo di Azure Resource Manager dell'origine dati da ripristinare.

AzureBackupRestoreWithRehydrationRequest

AzureBackupRestoreWithRehydrationRequest

Nome	Tipo	Descrizione
objectType	string: AzureBackupRestoreWithRehydrationRequest
recoveryPointId	string
rehydrationPriority	RehydrationPriority	Priorità da usare per la riattivazione. Valori elevati o standard
rehydrationRetentionDuration	string	Durata della conservazione in formato ISO 8601, ad esempio P10D.
restoreTargetInfo	RestoreTargetInfoBase: ItemLevelRestoreTargetInfo RestoreFilesTargetInfo RestoreTargetInfo	Ottiene o imposta le informazioni sulla destinazione di ripristino.
sourceDataStoreType	SourceDataStoreType	Ottiene o imposta il tipo dell'archivio dati di origine.
sourceResourceId	string	ID completo di Azure Resource Manager dell'origine dati da ripristinare.

CloudError

CloudError

Nome	Tipo	Descrizione
error	Error	Risposta all'errore di gestione delle risorse.

Datasource

Origine dati

Nome	Tipo	Descrizione
datasourceType	string	DatasourceType della risorsa.
objectType	string	Tipo di oggetto Datasource, utilizzato per inizializzare il tipo ereditato corretto
resourceID	string	ID arm completo della risorsa. Per le risorse di Azure, si tratta dell'ID ARM. Per le risorse non di Azure, questo sarà l'ID creato dal servizio di backup tramite Fabric/Vault.
resourceLocation	string	Posizione dell'origine dati.
resourceName	string	Identificatore univoco della risorsa nel contesto dell'elemento padre.
resourceType	string	Tipo di risorsa dell'origine dati.
resourceUri	string	URI della risorsa.

DatasourceSet

DatasourceSet

Nome	Tipo	Descrizione
datasourceType	string	DatasourceType della risorsa.
objectType	string	Tipo di oggetto Datasource, utilizzato per inizializzare il tipo ereditato corretto
resourceID	string	ID arm completo della risorsa. Per le risorse di Azure, si tratta dell'ID ARM. Per le risorse non di Azure, questo sarà l'ID creato dal servizio di backup tramite Fabric/Vault.
resourceLocation	string	Posizione dell'origine dati.
resourceName	string	Identificatore univoco della risorsa nel contesto dell'elemento padre.
resourceType	string	Tipo di risorsa dell'origine dati.
resourceUri	string	URI della risorsa.

Error

Risposta all'errore di gestione delle risorse.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	Error[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ExistingResourcePolicy

Ottiene o imposta la proprietà Conflict Policy. Questa proprietà imposta i criteri durante il conflitto delle risorse durante il ripristino.

Nome	Tipo	Descrizione
Patch	string
Skip	string

ItemLevelRestoreTargetInfo

Ripristinare le informazioni di destinazione per l'operazione di ripristino a livello di elemento

Nome	Tipo	Descrizione
datasourceAuthCredentials	AuthCredentials: SecretStoreBasedAuthCredentials	Credenziali da usare per l'autenticazione con il provider dell'origine dati.
datasourceInfo	Datasource	Origine dati Informazioni sul DS di destinazione
datasourceSetInfo	DatasourceSet	DatasourceSet Informazioni sul set di DS di destinazione
objectType	string: ItemLevelRestoreTargetInfo	Tipo di oggetto Datasource, utilizzato per inizializzare il tipo ereditato corretto
recoveryOption	RecoveryOption	Opzione di ripristino
restoreCriteria	ItemLevelRestoreCriteria[]: ItemPathBasedRestoreCriteria[] KubernetesClusterRestoreCriteria[] KubernetesPVRestoreCriteria[] KubernetesStorageClassRestoreCriteria[] RangeBasedItemLevelRestoreCriteria[]	Criteri di ripristino
restoreLocation	string	Area di ripristino di destinazione

ItemPathBasedRestoreCriteria

Criteri di prefisso da usare per durante il ripristino

Nome	Tipo	Descrizione
isPathRelativeToBackupItem	boolean	Flag per specificare se il percorso è relativo all'elemento di backup o al percorso completo
itemPath	string	Percorso dell'elemento da ripristinare. Potrebbe trattarsi del percorso completo dell'elemento o del percorso relativo all'elemento di backup
objectType	string: ItemPathBasedRestoreCriteria	Tipo dell'oggetto specifico : utilizzato per la deserializzazione
subItemPathPrefix	string[]	Elenco di stringhe di prefisso da utilizzare come criteri di filtro durante il ripristino. Questi valori sono relativi al percorso dell'elemento specificato.

KubernetesClusterRestoreCriteria

Informazioni di destinazione del backup del cluster kubernetes per l'operazione di ripristino

Nome	Tipo	Descrizione
conflictPolicy	ExistingResourcePolicy	Ottiene o imposta la proprietà Conflict Policy. Questa proprietà imposta i criteri durante il conflitto delle risorse durante il ripristino.
excludedNamespaces	string[]	Ottiene o imposta la proprietà escludi spazi dei nomi. Questa proprietà imposta gli spazi dei nomi da escludere durante il ripristino.
excludedResourceTypes	string[]	Ottiene o imposta la proprietà escludi tipi di risorse. Questa proprietà imposta i tipi di risorse da escludere durante il ripristino.
includeClusterScopeResources	boolean	Ottiene o imposta la proprietà include risorse del cluster. Questa proprietà se abilitata includerà le risorse dell'ambito del cluster durante il ripristino.
includedNamespaces	string[]	Ottiene o imposta la proprietà include spazi dei nomi. Questa proprietà imposta gli spazi dei nomi da includere durante il ripristino.
includedResourceTypes	string[]	Ottiene o imposta la proprietà include tipi di risorse. Questa proprietà imposta i tipi di risorse da includere durante il ripristino.
labelSelectors	string[]	Ottiene o imposta la proprietà LabelSelectors. Questa proprietà imposta la risorsa con tali selettore di etichette da includere durante il ripristino.
namespaceMappings	object	Ottiene o imposta la proprietà Mapping dello spazio dei nomi. Questa proprietà imposta se lo spazio dei nomi deve essere modificato durante il ripristino.
objectType	string: KubernetesClusterRestoreCriteria	Tipo dell'oggetto specifico : usato per la deserializzazione
persistentVolumeRestoreMode	PersistentVolumeRestoreMode	Ottiene o imposta la proprietà Modalità di ripristino pv (volume persistente). Questa proprietà imposta se i volumi devono essere ripristinati.

KubernetesPVRestoreCriteria

Informazioni sulla destinazione del volume persistente a livello di elemento per l'operazione di ripristino

Nome	Tipo	Descrizione
name	string	Nome dell'attestazione del volume persistente selezionato
objectType	string: KubernetesPVRestoreCriteria	Tipo dell'oggetto specifico : usato per la deserializzazione
storageClassName	string	Nome della classe di archiviazione selezionata per l'operazione di ripristino

KubernetesStorageClassRestoreCriteria

Informazioni sulla destinazione della classe di archiviazione kubernetes a livello di elemento per l'operazione di ripristino

Nome	Tipo	Descrizione
objectType	string: KubernetesStorageClassRestoreCriteria	Tipo dell'oggetto specifico : usato per la deserializzazione
provisioner	string	Provisioner della classe di archiviazione
selectedStorageClassName	string	Nome della classe di archiviazione selezionata

OperationJobExtendedInfo

OperationJobExtendedInfo

Nome	Tipo	Descrizione
jobId	string	ID arm del processo creato per questa operazione.
objectType	string: OperationJobExtendedInfo	Questa proprietà verrà utilizzata come discriminante per decidere i tipi specifici nella catena polimorfica di tipi.

PersistentVolumeRestoreMode

Ottiene o imposta la proprietà Modalità di ripristino pv (volume persistente). Questa proprietà imposta se i volumi devono essere ripristinati.

Nome	Tipo	Descrizione
RestoreWithVolumeData	string
RestoreWithoutVolumeData	string

RangeBasedItemLevelRestoreCriteria

Informazioni di destinazione a livello di elemento per l'operazione di ripristino

Nome	Tipo	Descrizione
maxMatchingValue	string	valore massimo per la corrispondenza del prefisso di intervallo
minMatchingValue	string	valore minimo per la corrispondenza del prefisso di intervallo
objectType	string: RangeBasedItemLevelRestoreCriteria	Tipo dell'oggetto specifico : utilizzato per la deserializzazione

RecoveryOption

Opzione di ripristino

Nome	Tipo	Descrizione
FailIfExists	string

RehydrationPriority

Priorità da usare per la riattivazione. Valori elevati o standard

Nome	Tipo	Descrizione
High	string
Invalid	string
Standard	string

RestoreFilesTargetInfo

Classe che incapsula il ripristino come parametri di destinazione dei file

Nome	Tipo	Descrizione
objectType	string: RestoreFilesTargetInfo	Tipo di oggetto Datasource, utilizzato per inizializzare il tipo ereditato corretto
recoveryOption	RecoveryOption	Opzione di ripristino
restoreLocation	string	Area di ripristino di destinazione
targetDetails	TargetDetails	Destinazione dell'operazione RestoreAsFiles, quando la destinazione non è un'origine dati

RestoreTargetInfo

Classe che incapsula i parametri di destinazione del ripristino

Nome	Tipo	Descrizione
datasourceAuthCredentials	AuthCredentials: SecretStoreBasedAuthCredentials	Credenziali da usare per l'autenticazione con il provider dell'origine dati.
datasourceInfo	Datasource	Origine dati Informazioni sul DS di destinazione
datasourceSetInfo	DatasourceSet	DatasourceSet Informazioni sul set di DS di destinazione
objectType	string: RestoreTargetInfo	Tipo di oggetto Datasource, utilizzato per inizializzare il tipo ereditato corretto
recoveryOption	RecoveryOption	Opzione di ripristino
restoreLocation	string	Area di ripristino di destinazione

RestoreTargetLocationType

Indica il percorso di destinazione in cui verranno ripristinati i dati, il valore stringa per l'enumerazione {Microsoft.Internal.AzureBackup.DataProtection.Common.Interface.RestoreTargetLocationType}

Nome	Tipo	Descrizione
AzureBlobs	string
AzureFiles	string
Invalid	string

SecretStoreBasedAuthCredentials

Credenziali di autenticazione basate sull'archivio segreto.

Nome	Tipo	Descrizione
objectType	string: SecretStoreBasedAuthCredentials	Tipo dell'oggetto specifico : usato per la deserializzazione
secretStoreResource	SecretStoreResource	Risorsa dell'archivio segreto

SecretStoreResource

Classe che rappresenta una risorsa dell'archivio segreto.

Nome	Tipo	Descrizione
secretStoreType	SecretStoreType	Ottiene o imposta il tipo di archivio segreto
uri	string	Uri per accedere alla risorsa
value	string	Ottiene o imposta il valore archiviato nella risorsa dell'archivio segreto

SecretStoreType

Ottiene o imposta il tipo di archivio segreto

Nome	Tipo	Descrizione
AzureKeyVault	string
Invalid	string

SourceDataStoreType

Ottiene o imposta il tipo dell'archivio dati di origine.

Nome	Tipo	Descrizione
ArchiveStore	string
OperationalStore	string
SnapshotStore	string
VaultStore	string

TargetDetails

Classe che incapsula i dettagli di destinazione, usato dove la destinazione non è un'origine dati

Nome	Tipo	Descrizione
filePrefix	string	L'operazione di ripristino può creare più file all'interno del percorso indicato dall'URL seguente sarà il prefisso comune per tutti
restoreTargetLocationType	RestoreTargetLocationType	Indica il percorso di destinazione in cui verranno ripristinati i dati, il valore stringa per l'enumerazione {Microsoft.Internal.AzureBackup.DataProtection.Common.Interface.RestoreTargetLocationType}
targetResourceArmId	string	ID ARM completo che indica la destinazione di ripristino. Si tratta dell'ID ARM che punta al contenitore o alla condivisione file Questo è facoltativo se la sottoscrizione di destinazione può essere identificata con il campo URL. In caso contrario, questa operazione è necessaria se il campo CrossSubscriptionRestore di BackupVault si trova in uno degli stati disabilitati
url	string	URL che indica la destinazione di ripristino. Può puntare a contenitore/condivisione file e così via