Share via

Microsoft.DataMigration services

  • Article

Bicep resource definition

The services 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.DataMigration/services resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DataMigration/services@2023-07-15-preview' = {
  etag: 'string'
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    autoStopDelay: 'string'
    deleteResourcesOnStop: bool
    publicKey: 'string'
    virtualNicId: 'string'
    virtualSubnetId: 'string'
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

DataMigrationServiceProperties

Name Description Value
autoStopDelay The time delay before the service is auto-stopped when idle. string
deleteResourcesOnStop Whether service resources should be deleted when stopped. (Turned on by default) bool
publicKey The public key of the service, used to encrypt secrets sent to the service string
virtualNicId The ID of the Microsoft.Network/networkInterfaces resource which the service have string
virtualSubnetId The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined string

Microsoft.DataMigration/services

Name Description Value
etag HTTP strong entity tag value. Ignored if submitted string
kind The resource kind. Only 'vm' (the default) is supported. string
location string
name The resource name string (required)
properties Custom service properties DataMigrationServiceProperties
sku Service SKU ServiceSku
tags Resource tags Dictionary of tag names and values. See Tags in templates

ServiceSku

Name Description Value
capacity The capacity of the SKU, if it supports scaling int
family The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines string
name The unique name of the SKU, such as 'P3' string
size The size of the SKU, used when the name alone does not denote a service size or when a SKU has multiple performance classes within a family, e.g. 'A1' for virtual machines string
tier The tier of the SKU, such as 'Basic', 'General Purpose', or 'Business Critical' string

TrackedResourceTags

Name Description Value

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File Description
Deploy Azure Database Migration Service (DMS) Azure Database Migration Service is a fully managed service designed to enable seamless migrations from multiple database sources to Azure data platforms with minimal downtime (online migrations).

ARM template resource definition

The services 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.DataMigration/services resource, add the following JSON to your template.

{
  "type": "Microsoft.DataMigration/services",
  "apiVersion": "2023-07-15-preview",
  "name": "string",
  "etag": "string",
  "kind": "string",
  "location": "string",
  "properties": {
    "autoStopDelay": "string",
    "deleteResourcesOnStop": "bool",
    "publicKey": "string",
    "virtualNicId": "string",
    "virtualSubnetId": "string"
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

DataMigrationServiceProperties

Name Description Value
autoStopDelay The time delay before the service is auto-stopped when idle. string
deleteResourcesOnStop Whether service resources should be deleted when stopped. (Turned on by default) bool
publicKey The public key of the service, used to encrypt secrets sent to the service string
virtualNicId The ID of the Microsoft.Network/networkInterfaces resource which the service have string
virtualSubnetId The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined string

Microsoft.DataMigration/services

Name Description Value
apiVersion The api version '2023-07-15-preview'
etag HTTP strong entity tag value. Ignored if submitted string
kind The resource kind. Only 'vm' (the default) is supported. string
location string
name The resource name string (required)
properties Custom service properties DataMigrationServiceProperties
sku Service SKU ServiceSku
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.DataMigration/services'

ServiceSku

Name Description Value
capacity The capacity of the SKU, if it supports scaling int
family The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines string
name The unique name of the SKU, such as 'P3' string
size The size of the SKU, used when the name alone does not denote a service size or when a SKU has multiple performance classes within a family, e.g. 'A1' for virtual machines string
tier The tier of the SKU, such as 'Basic', 'General Purpose', or 'Business Critical' string

TrackedResourceTags

Name Description Value

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Deploy Azure Database Migration Service (DMS)

Deploy to Azure		 Azure Database Migration Service is a fully managed service designed to enable seamless migrations from multiple database sources to Azure data platforms with minimal downtime (online migrations).
Migrate to Azure SQL database using Azure DMS

Deploy to Azure		 The Azure Database Migration Service (DMS) is designed to streamline the process of migrating on-premises databases to Azure. DMS will simplify the migration of existing on-premises SQL Server and Oracle databases to Azure SQL Database, Azure SQL Managed Instance or Microsoft SQL Server in an Azure Virtual Machine. This template would deploy an instance of Azure Database Migration service, an Azure VM with SQL server installed on it which will act as a Source server with pre created database on it and a Target Azure SQL DB server which will have a pre-created schema of the database to be migrated from Source to Target server. The template will also deploy the required resources like NIC, vnet etc for supporting the Source VM, DMS service and Target server.

Terraform (AzAPI provider) resource definition

The services 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.DataMigration/services resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DataMigration/services@2023-07-15-preview"
  name = "string"
  etag = "string"
  kind = "string"
  location = "string"
  sku = {
    capacity = int
    family = "string"
    name = "string"
    size = "string"
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      autoStopDelay = "string"
      deleteResourcesOnStop = bool
      publicKey = "string"
      virtualNicId = "string"
      virtualSubnetId = "string"
    }
  })
}

Property values

DataMigrationServiceProperties

Name Description Value
autoStopDelay The time delay before the service is auto-stopped when idle. string
deleteResourcesOnStop Whether service resources should be deleted when stopped. (Turned on by default) bool
publicKey The public key of the service, used to encrypt secrets sent to the service string
virtualNicId The ID of the Microsoft.Network/networkInterfaces resource which the service have string
virtualSubnetId The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined string

Microsoft.DataMigration/services

Name Description Value
etag HTTP strong entity tag value. Ignored if submitted string
kind The resource kind. Only 'vm' (the default) is supported. string
location string
name The resource name string (required)
properties Custom service properties DataMigrationServiceProperties
sku Service SKU ServiceSku
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.DataMigration/services@2023-07-15-preview"

ServiceSku

Name Description Value
capacity The capacity of the SKU, if it supports scaling int
family The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines string
name The unique name of the SKU, such as 'P3' string
size The size of the SKU, used when the name alone does not denote a service size or when a SKU has multiple performance classes within a family, e.g. 'A1' for virtual machines string
tier The tier of the SKU, such as 'Basic', 'General Purpose', or 'Business Critical' string

TrackedResourceTags

Name Description Value