Skip to main content

Create

Create Azure Cloud Assembly

Path Parameters
  • accountId int64 required

    Cloud Rewind account ID.

    Example: 12345678
  • projectId string required

    Cloud Rewind project ID.

    Example: 123456
Request Body required
  • name string

    Specifies the name of the assembly.

    Constraints:

    • Must match the regex: ^[a-zA-Z][a-zA-Z0-9-]{2,29}$
    • Length: 3-30 characters
    • Must start with a letter
    • Allowed characters: letters, numbers, and hyphens

    (Required)

  • description string

    Description of the Azure protection.

  • cloudConnectionId int64

    Specifies the cloud connection ID used for the protection.

    (Required)

  • region string

    Possible values: [all, eastus, eastus2, southcentralus, westus2, australiaeast, southeastasia, northeurope, uksouth, westeurope, centralus, northcentralus, westus, southafricanorth, centralindia, eastasia, japaneast, koreacentral, canadacentral, francecentral, germanywestcentral, norwayeast, switzerlandnorth, uaenorth, brazilsouth, centraluseuap, eastus2euap, westcentralus, southafricawest, australiacentral, australiacentral2, australiasoutheast, japanwest, koreasouth, southindia, westindia, canadaeast, francesouth, germanynorth, swedencentral, westus3, norwaywest, switzerlandwest, ukwest, uaecentral, brazilsoutheast, italynorth, polandcentral, spaincentral, mexicocentral, israelcentral, qatarcentral, global, jioindiawest, jioindiacentral]

    Specifies the source region for the protection.

    Constraints:

    • Must not be null
    • Must be a valid Azure region
  • resourceSelectionStrategy object

    Defines the strategy for selecting resources to be protected.

  • selectionType string

    Possible values: [RESOURCE_GROUP, TAGS]

    Specifies the type of resource selection strategy.

    Optional.

    Allowed values:

    • RESOURCE_GROUP
    • TAG
  • tags object[]

    Specifies a map of tag key-value pairs used for resource selection when resourceSelectionType is TAG.

    Optional: Required if resourceSelectionType is TAG; must not be null or empty in that case.

  • key string

    Key of the tag

  • value string

    Value of the tag

  • conditions string

    Possible values: [MATCH_ALL_TAGS, MATCH_ATLEAST_ONE_TAG]

    Specifies the condition logic applied when matching tags for resource selection.

    Optional: Required if resourceSelectionType is TAG; must not be null or empty in that case.

    Allowed values:

    • MATCH_ALL_TAGS
    • MATCH_ATLEAST_ONE_TAG
  • excludeTagStrategy object

    Specifies the configuration for excluding resources based on tags during selection.

  • isEnabled boolean

    Flag to indicate whether exclude tag strategy is enabled. (Optional)

  • excludedTags object[]

    Specifies a list of tags used to exclude resources from protection.

    Optional: Required if isEnabled is true; must not be null or empty in that case.

  • key string

    Key of the tag

  • value string

    Value of the tag

  • conditions string

    Possible values: [MATCH_ALL_TAGS, MATCH_ATLEAST_ONE_TAG]

    Specifies the conditions for tag matching.

    Optional: Required if isEnabled is true; must not be null or empty in that case.

    Allowed values:

    • MATCH_ALL_TAGS
    • MATCH_ATLEAST_ONE_TAG
  • resourceGroups string[]

    Specifies the list of Azure resource group IDs to include.

    Constraints:

    • If resourceGroupSelectionType is SELECTED_RESOURCE_GROUP, this field must not be null or empty.
    • If resourceGroupSelectionType is ALL, this field can be null.
    • Each value must match the regex: ^/subscriptions/[a-fA-F0-9\-]+/resourceGroups/[a-zA-Z0-9-_\.]{1,90}$
  • replicaRegions string[]

    Possible values: [all, eastus, eastus2, southcentralus, westus2, australiaeast, southeastasia, northeurope, uksouth, westeurope, centralus, northcentralus, westus, southafricanorth, centralindia, eastasia, japaneast, koreacentral, canadacentral, francecentral, germanywestcentral, norwayeast, switzerlandnorth, uaenorth, brazilsouth, centraluseuap, eastus2euap, westcentralus, southafricawest, australiacentral, australiacentral2, australiasoutheast, japanwest, koreasouth, southindia, westindia, canadaeast, francesouth, germanynorth, swedencentral, westus3, norwaywest, switzerlandwest, ukwest, uaecentral, brazilsoutheast, italynorth, polandcentral, spaincentral, mexicocentral, israelcentral, qatarcentral, global, jioindiawest, jioindiacentral]

    List of replica region names.

  • policyTemplateId int64

    Specifies the policy template ID applied to the protection.

    Optional: If not provided, the default policy template (Daily) will be used.

  • policyActivation string

    Possible values: [IMMEDIATE, BY_POLICY]

    Specifies how the policy is activated for this protection.

    Optional: Required only if policyTemplateId is provided.

    Allowed values:

    • IMMEDIATE
    • BY_POLICY
  • isStorageAccountOnly boolean

    Indicates whether only storage accounts are included in the protection.

    (Required)

  • protectionStrategyOptions object

    Container for Azure-specific protection strategy option objects.

    Notes:

    • Can be null if isConfigurationAssembly is true.
    • Must not be null if isConfigurationAssembly is false.
  • azureSnapshotProtectionStrategyOption object

    Specifies the snapshot protection strategy, including the source resource group and replication details.

  • sourceResourceGroupName string

    Source resource group used for snapshot based protection.

  • azureSnapshotReplicationDetails object[]

    Specifies a list of snapshot replication detail objects, including region and resource group information.

  • resourceGroupName string

    Name of the replica resource group.

  • replicaRegion string

    Replica region where data is copied.

  • azureServerlessProtectionStrategyOption object

    Serverless (e.g., storage account) strategy option with replication details.

  • sourceStorageAccountId string

    Source storage account ID for serverless protection.

  • azureServerlessReplicationDetails object[]

    List of serverless replication detail objects (region, storage account).

  • replicaRegion string

    Replica region where data is copied.

  • storageAccountId string

    Replica storage account ID.

  • azureStorageAccountProtectionStrategyOption object

    Specifies the storage account protection strategy, including container configuration and region mappings.

  • containerName string

    Name of the storage container to protect.

  • containerRenameType string

    Possible values: [NONE, PREFIX, SUFFIX]

    Specifies the strategy for renaming containers during recovery.

    Allowed values:

    • NONE
    • PREFIX
    • SUFFIX
  • storageAccountRegionMap object

    Specifies the mapping of source storage accounts to target region and account information.

    Format: {sourceSa:{region:targetRegion, storageAccount:targetSa}}

  • property name* string
  • isConfigurationAssembly boolean

    Indicates whether the cloud assembly is configuration-only (no data protection).

  • tags object

    Specifies a map of tag key-value pairs used for resource selection when resourceSelectionType is TAG.

    Optional: Required if resourceSelectionType is TAG; must not be null or empty in that case.

  • property name* string
  • resourceGroupSelectionType string

    Possible values: [ALL, SELECTED_RESOURCE_GROUP]

    Specifies the type of resource group selection.

    Constraints:

    • Must not be null.
    • Allowed values: SELECTED_RESOURCE_GROUP, ALL
Responses

OK


Schema
  • accountId int64

    Cloud Rewind account ID.

  • projectId int64

    Cloud Rewind project ID.

  • id int64

    Cloud assembly ID.

  • name string

    Specifies the name of the assembly.

    Constraints:

    • Must match the regex: ^[a-zA-Z][a-zA-Z0-9-]{2,29}$
    • Length: 3-30 characters
    • Must start with a letter
    • Allowed characters: letters, numbers, and hyphens

    (Required)

  • description string

    Description of the Azure protection.

  • cloudConnectionId int64

    Specifies the cloud connection ID used for the protection.

    (Required)

  • lockStatus string

    Possible values: [LOCKED, UNLOCKED]

    Protection lock status (LOCKED/UNLOCKED).

  • status string

    Possible values: [ENABLED, DISABLED]

    Current status of the protection assembly.

  • cloudType string

    Possible values: [aws, gcp, azure]

    Type of cloud provider.

  • sourceRegion string

    Specifies the source region for the protection.

    Constraints:

    • Must not be null
    • Must be a valid Azure region
  • createdAt date-time

    Timestamp when the protection was created in epoch-milli.

  • allowCrossRegionRecovery boolean

    Indicates whether cross-region recovery is allowed.

  • replicaRegions string[]

    List of replica region names.

  • isStorageAccountOnly boolean

    Indicates whether only storage accounts are included in the protection.

    (Required)

  • resourceSelectionStrategy object

    Defines the strategy for selecting resources to be protected.

  • resourceGroups string[]

    Specifies the list of Azure resource group IDs to include.

    Constraints:

    • If resourceGroupSelectionType is SELECTED_RESOURCE_GROUP, this field must not be null or empty.
    • If resourceGroupSelectionType is ALL, this field can be null.
    • Each value must match the regex: ^/subscriptions/[a-fA-F0-9\-]+/resourceGroups/[a-zA-Z0-9-_\.]{1,90}$
  • excludeTagStrategy object

    Specifies the configuration for excluding resources based on tags during selection.

  • isEnabled boolean

    Indicates whether the exclude tag strategy is enabled.

  • condition string

    Possible values: [MATCH_ALL_TAGS, MATCH_ATLEAST_ONE_TAG]

    Specifies the conditions for tag matching.

    Optional: Required if isEnabled is true; must not be null or empty in that case.

    Allowed values:

    • MATCH_ALL_TAGS
    • MATCH_ATLEAST_ONE_TAG
  • excludedTags object[]

    Specifies a list of tags used to exclude resources from protection.

    Optional: Required if isEnabled is true; must not be null or empty in that case.

  • key string

    Key of the tag

  • value string

    Value of the tag

  • protectionStrategyOptions object

    Container for Azure-specific protection strategy option objects.

    Notes:

    • Can be null if isConfigurationAssembly is true.
    • Must not be null if isConfigurationAssembly is false.
  • azureSnapshotProtectionStrategyOption object

    Specifies the snapshot protection strategy, including the source resource group and replication details.

  • sourceResourceGroup string

    Source resource group used for snapshot based protection.

  • azureSnapshotReplicationDetails object[]

    Specifies a list of snapshot replication detail objects, including region and resource group information.

  • sourceResourceGroup string

    Source resource group used for snapshot based protection.

  • replicaRegion string

    Replica region where data is copied.

  • azureServerlessProtectionStrategyOption object

    Serverless (e.g., storage account) strategy option with replication details.

  • sourceStorageAccountId string

    Source storage account ID for serverless protection.

  • azureServerlessReplicationDetails object[]

    List of serverless replication detail objects (region, storage account).

  • replicaRegion string

    Replica region where data is copied.

  • storageAccountId string

    Replica storage account ID.

  • azureStorageAccountProtectionStrategyOption object

    Specifies the storage account protection strategy, including container configuration and region mappings.

  • containerName string

    Name of the storage container to protect.

  • containerNameType string

    Possible values: [PREFIX, SUFFIX, NONE]

    Specifies the strategy for renaming containers during recovery.

    Allowed values:

    • NONE
    • PREFIX
    • SUFFIX
  • storageAccountRegionMap object

    Specifies the mapping of source storage accounts to target region and account information.

    Format: {sourceSa:{region:targetRegion, storageAccount:targetSa}}

  • property name* string
Loading...