Restores the specified backed up data. This is an asynchronous operation. To know the status of this API call, use
GetProtectedItemOperationResult API.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}/restore?api-version=2026-07-01
URI Parameters
| Name |
In |
Required |
Type |
Description |
|
containerName
|
path |
True
|
string
|
Name of the container whose details need to be fetched.
|
|
fabricName
|
path |
True
|
string
|
The name of the BackupFabricResource
|
|
protectedItemName
|
path |
True
|
string
|
Backed up item name whose details are to be fetched.
|
|
recoveryPointId
|
path |
True
|
string
|
RecoveryPointID represents the backed up data to be fetched.
|
|
resourceGroupName
|
path |
True
|
string
minLength: 1 maxLength: 90
|
The name of the resource group. The name is case insensitive.
|
|
subscriptionId
|
path |
True
|
string
minLength: 1
|
The ID of the target subscription.
|
|
vaultName
|
path |
True
|
string
|
The name of the VaultResource
|
|
api-version
|
query |
True
|
string
minLength: 1
|
The API version to use for this operation.
|
| Name |
Required |
Type |
Description |
|
x-ms-authorization-auxiliary
|
|
string
|
|
Request Body
| Name |
Type |
Description |
|
eTag
|
string
|
Optional ETag.
|
|
location
|
string
|
Resource location.
|
|
properties
|
RestoreRequest:
|
RestoreRequestResource properties
|
|
tags
|
object
|
Resource tags.
|
Responses
| Name |
Type |
Description |
|
202 Accepted
|
|
Resource operation accepted.
Headers
- Location: string
- Retry-After: integer
|
|
Other Status Codes
|
ErrorResponse
|
An unexpected error response.
|
Security
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name |
Description |
|
user_impersonation
|
impersonate your user account
|
Examples
Restore Azure File Share to Original Location with Managed Identity
Sample request
POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/swaggertestvault/backupFabrics/Azure/protectionContainers/StorageContainer;Storage;SwaggerTestRg;swaggertestsa/protectedItems/AzureFileShare;testshare/recoveryPoints/932886657837421071/restore?api-version=2026-07-01
{
"properties": {
"objectType": "AzureFileShareRestoreRequest",
"recoveryType": "OriginalLocation",
"sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/SwaggerTestRg/providers/Microsoft.Storage/storageAccounts/swaggertestsa",
"copyOptions": "Overwrite",
"restoreRequestType": "FullShareRestore",
"identityInfo": {
"isSystemAssignedIdentity": true
}
}
}
import com.azure.resourcemanager.recoveryservicesbackup.models.AzureFileShareRestoreRequest;
import com.azure.resourcemanager.recoveryservicesbackup.models.CopyOptions;
import com.azure.resourcemanager.recoveryservicesbackup.models.IdentityInfo;
import com.azure.resourcemanager.recoveryservicesbackup.models.RecoveryType;
import com.azure.resourcemanager.recoveryservicesbackup.models.RestoreRequestResource;
import com.azure.resourcemanager.recoveryservicesbackup.models.RestoreRequestType;
/**
* Samples for Restores Trigger.
*/
public final class Main {
/*
* x-ms-original-file: 2026-07-01/AzureStorage/TriggerRestore_AzureFileShare_WithSAMI.json
*/
/**
* Sample code: Restore Azure File Share to Original Location with Managed Identity.
*
* @param manager Entry point to RecoveryServicesBackupManager.
*/
public static void restoreAzureFileShareToOriginalLocationWithManagedIdentity(
com.azure.resourcemanager.recoveryservicesbackup.RecoveryServicesBackupManager manager) {
manager.restores().trigger("swaggertestvault", "SwaggerTestRg", "Azure",
"StorageContainer;Storage;SwaggerTestRg;swaggertestsa", "AzureFileShare;testshare", "932886657837421071",
new RestoreRequestResource().withProperties(new AzureFileShareRestoreRequest()
.withRecoveryType(RecoveryType.ORIGINAL_LOCATION)
.withSourceResourceId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/SwaggerTestRg/providers/Microsoft.Storage/storageAccounts/swaggertestsa")
.withCopyOptions(CopyOptions.OVERWRITE).withRestoreRequestType(RestoreRequestType.FULL_SHARE_RESTORE)
.withIdentityInfo(new IdentityInfo().withIsSystemAssignedIdentity(true))),
com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.recoveryservicesbackup import RecoveryServicesBackupClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-recoveryservicesbackup
# USAGE
python trigger_restore_azure_file_share_with_sami.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="SUBSCRIPTION_ID",
)
client.restores.begin_trigger(
vault_name="swaggertestvault",
resource_group_name="SwaggerTestRg",
fabric_name="Azure",
container_name="StorageContainer;Storage;SwaggerTestRg;swaggertestsa",
protected_item_name="AzureFileShare;testshare",
recovery_point_id="932886657837421071",
parameters={
"properties": {
"copyOptions": "Overwrite",
"identityInfo": {"isSystemAssignedIdentity": True},
"objectType": "AzureFileShareRestoreRequest",
"recoveryType": "OriginalLocation",
"restoreRequestType": "FullShareRestore",
"sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/SwaggerTestRg/providers/Microsoft.Storage/storageAccounts/swaggertestsa",
}
},
).result()
# x-ms-original-file: 2026-07-01/AzureStorage/TriggerRestore_AzureFileShare_WithSAMI.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armrecoveryservicesbackup_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/recoveryservices/armrecoveryservicesbackup/v5"
)
// Generated from example definition: 2026-07-01/AzureStorage/TriggerRestore_AzureFileShare_WithSAMI.json
func ExampleRestoresClient_BeginTrigger_restoreAzureFileShareToOriginalLocationWithManagedIdentity() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrecoveryservicesbackup.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewRestoresClient().BeginTrigger(ctx, "swaggertestvault", "SwaggerTestRg", "Azure", "StorageContainer;Storage;SwaggerTestRg;swaggertestsa", "AzureFileShare;testshare", "932886657837421071", armrecoveryservicesbackup.RestoreRequestResource{
Properties: &armrecoveryservicesbackup.AzureFileShareRestoreRequest{
ObjectType: to.Ptr("AzureFileShareRestoreRequest"),
RecoveryType: to.Ptr(armrecoveryservicesbackup.RecoveryTypeOriginalLocation),
SourceResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/SwaggerTestRg/providers/Microsoft.Storage/storageAccounts/swaggertestsa"),
CopyOptions: to.Ptr(armrecoveryservicesbackup.CopyOptionsOverwrite),
RestoreRequestType: to.Ptr(armrecoveryservicesbackup.RestoreRequestTypeFullShareRestore),
IdentityInfo: &armrecoveryservicesbackup.IdentityInfo{
IsSystemAssignedIdentity: to.Ptr(true),
},
},
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
log.Fatalf("failed to poll the result: %v", err)
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { RecoveryServicesBackupClient } = require("@azure/arm-recoveryservicesbackup");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to restores the specified backed up data. This is an asynchronous operation. To know the status of this API call, use
* GetProtectedItemOperationResult API.
*
* @summary restores the specified backed up data. This is an asynchronous operation. To know the status of this API call, use
* GetProtectedItemOperationResult API.
* x-ms-original-file: 2026-07-01/AzureStorage/TriggerRestore_AzureFileShare_WithSAMI.json
*/
async function restoreAzureFileShareToOriginalLocationWithManagedIdentity() {
const credential = new DefaultAzureCredential();
const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new RecoveryServicesBackupClient(credential, subscriptionId);
await client.restores.trigger(
"swaggertestvault",
"SwaggerTestRg",
"Azure",
"StorageContainer;Storage;SwaggerTestRg;swaggertestsa",
"AzureFileShare;testshare",
"932886657837421071",
{
properties: {
objectType: "AzureFileShareRestoreRequest",
recoveryType: "OriginalLocation",
sourceResourceId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/SwaggerTestRg/providers/Microsoft.Storage/storageAccounts/swaggertestsa",
copyOptions: "Overwrite",
restoreRequestType: "FullShareRestore",
identityInfo: { isSystemAssignedIdentity: true },
},
},
);
}
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
Azure-AsyncOperation: https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/swaggertestvault/backupFabrics/Azure/protectionContainers/StorageContainer;Storage;SwaggerTestRg;swaggertestsa/protectedItems/AzureFileShare;testshare/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2026-07-01
Location: https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/swaggertestvault/backupFabrics/Azure/protectionContainers/StorageContainer;Storage;SwaggerTestRg;swaggertestsa/protectedItems/AzureFileShare;testshare/operationResults/00000000-0000-0000-0000-000000000000?api-version=2026-07-01
Retry-After: 60
Restore Azure File Share to Original Location with User Assigned Managed Identity
Sample request
POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/swaggertestvault/backupFabrics/Azure/protectionContainers/StorageContainer;Storage;SwaggerTestRg;swaggertestsa/protectedItems/AzureFileShare;testshare/recoveryPoints/932886657837421071/restore?api-version=2026-07-01
{
"properties": {
"objectType": "AzureFileShareRestoreRequest",
"recoveryType": "OriginalLocation",
"sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/SwaggerTestRg/providers/Microsoft.Storage/storageAccounts/swaggertestsa",
"copyOptions": "Overwrite",
"restoreRequestType": "FullShareRestore",
"identityInfo": {
"isSystemAssignedIdentity": false,
"managedIdentityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/SwaggerTestRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/swaggertestuami"
}
}
}
import com.azure.resourcemanager.recoveryservicesbackup.models.AzureFileShareRestoreRequest;
import com.azure.resourcemanager.recoveryservicesbackup.models.CopyOptions;
import com.azure.resourcemanager.recoveryservicesbackup.models.IdentityInfo;
import com.azure.resourcemanager.recoveryservicesbackup.models.RecoveryType;
import com.azure.resourcemanager.recoveryservicesbackup.models.RestoreRequestResource;
import com.azure.resourcemanager.recoveryservicesbackup.models.RestoreRequestType;
/**
* Samples for Restores Trigger.
*/
public final class Main {
/*
* x-ms-original-file: 2026-07-01/AzureStorage/TriggerRestore_AzureFileShare_WithUAMI.json
*/
/**
* Sample code: Restore Azure File Share to Original Location with User Assigned Managed Identity.
*
* @param manager Entry point to RecoveryServicesBackupManager.
*/
public static void restoreAzureFileShareToOriginalLocationWithUserAssignedManagedIdentity(
com.azure.resourcemanager.recoveryservicesbackup.RecoveryServicesBackupManager manager) {
manager.restores().trigger("swaggertestvault", "SwaggerTestRg", "Azure",
"StorageContainer;Storage;SwaggerTestRg;swaggertestsa", "AzureFileShare;testshare", "932886657837421071",
new RestoreRequestResource().withProperties(new AzureFileShareRestoreRequest()
.withRecoveryType(RecoveryType.ORIGINAL_LOCATION)
.withSourceResourceId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/SwaggerTestRg/providers/Microsoft.Storage/storageAccounts/swaggertestsa")
.withCopyOptions(CopyOptions.OVERWRITE).withRestoreRequestType(RestoreRequestType.FULL_SHARE_RESTORE)
.withIdentityInfo(new IdentityInfo().withIsSystemAssignedIdentity(false).withManagedIdentityResourceId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/SwaggerTestRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/swaggertestuami"))),
com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.recoveryservicesbackup import RecoveryServicesBackupClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-recoveryservicesbackup
# USAGE
python trigger_restore_azure_file_share_with_uami.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="SUBSCRIPTION_ID",
)
client.restores.begin_trigger(
vault_name="swaggertestvault",
resource_group_name="SwaggerTestRg",
fabric_name="Azure",
container_name="StorageContainer;Storage;SwaggerTestRg;swaggertestsa",
protected_item_name="AzureFileShare;testshare",
recovery_point_id="932886657837421071",
parameters={
"properties": {
"copyOptions": "Overwrite",
"identityInfo": {
"isSystemAssignedIdentity": False,
"managedIdentityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/SwaggerTestRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/swaggertestuami",
},
"objectType": "AzureFileShareRestoreRequest",
"recoveryType": "OriginalLocation",
"restoreRequestType": "FullShareRestore",
"sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/SwaggerTestRg/providers/Microsoft.Storage/storageAccounts/swaggertestsa",
}
},
).result()
# x-ms-original-file: 2026-07-01/AzureStorage/TriggerRestore_AzureFileShare_WithUAMI.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armrecoveryservicesbackup_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/recoveryservices/armrecoveryservicesbackup/v5"
)
// Generated from example definition: 2026-07-01/AzureStorage/TriggerRestore_AzureFileShare_WithUAMI.json
func ExampleRestoresClient_BeginTrigger_restoreAzureFileShareToOriginalLocationWithUserAssignedManagedIdentity() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrecoveryservicesbackup.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewRestoresClient().BeginTrigger(ctx, "swaggertestvault", "SwaggerTestRg", "Azure", "StorageContainer;Storage;SwaggerTestRg;swaggertestsa", "AzureFileShare;testshare", "932886657837421071", armrecoveryservicesbackup.RestoreRequestResource{
Properties: &armrecoveryservicesbackup.AzureFileShareRestoreRequest{
ObjectType: to.Ptr("AzureFileShareRestoreRequest"),
RecoveryType: to.Ptr(armrecoveryservicesbackup.RecoveryTypeOriginalLocation),
SourceResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/SwaggerTestRg/providers/Microsoft.Storage/storageAccounts/swaggertestsa"),
CopyOptions: to.Ptr(armrecoveryservicesbackup.CopyOptionsOverwrite),
RestoreRequestType: to.Ptr(armrecoveryservicesbackup.RestoreRequestTypeFullShareRestore),
IdentityInfo: &armrecoveryservicesbackup.IdentityInfo{
IsSystemAssignedIdentity: to.Ptr(false),
ManagedIdentityResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/SwaggerTestRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/swaggertestuami"),
},
},
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
log.Fatalf("failed to poll the result: %v", err)
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { RecoveryServicesBackupClient } = require("@azure/arm-recoveryservicesbackup");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to restores the specified backed up data. This is an asynchronous operation. To know the status of this API call, use
* GetProtectedItemOperationResult API.
*
* @summary restores the specified backed up data. This is an asynchronous operation. To know the status of this API call, use
* GetProtectedItemOperationResult API.
* x-ms-original-file: 2026-07-01/AzureStorage/TriggerRestore_AzureFileShare_WithUAMI.json
*/
async function restoreAzureFileShareToOriginalLocationWithUserAssignedManagedIdentity() {
const credential = new DefaultAzureCredential();
const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new RecoveryServicesBackupClient(credential, subscriptionId);
await client.restores.trigger(
"swaggertestvault",
"SwaggerTestRg",
"Azure",
"StorageContainer;Storage;SwaggerTestRg;swaggertestsa",
"AzureFileShare;testshare",
"932886657837421071",
{
properties: {
objectType: "AzureFileShareRestoreRequest",
recoveryType: "OriginalLocation",
sourceResourceId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/SwaggerTestRg/providers/Microsoft.Storage/storageAccounts/swaggertestsa",
copyOptions: "Overwrite",
restoreRequestType: "FullShareRestore",
identityInfo: {
isSystemAssignedIdentity: false,
managedIdentityResourceId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/SwaggerTestRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/swaggertestuami",
},
},
},
);
}
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
Azure-AsyncOperation: https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/swaggertestvault/backupFabrics/Azure/protectionContainers/StorageContainer;Storage;SwaggerTestRg;swaggertestsa/protectedItems/AzureFileShare;testshare/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2026-07-01
Location: https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/swaggertestvault/backupFabrics/Azure/protectionContainers/StorageContainer;Storage;SwaggerTestRg;swaggertestsa/protectedItems/AzureFileShare;testshare/operationResults/00000000-0000-0000-0000-000000000000?api-version=2026-07-01
Retry-After: 60
Restore Disks with IaasVMRestoreRequest
Sample request
POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/recoveryPoints/348916168024334/restore?api-version=2026-07-01
{
"properties": {
"createNewCloudService": true,
"encryptionDetails": {
"encryptionEnabled": false
},
"identityInfo": {
"isSystemAssignedIdentity": false,
"managedIdentityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/asmaskarRG1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/asmaskartestmsi"
},
"objectType": "IaasVMRestoreRequest",
"originalStorageAccountOption": false,
"recoveryPointId": "348916168024334",
"recoveryType": "RestoreDisks",
"region": "southeastasia",
"sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1",
"storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testingRg/providers/Microsoft.Storage/storageAccounts/testAccount",
"targetDiskNetworkAccessSettings": {
"targetDiskAccessId": "/subscriptions/e7a191f5-713c-4bdb-b5e4-cf3dd90230ef/resourceGroups/arpja/providers/Microsoft.Compute/diskAccesses/arpja-diskaccess-ccy",
"targetDiskNetworkAccessOption": "EnablePrivateAccessForAllDisks"
}
}
}
import com.azure.resourcemanager.recoveryservicesbackup.models.EncryptionDetails;
import com.azure.resourcemanager.recoveryservicesbackup.models.IaasVMRestoreRequest;
import com.azure.resourcemanager.recoveryservicesbackup.models.IdentityInfo;
import com.azure.resourcemanager.recoveryservicesbackup.models.RecoveryType;
import com.azure.resourcemanager.recoveryservicesbackup.models.RestoreRequestResource;
import com.azure.resourcemanager.recoveryservicesbackup.models.TargetDiskNetworkAccessOption;
import com.azure.resourcemanager.recoveryservicesbackup.models.TargetDiskNetworkAccessSettings;
/**
* Samples for Restores Trigger.
*/
public final class Main {
/*
* x-ms-original-file: 2026-07-01/AzureIaasVm/TriggerRestore_RestoreDisks_IaasVMRestoreRequest.json
*/
/**
* Sample code: Restore Disks with IaasVMRestoreRequest.
*
* @param manager Entry point to RecoveryServicesBackupManager.
*/
public static void restoreDisksWithIaasVMRestoreRequest(
com.azure.resourcemanager.recoveryservicesbackup.RecoveryServicesBackupManager manager) {
manager.restores().trigger("testVault", "netsdktestrg", "Azure",
"IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
"VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", "348916168024334",
new RestoreRequestResource().withProperties(new IaasVMRestoreRequest()
.withRecoveryPointId("348916168024334").withRecoveryType(RecoveryType.RESTORE_DISKS)
.withSourceResourceId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1")
.withStorageAccountId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testingRg/providers/Microsoft.Storage/storageAccounts/testAccount")
.withRegion("southeastasia").withCreateNewCloudService(true).withOriginalStorageAccountOption(false)
.withEncryptionDetails(new EncryptionDetails().withEncryptionEnabled(false))
.withIdentityInfo(new IdentityInfo().withIsSystemAssignedIdentity(false).withManagedIdentityResourceId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/asmaskarRG1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/asmaskartestmsi"))
.withTargetDiskNetworkAccessSettings(new TargetDiskNetworkAccessSettings()
.withTargetDiskNetworkAccessOption(
TargetDiskNetworkAccessOption.ENABLE_PRIVATE_ACCESS_FOR_ALL_DISKS)
.withTargetDiskAccessId(
"/subscriptions/e7a191f5-713c-4bdb-b5e4-cf3dd90230ef/resourceGroups/arpja/providers/Microsoft.Compute/diskAccesses/arpja-diskaccess-ccy"))),
com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.recoveryservicesbackup import RecoveryServicesBackupClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-recoveryservicesbackup
# USAGE
python trigger_restore_restore_disks_iaas_vm_restore_request.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="SUBSCRIPTION_ID",
)
client.restores.begin_trigger(
vault_name="testVault",
resource_group_name="netsdktestrg",
fabric_name="Azure",
container_name="IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
protected_item_name="VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
recovery_point_id="348916168024334",
parameters={
"properties": {
"createNewCloudService": True,
"encryptionDetails": {"encryptionEnabled": False},
"identityInfo": {
"isSystemAssignedIdentity": False,
"managedIdentityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/asmaskarRG1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/asmaskartestmsi",
},
"objectType": "IaasVMRestoreRequest",
"originalStorageAccountOption": False,
"recoveryPointId": "348916168024334",
"recoveryType": "RestoreDisks",
"region": "southeastasia",
"sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1",
"storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testingRg/providers/Microsoft.Storage/storageAccounts/testAccount",
"targetDiskNetworkAccessSettings": {
"targetDiskAccessId": "/subscriptions/e7a191f5-713c-4bdb-b5e4-cf3dd90230ef/resourceGroups/arpja/providers/Microsoft.Compute/diskAccesses/arpja-diskaccess-ccy",
"targetDiskNetworkAccessOption": "EnablePrivateAccessForAllDisks",
},
}
},
).result()
# x-ms-original-file: 2026-07-01/AzureIaasVm/TriggerRestore_RestoreDisks_IaasVMRestoreRequest.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armrecoveryservicesbackup_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/recoveryservices/armrecoveryservicesbackup/v5"
)
// Generated from example definition: 2026-07-01/AzureIaasVm/TriggerRestore_RestoreDisks_IaasVMRestoreRequest.json
func ExampleRestoresClient_BeginTrigger_restoreDisksWithIaasVMRestoreRequest() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrecoveryservicesbackup.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewRestoresClient().BeginTrigger(ctx, "testVault", "netsdktestrg", "Azure", "IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", "348916168024334", armrecoveryservicesbackup.RestoreRequestResource{
Properties: &armrecoveryservicesbackup.IaasVMRestoreRequest{
CreateNewCloudService: to.Ptr(true),
EncryptionDetails: &armrecoveryservicesbackup.EncryptionDetails{
EncryptionEnabled: to.Ptr(false),
},
IdentityInfo: &armrecoveryservicesbackup.IdentityInfo{
IsSystemAssignedIdentity: to.Ptr(false),
ManagedIdentityResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/asmaskarRG1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/asmaskartestmsi"),
},
ObjectType: to.Ptr("IaasVMRestoreRequest"),
OriginalStorageAccountOption: to.Ptr(false),
RecoveryPointID: to.Ptr("348916168024334"),
RecoveryType: to.Ptr(armrecoveryservicesbackup.RecoveryTypeRestoreDisks),
Region: to.Ptr("southeastasia"),
SourceResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1"),
StorageAccountID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testingRg/providers/Microsoft.Storage/storageAccounts/testAccount"),
TargetDiskNetworkAccessSettings: &armrecoveryservicesbackup.TargetDiskNetworkAccessSettings{
TargetDiskAccessID: to.Ptr("/subscriptions/e7a191f5-713c-4bdb-b5e4-cf3dd90230ef/resourceGroups/arpja/providers/Microsoft.Compute/diskAccesses/arpja-diskaccess-ccy"),
TargetDiskNetworkAccessOption: to.Ptr(armrecoveryservicesbackup.TargetDiskNetworkAccessOptionEnablePrivateAccessForAllDisks),
},
},
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
log.Fatalf("failed to poll the result: %v", err)
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { RecoveryServicesBackupClient } = require("@azure/arm-recoveryservicesbackup");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to restores the specified backed up data. This is an asynchronous operation. To know the status of this API call, use
* GetProtectedItemOperationResult API.
*
* @summary restores the specified backed up data. This is an asynchronous operation. To know the status of this API call, use
* GetProtectedItemOperationResult API.
* x-ms-original-file: 2026-07-01/AzureIaasVm/TriggerRestore_RestoreDisks_IaasVMRestoreRequest.json
*/
async function restoreDisksWithIaasVMRestoreRequest() {
const credential = new DefaultAzureCredential();
const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new RecoveryServicesBackupClient(credential, subscriptionId);
await client.restores.trigger(
"testVault",
"netsdktestrg",
"Azure",
"IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
"VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
"348916168024334",
{
properties: {
createNewCloudService: true,
encryptionDetails: { encryptionEnabled: false },
identityInfo: {
isSystemAssignedIdentity: false,
managedIdentityResourceId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/asmaskarRG1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/asmaskartestmsi",
},
objectType: "IaasVMRestoreRequest",
originalStorageAccountOption: false,
recoveryPointId: "348916168024334",
recoveryType: "RestoreDisks",
region: "southeastasia",
sourceResourceId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1",
storageAccountId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testingRg/providers/Microsoft.Storage/storageAccounts/testAccount",
targetDiskNetworkAccessSettings: {
targetDiskAccessId:
"/subscriptions/e7a191f5-713c-4bdb-b5e4-cf3dd90230ef/resourceGroups/arpja/providers/Microsoft.Compute/diskAccesses/arpja-diskaccess-ccy",
targetDiskNetworkAccessOption: "EnablePrivateAccessForAllDisks",
},
},
},
);
}
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
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2020-09-01
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2020-09-01
Retry-After: 60
Restore Disks with IaasVMRestoreRequest with IdentityBasedRestoreDetails
Sample request
POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/recoveryPoints/348916168024334/restore?api-version=2026-07-01
{
"properties": {
"createNewCloudService": true,
"encryptionDetails": {
"encryptionEnabled": false
},
"identityBasedRestoreDetails": {
"targetStorageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testingRg/providers/Microsoft.Storage/storageAccounts/testAccount"
},
"identityInfo": {
"isSystemAssignedIdentity": false,
"managedIdentityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/asmaskarRG1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/asmaskartestmsi"
},
"objectType": "IaasVMRestoreRequest",
"originalStorageAccountOption": false,
"recoveryPointId": "348916168024334",
"recoveryType": "RestoreDisks",
"region": "southeastasia",
"sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1"
}
}
import com.azure.resourcemanager.recoveryservicesbackup.models.EncryptionDetails;
import com.azure.resourcemanager.recoveryservicesbackup.models.IaasVMRestoreRequest;
import com.azure.resourcemanager.recoveryservicesbackup.models.IdentityBasedRestoreDetails;
import com.azure.resourcemanager.recoveryservicesbackup.models.IdentityInfo;
import com.azure.resourcemanager.recoveryservicesbackup.models.RecoveryType;
import com.azure.resourcemanager.recoveryservicesbackup.models.RestoreRequestResource;
/**
* Samples for Restores Trigger.
*/
public final class Main {
/*
* x-ms-original-file:
* 2026-07-01/AzureIaasVm/TriggerRestore_RestoreDisks_IaasVMRestoreRequest_IdentityBasedRestoreDetails.json
*/
/**
* Sample code: Restore Disks with IaasVMRestoreRequest with IdentityBasedRestoreDetails.
*
* @param manager Entry point to RecoveryServicesBackupManager.
*/
public static void restoreDisksWithIaasVMRestoreRequestWithIdentityBasedRestoreDetails(
com.azure.resourcemanager.recoveryservicesbackup.RecoveryServicesBackupManager manager) {
manager.restores().trigger("testVault", "netsdktestrg", "Azure",
"IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
"VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", "348916168024334",
new RestoreRequestResource().withProperties(new IaasVMRestoreRequest()
.withRecoveryPointId("348916168024334").withRecoveryType(RecoveryType.RESTORE_DISKS)
.withSourceResourceId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1")
.withRegion("southeastasia").withCreateNewCloudService(true).withOriginalStorageAccountOption(false)
.withEncryptionDetails(new EncryptionDetails().withEncryptionEnabled(false))
.withIdentityInfo(new IdentityInfo().withIsSystemAssignedIdentity(false).withManagedIdentityResourceId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/asmaskarRG1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/asmaskartestmsi"))
.withIdentityBasedRestoreDetails(new IdentityBasedRestoreDetails().withTargetStorageAccountId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testingRg/providers/Microsoft.Storage/storageAccounts/testAccount"))),
com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.recoveryservicesbackup import RecoveryServicesBackupClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-recoveryservicesbackup
# USAGE
python trigger_restore_restore_disks_iaas_vm_restore_request_identity_based_restore_details.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="SUBSCRIPTION_ID",
)
client.restores.begin_trigger(
vault_name="testVault",
resource_group_name="netsdktestrg",
fabric_name="Azure",
container_name="IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
protected_item_name="VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
recovery_point_id="348916168024334",
parameters={
"properties": {
"createNewCloudService": True,
"encryptionDetails": {"encryptionEnabled": False},
"identityBasedRestoreDetails": {
"targetStorageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testingRg/providers/Microsoft.Storage/storageAccounts/testAccount"
},
"identityInfo": {
"isSystemAssignedIdentity": False,
"managedIdentityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/asmaskarRG1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/asmaskartestmsi",
},
"objectType": "IaasVMRestoreRequest",
"originalStorageAccountOption": False,
"recoveryPointId": "348916168024334",
"recoveryType": "RestoreDisks",
"region": "southeastasia",
"sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1",
}
},
).result()
# x-ms-original-file: 2026-07-01/AzureIaasVm/TriggerRestore_RestoreDisks_IaasVMRestoreRequest_IdentityBasedRestoreDetails.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armrecoveryservicesbackup_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/recoveryservices/armrecoveryservicesbackup/v5"
)
// Generated from example definition: 2026-07-01/AzureIaasVm/TriggerRestore_RestoreDisks_IaasVMRestoreRequest_IdentityBasedRestoreDetails.json
func ExampleRestoresClient_BeginTrigger_restoreDisksWithIaasVMRestoreRequestWithIdentityBasedRestoreDetails() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrecoveryservicesbackup.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewRestoresClient().BeginTrigger(ctx, "testVault", "netsdktestrg", "Azure", "IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", "348916168024334", armrecoveryservicesbackup.RestoreRequestResource{
Properties: &armrecoveryservicesbackup.IaasVMRestoreRequest{
CreateNewCloudService: to.Ptr(true),
EncryptionDetails: &armrecoveryservicesbackup.EncryptionDetails{
EncryptionEnabled: to.Ptr(false),
},
IdentityBasedRestoreDetails: &armrecoveryservicesbackup.IdentityBasedRestoreDetails{
TargetStorageAccountID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testingRg/providers/Microsoft.Storage/storageAccounts/testAccount"),
},
IdentityInfo: &armrecoveryservicesbackup.IdentityInfo{
IsSystemAssignedIdentity: to.Ptr(false),
ManagedIdentityResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/asmaskarRG1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/asmaskartestmsi"),
},
ObjectType: to.Ptr("IaasVMRestoreRequest"),
OriginalStorageAccountOption: to.Ptr(false),
RecoveryPointID: to.Ptr("348916168024334"),
RecoveryType: to.Ptr(armrecoveryservicesbackup.RecoveryTypeRestoreDisks),
Region: to.Ptr("southeastasia"),
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)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
log.Fatalf("failed to poll the result: %v", err)
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { RecoveryServicesBackupClient } = require("@azure/arm-recoveryservicesbackup");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to restores the specified backed up data. This is an asynchronous operation. To know the status of this API call, use
* GetProtectedItemOperationResult API.
*
* @summary restores the specified backed up data. This is an asynchronous operation. To know the status of this API call, use
* GetProtectedItemOperationResult API.
* x-ms-original-file: 2026-07-01/AzureIaasVm/TriggerRestore_RestoreDisks_IaasVMRestoreRequest_IdentityBasedRestoreDetails.json
*/
async function restoreDisksWithIaasVMRestoreRequestWithIdentityBasedRestoreDetails() {
const credential = new DefaultAzureCredential();
const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new RecoveryServicesBackupClient(credential, subscriptionId);
await client.restores.trigger(
"testVault",
"netsdktestrg",
"Azure",
"IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
"VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
"348916168024334",
{
properties: {
createNewCloudService: true,
encryptionDetails: { encryptionEnabled: false },
identityBasedRestoreDetails: {
targetStorageAccountId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testingRg/providers/Microsoft.Storage/storageAccounts/testAccount",
},
identityInfo: {
isSystemAssignedIdentity: false,
managedIdentityResourceId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/asmaskarRG1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/asmaskartestmsi",
},
objectType: "IaasVMRestoreRequest",
originalStorageAccountOption: false,
recoveryPointId: "348916168024334",
recoveryType: "RestoreDisks",
region: "southeastasia",
sourceResourceId:
"/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
Sample response
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2020-09-01
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2020-09-01
Retry-After: 60
Restore Disks with IaasVMRestoreWithRehydrationRequest
Sample request
POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/recoveryPoints/348916168024334/restore?api-version=2026-07-01
{
"properties": {
"createNewCloudService": true,
"encryptionDetails": {
"encryptionEnabled": false
},
"objectType": "IaasVMRestoreWithRehydrationRequest",
"originalStorageAccountOption": false,
"recoveryPointId": "348916168024334",
"recoveryPointRehydrationInfo": {
"rehydrationPriority": "Standard",
"rehydrationRetentionDuration": "P7D"
},
"recoveryType": "RestoreDisks",
"region": "southeastasia",
"sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1",
"storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testingRg/providers/Microsoft.Storage/storageAccounts/testAccount"
}
}
import com.azure.resourcemanager.recoveryservicesbackup.models.EncryptionDetails;
import com.azure.resourcemanager.recoveryservicesbackup.models.IaasVMRestoreWithRehydrationRequest;
import com.azure.resourcemanager.recoveryservicesbackup.models.RecoveryPointRehydrationInfo;
import com.azure.resourcemanager.recoveryservicesbackup.models.RecoveryType;
import com.azure.resourcemanager.recoveryservicesbackup.models.RehydrationPriority;
import com.azure.resourcemanager.recoveryservicesbackup.models.RestoreRequestResource;
/**
* Samples for Restores Trigger.
*/
public final class Main {
/*
* x-ms-original-file: 2026-07-01/AzureIaasVm/TriggerRestore_RestoreDisks_IaasVMRestoreWithRehydrationRequest.json
*/
/**
* Sample code: Restore Disks with IaasVMRestoreWithRehydrationRequest.
*
* @param manager Entry point to RecoveryServicesBackupManager.
*/
public static void restoreDisksWithIaasVMRestoreWithRehydrationRequest(
com.azure.resourcemanager.recoveryservicesbackup.RecoveryServicesBackupManager manager) {
manager.restores().trigger("testVault", "netsdktestrg", "Azure",
"IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
"VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", "348916168024334",
new RestoreRequestResource().withProperties(new IaasVMRestoreWithRehydrationRequest()
.withRecoveryPointId("348916168024334").withRecoveryType(RecoveryType.RESTORE_DISKS)
.withSourceResourceId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1")
.withStorageAccountId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testingRg/providers/Microsoft.Storage/storageAccounts/testAccount")
.withRegion("southeastasia").withCreateNewCloudService(true).withOriginalStorageAccountOption(false)
.withEncryptionDetails(new EncryptionDetails().withEncryptionEnabled(false))
.withRecoveryPointRehydrationInfo(new RecoveryPointRehydrationInfo()
.withRehydrationRetentionDuration("P7D").withRehydrationPriority(RehydrationPriority.STANDARD))),
com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.recoveryservicesbackup import RecoveryServicesBackupClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-recoveryservicesbackup
# USAGE
python trigger_restore_restore_disks_iaas_vm_restore_with_rehydration_request.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="SUBSCRIPTION_ID",
)
client.restores.begin_trigger(
vault_name="testVault",
resource_group_name="netsdktestrg",
fabric_name="Azure",
container_name="IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
protected_item_name="VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
recovery_point_id="348916168024334",
parameters={
"properties": {
"createNewCloudService": True,
"encryptionDetails": {"encryptionEnabled": False},
"objectType": "IaasVMRestoreWithRehydrationRequest",
"originalStorageAccountOption": False,
"recoveryPointId": "348916168024334",
"recoveryPointRehydrationInfo": {
"rehydrationPriority": "Standard",
"rehydrationRetentionDuration": "P7D",
},
"recoveryType": "RestoreDisks",
"region": "southeastasia",
"sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1",
"storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testingRg/providers/Microsoft.Storage/storageAccounts/testAccount",
}
},
).result()
# x-ms-original-file: 2026-07-01/AzureIaasVm/TriggerRestore_RestoreDisks_IaasVMRestoreWithRehydrationRequest.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armrecoveryservicesbackup_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/recoveryservices/armrecoveryservicesbackup/v5"
)
// Generated from example definition: 2026-07-01/AzureIaasVm/TriggerRestore_RestoreDisks_IaasVMRestoreWithRehydrationRequest.json
func ExampleRestoresClient_BeginTrigger_restoreDisksWithIaasVMRestoreWithRehydrationRequest() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrecoveryservicesbackup.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewRestoresClient().BeginTrigger(ctx, "testVault", "netsdktestrg", "Azure", "IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", "348916168024334", armrecoveryservicesbackup.RestoreRequestResource{
Properties: &armrecoveryservicesbackup.IaasVMRestoreWithRehydrationRequest{
CreateNewCloudService: to.Ptr(true),
EncryptionDetails: &armrecoveryservicesbackup.EncryptionDetails{
EncryptionEnabled: to.Ptr(false),
},
ObjectType: to.Ptr("IaasVMRestoreWithRehydrationRequest"),
OriginalStorageAccountOption: to.Ptr(false),
RecoveryPointID: to.Ptr("348916168024334"),
RecoveryPointRehydrationInfo: &armrecoveryservicesbackup.RecoveryPointRehydrationInfo{
RehydrationPriority: to.Ptr(armrecoveryservicesbackup.RehydrationPriorityStandard),
RehydrationRetentionDuration: to.Ptr("P7D"),
},
RecoveryType: to.Ptr(armrecoveryservicesbackup.RecoveryTypeRestoreDisks),
Region: to.Ptr("southeastasia"),
SourceResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1"),
StorageAccountID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testingRg/providers/Microsoft.Storage/storageAccounts/testAccount"),
},
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
log.Fatalf("failed to poll the result: %v", err)
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { RecoveryServicesBackupClient } = require("@azure/arm-recoveryservicesbackup");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to restores the specified backed up data. This is an asynchronous operation. To know the status of this API call, use
* GetProtectedItemOperationResult API.
*
* @summary restores the specified backed up data. This is an asynchronous operation. To know the status of this API call, use
* GetProtectedItemOperationResult API.
* x-ms-original-file: 2026-07-01/AzureIaasVm/TriggerRestore_RestoreDisks_IaasVMRestoreWithRehydrationRequest.json
*/
async function restoreDisksWithIaasVMRestoreWithRehydrationRequest() {
const credential = new DefaultAzureCredential();
const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new RecoveryServicesBackupClient(credential, subscriptionId);
await client.restores.trigger(
"testVault",
"netsdktestrg",
"Azure",
"IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
"VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
"348916168024334",
{
properties: {
createNewCloudService: true,
encryptionDetails: { encryptionEnabled: false },
objectType: "IaasVMRestoreWithRehydrationRequest",
originalStorageAccountOption: false,
recoveryPointId: "348916168024334",
recoveryPointRehydrationInfo: {
rehydrationPriority: "Standard",
rehydrationRetentionDuration: "P7D",
},
recoveryType: "RestoreDisks",
region: "southeastasia",
sourceResourceId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1",
storageAccountId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testingRg/providers/Microsoft.Storage/storageAccounts/testAccount",
},
},
);
}
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
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2020-09-01
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2020-09-01
Retry-After: 60
Restore to New Azure IaasVm with IaasVMRestoreRequest
Sample request
POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/recoveryPoints/348916168024334/restore?api-version=2026-07-01
{
"properties": {
"createNewCloudService": false,
"encryptionDetails": {
"encryptionEnabled": false
},
"identityInfo": {
"isSystemAssignedIdentity": true
},
"objectType": "IaasVMRestoreRequest",
"originalStorageAccountOption": false,
"recoveryPointId": "348916168024334",
"recoveryType": "AlternateLocation",
"region": "southeastasia",
"sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1",
"storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Storage/storageAccounts/testingAccount",
"subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet/subnets/default",
"targetResourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2",
"targetVirtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2/providers/Microsoft.Compute/virtualmachines/RSMDALRVM981435",
"virtualNetworkId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet"
}
}
import com.azure.resourcemanager.recoveryservicesbackup.models.EncryptionDetails;
import com.azure.resourcemanager.recoveryservicesbackup.models.IaasVMRestoreRequest;
import com.azure.resourcemanager.recoveryservicesbackup.models.IdentityInfo;
import com.azure.resourcemanager.recoveryservicesbackup.models.RecoveryType;
import com.azure.resourcemanager.recoveryservicesbackup.models.RestoreRequestResource;
/**
* Samples for Restores Trigger.
*/
public final class Main {
/*
* x-ms-original-file: 2026-07-01/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreRequest.json
*/
/**
* Sample code: Restore to New Azure IaasVm with IaasVMRestoreRequest.
*
* @param manager Entry point to RecoveryServicesBackupManager.
*/
public static void restoreToNewAzureIaasVmWithIaasVMRestoreRequest(
com.azure.resourcemanager.recoveryservicesbackup.RecoveryServicesBackupManager manager) {
manager.restores().trigger("testVault", "netsdktestrg", "Azure",
"IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
"VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", "348916168024334",
new RestoreRequestResource().withProperties(new IaasVMRestoreRequest()
.withRecoveryPointId("348916168024334").withRecoveryType(RecoveryType.ALTERNATE_LOCATION)
.withSourceResourceId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1")
.withTargetVirtualMachineId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2/providers/Microsoft.Compute/virtualmachines/RSMDALRVM981435")
.withTargetResourceGroupId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2")
.withStorageAccountId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Storage/storageAccounts/testingAccount")
.withVirtualNetworkId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet")
.withSubnetId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet/subnets/default")
.withRegion("southeastasia").withCreateNewCloudService(false).withOriginalStorageAccountOption(false)
.withEncryptionDetails(new EncryptionDetails().withEncryptionEnabled(false))
.withIdentityInfo(new IdentityInfo().withIsSystemAssignedIdentity(true))),
com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.recoveryservicesbackup import RecoveryServicesBackupClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-recoveryservicesbackup
# USAGE
python trigger_restore_alr_iaas_vm_restore_request.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="SUBSCRIPTION_ID",
)
client.restores.begin_trigger(
vault_name="testVault",
resource_group_name="netsdktestrg",
fabric_name="Azure",
container_name="IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
protected_item_name="VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
recovery_point_id="348916168024334",
parameters={
"properties": {
"createNewCloudService": False,
"encryptionDetails": {"encryptionEnabled": False},
"identityInfo": {"isSystemAssignedIdentity": True},
"objectType": "IaasVMRestoreRequest",
"originalStorageAccountOption": False,
"recoveryPointId": "348916168024334",
"recoveryType": "AlternateLocation",
"region": "southeastasia",
"sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1",
"storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Storage/storageAccounts/testingAccount",
"subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet/subnets/default",
"targetResourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2",
"targetVirtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2/providers/Microsoft.Compute/virtualmachines/RSMDALRVM981435",
"virtualNetworkId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet",
}
},
).result()
# x-ms-original-file: 2026-07-01/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreRequest.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armrecoveryservicesbackup_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/recoveryservices/armrecoveryservicesbackup/v5"
)
// Generated from example definition: 2026-07-01/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreRequest.json
func ExampleRestoresClient_BeginTrigger_restoreToNewAzureIaasVMWithIaasVMRestoreRequest() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrecoveryservicesbackup.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewRestoresClient().BeginTrigger(ctx, "testVault", "netsdktestrg", "Azure", "IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", "348916168024334", armrecoveryservicesbackup.RestoreRequestResource{
Properties: &armrecoveryservicesbackup.IaasVMRestoreRequest{
CreateNewCloudService: to.Ptr(false),
EncryptionDetails: &armrecoveryservicesbackup.EncryptionDetails{
EncryptionEnabled: to.Ptr(false),
},
IdentityInfo: &armrecoveryservicesbackup.IdentityInfo{
IsSystemAssignedIdentity: to.Ptr(true),
},
ObjectType: to.Ptr("IaasVMRestoreRequest"),
OriginalStorageAccountOption: to.Ptr(false),
RecoveryPointID: to.Ptr("348916168024334"),
RecoveryType: to.Ptr(armrecoveryservicesbackup.RecoveryTypeAlternateLocation),
Region: to.Ptr("southeastasia"),
SourceResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1"),
StorageAccountID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Storage/storageAccounts/testingAccount"),
SubnetID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet/subnets/default"),
TargetResourceGroupID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2"),
TargetVirtualMachineID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2/providers/Microsoft.Compute/virtualmachines/RSMDALRVM981435"),
VirtualNetworkID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet"),
},
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
log.Fatalf("failed to poll the result: %v", err)
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { RecoveryServicesBackupClient } = require("@azure/arm-recoveryservicesbackup");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to restores the specified backed up data. This is an asynchronous operation. To know the status of this API call, use
* GetProtectedItemOperationResult API.
*
* @summary restores the specified backed up data. This is an asynchronous operation. To know the status of this API call, use
* GetProtectedItemOperationResult API.
* x-ms-original-file: 2026-07-01/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreRequest.json
*/
async function restoreToNewAzureIaasVmWithIaasVMRestoreRequest() {
const credential = new DefaultAzureCredential();
const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new RecoveryServicesBackupClient(credential, subscriptionId);
await client.restores.trigger(
"testVault",
"netsdktestrg",
"Azure",
"IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
"VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
"348916168024334",
{
properties: {
createNewCloudService: false,
encryptionDetails: { encryptionEnabled: false },
identityInfo: { isSystemAssignedIdentity: true },
objectType: "IaasVMRestoreRequest",
originalStorageAccountOption: false,
recoveryPointId: "348916168024334",
recoveryType: "AlternateLocation",
region: "southeastasia",
sourceResourceId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1",
storageAccountId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Storage/storageAccounts/testingAccount",
subnetId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet/subnets/default",
targetResourceGroupId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2",
targetVirtualMachineId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2/providers/Microsoft.Compute/virtualmachines/RSMDALRVM981435",
virtualNetworkId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet",
},
},
);
}
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
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2017-07-01
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2017-07-01
Retry-After: 60
Restore to New Azure IaasVm with IaasVMRestoreRequest with identityBasedRestoreDetails
Sample request
POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/recoveryPoints/348916168024334/restore?api-version=2026-07-01
{
"properties": {
"createNewCloudService": false,
"encryptionDetails": {
"encryptionEnabled": false
},
"identityBasedRestoreDetails": {
"targetStorageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Storage/storageAccounts/testingAccount"
},
"identityInfo": {
"isSystemAssignedIdentity": true
},
"objectType": "IaasVMRestoreRequest",
"originalStorageAccountOption": false,
"recoveryPointId": "348916168024334",
"recoveryType": "AlternateLocation",
"region": "southeastasia",
"sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1",
"subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet/subnets/default",
"targetResourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2",
"targetVirtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2/providers/Microsoft.Compute/virtualmachines/RSMDALRVM981435",
"virtualNetworkId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet"
}
}
import com.azure.resourcemanager.recoveryservicesbackup.models.EncryptionDetails;
import com.azure.resourcemanager.recoveryservicesbackup.models.IaasVMRestoreRequest;
import com.azure.resourcemanager.recoveryservicesbackup.models.IdentityBasedRestoreDetails;
import com.azure.resourcemanager.recoveryservicesbackup.models.IdentityInfo;
import com.azure.resourcemanager.recoveryservicesbackup.models.RecoveryType;
import com.azure.resourcemanager.recoveryservicesbackup.models.RestoreRequestResource;
/**
* Samples for Restores Trigger.
*/
public final class Main {
/*
* x-ms-original-file:
* 2026-07-01/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreRequest_IdentityBasedRestoreDetails.json
*/
/**
* Sample code: Restore to New Azure IaasVm with IaasVMRestoreRequest with identityBasedRestoreDetails.
*
* @param manager Entry point to RecoveryServicesBackupManager.
*/
public static void restoreToNewAzureIaasVmWithIaasVMRestoreRequestWithIdentityBasedRestoreDetails(
com.azure.resourcemanager.recoveryservicesbackup.RecoveryServicesBackupManager manager) {
manager.restores().trigger("testVault", "netsdktestrg", "Azure",
"IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
"VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", "348916168024334",
new RestoreRequestResource().withProperties(new IaasVMRestoreRequest()
.withRecoveryPointId("348916168024334").withRecoveryType(RecoveryType.ALTERNATE_LOCATION)
.withSourceResourceId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1")
.withTargetVirtualMachineId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2/providers/Microsoft.Compute/virtualmachines/RSMDALRVM981435")
.withTargetResourceGroupId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2")
.withVirtualNetworkId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet")
.withSubnetId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet/subnets/default")
.withRegion("southeastasia").withCreateNewCloudService(false).withOriginalStorageAccountOption(false)
.withEncryptionDetails(new EncryptionDetails().withEncryptionEnabled(false))
.withIdentityInfo(new IdentityInfo().withIsSystemAssignedIdentity(true))
.withIdentityBasedRestoreDetails(new IdentityBasedRestoreDetails().withTargetStorageAccountId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Storage/storageAccounts/testingAccount"))),
com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.recoveryservicesbackup import RecoveryServicesBackupClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-recoveryservicesbackup
# USAGE
python trigger_restore_alr_iaas_vm_restore_request_identity_based_restore_details.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="SUBSCRIPTION_ID",
)
client.restores.begin_trigger(
vault_name="testVault",
resource_group_name="netsdktestrg",
fabric_name="Azure",
container_name="IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
protected_item_name="VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
recovery_point_id="348916168024334",
parameters={
"properties": {
"createNewCloudService": False,
"encryptionDetails": {"encryptionEnabled": False},
"identityBasedRestoreDetails": {
"targetStorageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Storage/storageAccounts/testingAccount"
},
"identityInfo": {"isSystemAssignedIdentity": True},
"objectType": "IaasVMRestoreRequest",
"originalStorageAccountOption": False,
"recoveryPointId": "348916168024334",
"recoveryType": "AlternateLocation",
"region": "southeastasia",
"sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1",
"subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet/subnets/default",
"targetResourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2",
"targetVirtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2/providers/Microsoft.Compute/virtualmachines/RSMDALRVM981435",
"virtualNetworkId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet",
}
},
).result()
# x-ms-original-file: 2026-07-01/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreRequest_IdentityBasedRestoreDetails.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armrecoveryservicesbackup_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/recoveryservices/armrecoveryservicesbackup/v5"
)
// Generated from example definition: 2026-07-01/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreRequest_IdentityBasedRestoreDetails.json
func ExampleRestoresClient_BeginTrigger_restoreToNewAzureIaasVMWithIaasVMRestoreRequestWithIdentityBasedRestoreDetails() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrecoveryservicesbackup.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewRestoresClient().BeginTrigger(ctx, "testVault", "netsdktestrg", "Azure", "IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", "348916168024334", armrecoveryservicesbackup.RestoreRequestResource{
Properties: &armrecoveryservicesbackup.IaasVMRestoreRequest{
CreateNewCloudService: to.Ptr(false),
EncryptionDetails: &armrecoveryservicesbackup.EncryptionDetails{
EncryptionEnabled: to.Ptr(false),
},
IdentityBasedRestoreDetails: &armrecoveryservicesbackup.IdentityBasedRestoreDetails{
TargetStorageAccountID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Storage/storageAccounts/testingAccount"),
},
IdentityInfo: &armrecoveryservicesbackup.IdentityInfo{
IsSystemAssignedIdentity: to.Ptr(true),
},
ObjectType: to.Ptr("IaasVMRestoreRequest"),
OriginalStorageAccountOption: to.Ptr(false),
RecoveryPointID: to.Ptr("348916168024334"),
RecoveryType: to.Ptr(armrecoveryservicesbackup.RecoveryTypeAlternateLocation),
Region: to.Ptr("southeastasia"),
SourceResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1"),
SubnetID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet/subnets/default"),
TargetResourceGroupID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2"),
TargetVirtualMachineID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2/providers/Microsoft.Compute/virtualmachines/RSMDALRVM981435"),
VirtualNetworkID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet"),
},
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
log.Fatalf("failed to poll the result: %v", err)
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { RecoveryServicesBackupClient } = require("@azure/arm-recoveryservicesbackup");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to restores the specified backed up data. This is an asynchronous operation. To know the status of this API call, use
* GetProtectedItemOperationResult API.
*
* @summary restores the specified backed up data. This is an asynchronous operation. To know the status of this API call, use
* GetProtectedItemOperationResult API.
* x-ms-original-file: 2026-07-01/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreRequest_IdentityBasedRestoreDetails.json
*/
async function restoreToNewAzureIaasVmWithIaasVMRestoreRequestWithIdentityBasedRestoreDetails() {
const credential = new DefaultAzureCredential();
const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new RecoveryServicesBackupClient(credential, subscriptionId);
await client.restores.trigger(
"testVault",
"netsdktestrg",
"Azure",
"IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
"VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
"348916168024334",
{
properties: {
createNewCloudService: false,
encryptionDetails: { encryptionEnabled: false },
identityBasedRestoreDetails: {
targetStorageAccountId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Storage/storageAccounts/testingAccount",
},
identityInfo: { isSystemAssignedIdentity: true },
objectType: "IaasVMRestoreRequest",
originalStorageAccountOption: false,
recoveryPointId: "348916168024334",
recoveryType: "AlternateLocation",
region: "southeastasia",
sourceResourceId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1",
subnetId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet/subnets/default",
targetResourceGroupId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2",
targetVirtualMachineId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2/providers/Microsoft.Compute/virtualmachines/RSMDALRVM981435",
virtualNetworkId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet",
},
},
);
}
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
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2017-07-01
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2017-07-01
Retry-After: 60
Restore to New Azure IaasVm with IaasVMRestoreRequest with identityBasedRestoreDetails and Data Disk Encryption Settings
Sample request
POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/recoveryPoints/348916168024334/restore?api-version=2026-07-01
{
"properties": {
"createNewCloudService": false,
"encryptionDetails": {
"encryptionEnabled": false
},
"identityBasedRestoreDetails": {
"targetStorageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Storage/storageAccounts/testingAccount"
},
"identityInfo": {
"isSystemAssignedIdentity": true
},
"objectType": "IaasVMRestoreRequest",
"originalStorageAccountOption": false,
"recoveryPointId": "348916168024334",
"recoveryType": "AlternateLocation",
"region": "southeastasia",
"securedVMDetails": {
"securedVMOsDiskEncryptionSetId": "/subscriptions/5288acd1-ba79-4377-9205-9f220331a44a/resourceGroups/asmaskarrg-cvm-os-cmk-3cmk-1none-data-2606040706/providers/Microsoft.Compute/diskEncryptionSets/des-os",
"dataDiskEncryptionSettings": {
"dataDiskEncryptionSetId": "/subscriptions/5288acd1-ba79-4377-9205-9f220331a44a/resourceGroups/asmaskarrg-cvm-os-cmk-3cmk-1none-data-2606040706/providers/Microsoft.Compute/diskEncryptionSets/des-data-lun-0",
"dataDiskEncryptionIdentity": "/subscriptions/5288acd1-ba79-4377-9205-9f220331a44a/resourcegroups/asmaskarrg-cvm-os-cmk-3cmk-1none-data-2606040706/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami-cdde"
}
},
"sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1",
"subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet/subnets/default",
"targetResourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2",
"targetVirtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2/providers/Microsoft.Compute/virtualmachines/RSMDALRVM981435",
"virtualNetworkId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet"
}
}
import com.azure.resourcemanager.recoveryservicesbackup.models.DataDiskEncryptionSettings;
import com.azure.resourcemanager.recoveryservicesbackup.models.EncryptionDetails;
import com.azure.resourcemanager.recoveryservicesbackup.models.IaasVMRestoreRequest;
import com.azure.resourcemanager.recoveryservicesbackup.models.IdentityBasedRestoreDetails;
import com.azure.resourcemanager.recoveryservicesbackup.models.IdentityInfo;
import com.azure.resourcemanager.recoveryservicesbackup.models.RecoveryType;
import com.azure.resourcemanager.recoveryservicesbackup.models.RestoreRequestResource;
import com.azure.resourcemanager.recoveryservicesbackup.models.SecuredVMDetails;
/**
* Samples for Restores Trigger.
*/
public final class Main {
/*
* x-ms-original-file:
* 2026-07-01/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreRequest_DataDiskEncryption_SingleEntry.json
*/
/**
* Sample code: Restore to New Azure IaasVm with IaasVMRestoreRequest with identityBasedRestoreDetails and Data Disk
* Encryption Settings.
*
* @param manager Entry point to RecoveryServicesBackupManager.
*/
public static void
restoreToNewAzureIaasVmWithIaasVMRestoreRequestWithIdentityBasedRestoreDetailsAndDataDiskEncryptionSettings(
com.azure.resourcemanager.recoveryservicesbackup.RecoveryServicesBackupManager manager) {
manager.restores().trigger("testVault", "netsdktestrg", "Azure",
"IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
"VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", "348916168024334",
new RestoreRequestResource().withProperties(new IaasVMRestoreRequest()
.withRecoveryPointId("348916168024334").withRecoveryType(RecoveryType.ALTERNATE_LOCATION)
.withSourceResourceId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1")
.withTargetVirtualMachineId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2/providers/Microsoft.Compute/virtualmachines/RSMDALRVM981435")
.withTargetResourceGroupId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2")
.withVirtualNetworkId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet")
.withSubnetId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet/subnets/default")
.withRegion("southeastasia").withCreateNewCloudService(false).withOriginalStorageAccountOption(false)
.withEncryptionDetails(new EncryptionDetails().withEncryptionEnabled(false))
.withIdentityInfo(new IdentityInfo().withIsSystemAssignedIdentity(true))
.withIdentityBasedRestoreDetails(new IdentityBasedRestoreDetails().withTargetStorageAccountId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Storage/storageAccounts/testingAccount"))
.withSecuredVMDetails(new SecuredVMDetails().withSecuredVmosDiskEncryptionSetId(
"/subscriptions/5288acd1-ba79-4377-9205-9f220331a44a/resourceGroups/asmaskarrg-cvm-os-cmk-3cmk-1none-data-2606040706/providers/Microsoft.Compute/diskEncryptionSets/des-os")
.withDataDiskEncryptionSettings(new DataDiskEncryptionSettings().withDataDiskEncryptionSetId(
"/subscriptions/5288acd1-ba79-4377-9205-9f220331a44a/resourceGroups/asmaskarrg-cvm-os-cmk-3cmk-1none-data-2606040706/providers/Microsoft.Compute/diskEncryptionSets/des-data-lun-0")
.withDataDiskEncryptionIdentity(
"/subscriptions/5288acd1-ba79-4377-9205-9f220331a44a/resourcegroups/asmaskarrg-cvm-os-cmk-3cmk-1none-data-2606040706/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami-cdde")))),
com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.recoveryservicesbackup import RecoveryServicesBackupClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-recoveryservicesbackup
# USAGE
python trigger_restore_alr_iaas_vm_restore_request_data_disk_encryption_single_entry.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="SUBSCRIPTION_ID",
)
client.restores.begin_trigger(
vault_name="testVault",
resource_group_name="netsdktestrg",
fabric_name="Azure",
container_name="IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
protected_item_name="VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
recovery_point_id="348916168024334",
parameters={
"properties": {
"createNewCloudService": False,
"encryptionDetails": {"encryptionEnabled": False},
"identityBasedRestoreDetails": {
"targetStorageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Storage/storageAccounts/testingAccount"
},
"identityInfo": {"isSystemAssignedIdentity": True},
"objectType": "IaasVMRestoreRequest",
"originalStorageAccountOption": False,
"recoveryPointId": "348916168024334",
"recoveryType": "AlternateLocation",
"region": "southeastasia",
"securedVMDetails": {
"dataDiskEncryptionSettings": {
"dataDiskEncryptionIdentity": "/subscriptions/5288acd1-ba79-4377-9205-9f220331a44a/resourcegroups/asmaskarrg-cvm-os-cmk-3cmk-1none-data-2606040706/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami-cdde",
"dataDiskEncryptionSetId": "/subscriptions/5288acd1-ba79-4377-9205-9f220331a44a/resourceGroups/asmaskarrg-cvm-os-cmk-3cmk-1none-data-2606040706/providers/Microsoft.Compute/diskEncryptionSets/des-data-lun-0",
},
"securedVMOsDiskEncryptionSetId": "/subscriptions/5288acd1-ba79-4377-9205-9f220331a44a/resourceGroups/asmaskarrg-cvm-os-cmk-3cmk-1none-data-2606040706/providers/Microsoft.Compute/diskEncryptionSets/des-os",
},
"sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1",
"subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet/subnets/default",
"targetResourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2",
"targetVirtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2/providers/Microsoft.Compute/virtualmachines/RSMDALRVM981435",
"virtualNetworkId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet",
}
},
).result()
# x-ms-original-file: 2026-07-01/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreRequest_DataDiskEncryption_SingleEntry.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armrecoveryservicesbackup_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/recoveryservices/armrecoveryservicesbackup/v5"
)
// Generated from example definition: 2026-07-01/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreRequest_DataDiskEncryption_SingleEntry.json
func ExampleRestoresClient_BeginTrigger_restoreToNewAzureIaasVMWithIaasVMRestoreRequestWithIdentityBasedRestoreDetailsAndDataDiskEncryptionSettings() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrecoveryservicesbackup.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewRestoresClient().BeginTrigger(ctx, "testVault", "netsdktestrg", "Azure", "IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", "348916168024334", armrecoveryservicesbackup.RestoreRequestResource{
Properties: &armrecoveryservicesbackup.IaasVMRestoreRequest{
CreateNewCloudService: to.Ptr(false),
EncryptionDetails: &armrecoveryservicesbackup.EncryptionDetails{
EncryptionEnabled: to.Ptr(false),
},
IdentityBasedRestoreDetails: &armrecoveryservicesbackup.IdentityBasedRestoreDetails{
TargetStorageAccountID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Storage/storageAccounts/testingAccount"),
},
IdentityInfo: &armrecoveryservicesbackup.IdentityInfo{
IsSystemAssignedIdentity: to.Ptr(true),
},
ObjectType: to.Ptr("IaasVMRestoreRequest"),
OriginalStorageAccountOption: to.Ptr(false),
RecoveryPointID: to.Ptr("348916168024334"),
RecoveryType: to.Ptr(armrecoveryservicesbackup.RecoveryTypeAlternateLocation),
Region: to.Ptr("southeastasia"),
SecuredVMDetails: &armrecoveryservicesbackup.SecuredVMDetails{
SecuredVMOsDiskEncryptionSetID: to.Ptr("/subscriptions/5288acd1-ba79-4377-9205-9f220331a44a/resourceGroups/asmaskarrg-cvm-os-cmk-3cmk-1none-data-2606040706/providers/Microsoft.Compute/diskEncryptionSets/des-os"),
DataDiskEncryptionSettings: &armrecoveryservicesbackup.DataDiskEncryptionSettings{
DataDiskEncryptionSetID: to.Ptr("/subscriptions/5288acd1-ba79-4377-9205-9f220331a44a/resourceGroups/asmaskarrg-cvm-os-cmk-3cmk-1none-data-2606040706/providers/Microsoft.Compute/diskEncryptionSets/des-data-lun-0"),
DataDiskEncryptionIdentity: to.Ptr("/subscriptions/5288acd1-ba79-4377-9205-9f220331a44a/resourcegroups/asmaskarrg-cvm-os-cmk-3cmk-1none-data-2606040706/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami-cdde"),
},
},
SourceResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1"),
SubnetID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet/subnets/default"),
TargetResourceGroupID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2"),
TargetVirtualMachineID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2/providers/Microsoft.Compute/virtualmachines/RSMDALRVM981435"),
VirtualNetworkID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet"),
},
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
log.Fatalf("failed to poll the result: %v", err)
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { RecoveryServicesBackupClient } = require("@azure/arm-recoveryservicesbackup");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to restores the specified backed up data. This is an asynchronous operation. To know the status of this API call, use
* GetProtectedItemOperationResult API.
*
* @summary restores the specified backed up data. This is an asynchronous operation. To know the status of this API call, use
* GetProtectedItemOperationResult API.
* x-ms-original-file: 2026-07-01/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreRequest_DataDiskEncryption_SingleEntry.json
*/
async function restoreToNewAzureIaasVmWithIaasVMRestoreRequestWithIdentityBasedRestoreDetailsAndDataDiskEncryptionSettings() {
const credential = new DefaultAzureCredential();
const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new RecoveryServicesBackupClient(credential, subscriptionId);
await client.restores.trigger(
"testVault",
"netsdktestrg",
"Azure",
"IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
"VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
"348916168024334",
{
properties: {
createNewCloudService: false,
encryptionDetails: { encryptionEnabled: false },
identityBasedRestoreDetails: {
targetStorageAccountId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Storage/storageAccounts/testingAccount",
},
identityInfo: { isSystemAssignedIdentity: true },
objectType: "IaasVMRestoreRequest",
originalStorageAccountOption: false,
recoveryPointId: "348916168024334",
recoveryType: "AlternateLocation",
region: "southeastasia",
securedVMDetails: {
securedVMOsDiskEncryptionSetId:
"/subscriptions/5288acd1-ba79-4377-9205-9f220331a44a/resourceGroups/asmaskarrg-cvm-os-cmk-3cmk-1none-data-2606040706/providers/Microsoft.Compute/diskEncryptionSets/des-os",
dataDiskEncryptionSettings: {
dataDiskEncryptionSetId:
"/subscriptions/5288acd1-ba79-4377-9205-9f220331a44a/resourceGroups/asmaskarrg-cvm-os-cmk-3cmk-1none-data-2606040706/providers/Microsoft.Compute/diskEncryptionSets/des-data-lun-0",
dataDiskEncryptionIdentity:
"/subscriptions/5288acd1-ba79-4377-9205-9f220331a44a/resourcegroups/asmaskarrg-cvm-os-cmk-3cmk-1none-data-2606040706/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami-cdde",
},
},
sourceResourceId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1",
subnetId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet/subnets/default",
targetResourceGroupId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2",
targetVirtualMachineId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2/providers/Microsoft.Compute/virtualmachines/RSMDALRVM981435",
virtualNetworkId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet",
},
},
);
}
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
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2017-07-01
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2017-07-01
Retry-After: 60
Restore to New Azure IaasVm with IaasVMRestoreRequest with identityBasedRestoreDetails and per disk encryption settings
Sample request
POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/recoveryPoints/348916168024334/restore?api-version=2026-07-01
{
"properties": {
"createNewCloudService": false,
"encryptionDetails": {
"encryptionEnabled": false
},
"identityBasedRestoreDetails": {
"targetStorageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Storage/storageAccounts/testingAccount"
},
"identityInfo": {
"isSystemAssignedIdentity": true
},
"objectType": "IaasVMRestoreRequest",
"originalStorageAccountOption": false,
"recoveryPointId": "348916168024334",
"recoveryType": "AlternateLocation",
"region": "southeastasia",
"securedVMDetails": {
"securedVMOsDiskEncryptionSetId": "/subscriptions/5288acd1-ba79-4377-9205-9f220331a44a/resourceGroups/asmaskarrg-cvm-os-cmk-3cmk-1none-data-2606040706/providers/Microsoft.Compute/diskEncryptionSets/des-os",
"dataDiskEncryptionSettings": {
"perDiskEncryptionSetIds": [
{
"lun": 0,
"diskEncryptionSetId": "/subscriptions/5288acd1-ba79-4377-9205-9f220331a44a/resourceGroups/asmaskarrg-cvm-os-cmk-3cmk-1none-data-2606040706/providers/Microsoft.Compute/diskEncryptionSets/des-data-lun-0"
},
{
"lun": 1,
"diskEncryptionSetId": "/subscriptions/5288acd1-ba79-4377-9205-9f220331a44a/resourceGroups/asmaskarrg-cvm-os-cmk-3cmk-1none-data-2606040706/providers/Microsoft.Compute/diskEncryptionSets/des-data-lun-1"
},
{
"lun": 2,
"diskEncryptionSetId": "/subscriptions/5288acd1-ba79-4377-9205-9f220331a44a/resourceGroups/asmaskarrg-cvm-os-cmk-3cmk-1none-data-2606040706/providers/Microsoft.Compute/diskEncryptionSets/des-data-lun-2"
}
],
"dataDiskEncryptionIdentity": "/subscriptions/5288acd1-ba79-4377-9205-9f220331a44a/resourcegroups/asmaskarrg-cvm-os-cmk-3cmk-1none-data-2606040706/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami-cdde"
}
},
"sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1",
"subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet/subnets/default",
"targetResourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2",
"targetVirtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2/providers/Microsoft.Compute/virtualmachines/RSMDALRVM981435",
"virtualNetworkId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet"
}
}
import com.azure.resourcemanager.recoveryservicesbackup.models.DataDiskEncryptionSettings;
import com.azure.resourcemanager.recoveryservicesbackup.models.EncryptionDetails;
import com.azure.resourcemanager.recoveryservicesbackup.models.IaasVMRestoreRequest;
import com.azure.resourcemanager.recoveryservicesbackup.models.IdentityBasedRestoreDetails;
import com.azure.resourcemanager.recoveryservicesbackup.models.IdentityInfo;
import com.azure.resourcemanager.recoveryservicesbackup.models.PerDiskEncryptionSetId;
import com.azure.resourcemanager.recoveryservicesbackup.models.RecoveryType;
import com.azure.resourcemanager.recoveryservicesbackup.models.RestoreRequestResource;
import com.azure.resourcemanager.recoveryservicesbackup.models.SecuredVMDetails;
import java.util.Arrays;
/**
* Samples for Restores Trigger.
*/
public final class Main {
/*
* x-ms-original-file: 2026-07-01/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreRequest_DataDiskEncryption.json
*/
/**
* Sample code: Restore to New Azure IaasVm with IaasVMRestoreRequest with identityBasedRestoreDetails and per disk
* encryption settings.
*
* @param manager Entry point to RecoveryServicesBackupManager.
*/
public static void
restoreToNewAzureIaasVmWithIaasVMRestoreRequestWithIdentityBasedRestoreDetailsAndPerDiskEncryptionSettings(
com.azure.resourcemanager.recoveryservicesbackup.RecoveryServicesBackupManager manager) {
manager.restores().trigger("testVault", "netsdktestrg", "Azure",
"IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
"VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", "348916168024334",
new RestoreRequestResource().withProperties(new IaasVMRestoreRequest()
.withRecoveryPointId("348916168024334").withRecoveryType(RecoveryType.ALTERNATE_LOCATION)
.withSourceResourceId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1")
.withTargetVirtualMachineId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2/providers/Microsoft.Compute/virtualmachines/RSMDALRVM981435")
.withTargetResourceGroupId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2")
.withVirtualNetworkId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet")
.withSubnetId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet/subnets/default")
.withRegion("southeastasia").withCreateNewCloudService(false).withOriginalStorageAccountOption(false)
.withEncryptionDetails(new EncryptionDetails().withEncryptionEnabled(false))
.withIdentityInfo(new IdentityInfo().withIsSystemAssignedIdentity(true))
.withIdentityBasedRestoreDetails(new IdentityBasedRestoreDetails().withTargetStorageAccountId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Storage/storageAccounts/testingAccount"))
.withSecuredVMDetails(new SecuredVMDetails().withSecuredVmosDiskEncryptionSetId(
"/subscriptions/5288acd1-ba79-4377-9205-9f220331a44a/resourceGroups/asmaskarrg-cvm-os-cmk-3cmk-1none-data-2606040706/providers/Microsoft.Compute/diskEncryptionSets/des-os")
.withDataDiskEncryptionSettings(new DataDiskEncryptionSettings().withPerDiskEncryptionSetIds(
Arrays.asList(new PerDiskEncryptionSetId().withLun(0).withDiskEncryptionSetId(
"/subscriptions/5288acd1-ba79-4377-9205-9f220331a44a/resourceGroups/asmaskarrg-cvm-os-cmk-3cmk-1none-data-2606040706/providers/Microsoft.Compute/diskEncryptionSets/des-data-lun-0"),
new PerDiskEncryptionSetId().withLun(1).withDiskEncryptionSetId(
"/subscriptions/5288acd1-ba79-4377-9205-9f220331a44a/resourceGroups/asmaskarrg-cvm-os-cmk-3cmk-1none-data-2606040706/providers/Microsoft.Compute/diskEncryptionSets/des-data-lun-1"),
new PerDiskEncryptionSetId().withLun(2).withDiskEncryptionSetId(
"/subscriptions/5288acd1-ba79-4377-9205-9f220331a44a/resourceGroups/asmaskarrg-cvm-os-cmk-3cmk-1none-data-2606040706/providers/Microsoft.Compute/diskEncryptionSets/des-data-lun-2")))
.withDataDiskEncryptionIdentity(
"/subscriptions/5288acd1-ba79-4377-9205-9f220331a44a/resourcegroups/asmaskarrg-cvm-os-cmk-3cmk-1none-data-2606040706/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami-cdde")))),
com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.recoveryservicesbackup import RecoveryServicesBackupClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-recoveryservicesbackup
# USAGE
python trigger_restore_alr_iaas_vm_restore_request_data_disk_encryption.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="SUBSCRIPTION_ID",
)
client.restores.begin_trigger(
vault_name="testVault",
resource_group_name="netsdktestrg",
fabric_name="Azure",
container_name="IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
protected_item_name="VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
recovery_point_id="348916168024334",
parameters={
"properties": {
"createNewCloudService": False,
"encryptionDetails": {"encryptionEnabled": False},
"identityBasedRestoreDetails": {
"targetStorageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Storage/storageAccounts/testingAccount"
},
"identityInfo": {"isSystemAssignedIdentity": True},
"objectType": "IaasVMRestoreRequest",
"originalStorageAccountOption": False,
"recoveryPointId": "348916168024334",
"recoveryType": "AlternateLocation",
"region": "southeastasia",
"securedVMDetails": {
"dataDiskEncryptionSettings": {
"dataDiskEncryptionIdentity": "/subscriptions/5288acd1-ba79-4377-9205-9f220331a44a/resourcegroups/asmaskarrg-cvm-os-cmk-3cmk-1none-data-2606040706/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami-cdde",
"perDiskEncryptionSetIds": [
{
"diskEncryptionSetId": "/subscriptions/5288acd1-ba79-4377-9205-9f220331a44a/resourceGroups/asmaskarrg-cvm-os-cmk-3cmk-1none-data-2606040706/providers/Microsoft.Compute/diskEncryptionSets/des-data-lun-0",
"lun": 0,
},
{
"diskEncryptionSetId": "/subscriptions/5288acd1-ba79-4377-9205-9f220331a44a/resourceGroups/asmaskarrg-cvm-os-cmk-3cmk-1none-data-2606040706/providers/Microsoft.Compute/diskEncryptionSets/des-data-lun-1",
"lun": 1,
},
{
"diskEncryptionSetId": "/subscriptions/5288acd1-ba79-4377-9205-9f220331a44a/resourceGroups/asmaskarrg-cvm-os-cmk-3cmk-1none-data-2606040706/providers/Microsoft.Compute/diskEncryptionSets/des-data-lun-2",
"lun": 2,
},
],
},
"securedVMOsDiskEncryptionSetId": "/subscriptions/5288acd1-ba79-4377-9205-9f220331a44a/resourceGroups/asmaskarrg-cvm-os-cmk-3cmk-1none-data-2606040706/providers/Microsoft.Compute/diskEncryptionSets/des-os",
},
"sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1",
"subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet/subnets/default",
"targetResourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2",
"targetVirtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2/providers/Microsoft.Compute/virtualmachines/RSMDALRVM981435",
"virtualNetworkId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet",
}
},
).result()
# x-ms-original-file: 2026-07-01/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreRequest_DataDiskEncryption.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armrecoveryservicesbackup_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/recoveryservices/armrecoveryservicesbackup/v5"
)
// Generated from example definition: 2026-07-01/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreRequest_DataDiskEncryption.json
func ExampleRestoresClient_BeginTrigger_restoreToNewAzureIaasVMWithIaasVMRestoreRequestWithIdentityBasedRestoreDetailsAndPerDiskEncryptionSettings() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrecoveryservicesbackup.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewRestoresClient().BeginTrigger(ctx, "testVault", "netsdktestrg", "Azure", "IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", "348916168024334", armrecoveryservicesbackup.RestoreRequestResource{
Properties: &armrecoveryservicesbackup.IaasVMRestoreRequest{
CreateNewCloudService: to.Ptr(false),
EncryptionDetails: &armrecoveryservicesbackup.EncryptionDetails{
EncryptionEnabled: to.Ptr(false),
},
IdentityBasedRestoreDetails: &armrecoveryservicesbackup.IdentityBasedRestoreDetails{
TargetStorageAccountID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Storage/storageAccounts/testingAccount"),
},
IdentityInfo: &armrecoveryservicesbackup.IdentityInfo{
IsSystemAssignedIdentity: to.Ptr(true),
},
ObjectType: to.Ptr("IaasVMRestoreRequest"),
OriginalStorageAccountOption: to.Ptr(false),
RecoveryPointID: to.Ptr("348916168024334"),
RecoveryType: to.Ptr(armrecoveryservicesbackup.RecoveryTypeAlternateLocation),
Region: to.Ptr("southeastasia"),
SecuredVMDetails: &armrecoveryservicesbackup.SecuredVMDetails{
SecuredVMOsDiskEncryptionSetID: to.Ptr("/subscriptions/5288acd1-ba79-4377-9205-9f220331a44a/resourceGroups/asmaskarrg-cvm-os-cmk-3cmk-1none-data-2606040706/providers/Microsoft.Compute/diskEncryptionSets/des-os"),
DataDiskEncryptionSettings: &armrecoveryservicesbackup.DataDiskEncryptionSettings{
PerDiskEncryptionSetIDs: []*armrecoveryservicesbackup.PerDiskEncryptionSetID{
{
Lun: to.Ptr[int32](0),
DiskEncryptionSetID: to.Ptr("/subscriptions/5288acd1-ba79-4377-9205-9f220331a44a/resourceGroups/asmaskarrg-cvm-os-cmk-3cmk-1none-data-2606040706/providers/Microsoft.Compute/diskEncryptionSets/des-data-lun-0"),
},
{
Lun: to.Ptr[int32](1),
DiskEncryptionSetID: to.Ptr("/subscriptions/5288acd1-ba79-4377-9205-9f220331a44a/resourceGroups/asmaskarrg-cvm-os-cmk-3cmk-1none-data-2606040706/providers/Microsoft.Compute/diskEncryptionSets/des-data-lun-1"),
},
{
Lun: to.Ptr[int32](2),
DiskEncryptionSetID: to.Ptr("/subscriptions/5288acd1-ba79-4377-9205-9f220331a44a/resourceGroups/asmaskarrg-cvm-os-cmk-3cmk-1none-data-2606040706/providers/Microsoft.Compute/diskEncryptionSets/des-data-lun-2"),
},
},
DataDiskEncryptionIdentity: to.Ptr("/subscriptions/5288acd1-ba79-4377-9205-9f220331a44a/resourcegroups/asmaskarrg-cvm-os-cmk-3cmk-1none-data-2606040706/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami-cdde"),
},
},
SourceResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1"),
SubnetID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet/subnets/default"),
TargetResourceGroupID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2"),
TargetVirtualMachineID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2/providers/Microsoft.Compute/virtualmachines/RSMDALRVM981435"),
VirtualNetworkID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet"),
},
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
log.Fatalf("failed to poll the result: %v", err)
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { RecoveryServicesBackupClient } = require("@azure/arm-recoveryservicesbackup");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to restores the specified backed up data. This is an asynchronous operation. To know the status of this API call, use
* GetProtectedItemOperationResult API.
*
* @summary restores the specified backed up data. This is an asynchronous operation. To know the status of this API call, use
* GetProtectedItemOperationResult API.
* x-ms-original-file: 2026-07-01/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreRequest_DataDiskEncryption.json
*/
async function restoreToNewAzureIaasVmWithIaasVMRestoreRequestWithIdentityBasedRestoreDetailsAndPerDiskEncryptionSettings() {
const credential = new DefaultAzureCredential();
const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new RecoveryServicesBackupClient(credential, subscriptionId);
await client.restores.trigger(
"testVault",
"netsdktestrg",
"Azure",
"IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
"VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
"348916168024334",
{
properties: {
createNewCloudService: false,
encryptionDetails: { encryptionEnabled: false },
identityBasedRestoreDetails: {
targetStorageAccountId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Storage/storageAccounts/testingAccount",
},
identityInfo: { isSystemAssignedIdentity: true },
objectType: "IaasVMRestoreRequest",
originalStorageAccountOption: false,
recoveryPointId: "348916168024334",
recoveryType: "AlternateLocation",
region: "southeastasia",
securedVMDetails: {
securedVMOsDiskEncryptionSetId:
"/subscriptions/5288acd1-ba79-4377-9205-9f220331a44a/resourceGroups/asmaskarrg-cvm-os-cmk-3cmk-1none-data-2606040706/providers/Microsoft.Compute/diskEncryptionSets/des-os",
dataDiskEncryptionSettings: {
perDiskEncryptionSetIds: [
{
lun: 0,
diskEncryptionSetId:
"/subscriptions/5288acd1-ba79-4377-9205-9f220331a44a/resourceGroups/asmaskarrg-cvm-os-cmk-3cmk-1none-data-2606040706/providers/Microsoft.Compute/diskEncryptionSets/des-data-lun-0",
},
{
lun: 1,
diskEncryptionSetId:
"/subscriptions/5288acd1-ba79-4377-9205-9f220331a44a/resourceGroups/asmaskarrg-cvm-os-cmk-3cmk-1none-data-2606040706/providers/Microsoft.Compute/diskEncryptionSets/des-data-lun-1",
},
{
lun: 2,
diskEncryptionSetId:
"/subscriptions/5288acd1-ba79-4377-9205-9f220331a44a/resourceGroups/asmaskarrg-cvm-os-cmk-3cmk-1none-data-2606040706/providers/Microsoft.Compute/diskEncryptionSets/des-data-lun-2",
},
],
dataDiskEncryptionIdentity:
"/subscriptions/5288acd1-ba79-4377-9205-9f220331a44a/resourcegroups/asmaskarrg-cvm-os-cmk-3cmk-1none-data-2606040706/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami-cdde",
},
},
sourceResourceId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1",
subnetId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet/subnets/default",
targetResourceGroupId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2",
targetVirtualMachineId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2/providers/Microsoft.Compute/virtualmachines/RSMDALRVM981435",
virtualNetworkId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet",
},
},
);
}
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
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2017-07-01
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2017-07-01
Retry-After: 60
Restore to New Azure IaasVm with IaasVMRestoreWithRehydrationRequest
Sample request
POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/recoveryPoints/348916168024334/restore?api-version=2026-07-01
{
"properties": {
"createNewCloudService": false,
"encryptionDetails": {
"encryptionEnabled": false
},
"objectType": "IaasVMRestoreWithRehydrationRequest",
"originalStorageAccountOption": false,
"recoveryPointId": "348916168024334",
"recoveryPointRehydrationInfo": {
"rehydrationPriority": "High",
"rehydrationRetentionDuration": "P7D"
},
"recoveryType": "AlternateLocation",
"region": "southeastasia",
"sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1",
"storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Storage/storageAccounts/testingAccount",
"subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet/subnets/default",
"targetResourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2",
"targetVirtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2/providers/Microsoft.Compute/virtualmachines/RSMDALRVM981435",
"virtualNetworkId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet"
}
}
import com.azure.resourcemanager.recoveryservicesbackup.models.EncryptionDetails;
import com.azure.resourcemanager.recoveryservicesbackup.models.IaasVMRestoreWithRehydrationRequest;
import com.azure.resourcemanager.recoveryservicesbackup.models.RecoveryPointRehydrationInfo;
import com.azure.resourcemanager.recoveryservicesbackup.models.RecoveryType;
import com.azure.resourcemanager.recoveryservicesbackup.models.RehydrationPriority;
import com.azure.resourcemanager.recoveryservicesbackup.models.RestoreRequestResource;
/**
* Samples for Restores Trigger.
*/
public final class Main {
/*
* x-ms-original-file: 2026-07-01/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreWithRehydrationRequest.json
*/
/**
* Sample code: Restore to New Azure IaasVm with IaasVMRestoreWithRehydrationRequest.
*
* @param manager Entry point to RecoveryServicesBackupManager.
*/
public static void restoreToNewAzureIaasVmWithIaasVMRestoreWithRehydrationRequest(
com.azure.resourcemanager.recoveryservicesbackup.RecoveryServicesBackupManager manager) {
manager.restores().trigger("testVault", "netsdktestrg", "Azure",
"IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
"VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", "348916168024334",
new RestoreRequestResource().withProperties(new IaasVMRestoreWithRehydrationRequest()
.withRecoveryPointId("348916168024334").withRecoveryType(RecoveryType.ALTERNATE_LOCATION)
.withSourceResourceId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1")
.withTargetVirtualMachineId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2/providers/Microsoft.Compute/virtualmachines/RSMDALRVM981435")
.withTargetResourceGroupId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2")
.withStorageAccountId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Storage/storageAccounts/testingAccount")
.withVirtualNetworkId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet")
.withSubnetId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet/subnets/default")
.withRegion("southeastasia").withCreateNewCloudService(false).withOriginalStorageAccountOption(false)
.withEncryptionDetails(new EncryptionDetails().withEncryptionEnabled(false))
.withRecoveryPointRehydrationInfo(new RecoveryPointRehydrationInfo()
.withRehydrationRetentionDuration("P7D").withRehydrationPriority(RehydrationPriority.HIGH))),
com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.recoveryservicesbackup import RecoveryServicesBackupClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-recoveryservicesbackup
# USAGE
python trigger_restore_alr_iaas_vm_restore_with_rehydration_request.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="SUBSCRIPTION_ID",
)
client.restores.begin_trigger(
vault_name="testVault",
resource_group_name="netsdktestrg",
fabric_name="Azure",
container_name="IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
protected_item_name="VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
recovery_point_id="348916168024334",
parameters={
"properties": {
"createNewCloudService": False,
"encryptionDetails": {"encryptionEnabled": False},
"objectType": "IaasVMRestoreWithRehydrationRequest",
"originalStorageAccountOption": False,
"recoveryPointId": "348916168024334",
"recoveryPointRehydrationInfo": {"rehydrationPriority": "High", "rehydrationRetentionDuration": "P7D"},
"recoveryType": "AlternateLocation",
"region": "southeastasia",
"sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1",
"storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Storage/storageAccounts/testingAccount",
"subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet/subnets/default",
"targetResourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2",
"targetVirtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2/providers/Microsoft.Compute/virtualmachines/RSMDALRVM981435",
"virtualNetworkId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet",
}
},
).result()
# x-ms-original-file: 2026-07-01/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreWithRehydrationRequest.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armrecoveryservicesbackup_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/recoveryservices/armrecoveryservicesbackup/v5"
)
// Generated from example definition: 2026-07-01/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreWithRehydrationRequest.json
func ExampleRestoresClient_BeginTrigger_restoreToNewAzureIaasVMWithIaasVMRestoreWithRehydrationRequest() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrecoveryservicesbackup.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewRestoresClient().BeginTrigger(ctx, "testVault", "netsdktestrg", "Azure", "IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", "348916168024334", armrecoveryservicesbackup.RestoreRequestResource{
Properties: &armrecoveryservicesbackup.IaasVMRestoreWithRehydrationRequest{
CreateNewCloudService: to.Ptr(false),
EncryptionDetails: &armrecoveryservicesbackup.EncryptionDetails{
EncryptionEnabled: to.Ptr(false),
},
ObjectType: to.Ptr("IaasVMRestoreWithRehydrationRequest"),
OriginalStorageAccountOption: to.Ptr(false),
RecoveryPointID: to.Ptr("348916168024334"),
RecoveryPointRehydrationInfo: &armrecoveryservicesbackup.RecoveryPointRehydrationInfo{
RehydrationPriority: to.Ptr(armrecoveryservicesbackup.RehydrationPriorityHigh),
RehydrationRetentionDuration: to.Ptr("P7D"),
},
RecoveryType: to.Ptr(armrecoveryservicesbackup.RecoveryTypeAlternateLocation),
Region: to.Ptr("southeastasia"),
SourceResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1"),
StorageAccountID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Storage/storageAccounts/testingAccount"),
SubnetID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet/subnets/default"),
TargetResourceGroupID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2"),
TargetVirtualMachineID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2/providers/Microsoft.Compute/virtualmachines/RSMDALRVM981435"),
VirtualNetworkID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet"),
},
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
log.Fatalf("failed to poll the result: %v", err)
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { RecoveryServicesBackupClient } = require("@azure/arm-recoveryservicesbackup");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to restores the specified backed up data. This is an asynchronous operation. To know the status of this API call, use
* GetProtectedItemOperationResult API.
*
* @summary restores the specified backed up data. This is an asynchronous operation. To know the status of this API call, use
* GetProtectedItemOperationResult API.
* x-ms-original-file: 2026-07-01/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreWithRehydrationRequest.json
*/
async function restoreToNewAzureIaasVmWithIaasVMRestoreWithRehydrationRequest() {
const credential = new DefaultAzureCredential();
const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new RecoveryServicesBackupClient(credential, subscriptionId);
await client.restores.trigger(
"testVault",
"netsdktestrg",
"Azure",
"IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
"VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
"348916168024334",
{
properties: {
createNewCloudService: false,
encryptionDetails: { encryptionEnabled: false },
objectType: "IaasVMRestoreWithRehydrationRequest",
originalStorageAccountOption: false,
recoveryPointId: "348916168024334",
recoveryPointRehydrationInfo: {
rehydrationPriority: "High",
rehydrationRetentionDuration: "P7D",
},
recoveryType: "AlternateLocation",
region: "southeastasia",
sourceResourceId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1",
storageAccountId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Storage/storageAccounts/testingAccount",
subnetId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet/subnets/default",
targetResourceGroupId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2",
targetVirtualMachineId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2/providers/Microsoft.Compute/virtualmachines/RSMDALRVM981435",
virtualNetworkId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet",
},
},
);
}
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
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2017-07-01
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2017-07-01
Retry-After: 60
Restore with Resource Guard Enabled
Sample request
POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/recoveryPoints/348916168024334/restore?api-version=2026-07-01
{
"properties": {
"createNewCloudService": true,
"encryptionDetails": {
"encryptionEnabled": false
},
"identityBasedRestoreDetails": {
"targetStorageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testingRg/providers/Microsoft.Storage/storageAccounts/testAccount"
},
"identityInfo": {
"isSystemAssignedIdentity": false,
"managedIdentityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/asmaskarRG1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/asmaskartestmsi"
},
"objectType": "IaasVMRestoreRequest",
"originalStorageAccountOption": false,
"recoveryPointId": "348916168024334",
"recoveryType": "RestoreDisks",
"region": "southeastasia",
"resourceGuardOperationRequests": [
"/subscriptions/063bf7bc-e4dc-4cde-8840-8416fbd7921e/resourcegroups/ankurRG1/providers/Microsoft.DataProtection/resourceGuards/RG341/triggerRestoreRequests/default"
],
"sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1"
}
}
import com.azure.resourcemanager.recoveryservicesbackup.models.EncryptionDetails;
import com.azure.resourcemanager.recoveryservicesbackup.models.IaasVMRestoreRequest;
import com.azure.resourcemanager.recoveryservicesbackup.models.IdentityBasedRestoreDetails;
import com.azure.resourcemanager.recoveryservicesbackup.models.IdentityInfo;
import com.azure.resourcemanager.recoveryservicesbackup.models.RecoveryType;
import com.azure.resourcemanager.recoveryservicesbackup.models.RestoreRequestResource;
import java.util.Arrays;
/**
* Samples for Restores Trigger.
*/
public final class Main {
/*
* x-ms-original-file: 2026-07-01/AzureIaasVm/TriggerRestore_ResourceGuardEnabled.json
*/
/**
* Sample code: Restore with Resource Guard Enabled.
*
* @param manager Entry point to RecoveryServicesBackupManager.
*/
public static void restoreWithResourceGuardEnabled(
com.azure.resourcemanager.recoveryservicesbackup.RecoveryServicesBackupManager manager) {
manager.restores().trigger("testVault", "netsdktestrg", "Azure",
"IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
"VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", "348916168024334",
new RestoreRequestResource().withProperties(new IaasVMRestoreRequest()
.withResourceGuardOperationRequests(Arrays.asList(
"/subscriptions/063bf7bc-e4dc-4cde-8840-8416fbd7921e/resourcegroups/ankurRG1/providers/Microsoft.DataProtection/resourceGuards/RG341/triggerRestoreRequests/default"))
.withRecoveryPointId("348916168024334").withRecoveryType(RecoveryType.RESTORE_DISKS)
.withSourceResourceId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1")
.withRegion("southeastasia").withCreateNewCloudService(true).withOriginalStorageAccountOption(false)
.withEncryptionDetails(new EncryptionDetails().withEncryptionEnabled(false))
.withIdentityInfo(new IdentityInfo().withIsSystemAssignedIdentity(false).withManagedIdentityResourceId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/asmaskarRG1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/asmaskartestmsi"))
.withIdentityBasedRestoreDetails(new IdentityBasedRestoreDetails().withTargetStorageAccountId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testingRg/providers/Microsoft.Storage/storageAccounts/testAccount"))),
com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.recoveryservicesbackup import RecoveryServicesBackupClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-recoveryservicesbackup
# USAGE
python trigger_restore_resource_guard_enabled.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="SUBSCRIPTION_ID",
)
client.restores.begin_trigger(
vault_name="testVault",
resource_group_name="netsdktestrg",
fabric_name="Azure",
container_name="IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
protected_item_name="VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
recovery_point_id="348916168024334",
parameters={
"properties": {
"createNewCloudService": True,
"encryptionDetails": {"encryptionEnabled": False},
"identityBasedRestoreDetails": {
"targetStorageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testingRg/providers/Microsoft.Storage/storageAccounts/testAccount"
},
"identityInfo": {
"isSystemAssignedIdentity": False,
"managedIdentityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/asmaskarRG1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/asmaskartestmsi",
},
"objectType": "IaasVMRestoreRequest",
"originalStorageAccountOption": False,
"recoveryPointId": "348916168024334",
"recoveryType": "RestoreDisks",
"region": "southeastasia",
"resourceGuardOperationRequests": [
"/subscriptions/063bf7bc-e4dc-4cde-8840-8416fbd7921e/resourcegroups/ankurRG1/providers/Microsoft.DataProtection/resourceGuards/RG341/triggerRestoreRequests/default"
],
"sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1",
}
},
).result()
# x-ms-original-file: 2026-07-01/AzureIaasVm/TriggerRestore_ResourceGuardEnabled.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armrecoveryservicesbackup_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/recoveryservices/armrecoveryservicesbackup/v5"
)
// Generated from example definition: 2026-07-01/AzureIaasVm/TriggerRestore_ResourceGuardEnabled.json
func ExampleRestoresClient_BeginTrigger_restoreWithResourceGuardEnabled() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrecoveryservicesbackup.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewRestoresClient().BeginTrigger(ctx, "testVault", "netsdktestrg", "Azure", "IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", "348916168024334", armrecoveryservicesbackup.RestoreRequestResource{
Properties: &armrecoveryservicesbackup.IaasVMRestoreRequest{
CreateNewCloudService: to.Ptr(true),
EncryptionDetails: &armrecoveryservicesbackup.EncryptionDetails{
EncryptionEnabled: to.Ptr(false),
},
IdentityBasedRestoreDetails: &armrecoveryservicesbackup.IdentityBasedRestoreDetails{
TargetStorageAccountID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testingRg/providers/Microsoft.Storage/storageAccounts/testAccount"),
},
IdentityInfo: &armrecoveryservicesbackup.IdentityInfo{
IsSystemAssignedIdentity: to.Ptr(false),
ManagedIdentityResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/asmaskarRG1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/asmaskartestmsi"),
},
ObjectType: to.Ptr("IaasVMRestoreRequest"),
OriginalStorageAccountOption: to.Ptr(false),
RecoveryPointID: to.Ptr("348916168024334"),
RecoveryType: to.Ptr(armrecoveryservicesbackup.RecoveryTypeRestoreDisks),
Region: to.Ptr("southeastasia"),
ResourceGuardOperationRequests: []*string{
to.Ptr("/subscriptions/063bf7bc-e4dc-4cde-8840-8416fbd7921e/resourcegroups/ankurRG1/providers/Microsoft.DataProtection/resourceGuards/RG341/triggerRestoreRequests/default"),
},
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)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
log.Fatalf("failed to poll the result: %v", err)
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { RecoveryServicesBackupClient } = require("@azure/arm-recoveryservicesbackup");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to restores the specified backed up data. This is an asynchronous operation. To know the status of this API call, use
* GetProtectedItemOperationResult API.
*
* @summary restores the specified backed up data. This is an asynchronous operation. To know the status of this API call, use
* GetProtectedItemOperationResult API.
* x-ms-original-file: 2026-07-01/AzureIaasVm/TriggerRestore_ResourceGuardEnabled.json
*/
async function restoreWithResourceGuardEnabled() {
const credential = new DefaultAzureCredential();
const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new RecoveryServicesBackupClient(credential, subscriptionId);
await client.restores.trigger(
"testVault",
"netsdktestrg",
"Azure",
"IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
"VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1",
"348916168024334",
{
properties: {
createNewCloudService: true,
encryptionDetails: { encryptionEnabled: false },
identityBasedRestoreDetails: {
targetStorageAccountId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testingRg/providers/Microsoft.Storage/storageAccounts/testAccount",
},
identityInfo: {
isSystemAssignedIdentity: false,
managedIdentityResourceId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/asmaskarRG1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/asmaskartestmsi",
},
objectType: "IaasVMRestoreRequest",
originalStorageAccountOption: false,
recoveryPointId: "348916168024334",
recoveryType: "RestoreDisks",
region: "southeastasia",
resourceGuardOperationRequests: [
"/subscriptions/063bf7bc-e4dc-4cde-8840-8416fbd7921e/resourcegroups/ankurRG1/providers/Microsoft.DataProtection/resourceGuards/RG341/triggerRestoreRequests/default",
],
sourceResourceId:
"/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
Sample response
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2020-09-01
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2020-09-01
Retry-After: 60
Definitions
AzureFileShareRestoreRequest
Object
AzureFileShare Restore Request
| Name |
Type |
Description |
|
copyOptions
|
CopyOptions
|
Options to resolve copy conflicts.
|
|
identityInfo
|
IdentityInfo
|
Managed identity information required to access the storage account.
|
|
objectType
|
string:
AzureFileShareRestoreRequest
|
This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
|
|
recoveryType
|
RecoveryType
|
Type of this recovery.
|
|
resourceGuardOperationRequests
|
string[]
|
ResourceGuardOperationRequests on which LAC check will be performed
|
|
restoreFileSpecs
|
RestoreFileSpecs[]
|
List of Source Files/Folders(which need to recover) and TargetFolderPath details
|
|
restoreRequestType
|
RestoreRequestType
|
Restore Type (FullShareRestore or ItemLevelRestore)
|
|
sourceResourceId
|
string
|
Source storage account ARM Id
|
|
targetDetails
|
TargetAFSRestoreInfo
|
Target File Share Details
|
AzureWorkloadPointInTimeRestoreRequest
Object
AzureWorkload SAP Hana -specific restore. Specifically for PointInTime/Log restore
| Name |
Type |
Description |
|
objectType
|
string:
AzureWorkloadPointInTimeRestoreRequest
|
This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
|
|
pointInTime
|
string
(date-time)
|
PointInTime value
|
|
propertyBag
|
object
|
Workload specific property bag.
|
|
recoveryMode
|
RecoveryMode
|
Defines whether the current recovery mode is file restore or database restore
|
|
recoveryType
|
RecoveryType
|
Type of this recovery.
|
|
resourceGuardOperationRequests
|
string[]
|
ResourceGuardOperationRequests on which LAC check will be performed
|
|
snapshotRestoreParameters
|
SnapshotRestoreParameters
|
Additional details for snapshot recovery
Currently used for snapshot for SAP Hana.
|
|
sourceResourceId
|
string
|
Fully qualified ARM ID of the VM on which workload that was running is being recovered.
|
|
targetInfo
|
TargetRestoreInfo
|
Details of target database
|
|
targetResourceGroupName
|
string
|
Defines the Resource group of the Target VM
|
|
targetVirtualMachineId
|
string
|
This is the complete ARM Id of the target VM
For e.g. /subscriptions/{subId}/resourcegroups/{rg}/provider/Microsoft.Compute/virtualmachines/{vm}
|
|
userAssignedManagedIdentityDetails
|
UserAssignedManagedIdentityDetails
|
User Assigned managed identity details
Currently used for snapshot.
|
AzureWorkloadRestoreRequest
Object
AzureWorkload-specific restore.
| Name |
Type |
Description |
|
objectType
|
string:
AzureWorkloadRestoreRequest
|
This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
|
|
propertyBag
|
object
|
Workload specific property bag.
|
|
recoveryMode
|
RecoveryMode
|
Defines whether the current recovery mode is file restore or database restore
|
|
recoveryType
|
RecoveryType
|
Type of this recovery.
|
|
resourceGuardOperationRequests
|
string[]
|
ResourceGuardOperationRequests on which LAC check will be performed
|
|
snapshotRestoreParameters
|
SnapshotRestoreParameters
|
Additional details for snapshot recovery
Currently used for snapshot for SAP Hana.
|
|
sourceResourceId
|
string
|
Fully qualified ARM ID of the VM on which workload that was running is being recovered.
|
|
targetInfo
|
TargetRestoreInfo
|
Details of target database
|
|
targetResourceGroupName
|
string
|
Defines the Resource group of the Target VM
|
|
targetVirtualMachineId
|
string
|
This is the complete ARM Id of the target VM
For e.g. /subscriptions/{subId}/resourcegroups/{rg}/provider/Microsoft.Compute/virtualmachines/{vm}
|
|
userAssignedManagedIdentityDetails
|
UserAssignedManagedIdentityDetails
|
User Assigned managed identity details
Currently used for snapshot.
|
AzureWorkloadSAPAsePointInTimeRestoreRequest
Object
AzureWorkload SAP Ase-specific restore. Specifically for PointInTime/Log restore
| Name |
Type |
Description |
|
objectType
|
string:
AzureWorkloadSAPAsePointInTimeRestoreRequest
|
This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
|
|
pointInTime
|
string
(date-time)
|
PointInTime value
|
|
propertyBag
|
object
|
Workload specific property bag.
|
|
recoveryMode
|
RecoveryMode
|
Defines whether the current recovery mode is file restore or database restore
|
|
recoveryType
|
RecoveryType
|
Type of this recovery.
|
|
resourceGuardOperationRequests
|
string[]
|
ResourceGuardOperationRequests on which LAC check will be performed
|
|
snapshotRestoreParameters
|
SnapshotRestoreParameters
|
Additional details for snapshot recovery
Currently used for snapshot for SAP Hana.
|
|
sourceResourceId
|
string
|
Fully qualified ARM ID of the VM on which workload that was running is being recovered.
|
|
targetInfo
|
TargetRestoreInfo
|
Details of target database
|
|
targetResourceGroupName
|
string
|
Defines the Resource group of the Target VM
|
|
targetVirtualMachineId
|
string
|
This is the complete ARM Id of the target VM
For e.g. /subscriptions/{subId}/resourcegroups/{rg}/provider/Microsoft.Compute/virtualmachines/{vm}
|
|
userAssignedManagedIdentityDetails
|
UserAssignedManagedIdentityDetails
|
User Assigned managed identity details
Currently used for snapshot.
|
AzureWorkloadSAPAseRestoreRequest
Object
AzureWorkload SAP Ase-specific restore.
| Name |
Type |
Description |
|
objectType
|
string:
AzureWorkloadSAPAseRestoreRequest
|
This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
|
|
propertyBag
|
object
|
Workload specific property bag.
|
|
recoveryMode
|
RecoveryMode
|
Defines whether the current recovery mode is file restore or database restore
|
|
recoveryType
|
RecoveryType
|
Type of this recovery.
|
|
resourceGuardOperationRequests
|
string[]
|
ResourceGuardOperationRequests on which LAC check will be performed
|
|
snapshotRestoreParameters
|
SnapshotRestoreParameters
|
Additional details for snapshot recovery
Currently used for snapshot for SAP Hana.
|
|
sourceResourceId
|
string
|
Fully qualified ARM ID of the VM on which workload that was running is being recovered.
|
|
targetInfo
|
TargetRestoreInfo
|
Details of target database
|
|
targetResourceGroupName
|
string
|
Defines the Resource group of the Target VM
|
|
targetVirtualMachineId
|
string
|
This is the complete ARM Id of the target VM
For e.g. /subscriptions/{subId}/resourcegroups/{rg}/provider/Microsoft.Compute/virtualmachines/{vm}
|
|
userAssignedManagedIdentityDetails
|
UserAssignedManagedIdentityDetails
|
User Assigned managed identity details
Currently used for snapshot.
|
AzureWorkloadSAPHanaPointInTimeRestoreRequest
Object
AzureWorkload SAP Hana -specific restore. Specifically for PointInTime/Log restore
| Name |
Type |
Description |
|
objectType
|
string:
AzureWorkloadSAPHanaPointInTimeRestoreRequest
|
This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
|
|
pointInTime
|
string
(date-time)
|
PointInTime value
|
|
propertyBag
|
object
|
Workload specific property bag.
|
|
recoveryMode
|
RecoveryMode
|
Defines whether the current recovery mode is file restore or database restore
|
|
recoveryType
|
RecoveryType
|
Type of this recovery.
|
|
resourceGuardOperationRequests
|
string[]
|
ResourceGuardOperationRequests on which LAC check will be performed
|
|
snapshotRestoreParameters
|
SnapshotRestoreParameters
|
Additional details for snapshot recovery
Currently used for snapshot for SAP Hana.
|
|
sourceResourceId
|
string
|
Fully qualified ARM ID of the VM on which workload that was running is being recovered.
|
|
targetInfo
|
TargetRestoreInfo
|
Details of target database
|
|
targetResourceGroupName
|
string
|
Defines the Resource group of the Target VM
|
|
targetVirtualMachineId
|
string
|
This is the complete ARM Id of the target VM
For e.g. /subscriptions/{subId}/resourcegroups/{rg}/provider/Microsoft.Compute/virtualmachines/{vm}
|
|
userAssignedManagedIdentityDetails
|
UserAssignedManagedIdentityDetails
|
User Assigned managed identity details
Currently used for snapshot.
|
AzureWorkloadSAPHanaPointInTimeRestoreWithRehydrateRequest
Object
AzureWorkload SAP Hana-specific restore with integrated rehydration of recovery point.
| Name |
Type |
Description |
|
objectType
|
string:
AzureWorkloadSAPHanaPointInTimeRestoreWithRehydrateRequest
|
This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
|
|
pointInTime
|
string
(date-time)
|
PointInTime value
|
|
propertyBag
|
object
|
Workload specific property bag.
|
|
recoveryMode
|
RecoveryMode
|
Defines whether the current recovery mode is file restore or database restore
|
|
recoveryPointRehydrationInfo
|
RecoveryPointRehydrationInfo
|
RP Rehydration Info
|
|
recoveryType
|
RecoveryType
|
Type of this recovery.
|
|
resourceGuardOperationRequests
|
string[]
|
ResourceGuardOperationRequests on which LAC check will be performed
|
|
snapshotRestoreParameters
|
SnapshotRestoreParameters
|
Additional details for snapshot recovery
Currently used for snapshot for SAP Hana.
|
|
sourceResourceId
|
string
|
Fully qualified ARM ID of the VM on which workload that was running is being recovered.
|
|
targetInfo
|
TargetRestoreInfo
|
Details of target database
|
|
targetResourceGroupName
|
string
|
Defines the Resource group of the Target VM
|
|
targetVirtualMachineId
|
string
|
This is the complete ARM Id of the target VM
For e.g. /subscriptions/{subId}/resourcegroups/{rg}/provider/Microsoft.Compute/virtualmachines/{vm}
|
|
userAssignedManagedIdentityDetails
|
UserAssignedManagedIdentityDetails
|
User Assigned managed identity details
Currently used for snapshot.
|
AzureWorkloadSAPHanaRestoreRequest
Object
AzureWorkload SAP Hana-specific restore.
| Name |
Type |
Description |
|
objectType
|
string:
AzureWorkloadSAPHanaRestoreRequest
|
This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
|
|
propertyBag
|
object
|
Workload specific property bag.
|
|
recoveryMode
|
RecoveryMode
|
Defines whether the current recovery mode is file restore or database restore
|
|
recoveryType
|
RecoveryType
|
Type of this recovery.
|
|
resourceGuardOperationRequests
|
string[]
|
ResourceGuardOperationRequests on which LAC check will be performed
|
|
snapshotRestoreParameters
|
SnapshotRestoreParameters
|
Additional details for snapshot recovery
Currently used for snapshot for SAP Hana.
|
|
sourceResourceId
|
string
|
Fully qualified ARM ID of the VM on which workload that was running is being recovered.
|
|
targetInfo
|
TargetRestoreInfo
|
Details of target database
|
|
targetResourceGroupName
|
string
|
Defines the Resource group of the Target VM
|
|
targetVirtualMachineId
|
string
|
This is the complete ARM Id of the target VM
For e.g. /subscriptions/{subId}/resourcegroups/{rg}/provider/Microsoft.Compute/virtualmachines/{vm}
|
|
userAssignedManagedIdentityDetails
|
UserAssignedManagedIdentityDetails
|
User Assigned managed identity details
Currently used for snapshot.
|
AzureWorkloadSAPHanaRestoreWithRehydrateRequest
Object
AzureWorkload SAP Hana-specific restore with integrated rehydration of recovery point.
| Name |
Type |
Description |
|
objectType
|
string:
AzureWorkloadSAPHanaRestoreWithRehydrateRequest
|
This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
|
|
propertyBag
|
object
|
Workload specific property bag.
|
|
recoveryMode
|
RecoveryMode
|
Defines whether the current recovery mode is file restore or database restore
|
|
recoveryPointRehydrationInfo
|
RecoveryPointRehydrationInfo
|
RP Rehydration Info
|
|
recoveryType
|
RecoveryType
|
Type of this recovery.
|
|
resourceGuardOperationRequests
|
string[]
|
ResourceGuardOperationRequests on which LAC check will be performed
|
|
snapshotRestoreParameters
|
SnapshotRestoreParameters
|
Additional details for snapshot recovery
Currently used for snapshot for SAP Hana.
|
|
sourceResourceId
|
string
|
Fully qualified ARM ID of the VM on which workload that was running is being recovered.
|
|
targetInfo
|
TargetRestoreInfo
|
Details of target database
|
|
targetResourceGroupName
|
string
|
Defines the Resource group of the Target VM
|
|
targetVirtualMachineId
|
string
|
This is the complete ARM Id of the target VM
For e.g. /subscriptions/{subId}/resourcegroups/{rg}/provider/Microsoft.Compute/virtualmachines/{vm}
|
|
userAssignedManagedIdentityDetails
|
UserAssignedManagedIdentityDetails
|
User Assigned managed identity details
Currently used for snapshot.
|
AzureWorkloadSQLPointInTimeRestoreRequest
Object
AzureWorkload SQL -specific restore. Specifically for PointInTime/Log restore
| Name |
Type |
Description |
|
alternateDirectoryPaths
|
SQLDataDirectoryMapping[]
|
Data directory details
|
|
isNonRecoverable
|
boolean
|
SQL specific property where user can chose to set no-recovery when restore operation is tried
|
|
objectType
|
string:
AzureWorkloadSQLPointInTimeRestoreRequest
|
This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
|
|
pointInTime
|
string
(date-time)
|
PointInTime value
|
|
propertyBag
|
object
|
Workload specific property bag.
|
|
recoveryMode
|
RecoveryMode
|
Defines whether the current recovery mode is file restore or database restore
|
|
recoveryType
|
RecoveryType
|
Type of this recovery.
|
|
resourceGuardOperationRequests
|
string[]
|
ResourceGuardOperationRequests on which LAC check will be performed
|
|
shouldUseAlternateTargetLocation
|
boolean
|
Default option set to true. If this is set to false, alternate data directory must be provided
|
|
snapshotRestoreParameters
|
SnapshotRestoreParameters
|
Additional details for snapshot recovery
Currently used for snapshot for SAP Hana.
|
|
sourceResourceId
|
string
|
Fully qualified ARM ID of the VM on which workload that was running is being recovered.
|
|
targetInfo
|
TargetRestoreInfo
|
Details of target database
|
|
targetResourceGroupName
|
string
|
Defines the Resource group of the Target VM
|
|
targetVirtualMachineId
|
string
|
This is the complete ARM Id of the target VM
For e.g. /subscriptions/{subId}/resourcegroups/{rg}/provider/Microsoft.Compute/virtualmachines/{vm}
|
|
userAssignedManagedIdentityDetails
|
UserAssignedManagedIdentityDetails
|
User Assigned managed identity details
Currently used for snapshot.
|
AzureWorkloadSQLPointInTimeRestoreWithRehydrateRequest
Object
AzureWorkload SQL-specific restore with integrated rehydration of recovery point.
| Name |
Type |
Description |
|
alternateDirectoryPaths
|
SQLDataDirectoryMapping[]
|
Data directory details
|
|
isNonRecoverable
|
boolean
|
SQL specific property where user can chose to set no-recovery when restore operation is tried
|
|
objectType
|
string:
AzureWorkloadSQLPointInTimeRestoreWithRehydrateRequest
|
This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
|
|
pointInTime
|
string
(date-time)
|
PointInTime value
|
|
propertyBag
|
object
|
Workload specific property bag.
|
|
recoveryMode
|
RecoveryMode
|
Defines whether the current recovery mode is file restore or database restore
|
|
recoveryPointRehydrationInfo
|
RecoveryPointRehydrationInfo
|
RP Rehydration Info
|
|
recoveryType
|
RecoveryType
|
Type of this recovery.
|
|
resourceGuardOperationRequests
|
string[]
|
ResourceGuardOperationRequests on which LAC check will be performed
|
|
shouldUseAlternateTargetLocation
|
boolean
|
Default option set to true. If this is set to false, alternate data directory must be provided
|
|
snapshotRestoreParameters
|
SnapshotRestoreParameters
|
Additional details for snapshot recovery
Currently used for snapshot for SAP Hana.
|
|
sourceResourceId
|
string
|
Fully qualified ARM ID of the VM on which workload that was running is being recovered.
|
|
targetInfo
|
TargetRestoreInfo
|
Details of target database
|
|
targetResourceGroupName
|
string
|
Defines the Resource group of the Target VM
|
|
targetVirtualMachineId
|
string
|
This is the complete ARM Id of the target VM
For e.g. /subscriptions/{subId}/resourcegroups/{rg}/provider/Microsoft.Compute/virtualmachines/{vm}
|
|
userAssignedManagedIdentityDetails
|
UserAssignedManagedIdentityDetails
|
User Assigned managed identity details
Currently used for snapshot.
|
AzureWorkloadSQLRestoreRequest
Object
AzureWorkload SQL -specific restore. Specifically for full/diff restore
| Name |
Type |
Description |
|
alternateDirectoryPaths
|
SQLDataDirectoryMapping[]
|
Data directory details
|
|
isNonRecoverable
|
boolean
|
SQL specific property where user can chose to set no-recovery when restore operation is tried
|
|
objectType
|
string:
AzureWorkloadSQLRestoreRequest
|
This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
|
|
propertyBag
|
object
|
Workload specific property bag.
|
|
recoveryMode
|
RecoveryMode
|
Defines whether the current recovery mode is file restore or database restore
|
|
recoveryType
|
RecoveryType
|
Type of this recovery.
|
|
resourceGuardOperationRequests
|
string[]
|
ResourceGuardOperationRequests on which LAC check will be performed
|
|
shouldUseAlternateTargetLocation
|
boolean
|
Default option set to true. If this is set to false, alternate data directory must be provided
|
|
snapshotRestoreParameters
|
SnapshotRestoreParameters
|
Additional details for snapshot recovery
Currently used for snapshot for SAP Hana.
|
|
sourceResourceId
|
string
|
Fully qualified ARM ID of the VM on which workload that was running is being recovered.
|
|
targetInfo
|
TargetRestoreInfo
|
Details of target database
|
|
targetResourceGroupName
|
string
|
Defines the Resource group of the Target VM
|
|
targetVirtualMachineId
|
string
|
This is the complete ARM Id of the target VM
For e.g. /subscriptions/{subId}/resourcegroups/{rg}/provider/Microsoft.Compute/virtualmachines/{vm}
|
|
userAssignedManagedIdentityDetails
|
UserAssignedManagedIdentityDetails
|
User Assigned managed identity details
Currently used for snapshot.
|
AzureWorkloadSQLRestoreWithRehydrateRequest
Object
AzureWorkload SQL-specific restore with integrated rehydration of recovery point
| Name |
Type |
Description |
|
alternateDirectoryPaths
|
SQLDataDirectoryMapping[]
|
Data directory details
|
|
isNonRecoverable
|
boolean
|
SQL specific property where user can chose to set no-recovery when restore operation is tried
|
|
objectType
|
string:
AzureWorkloadSQLRestoreWithRehydrateRequest
|
This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
|
|
propertyBag
|
object
|
Workload specific property bag.
|
|
recoveryMode
|
RecoveryMode
|
Defines whether the current recovery mode is file restore or database restore
|
|
recoveryPointRehydrationInfo
|
RecoveryPointRehydrationInfo
|
RP Rehydration Info
|
|
recoveryType
|
RecoveryType
|
Type of this recovery.
|
|
resourceGuardOperationRequests
|
string[]
|
ResourceGuardOperationRequests on which LAC check will be performed
|
|
shouldUseAlternateTargetLocation
|
boolean
|
Default option set to true. If this is set to false, alternate data directory must be provided
|
|
snapshotRestoreParameters
|
SnapshotRestoreParameters
|
Additional details for snapshot recovery
Currently used for snapshot for SAP Hana.
|
|
sourceResourceId
|
string
|
Fully qualified ARM ID of the VM on which workload that was running is being recovered.
|
|
targetInfo
|
TargetRestoreInfo
|
Details of target database
|
|
targetResourceGroupName
|
string
|
Defines the Resource group of the Target VM
|
|
targetVirtualMachineId
|
string
|
This is the complete ARM Id of the target VM
For e.g. /subscriptions/{subId}/resourcegroups/{rg}/provider/Microsoft.Compute/virtualmachines/{vm}
|
|
userAssignedManagedIdentityDetails
|
UserAssignedManagedIdentityDetails
|
User Assigned managed identity details
Currently used for snapshot.
|
CopyOptions
Enumeration
Options to resolve copy conflicts.
| Value |
Description |
|
Invalid
|
|
|
CreateCopy
|
|
|
Skip
|
|
|
Overwrite
|
|
|
FailOnConflict
|
|
createdByType
Enumeration
The type of identity that created the resource.
| Value |
Description |
|
User
|
|
|
Application
|
|
|
ManagedIdentity
|
|
|
Key
|
|
DataDiskEncryptionSettings
Object
Data disk encryption settings for Secured VM. This will be used to provide Disk Encryption Set Id for each data disk.
| Name |
Type |
Description |
|
dataDiskEncryptionIdentity
|
string
(arm-id)
|
Managed Identity resource Id used to encrypt the data disk during restore.
|
|
dataDiskEncryptionSetId
|
string
(arm-id)
|
Disk Encryption Set Id for Secured VM Data Disk. This will be used for all data disks if perDiskEncryptionSetIds is not provided. If perDiskEncryptionSetIds is provided, this will be ignored.
|
|
perDiskEncryptionSetIds
|
PerDiskEncryptionSetId[]
|
Per Disk Encryption Set Ids for Secured VM Data Disks. This will be used to provide Disk Encryption Set Id for each data disk.
|
EncryptionDetails
Object
Details needed if the VM was encrypted at the time of backup.
| Name |
Type |
Description |
|
encryptionEnabled
|
boolean
|
Identifies whether this backup copy represents an encrypted VM at the time of backup.
|
|
kekUrl
|
string
|
Key Url.
|
|
kekVaultId
|
string
|
ID of Key Vault where KEK is stored.
|
|
secretKeyUrl
|
string
|
Secret Url.
|
|
secretKeyVaultId
|
string
|
ID of Key Vault where Secret is stored.
|
ErrorDetail
Object
Error Detail class which encapsulates Code, Message and Recommendations.
| Name |
Type |
Description |
|
code
|
string
|
Error code.
|
|
message
|
string
|
Error Message related to the Code.
|
|
recommendations
|
string[]
|
List of recommendation strings.
|
ErrorResponse
Object
Error response
| Name |
Type |
Description |
|
error
|
ErrorDetail
|
The error object.
|
ExtendedLocation
Object
The extended location of Recovery point where VM was present.
| Name |
Type |
Description |
|
name
|
string
|
Name of the extended location.
|
|
type
|
string
|
Type of the extended location. Possible values include: 'EdgeZone'
|
IaasVMRestoreRequest
Object
IaaS VM workload-specific restore.
| Name |
Type |
Description |
|
affinityGroup
|
string
|
Affinity group associated to VM to be restored. Used only for Classic Compute Virtual Machines.
|
|
createNewCloudService
|
boolean
|
Should a new cloud service be created while restoring the VM. If this is false, VM will be restored to the same
cloud service as it was at the time of backup.
|
|
diskEncryptionSetId
|
string
|
DiskEncryptionSet's ID - needed if the VM needs to be encrypted at rest during restore with customer managed key.
|
|
encryptionDetails
|
EncryptionDetails
|
Details needed if the VM was encrypted at the time of backup.
|
|
extendedLocation
|
ExtendedLocation
|
Target extended location where the VM should be restored,
should be null if restore is to be done in public cloud
|
|
identityBasedRestoreDetails
|
IdentityBasedRestoreDetails
|
IaaS VM workload specific restore details for restores using managed identity.
|
|
identityInfo
|
IdentityInfo
|
Managed Identity information required to access customer storage account.
|
|
objectType
|
string:
IaasVMRestoreRequest
|
This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
|
|
originalStorageAccountOption
|
boolean
|
Original Storage Account Option
|
|
recoveryPointId
|
string
|
ID of the backup copy to be recovered.
|
|
recoveryType
|
RecoveryType
|
Type of this recovery.
|
|
region
|
string
|
Region in which the virtual machine is restored.
|
|
resourceGuardOperationRequests
|
string[]
|
ResourceGuardOperationRequests on which LAC check will be performed
|
|
restoreDiskLunList
|
integer[]
(int32)
|
List of Disk LUNs for partial restore
|
|
restoreWithManagedDisks
|
boolean
|
Flag to denote of an Unmanaged disk VM should be restored with Managed disks.
|
|
securedVMDetails
|
SecuredVMDetails
|
Stores Secured VM Details
|
|
sourceResourceId
|
string
|
Fully qualified ARM ID of the VM which is being recovered.
|
|
storageAccountId
|
string
|
Fully qualified ARM ID of the storage account to which the VM has to be restored.
|
|
subnetId
|
string
|
Subnet ID, is the subnet ID associated with the to be restored VM. For Classic VMs it would be
{VnetID}/Subnet/{SubnetName} and, for the Azure Resource Manager VMs it would be ARM resource ID used to represent
the subnet.
|
|
targetDiskNetworkAccessSettings
|
TargetDiskNetworkAccessSettings
|
Specifies target network access settings for disks of VM to be restored,
|
|
targetDomainNameId
|
string
|
Fully qualified ARM ID of the domain name to be associated to the VM being restored. This applies only to Classic
Virtual Machines.
|
|
targetResourceGroupId
|
string
|
This is the ARM Id of the resource group that you want to create for this Virtual machine and other artifacts.
For e.g. /subscriptions/{subId}/resourcegroups/{rg}
|
|
targetVirtualMachineId
|
string
|
This is the complete ARM Id of the VM that will be created.
For e.g. /subscriptions/{subId}/resourcegroups/{rg}/provider/Microsoft.Compute/virtualmachines/{vm}
|
|
virtualNetworkId
|
string
|
This is the virtual network Id of the vnet that will be attached to the virtual machine.
User will be validated for join action permissions in the linked access.
|
|
zones
|
string[]
|
Target zone where the VM and its disks should be restored.
|
IaasVMRestoreWithRehydrationRequest
Object
IaaS VM workload-specific restore with integrated rehydration of recovery point.
| Name |
Type |
Description |
|
affinityGroup
|
string
|
Affinity group associated to VM to be restored. Used only for Classic Compute Virtual Machines.
|
|
createNewCloudService
|
boolean
|
Should a new cloud service be created while restoring the VM. If this is false, VM will be restored to the same
cloud service as it was at the time of backup.
|
|
diskEncryptionSetId
|
string
|
DiskEncryptionSet's ID - needed if the VM needs to be encrypted at rest during restore with customer managed key.
|
|
encryptionDetails
|
EncryptionDetails
|
Details needed if the VM was encrypted at the time of backup.
|
|
extendedLocation
|
ExtendedLocation
|
Target extended location where the VM should be restored,
should be null if restore is to be done in public cloud
|
|
identityBasedRestoreDetails
|
IdentityBasedRestoreDetails
|
IaaS VM workload specific restore details for restores using managed identity.
|
|
identityInfo
|
IdentityInfo
|
Managed Identity information required to access customer storage account.
|
|
objectType
|
string:
IaasVMRestoreWithRehydrationRequest
|
This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
|
|
originalStorageAccountOption
|
boolean
|
Original Storage Account Option
|
|
recoveryPointId
|
string
|
ID of the backup copy to be recovered.
|
|
recoveryPointRehydrationInfo
|
RecoveryPointRehydrationInfo
|
RP Rehydration Info
|
|
recoveryType
|
RecoveryType
|
Type of this recovery.
|
|
region
|
string
|
Region in which the virtual machine is restored.
|
|
resourceGuardOperationRequests
|
string[]
|
ResourceGuardOperationRequests on which LAC check will be performed
|
|
restoreDiskLunList
|
integer[]
(int32)
|
List of Disk LUNs for partial restore
|
|
restoreWithManagedDisks
|
boolean
|
Flag to denote of an Unmanaged disk VM should be restored with Managed disks.
|
|
securedVMDetails
|
SecuredVMDetails
|
Stores Secured VM Details
|
|
sourceResourceId
|
string
|
Fully qualified ARM ID of the VM which is being recovered.
|
|
storageAccountId
|
string
|
Fully qualified ARM ID of the storage account to which the VM has to be restored.
|
|
subnetId
|
string
|
Subnet ID, is the subnet ID associated with the to be restored VM. For Classic VMs it would be
{VnetID}/Subnet/{SubnetName} and, for the Azure Resource Manager VMs it would be ARM resource ID used to represent
the subnet.
|
|
targetDiskNetworkAccessSettings
|
TargetDiskNetworkAccessSettings
|
Specifies target network access settings for disks of VM to be restored,
|
|
targetDomainNameId
|
string
|
Fully qualified ARM ID of the domain name to be associated to the VM being restored. This applies only to Classic
Virtual Machines.
|
|
targetResourceGroupId
|
string
|
This is the ARM Id of the resource group that you want to create for this Virtual machine and other artifacts.
For e.g. /subscriptions/{subId}/resourcegroups/{rg}
|
|
targetVirtualMachineId
|
string
|
This is the complete ARM Id of the VM that will be created.
For e.g. /subscriptions/{subId}/resourcegroups/{rg}/provider/Microsoft.Compute/virtualmachines/{vm}
|
|
virtualNetworkId
|
string
|
This is the virtual network Id of the vnet that will be attached to the virtual machine.
User will be validated for join action permissions in the linked access.
|
|
zones
|
string[]
|
Target zone where the VM and its disks should be restored.
|
IdentityBasedRestoreDetails
Object
IaaS VM workload specific restore details for restores using managed identity
| Name |
Type |
Description |
|
objectType
|
string
|
Gets the class type.
|
|
targetStorageAccountId
|
string
|
Fully qualified ARM ID of the target storage account.
|
IdentityInfo
Object
Encapsulates Managed Identity related information
| Name |
Type |
Description |
|
isSystemAssignedIdentity
|
boolean
|
To differentiate if the managed identity is system assigned or user assigned
|
|
managedIdentityResourceId
|
string
|
Managed Identity Resource Id
Optional: Might not be required in the case of system assigned managed identity
|
OverwriteOptions
Enumeration
Can Overwrite if Target DataBase already exists
| Value |
Description |
|
Invalid
|
|
|
FailOnConflict
|
|
|
Overwrite
|
|
PerDiskEncryptionSetId
Object
Per Disk Encryption Set Ids for Secured VM Data Disks. This will be used to provide Disk Encryption Set Id for each data disk.
| Name |
Type |
Description |
|
diskEncryptionSetId
|
string
(arm-id)
|
Disk Encryption Set Id for Secured VM Data Disk
|
|
lun
|
integer
(int32)
|
LUN for Secured VM Data Disk
|
RecoveryMode
Enumeration
Defines whether the current recovery mode is file restore or database restore
| Value |
Description |
|
Invalid
|
|
|
FileRecovery
|
|
|
WorkloadRecovery
|
|
|
SnapshotAttach
|
|
|
RecoveryUsingSnapshot
|
|
|
SnapshotAttachAndRecover
|
|
RecoveryPointRehydrationInfo
Object
RP Rehydration Info
| Name |
Type |
Description |
|
rehydrationPriority
|
RehydrationPriority
|
Rehydration Priority
|
|
rehydrationRetentionDuration
|
string
|
How long the rehydrated RP should be kept
Should be ISO8601 Duration format e.g. "P7D"
|
RecoveryType
Enumeration
Type of this recovery.
| Value |
Description |
|
Invalid
|
|
|
OriginalLocation
|
|
|
AlternateLocation
|
|
|
RestoreDisks
|
|
|
Offline
|
|
RehydrationPriority
Enumeration
Rehydration Priority
| Value |
Description |
|
Standard
|
|
|
High
|
|
RestoreFileSpecs
Object
Restore file specs like file path, type and target folder path info.
| Name |
Type |
Description |
|
fileSpecType
|
string
|
Indicates what the Path variable stands for
|
|
path
|
string
|
Source File/Folder path
|
|
targetFolderPath
|
string
|
Destination folder path in target FileShare
|
RestoreRequestResource
Object
Base class for restore request. Workload-specific restore requests are derived from this class.
| Name |
Type |
Description |
|
eTag
|
string
|
Optional ETag.
|
|
id
|
string
|
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
|
|
location
|
string
|
Resource location.
|
|
name
|
string
|
The name of the resource
|
|
properties
|
RestoreRequest:
|
RestoreRequestResource properties
|
|
systemData
|
systemData
|
Azure Resource Manager metadata containing createdBy and modifiedBy information.
|
|
tags
|
object
|
Resource tags.
|
|
type
|
string
|
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
|
RestoreRequestType
Enumeration
Restore Type (FullShareRestore or ItemLevelRestore)
| Value |
Description |
|
Invalid
|
|
|
FullShareRestore
|
|
|
ItemLevelRestore
|
|
SecuredVMDetails
Object
Restore request parameters for Secured VMs
| Name |
Type |
Description |
|
dataDiskEncryptionSettings
|
DataDiskEncryptionSettings
|
Data disk encryption settings for Secured VM. This will be used to provide Disk Encryption Set Id for each data disk.
|
|
securedVMOsDiskEncryptionSetId
|
string
|
Gets or Sets Disk Encryption Set Id for Secured VM OS Disk
|
SnapshotRestoreParameters
Object
Encapsulates information regarding snapshot recovery for SAP Hana
| Name |
Type |
Description |
|
logPointInTimeForDBRecovery
|
string
|
|
|
skipAttachAndMount
|
boolean
|
|
SQLDataDirectoryMapping
Object
Encapsulates information regarding data directory
| Name |
Type |
Description |
|
mappingType
|
SQLDataDirectoryType
|
Type of data directory mapping
|
|
sourceLogicalName
|
string
|
Restore source logical name path
|
|
sourcePath
|
string
|
Restore source path
|
|
targetPath
|
string
|
Target path
|
SQLDataDirectoryType
Enumeration
Type of data directory mapping
| Value |
Description |
|
Invalid
|
|
|
Data
|
|
|
Log
|
|
systemData
Object
Metadata pertaining to creation and last modification of the resource.
| Name |
Type |
Description |
|
createdAt
|
string
(date-time)
|
The timestamp of resource creation (UTC).
|
|
createdBy
|
string
|
The identity that created the resource.
|
|
createdByType
|
createdByType
|
The type of identity that created the resource.
|
|
lastModifiedAt
|
string
(date-time)
|
The timestamp of resource last modification (UTC)
|
|
lastModifiedBy
|
string
|
The identity that last modified the resource.
|
|
lastModifiedByType
|
createdByType
|
The type of identity that last modified the resource.
|
TargetAFSRestoreInfo
Object
Target Azure File Share Info.
| Name |
Type |
Description |
|
name
|
string
|
File share name
|
|
targetResourceId
|
string
|
Target file share resource ARM ID
|
TargetDiskNetworkAccessOption
Enumeration
Network access settings to be used for restored disks
| Value |
Description |
|
SameAsOnSourceDisks
|
|
|
EnablePrivateAccessForAllDisks
|
|
|
EnablePublicAccessForAllDisks
|
|
TargetDiskNetworkAccessSettings
Object
Specifies target network access settings for disks of VM to be restored.
| Name |
Type |
Description |
|
targetDiskAccessId
|
string
|
Gets or sets the ARM resource ID of the target disk access to be used when TargetDiskNetworkAccessOption is set to TargetDiskNetworkAccessOption.UseNew
|
|
targetDiskNetworkAccessOption
|
TargetDiskNetworkAccessOption
|
Network access settings to be used for restored disks
|
TargetRestoreInfo
Object
Details about target workload during restore operation.
| Name |
Type |
Description |
|
containerId
|
string
|
Resource Id name of the container in which Target DataBase resides
|
|
databaseName
|
string
|
Database name InstanceName/DataBaseName for SQL or System/DbName for SAP Hana
|
|
overwriteOption
|
OverwriteOptions
|
Can Overwrite if Target DataBase already exists
|
|
targetDirectoryForFileRestore
|
string
|
Target directory location for restore as files.
|
UserAssignedIdentityProperties
Object
User assigned managed identity properties
| Name |
Type |
Description |
|
clientId
|
string
|
The client ID of the assigned identity.
|
|
principalId
|
string
|
The principal ID of the assigned identity.
|
UserAssignedManagedIdentityDetails
Object
User assigned managed identity details
| Name |
Type |
Description |
|
identityArmId
|
string
|
The ARM id of the assigned identity.
|
|
identityName
|
string
|
The name of the assigned identity.
|
|
userAssignedIdentityProperties
|
UserAssignedIdentityProperties
|
User assigned managed identity properties
|