Microsoft.DataMigration/services 2021-06-30 – Bicep, ARM template & Terraform AzAPI reference

Table of Contents1 Bicep resource definition2 Resource format3 Property values3.1 services3.2 DataMigrationServiceProperties3.3 ServiceSku4 Quickstart templates5 ARM template resource definition6 Resource format7 Property values7.1 services7.2 DataMigrationServiceProperties7.3 ServiceSku8 Quickstart templates9 Terraform (AzAPI provider) resource definition10 Resource format11 Property values11.1 services11.2 DataMigrationServiceProperties11.3 ServiceSku Bicep resource definition The services resource type can be deployed […]

Bicep resource definition

The services resource type can be deployed to:

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/[email protected]' = {
  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: {
    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 Resource location. string (required)
tags Resource tags. 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
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 (required)

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

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

ARM template resource definition

The services resource type can be deployed to:

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": "2021-06-30",
  "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": {
    "publicKey": "string",
    "virtualNicId": "string",
    "virtualSubnetId": "string"
  }
}

Property values

services

Name Description Value
type The resource type ‘Microsoft.DataMigration/services’
apiVersion The resource api version ‘2021-06-30’
name The resource name string (required)

Character limit: 2-62

Valid characters:
Alphanumerics, hyphens, periods, and underscores.

Start with alphanumeric.

location Resource location. string (required)
tags Resource tags. 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
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 (required)

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

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

Terraform (AzAPI provider) resource definition

The services resource type can be deployed to:

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/[email protected]"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      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/[email protected]
name The resource name string (required)

Character limit: 2-62

Valid characters:
Alphanumerics, hyphens, periods, and underscores.

Start with alphanumeric.

location Resource location. string (required)
parent_id To deploy to a resource group, use the ID of that resource group. string (required)
tags Resource tags. 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
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 (required)

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

Source Article

Next Post

Microsoft.Management/managementGroups 2020-02-01 - Bicep, ARM template & Terraform AzAPI reference

Wed Sep 28 , 2022
Table of Contents0.1 In this article1 Bicep resource definition2 Remarks3 Resource format4 Property values4.1 managementGroups4.2 CreateManagementGroupPropertiesOrManagementGroupProperties4.3 CreateManagementGroupDetailsOrManagementGroupDetails4.4 CreateParentGroupInfoOrParentGroupInfo5 Quickstart templates6 ARM template resource definition7 Remarks8 Resource format9 Property values9.1 managementGroups9.2 CreateManagementGroupPropertiesOrManagementGroupProperties9.3 CreateManagementGroupDetailsOrManagementGroupDetails9.4 CreateParentGroupInfoOrParentGroupInfo10 Quickstart templates11 Terraform (AzAPI provider) resource definition12 Resource format13 Property values13.1 managementGroups13.2 CreateManagementGroupPropertiesOrManagementGroupProperties13.3 CreateManagementGroupDetailsOrManagementGroupDetails13.4 CreateParentGroupInfoOrParentGroupInfo […]