1. Packages
  2. Azure Classic
  3. API Docs
  4. databasemigration
  5. Service

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

azure.databasemigration.Service

Explore with Pulumi AI

Manages a Azure Database Migration Service.

NOTE: Destroying a Database Migration Service will leave any outstanding tasks untouched. This is to avoid unexpectedly deleting any tasks managed outside of this provide.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-rg",
    location: "West Europe",
});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("example", {
    name: "example-vnet",
    addressSpaces: ["10.0.0.0/16"],
    location: example.location,
    resourceGroupName: example.name,
});
const exampleSubnet = new azure.network.Subnet("example", {
    name: "example-subnet",
    resourceGroupName: example.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefixes: ["10.0.1.0/24"],
});
const exampleService = new azure.databasemigration.Service("example", {
    name: "example-dms",
    location: example.location,
    resourceGroupName: example.name,
    subnetId: exampleSubnet.id,
    skuName: "Standard_1vCores",
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-rg",
    location="West Europe")
example_virtual_network = azure.network.VirtualNetwork("example",
    name="example-vnet",
    address_spaces=["10.0.0.0/16"],
    location=example.location,
    resource_group_name=example.name)
example_subnet = azure.network.Subnet("example",
    name="example-subnet",
    resource_group_name=example.name,
    virtual_network_name=example_virtual_network.name,
    address_prefixes=["10.0.1.0/24"])
example_service = azure.databasemigration.Service("example",
    name="example-dms",
    location=example.location,
    resource_group_name=example.name,
    subnet_id=example_subnet.id,
    sku_name="Standard_1vCores")
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/databasemigration"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/network"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-rg"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleVirtualNetwork, err := network.NewVirtualNetwork(ctx, "example", &network.VirtualNetworkArgs{
			Name: pulumi.String("example-vnet"),
			AddressSpaces: pulumi.StringArray{
				pulumi.String("10.0.0.0/16"),
			},
			Location:          example.Location,
			ResourceGroupName: example.Name,
		})
		if err != nil {
			return err
		}
		exampleSubnet, err := network.NewSubnet(ctx, "example", &network.SubnetArgs{
			Name:               pulumi.String("example-subnet"),
			ResourceGroupName:  example.Name,
			VirtualNetworkName: exampleVirtualNetwork.Name,
			AddressPrefixes: pulumi.StringArray{
				pulumi.String("10.0.1.0/24"),
			},
		})
		if err != nil {
			return err
		}
		_, err = databasemigration.NewService(ctx, "example", &databasemigration.ServiceArgs{
			Name:              pulumi.String("example-dms"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			SubnetId:          exampleSubnet.ID(),
			SkuName:           pulumi.String("Standard_1vCores"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-rg",
        Location = "West Europe",
    });

    var exampleVirtualNetwork = new Azure.Network.VirtualNetwork("example", new()
    {
        Name = "example-vnet",
        AddressSpaces = new[]
        {
            "10.0.0.0/16",
        },
        Location = example.Location,
        ResourceGroupName = example.Name,
    });

    var exampleSubnet = new Azure.Network.Subnet("example", new()
    {
        Name = "example-subnet",
        ResourceGroupName = example.Name,
        VirtualNetworkName = exampleVirtualNetwork.Name,
        AddressPrefixes = new[]
        {
            "10.0.1.0/24",
        },
    });

    var exampleService = new Azure.DatabaseMigration.Service("example", new()
    {
        Name = "example-dms",
        Location = example.Location,
        ResourceGroupName = example.Name,
        SubnetId = exampleSubnet.Id,
        SkuName = "Standard_1vCores",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.network.VirtualNetwork;
import com.pulumi.azure.network.VirtualNetworkArgs;
import com.pulumi.azure.network.Subnet;
import com.pulumi.azure.network.SubnetArgs;
import com.pulumi.azure.databasemigration.Service;
import com.pulumi.azure.databasemigration.ServiceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-rg")
            .location("West Europe")
            .build());

        var exampleVirtualNetwork = new VirtualNetwork("exampleVirtualNetwork", VirtualNetworkArgs.builder()
            .name("example-vnet")
            .addressSpaces("10.0.0.0/16")
            .location(example.location())
            .resourceGroupName(example.name())
            .build());

        var exampleSubnet = new Subnet("exampleSubnet", SubnetArgs.builder()
            .name("example-subnet")
            .resourceGroupName(example.name())
            .virtualNetworkName(exampleVirtualNetwork.name())
            .addressPrefixes("10.0.1.0/24")
            .build());

        var exampleService = new Service("exampleService", ServiceArgs.builder()
            .name("example-dms")
            .location(example.location())
            .resourceGroupName(example.name())
            .subnetId(exampleSubnet.id())
            .skuName("Standard_1vCores")
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-rg
      location: West Europe
  exampleVirtualNetwork:
    type: azure:network:VirtualNetwork
    name: example
    properties:
      name: example-vnet
      addressSpaces:
        - 10.0.0.0/16
      location: ${example.location}
      resourceGroupName: ${example.name}
  exampleSubnet:
    type: azure:network:Subnet
    name: example
    properties:
      name: example-subnet
      resourceGroupName: ${example.name}
      virtualNetworkName: ${exampleVirtualNetwork.name}
      addressPrefixes:
        - 10.0.1.0/24
  exampleService:
    type: azure:databasemigration:Service
    name: example
    properties:
      name: example-dms
      location: ${example.location}
      resourceGroupName: ${example.name}
      subnetId: ${exampleSubnet.id}
      skuName: Standard_1vCores
Copy

Create Service Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Service(name: string, args: ServiceArgs, opts?: CustomResourceOptions);
@overload
def Service(resource_name: str,
            args: ServiceArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Service(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            resource_group_name: Optional[str] = None,
            sku_name: Optional[str] = None,
            subnet_id: Optional[str] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None)
func NewService(ctx *Context, name string, args ServiceArgs, opts ...ResourceOption) (*Service, error)
public Service(string name, ServiceArgs args, CustomResourceOptions? opts = null)
public Service(String name, ServiceArgs args)
public Service(String name, ServiceArgs args, CustomResourceOptions options)
type: azure:databasemigration:Service
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ServiceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ServiceArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ServiceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ServiceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ServiceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var exampleserviceResourceResourceFromDatabasemigrationservice = new Azure.DatabaseMigration.Service("exampleserviceResourceResourceFromDatabasemigrationservice", new()
{
    ResourceGroupName = "string",
    SkuName = "string",
    SubnetId = "string",
    Location = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := databasemigration.NewService(ctx, "exampleserviceResourceResourceFromDatabasemigrationservice", &databasemigration.ServiceArgs{
	ResourceGroupName: pulumi.String("string"),
	SkuName:           pulumi.String("string"),
	SubnetId:          pulumi.String("string"),
	Location:          pulumi.String("string"),
	Name:              pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var exampleserviceResourceResourceFromDatabasemigrationservice = new Service("exampleserviceResourceResourceFromDatabasemigrationservice", ServiceArgs.builder()
    .resourceGroupName("string")
    .skuName("string")
    .subnetId("string")
    .location("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
exampleservice_resource_resource_from_databasemigrationservice = azure.databasemigration.Service("exampleserviceResourceResourceFromDatabasemigrationservice",
    resource_group_name="string",
    sku_name="string",
    subnet_id="string",
    location="string",
    name="string",
    tags={
        "string": "string",
    })
Copy
const exampleserviceResourceResourceFromDatabasemigrationservice = new azure.databasemigration.Service("exampleserviceResourceResourceFromDatabasemigrationservice", {
    resourceGroupName: "string",
    skuName: "string",
    subnetId: "string",
    location: "string",
    name: "string",
    tags: {
        string: "string",
    },
});
Copy
type: azure:databasemigration:Service
properties:
    location: string
    name: string
    resourceGroupName: string
    skuName: string
    subnetId: string
    tags:
        string: string
Copy

Service Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Service resource accepts the following input properties:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group in which to create the database migration service. Changing this forces a new resource to be created.
SkuName
This property is required.
Changes to this property will trigger replacement.
string
The SKU name of the database migration service. Possible values are Premium_4vCores, Standard_1vCores, Standard_2vCores and Standard_4vCores. Changing this forces a new resource to be created.
SubnetId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the virtual subnet resource to which the database migration service should be joined. Changing this forces a new resource to be created.
Location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specify the name of the database migration service. Changing this forces a new resource to be created.
Tags Dictionary<string, string>
A mapping of tags to assigned to the resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group in which to create the database migration service. Changing this forces a new resource to be created.
SkuName
This property is required.
Changes to this property will trigger replacement.
string
The SKU name of the database migration service. Possible values are Premium_4vCores, Standard_1vCores, Standard_2vCores and Standard_4vCores. Changing this forces a new resource to be created.
SubnetId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the virtual subnet resource to which the database migration service should be joined. Changing this forces a new resource to be created.
Location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specify the name of the database migration service. Changing this forces a new resource to be created.
Tags map[string]string
A mapping of tags to assigned to the resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group in which to create the database migration service. Changing this forces a new resource to be created.
skuName
This property is required.
Changes to this property will trigger replacement.
String
The SKU name of the database migration service. Possible values are Premium_4vCores, Standard_1vCores, Standard_2vCores and Standard_4vCores. Changing this forces a new resource to be created.
subnetId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the virtual subnet resource to which the database migration service should be joined. Changing this forces a new resource to be created.
location Changes to this property will trigger replacement. String
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specify the name of the database migration service. Changing this forces a new resource to be created.
tags Map<String,String>
A mapping of tags to assigned to the resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group in which to create the database migration service. Changing this forces a new resource to be created.
skuName
This property is required.
Changes to this property will trigger replacement.
string
The SKU name of the database migration service. Possible values are Premium_4vCores, Standard_1vCores, Standard_2vCores and Standard_4vCores. Changing this forces a new resource to be created.
subnetId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the virtual subnet resource to which the database migration service should be joined. Changing this forces a new resource to be created.
location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
Specify the name of the database migration service. Changing this forces a new resource to be created.
tags {[key: string]: string}
A mapping of tags to assigned to the resource.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the resource group in which to create the database migration service. Changing this forces a new resource to be created.
sku_name
This property is required.
Changes to this property will trigger replacement.
str
The SKU name of the database migration service. Possible values are Premium_4vCores, Standard_1vCores, Standard_2vCores and Standard_4vCores. Changing this forces a new resource to be created.
subnet_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the virtual subnet resource to which the database migration service should be joined. Changing this forces a new resource to be created.
location Changes to this property will trigger replacement. str
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
Specify the name of the database migration service. Changing this forces a new resource to be created.
tags Mapping[str, str]
A mapping of tags to assigned to the resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group in which to create the database migration service. Changing this forces a new resource to be created.
skuName
This property is required.
Changes to this property will trigger replacement.
String
The SKU name of the database migration service. Possible values are Premium_4vCores, Standard_1vCores, Standard_2vCores and Standard_4vCores. Changing this forces a new resource to be created.
subnetId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the virtual subnet resource to which the database migration service should be joined. Changing this forces a new resource to be created.
location Changes to this property will trigger replacement. String
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specify the name of the database migration service. Changing this forces a new resource to be created.
tags Map<String>
A mapping of tags to assigned to the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the Service resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing Service Resource

Get an existing Service resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ServiceState, opts?: CustomResourceOptions): Service
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        sku_name: Optional[str] = None,
        subnet_id: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> Service
func GetService(ctx *Context, name string, id IDInput, state *ServiceState, opts ...ResourceOption) (*Service, error)
public static Service Get(string name, Input<string> id, ServiceState? state, CustomResourceOptions? opts = null)
public static Service get(String name, Output<String> id, ServiceState state, CustomResourceOptions options)
resources:  _:    type: azure:databasemigration:Service    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specify the name of the database migration service. Changing this forces a new resource to be created.
ResourceGroupName Changes to this property will trigger replacement. string
Name of the resource group in which to create the database migration service. Changing this forces a new resource to be created.
SkuName Changes to this property will trigger replacement. string
The SKU name of the database migration service. Possible values are Premium_4vCores, Standard_1vCores, Standard_2vCores and Standard_4vCores. Changing this forces a new resource to be created.
SubnetId Changes to this property will trigger replacement. string
The ID of the virtual subnet resource to which the database migration service should be joined. Changing this forces a new resource to be created.
Tags Dictionary<string, string>
A mapping of tags to assigned to the resource.
Location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specify the name of the database migration service. Changing this forces a new resource to be created.
ResourceGroupName Changes to this property will trigger replacement. string
Name of the resource group in which to create the database migration service. Changing this forces a new resource to be created.
SkuName Changes to this property will trigger replacement. string
The SKU name of the database migration service. Possible values are Premium_4vCores, Standard_1vCores, Standard_2vCores and Standard_4vCores. Changing this forces a new resource to be created.
SubnetId Changes to this property will trigger replacement. string
The ID of the virtual subnet resource to which the database migration service should be joined. Changing this forces a new resource to be created.
Tags map[string]string
A mapping of tags to assigned to the resource.
location Changes to this property will trigger replacement. String
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specify the name of the database migration service. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. String
Name of the resource group in which to create the database migration service. Changing this forces a new resource to be created.
skuName Changes to this property will trigger replacement. String
The SKU name of the database migration service. Possible values are Premium_4vCores, Standard_1vCores, Standard_2vCores and Standard_4vCores. Changing this forces a new resource to be created.
subnetId Changes to this property will trigger replacement. String
The ID of the virtual subnet resource to which the database migration service should be joined. Changing this forces a new resource to be created.
tags Map<String,String>
A mapping of tags to assigned to the resource.
location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
Specify the name of the database migration service. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. string
Name of the resource group in which to create the database migration service. Changing this forces a new resource to be created.
skuName Changes to this property will trigger replacement. string
The SKU name of the database migration service. Possible values are Premium_4vCores, Standard_1vCores, Standard_2vCores and Standard_4vCores. Changing this forces a new resource to be created.
subnetId Changes to this property will trigger replacement. string
The ID of the virtual subnet resource to which the database migration service should be joined. Changing this forces a new resource to be created.
tags {[key: string]: string}
A mapping of tags to assigned to the resource.
location Changes to this property will trigger replacement. str
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
Specify the name of the database migration service. Changing this forces a new resource to be created.
resource_group_name Changes to this property will trigger replacement. str
Name of the resource group in which to create the database migration service. Changing this forces a new resource to be created.
sku_name Changes to this property will trigger replacement. str
The SKU name of the database migration service. Possible values are Premium_4vCores, Standard_1vCores, Standard_2vCores and Standard_4vCores. Changing this forces a new resource to be created.
subnet_id Changes to this property will trigger replacement. str
The ID of the virtual subnet resource to which the database migration service should be joined. Changing this forces a new resource to be created.
tags Mapping[str, str]
A mapping of tags to assigned to the resource.
location Changes to this property will trigger replacement. String
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specify the name of the database migration service. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. String
Name of the resource group in which to create the database migration service. Changing this forces a new resource to be created.
skuName Changes to this property will trigger replacement. String
The SKU name of the database migration service. Possible values are Premium_4vCores, Standard_1vCores, Standard_2vCores and Standard_4vCores. Changing this forces a new resource to be created.
subnetId Changes to this property will trigger replacement. String
The ID of the virtual subnet resource to which the database migration service should be joined. Changing this forces a new resource to be created.
tags Map<String>
A mapping of tags to assigned to the resource.

Import

Database Migration Services can be imported using the resource id, e.g.

$ pulumi import azure:databasemigration/service:Service example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example-rg/providers/Microsoft.DataMigration/services/database_migration_service1
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.