The recovery name must be unique within the protection scope.
The new resource group will follow the format: -.
(Required)
recoveryRegion string
Specifies the Azure region where the recovery operation will be performed.
Notes:
Must be a valid Azure region name.
(Required)
protectionId string
Specifies the ID of the protection item to be recovered.
Notes:
Must be a valid timeline item ID.
(Required)
recoveryType string
Possible values: [ENTIRE_ASSEMBLY, SELECTED_RESOURCE_GROUPS, SELECTED_RESOURCE]
Specifies the type of recovery operation to be performed.
Allowed values:
ENTIRE_ASSEMBLY
SELECTED_RESOURCE_GROUP
SELECTED_RESOURCE
(Required)
resources string[]
Specifies the list of resource IDs to be recovered.
Notes:
Required if recoveryType is set to SELECTED_RESOURCE.
Each entry must be a valid Azure resource ID.
resourceGroups string[]
Specifies the list of resource groups to be recovered.
Notes:
Required if recoveryType is set to SELECTED_RESOURCE_GROUP.
Each entry must be a valid Azure resource group.
recoveryProfileId string
Specifies the ID of the recovery profile containing predefined recovery configurations.
If the configurations are already defined in the recovery profile, specifying recoveryConfiguration is not required.
Notes:
Must be a valid recovery profile ID.
recoveryProfileAssociationType string
Possible values: [CLOUD_CONNECTION, CLOUD_ASSEMBLY]
Specifies the type of recovery profile association.
Allowed values:
CLOUD_ASSEMBLY
enableCrossCloudConnectionRecovery boolean
Flag to enable cross-cloud connection recovery
targetCloudConnectionId int64
Specifies the cloud connection ID where the recovery should be performed.
Notes:
Must be a valid cloud connection ID.
Required only if cross-subscription or cloud-connection recovery is enabled.
recoveryConfiguration object
The recovery configurations option object.
enableRecoverWithDependency boolean
Enables recovery of resources along with their dependencies.
When enabled, it overrides all dependencies of the selected resources.
Default: FALSE if not specified.
enableCreateScaleSetWithZeroInstance boolean
Enables recovery of a virtual machine scale set without its virtual machine instances.
Default: FALSE if not specified.
enableIsolatedServerlessRecovery boolean
Enables isolated serverless recovery.
Default: FALSE if not specified.
enablePrivateIpRetention boolean
Enables retention of the private IP address of the resource.
Notes:
Must be disabled when recovering the same resource group in the same region to avoid errors from Azure.
Default: TRUE if not specified.
enableSkipProtection boolean
Enables skipping protection for the recovered resource.
Default: FALSE if not specified.
enableVnetMapping boolean
Enables configuration of VNet mapping options.
Notes:
Used when the application needs to be recovered to an existing virtual network (VNet).
If the CIDR ranges of the VNets do not match, set enablePrivateIpRetention to FALSE for successful recovery.
Default: FALSE if not specified.
vnetMapping object[]
Virtual network mapping configuration
sourceVnetId string
Specifies the source virtual network (VNet) ID for VNet mapping.
Notes:
Required only if the recovery option EnableVnetMappingData is enabled.
targetVnetId string
Specifies the target virtual network (VNet) ID for VNet mapping.
Notes:
Required only if the recovery option EnableVnetMappingData is enabled.
subnetMapping object
Specifies the subnet mapping configuration.
Notes:
Required only if the recovery option EnableVnetMappingData is enabled.
property name* string
enableResourceMapping boolean
Enables resource mapping during recovery.
Notes:
Contains the source and destination resource IDs that should be replaced during recovery.
Default: FALSE if not specified.
resourceMapping object[]
Specifies the resource mapping details used during recovery.
Notes:
Contains the source and destination resource IDs to be replaced if resource mapping is enabled.
mappingType string
Possible values: [VM_SIZE, PROXIMITY_PLACEMENT_GROUP, NEW_RESOURCE_GROUP, EXISTING_RESOURCE_GROUP]
Specifies the type of resource mapping.
Allowed values:
VM_SIZE
PROXIMITY_PLACEMENT_GROUP
EXISTING_RESOURCE_GROUP
NEW_RESOURCE_GROUP
Details:
PROXIMITY_PLACEMENT_GROUP: Maps one proximity placement group to another.
Example:
{
"/subscriptions/ab123456-aa12-abcd-12c-abcdefghijkl/resourceGroups/appservice1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" :
"/subscriptions/ab123456-aa12-abcd-12c-abcdefghijkl/resourceGroups/appservice1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1"
}
VM_SIZE: Maps a virtual machine size to another size.
Example: {"Standard_B1ls":"Standard_DS2_v2"}
EXISTING_RESOURCE_GROUP: Maps a resource group to an existing resource group.
Notes:
Recovery may override existing resource configurations or fail if resource name conflicts occur. As a result, the recovery reset cannot be performed.
Format: <SourceResourceGroupName, TargetResourceGroupName>
Example: {"SourceResourceGroupName":"TargetResourceGroupName"}
NEW_RESOURCE_GROUP: Maps a resource group to a new resource group.
Format: <SourceResourceGroupName, NewTargetResourceGroupName>
Example: {"SourceResourceGroupName":"new-rg-name"}
mappings object
Resource mappings configuration It is a map of source id and target id
property name* string
scheduleResetOption object
Specifies whether to reset the recovery after completion.
Enabling this option will delete the recovered resources, typically used for testing purposes.
resetFrequency string
Possible values: [HOURS, DAYS]
Specifies the frequency for schedule reset, defining the time unit used.