Microsoft.Cache redisEnterprise/migrations

Bicep resource definition

The redisEnterprise/migrations resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Cache/redisEnterprise/migrations resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Cache/redisEnterprise/migrations@2026-05-01-preview' = {
  parent: resourceSymbolicName
  name: 'default'
  properties: {
    sourceType: 'string'
    // For remaining properties, see MigrationProperties objects
  }
}

MigrationProperties objects

Set the sourceType property to specify the type of object.

For AzureCacheForRedis, use:

{
  forceMigrate: bool
  skipDataMigration: bool
  sourceResourceId: 'string'
  sourceType: 'AzureCacheForRedis'
  switchDns: bool
}

Property Values

Microsoft.Cache/redisEnterprise/migrations

Name Description Value
name The resource name 'default' (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: redisEnterprise
properties Properties of the migration operation. MigrationProperties

AzureCacheForRedisMigrationProperties

Name Description Value
forceMigrate Sets whether to ignore warnings when performing validation of the migration request. If this property is true, warning-level disparities between the source and target resources will be ignored, and the request will only fail validation if there are error-level disparities. The default value is false. bool
skipDataMigration Sets whether the data is migrated from source to target or not. This property must be true during the preview. bool (required)
sourceResourceId The source resource ID to migrate from. This is the resource ID of the Azure Cache for Redis. string (required)
sourceType Describes the source of the migration operation. 'AzureCacheForRedis' (required)
switchDns Sets whether the DNS is switched automatically after the data is transferred from the source cache to the target cache. This property must be true during the preview. bool (required)

MigrationProperties

Name Description Value
sourceType Set to 'AzureCacheForRedis' for type AzureCacheForRedisMigrationProperties. 'AzureCacheForRedis' (required)

ARM template resource definition

The redisEnterprise/migrations resource type can be deployed with operations that target:

Usage Examples

Resource format

To create a Microsoft.Cache/redisEnterprise/migrations resource, add the following JSON to your template.

{
  "type": "Microsoft.Cache/redisEnterprise/migrations",
  "apiVersion": "2026-05-01-preview",
  "name": "string",
  "properties": {
    "sourceType": "string"
    // For remaining properties, see MigrationProperties objects
  }
}

MigrationProperties objects

Set the sourceType property to specify the type of object.

For AzureCacheForRedis, use:

{
  "forceMigrate": "bool",
  "skipDataMigration": "bool",
  "sourceResourceId": "string",
  "sourceType": "AzureCacheForRedis",
  "switchDns": "bool"
}

Property Values

Microsoft.Cache/redisEnterprise/migrations

Name Description Value
apiVersion The api version '2026-05-01-preview'
name The resource name 'default' (required)
properties Properties of the migration operation. MigrationProperties
type The resource type 'Microsoft.Cache/redisEnterprise/migrations'

AzureCacheForRedisMigrationProperties

Name Description Value
forceMigrate Sets whether to ignore warnings when performing validation of the migration request. If this property is true, warning-level disparities between the source and target resources will be ignored, and the request will only fail validation if there are error-level disparities. The default value is false. bool
skipDataMigration Sets whether the data is migrated from source to target or not. This property must be true during the preview. bool (required)
sourceResourceId The source resource ID to migrate from. This is the resource ID of the Azure Cache for Redis. string (required)
sourceType Describes the source of the migration operation. 'AzureCacheForRedis' (required)
switchDns Sets whether the DNS is switched automatically after the data is transferred from the source cache to the target cache. This property must be true during the preview. bool (required)

MigrationProperties

Name Description Value
sourceType Set to 'AzureCacheForRedis' for type AzureCacheForRedisMigrationProperties. 'AzureCacheForRedis' (required)

Terraform (AzAPI provider) resource definition

The redisEnterprise/migrations resource type can be deployed with operations that target:

  • Resource groups For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Cache/redisEnterprise/migrations resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Cache/redisEnterprise/migrations@2026-05-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      sourceType = "string"
      // For remaining properties, see MigrationProperties objects
    }
  }
}

MigrationProperties objects

Set the sourceType property to specify the type of object.

For AzureCacheForRedis, use:

{
  forceMigrate = bool
  skipDataMigration = bool
  sourceResourceId = "string"
  sourceType = "AzureCacheForRedis"
  switchDns = bool
}

Property Values

Microsoft.Cache/redisEnterprise/migrations

Name Description Value
name The resource name 'default' (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: redisEnterprise
properties Properties of the migration operation. MigrationProperties
type The resource type "Microsoft.Cache/redisEnterprise/migrations@2026-05-01-preview"

AzureCacheForRedisMigrationProperties

Name Description Value
forceMigrate Sets whether to ignore warnings when performing validation of the migration request. If this property is true, warning-level disparities between the source and target resources will be ignored, and the request will only fail validation if there are error-level disparities. The default value is false. bool
skipDataMigration Sets whether the data is migrated from source to target or not. This property must be true during the preview. bool (required)
sourceResourceId The source resource ID to migrate from. This is the resource ID of the Azure Cache for Redis. string (required)
sourceType Describes the source of the migration operation. 'AzureCacheForRedis' (required)
switchDns Sets whether the DNS is switched automatically after the data is transferred from the source cache to the target cache. This property must be true during the preview. bool (required)

MigrationProperties

Name Description Value
sourceType Set to 'AzureCacheForRedis' for type AzureCacheForRedisMigrationProperties. 'AzureCacheForRedis' (required)
  • Last updated on