Restores - Trigger

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=2024-04-01

URI Parameters

Name In Required Type Description
containerName
path True

string

Container name associated with the backed up items.

fabricName
path True

string

Fabric name associated with the backed up items.

protectedItemName
path True

string

Backed up item to be restored.

recoveryPointId
path True

string

Recovery point ID which represents the backed up data to be restored.

resourceGroupName
path True

string

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

subscriptionId
path True

string

The subscription Id.

vaultName
path True

string

The name of the recovery services vault.

api-version
query True

string

Client Api Version.

Request Header

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

Accepted

Other Status Codes

CloudError

Error response describing why the operation failed.

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 Disks with IaasVMRestoreRequest
Restore Disks with IaasVMRestoreRequest with IdentityBasedRestoreDetails
Restore Disks with IaasVMRestoreWithRehydrationRequest
Restore to New Azure IaasVm with IaasVMRestoreRequest
Restore to New Azure IaasVm with IaasVMRestoreRequest with identityBasedRestoreDetails
Restore to New Azure IaasVm with IaasVMRestoreWithRehydrationRequest

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=2024-04-01

{
  "properties": {
    "objectType": "IaasVMRestoreRequest",
    "recoveryPointId": "348916168024334",
    "recoveryType": "RestoreDisks",
    "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",
    "region": "southeastasia",
    "createNewCloudService": true,
    "originalStorageAccountOption": false,
    "encryptionDetails": {
      "encryptionEnabled": false
    },
    "identityInfo": {
      "isSystemAssignedIdentity": false,
      "managedIdentityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/asmaskarRG1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/asmaskartestmsi"
    },
    "targetDiskNetworkAccessSettings": {
      "targetDiskNetworkAccessOption": "EnablePrivateAccessForAllDisks",
      "targetDiskAccessId": "/subscriptions/e7a191f5-713c-4bdb-b5e4-cf3dd90230ef/resourceGroups/arpja/providers/Microsoft.Compute/diskAccesses/arpja-diskaccess-ccy"
    }
  }
}

Sample response

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
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
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=2024-04-01

{
  "properties": {
    "objectType": "IaasVMRestoreRequest",
    "recoveryPointId": "348916168024334",
    "recoveryType": "RestoreDisks",
    "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1",
    "region": "southeastasia",
    "createNewCloudService": true,
    "originalStorageAccountOption": false,
    "encryptionDetails": {
      "encryptionEnabled": false
    },
    "identityInfo": {
      "isSystemAssignedIdentity": false,
      "managedIdentityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/asmaskarRG1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/asmaskartestmsi"
    },
    "identityBasedRestoreDetails": {
      "targetStorageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testingRg/providers/Microsoft.Storage/storageAccounts/testAccount"
    }
  }
}

Sample response

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
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
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=2024-04-01

{
  "properties": {
    "objectType": "IaasVMRestoreWithRehydrationRequest",
    "recoveryPointId": "348916168024334",
    "recoveryType": "RestoreDisks",
    "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",
    "region": "southeastasia",
    "createNewCloudService": true,
    "originalStorageAccountOption": false,
    "encryptionDetails": {
      "encryptionEnabled": false
    },
    "recoveryPointRehydrationInfo": {
      "rehydrationRetentionDuration": "P7D",
      "rehydrationPriority": "Standard"
    }
  }
}

Sample response

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
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
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=2024-04-01

{
  "properties": {
    "objectType": "IaasVMRestoreRequest",
    "recoveryPointId": "348916168024334",
    "recoveryType": "AlternateLocation",
    "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1",
    "targetVirtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2/providers/Microsoft.Compute/virtualmachines/RSMDALRVM981435",
    "targetResourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2",
    "storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Storage/storageAccounts/testingAccount",
    "virtualNetworkId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet",
    "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet/subnets/default",
    "region": "southeastasia",
    "createNewCloudService": false,
    "originalStorageAccountOption": false,
    "encryptionDetails": {
      "encryptionEnabled": false
    },
    "identityInfo": {
      "isSystemAssignedIdentity": true
    }
  }
}

Sample response

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
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
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=2024-04-01

{
  "properties": {
    "objectType": "IaasVMRestoreRequest",
    "recoveryPointId": "348916168024334",
    "recoveryType": "AlternateLocation",
    "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1",
    "targetVirtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2/providers/Microsoft.Compute/virtualmachines/RSMDALRVM981435",
    "targetResourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2",
    "virtualNetworkId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet",
    "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet/subnets/default",
    "region": "southeastasia",
    "createNewCloudService": false,
    "originalStorageAccountOption": false,
    "encryptionDetails": {
      "encryptionEnabled": false
    },
    "identityInfo": {
      "isSystemAssignedIdentity": true
    },
    "identityBasedRestoreDetails": {
      "targetStorageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Storage/storageAccounts/testingAccount"
    }
  }
}

Sample response

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
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
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=2024-04-01

{
  "properties": {
    "objectType": "IaasVMRestoreWithRehydrationRequest",
    "recoveryPointId": "348916168024334",
    "recoveryType": "AlternateLocation",
    "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1",
    "targetVirtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2/providers/Microsoft.Compute/virtualmachines/RSMDALRVM981435",
    "targetResourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2",
    "storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Storage/storageAccounts/testingAccount",
    "virtualNetworkId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet",
    "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet/subnets/default",
    "region": "southeastasia",
    "createNewCloudService": false,
    "originalStorageAccountOption": false,
    "encryptionDetails": {
      "encryptionEnabled": false
    },
    "recoveryPointRehydrationInfo": {
      "rehydrationRetentionDuration": "P7D",
      "rehydrationPriority": "High"
    }
  }
}

Sample response

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
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
Retry-After: 60

Definitions

Name Description
AzureFileShareRestoreRequest

AzureFileShare Restore Request

AzureWorkloadPointInTimeRestoreRequest

AzureWorkload SAP Hana -specific restore. Specifically for PointInTime/Log restore

AzureWorkloadRestoreRequest

AzureWorkload-specific restore.

AzureWorkloadSAPHanaPointInTimeRestoreRequest

AzureWorkload SAP Hana -specific restore. Specifically for PointInTime/Log restore

AzureWorkloadSAPHanaPointInTimeRestoreWithRehydrateRequest

AzureWorkload SAP Hana-specific restore with integrated rehydration of recovery point.

AzureWorkloadSAPHanaRestoreRequest

AzureWorkload SAP Hana-specific restore.

AzureWorkloadSAPHanaRestoreWithRehydrateRequest

AzureWorkload SAP Hana-specific restore with integrated rehydration of recovery point.

AzureWorkloadSQLPointInTimeRestoreRequest

AzureWorkload SQL -specific restore. Specifically for PointInTime/Log restore

AzureWorkloadSQLPointInTimeRestoreWithRehydrateRequest

AzureWorkload SQL-specific restore with integrated rehydration of recovery point.

AzureWorkloadSQLRestoreRequest

AzureWorkload SQL -specific restore. Specifically for full/diff restore

AzureWorkloadSQLRestoreWithRehydrateRequest

AzureWorkload SQL-specific restore with integrated rehydration of recovery point

CloudError

An error response from the Container Instance service.

CloudErrorBody

An error response from the Container Instance service.

CopyOptions

Options to resolve copy conflicts.

EncryptionDetails

Details needed if the VM was encrypted at the time of backup.

ErrorAdditionalInfo

The resource management error additional info.

ExtendedLocation

The extended location of Recovery point where VM was present.

IaasVMRestoreRequest

IaaS VM workload-specific restore.

IaasVMRestoreWithRehydrationRequest

IaaS VM workload-specific restore with integrated rehydration of recovery point.

IdentityBasedRestoreDetails

IaaS VM workload specific restore details for restores using managed identity

IdentityInfo

Encapsulates Managed Identity related information

OverwriteOptions

Can Overwrite if Target DataBase already exists

RecoveryMode

Defines whether the current recovery mode is file restore or database restore

RecoveryPointRehydrationInfo

RP Rehydration Info

RecoveryType

Type of this recovery.

RehydrationPriority

Rehydration Priority

RestoreFileSpecs

Restore file specs like file path, type and target folder path info.

RestoreRequestResource

Base class for restore request. Workload-specific restore requests are derived from this class.

RestoreRequestType

Restore Type (FullShareRestore or ItemLevelRestore)

SecuredVMDetails

Restore request parameters for Secured VMs

SnapshotRestoreParameters

Encapsulates information regarding snapshot recovery for SAP Hana

SQLDataDirectoryMapping

Encapsulates information regarding data directory

SQLDataDirectoryType

Type of data directory mapping

TargetAFSRestoreInfo

Target Azure File Share Info.

TargetDiskNetworkAccessOption

Network access settings to be used for restored disks

TargetDiskNetworkAccessSettings

Specifies target network access settings for disks of VM to be restored.

TargetRestoreInfo

Details about target workload during restore operation.

UserAssignedIdentityProperties

User assigned managed identity properties

UserAssignedManagedIdentityDetails

User assigned managed identity details

AzureFileShareRestoreRequest

AzureFileShare Restore Request

Name Type Description
copyOptions

CopyOptions

Options to resolve copy conflicts.

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

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

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

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.

AzureWorkloadSAPHanaPointInTimeRestoreRequest

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

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

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

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

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

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

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

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

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

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

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

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.

CloudError

An error response from the Container Instance service.

Name Type Description
error

CloudErrorBody

The error object.

CloudErrorBody

An error response from the Container Instance service.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

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

details

CloudErrorBody[]

A list of additional details about the error.

message

string

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

target

string

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

CopyOptions

Options to resolve copy conflicts.

Name Type Description
CreateCopy

string

FailOnConflict

string

Invalid

string

Overwrite

string

Skip

string

EncryptionDetails

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.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ExtendedLocation

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

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[]

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

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[]

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

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

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

Can Overwrite if Target DataBase already exists

Name Type Description
FailOnConflict

string

Invalid

string

Overwrite

string

RecoveryMode

Defines whether the current recovery mode is file restore or database restore

Name Type Description
FileRecovery

string

Invalid

string

RecoveryUsingSnapshot

string

SnapshotAttach

string

SnapshotAttachAndRecover

string

WorkloadRecovery

string

RecoveryPointRehydrationInfo

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

Type of this recovery.

Name Type Description
AlternateLocation

string

Invalid

string

Offline

string

OriginalLocation

string

RestoreDisks

string

RehydrationPriority

Rehydration Priority

Name Type Description
High

string

Standard

string

RestoreFileSpecs

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

Base class for restore request. Workload-specific restore requests are derived from this class.

Name Type Description
eTag

string

Optional ETag.

id

string

Resource Id represents the complete path to the resource.

location

string

Resource location.

name

string

Resource name associated with the resource.

properties RestoreRequest:

RestoreRequestResource properties

tags

object

Resource tags.

type

string

Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...

RestoreRequestType

Restore Type (FullShareRestore or ItemLevelRestore)

Name Type Description
FullShareRestore

string

Invalid

string

ItemLevelRestore

string

SecuredVMDetails

Restore request parameters for Secured VMs

Name Type Description
securedVMOsDiskEncryptionSetId

string

Gets or Sets Disk Encryption Set Id for Secured VM OS Disk

SnapshotRestoreParameters

Encapsulates information regarding snapshot recovery for SAP Hana

Name Type Description
logPointInTimeForDBRecovery

string

skipAttachAndMount

boolean

SQLDataDirectoryMapping

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

Type of data directory mapping

Name Type Description
Data

string

Invalid

string

Log

string

TargetAFSRestoreInfo

Target Azure File Share Info.

Name Type Description
name

string

File share name

targetResourceId

string

Target file share resource ARM ID

TargetDiskNetworkAccessOption

Network access settings to be used for restored disks

Name Type Description
EnablePrivateAccessForAllDisks

string

EnablePublicAccessForAllDisks

string

SameAsOnSourceDisks

string

TargetDiskNetworkAccessSettings

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

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

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

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