Skip to main content

Create​

Create Azure Cloud Assembly recovery profile

Path Parameters
  • accountId int64 required

    Cloud Rewind account ID.

    Example: 12345678
  • projectId string required

    Cloud Rewind project ID.

    Example: 123456
  • cloudAssemblyId int64 required

    Azure Cloud assembly ID.

    Example: 1234
Request Body required
  • name string

    Specifies the name of the recovery profile.

    (Required)

  • description string

    Provides a description of the recovery profile.

  • sourceRegion string

    Specifies the source region for the recovery profile.

    (Required)

  • recoveryRegion string

    Specifies the recovery region for the recovery profile.

    (Required)

  • 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
  • recoveryWebhook object[]

    Recovery webhook configuration

  • type string

    Specifies the type of webhook trigger.

    Notes:

    • Required only if the recovery option EnableVnetMappingData is enabled.

    Allowed values:

    • POST_RECOVERY
    • PRE_RECOVERY
    • PRE_RESET
    • POST_RESET
  • data object

    Webhook data configuration

  • url string

    URL endpoint for the webhook

  • timeout int32

    Timeout duration for webhook in seconds

  • retryAttempts int32

    Number of retry attempts for webhook

  • failOnError boolean

    Flag to fail recovery on webhook error

  • authenticationHeaders string

    Authentication headers for webhook

  • authenticationType string

    Type of authentication for webhook

  • headers string

    Additional headers for webhook

Responses

OK

Schema
  • tenantId string

    Tenant identifier owning the recovery profile

  • projectId int64

    Project identifier associated with the recovery profile

  • cloudAssemblyId int64

    Cloud assembly identifier

  • id int64

    Unique identifier of the recovery profile

  • name string

    Specifies the name of the recovery profile.

    (Required)

  • description string

    Provides a description of the recovery profile.

  • cloudType string

    Cloud provider type

  • configurations object[]

    List of configuration items for the recovery profile

  • name string
  • type string
  • description string
  • isEnabled boolean
  • options object
  • createdAt date-time

    Timestamp when the recovery profile was created (epoch millis)

Loading...