Microsoft.DataMigration services template reference

Template format

To create a Microsoft.DataMigration/services resource, add the following JSON to the resources section of your template.

  "name": "string",
  "type": "Microsoft.DataMigration/services",
  "apiVersion": "2018-04-19",
  "tags": {},
  "location": "string",
  "kind": "string",
  "properties": {
    "publicKey": "string",
    "virtualSubnetId": "string"
  "sku": {
    "name": "string",
    "tier": "string",
    "family": "string",
    "size": "string",
    "capacity": "integer"
  "resources": []

Property values

The following tables describe the values you need to set in the schema.

Microsoft.DataMigration/services object

Name Type Required Value
name string Yes Name of the service
type enum Yes Microsoft.DataMigration/services
apiVersion enum Yes 2018-04-19
tags object No Resource tags.
location string Yes Resource location.
kind string No The resource kind. Only 'vm' (the default) is supported.
properties object Yes Custom service properties - DataMigrationServiceProperties object
sku object No Service SKU - ServiceSku object
resources array No projects

DataMigrationServiceProperties object

Name Type Required Value
publicKey string No The public key of the service, used to encrypt secrets sent to the service
virtualSubnetId string Yes The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined

ServiceSku object

Name Type Required Value
name string No The unique name of the SKU, such as 'P3'
tier string No The tier of the SKU, such as 'Free', 'Basic', 'Standard', or 'Premium'
family string No The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines
size string No 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
capacity integer No The capacity of the SKU, if it supports scaling

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
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.
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).