Microsoft.DataMigration services
Bicep resource definition
The services resource type can be deployed to:
- Resource groups - See resource group deployment commands
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@2022-03-30-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
capacity: int
family: 'string'
name: 'string'
size: 'string'
tier: 'string'
}
kind: 'string'
etag: 'string'
properties: {
autoStopDelay: 'string'
deleteResourcesOnStop: bool
publicKey: 'string'
virtualNicId: 'string'
virtualSubnetId: 'string'
}
}
Property values
services
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) Character limit: 2-62 Valid characters: Alphanumerics, hyphens, periods, and underscores. Start with alphanumeric. |
| location | string | |
| tags | Dictionary of {string} | Dictionary of tag names and values. See Tags in templates |
| sku | Service SKU | ServiceSku |
| kind | The resource kind. Only 'vm' (the default) is supported. | string |
| etag | HTTP strong entity tag value. Ignored if submitted | string |
| properties | Custom service properties | DataMigrationServiceProperties |
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 |
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 |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Migrate to Azure SQL database using Azure DMS |
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) |
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 to:
- Resource groups - See resource group deployment commands
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": "2022-03-30-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"capacity": "int",
"family": "string",
"name": "string",
"size": "string",
"tier": "string"
},
"kind": "string",
"etag": "string",
"properties": {
"autoStopDelay": "string",
"deleteResourcesOnStop": "bool",
"publicKey": "string",
"virtualNicId": "string",
"virtualSubnetId": "string"
}
}
Property values
services
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.DataMigration/services' |
| apiVersion | The resource api version | '2022-03-30-preview' |
| name | The resource name | string (required) Character limit: 2-62 Valid characters: Alphanumerics, hyphens, periods, and underscores. Start with alphanumeric. |
| location | string | |
| tags | Dictionary of {string} | Dictionary of tag names and values. See Tags in templates |
| sku | Service SKU | ServiceSku |
| kind | The resource kind. Only 'vm' (the default) is supported. | string |
| etag | HTTP strong entity tag value. Ignored if submitted | string |
| properties | Custom service properties | DataMigrationServiceProperties |
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 |
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 |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
| Migrate to Azure SQL database using Azure DMS |
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) |
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). |
Terraform (AzAPI provider) resource definition
The services resource type can be deployed to:
- 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@2022-03-30-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
autoStopDelay = "string"
deleteResourcesOnStop = bool
publicKey = "string"
virtualNicId = "string"
virtualSubnetId = "string"
}
sku = {
capacity = int
family = "string"
name = "string"
size = "string"
tier = "string"
}
kind = "string"
etag = "string"
})
}
Property values
services
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.DataMigration/services@2022-03-30-preview" |
| name | The resource name | string (required) Character limit: 2-62 Valid characters: Alphanumerics, hyphens, periods, and underscores. Start with alphanumeric. |
| location | string | |
| parent_id | To deploy to a resource group, use the ID of that resource group. | string (required) |
| tags | Dictionary of {string} | Dictionary of tag names and values. |
| sku | Service SKU | ServiceSku |
| kind | The resource kind. Only 'vm' (the default) is supported. | string |
| etag | HTTP strong entity tag value. Ignored if submitted | string |
| properties | Custom service properties | DataMigrationServiceProperties |
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 |
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 |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for