1. Packages
  2. Azure Native
  3. API Docs
  4. datamigration
  5. SqlMigrationService
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.datamigration.SqlMigrationService

Explore with Pulumi AI

A SQL Migration Service.

Uses Azure REST API version 2023-07-15-preview. In version 2.x of the Azure Native provider, it used API version 2022-03-30-preview.

Other available API versions: 2021-10-30-preview, 2022-01-30-preview, 2022-03-30-preview, 2025-03-15-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native datamigration [ApiVersion]. See the version guide for details.

Example Usage

Create or Update SQL Migration Service with maximum parameters.

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var sqlMigrationService = new AzureNative.DataMigration.SqlMigrationService("sqlMigrationService", new()
    {
        Location = "northeurope",
        ResourceGroupName = "testrg",
        SqlMigrationServiceName = "testagent",
    });

});
Copy
package main

import (
	datamigration "github.com/pulumi/pulumi-azure-native-sdk/datamigration/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datamigration.NewSqlMigrationService(ctx, "sqlMigrationService", &datamigration.SqlMigrationServiceArgs{
			Location:                pulumi.String("northeurope"),
			ResourceGroupName:       pulumi.String("testrg"),
			SqlMigrationServiceName: pulumi.String("testagent"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.datamigration.SqlMigrationService;
import com.pulumi.azurenative.datamigration.SqlMigrationServiceArgs;
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 sqlMigrationService = new SqlMigrationService("sqlMigrationService", SqlMigrationServiceArgs.builder()
            .location("northeurope")
            .resourceGroupName("testrg")
            .sqlMigrationServiceName("testagent")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const sqlMigrationService = new azure_native.datamigration.SqlMigrationService("sqlMigrationService", {
    location: "northeurope",
    resourceGroupName: "testrg",
    sqlMigrationServiceName: "testagent",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

sql_migration_service = azure_native.datamigration.SqlMigrationService("sqlMigrationService",
    location="northeurope",
    resource_group_name="testrg",
    sql_migration_service_name="testagent")
Copy
resources:
  sqlMigrationService:
    type: azure-native:datamigration:SqlMigrationService
    properties:
      location: northeurope
      resourceGroupName: testrg
      sqlMigrationServiceName: testagent
Copy

Create or Update SQL Migration Service with minimum parameters.

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var sqlMigrationService = new AzureNative.DataMigration.SqlMigrationService("sqlMigrationService", new()
    {
        Location = "northeurope",
        ResourceGroupName = "testrg",
        SqlMigrationServiceName = "testagent",
    });

});
Copy
package main

import (
	datamigration "github.com/pulumi/pulumi-azure-native-sdk/datamigration/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datamigration.NewSqlMigrationService(ctx, "sqlMigrationService", &datamigration.SqlMigrationServiceArgs{
			Location:                pulumi.String("northeurope"),
			ResourceGroupName:       pulumi.String("testrg"),
			SqlMigrationServiceName: pulumi.String("testagent"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.datamigration.SqlMigrationService;
import com.pulumi.azurenative.datamigration.SqlMigrationServiceArgs;
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 sqlMigrationService = new SqlMigrationService("sqlMigrationService", SqlMigrationServiceArgs.builder()
            .location("northeurope")
            .resourceGroupName("testrg")
            .sqlMigrationServiceName("testagent")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const sqlMigrationService = new azure_native.datamigration.SqlMigrationService("sqlMigrationService", {
    location: "northeurope",
    resourceGroupName: "testrg",
    sqlMigrationServiceName: "testagent",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

sql_migration_service = azure_native.datamigration.SqlMigrationService("sqlMigrationService",
    location="northeurope",
    resource_group_name="testrg",
    sql_migration_service_name="testagent")
Copy
resources:
  sqlMigrationService:
    type: azure-native:datamigration:SqlMigrationService
    properties:
      location: northeurope
      resourceGroupName: testrg
      sqlMigrationServiceName: testagent
Copy

Create SqlMigrationService Resource

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

Constructor syntax

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

@overload
def SqlMigrationService(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        resource_group_name: Optional[str] = None,
                        location: Optional[str] = None,
                        sql_migration_service_name: Optional[str] = None,
                        tags: Optional[Mapping[str, str]] = None)
func NewSqlMigrationService(ctx *Context, name string, args SqlMigrationServiceArgs, opts ...ResourceOption) (*SqlMigrationService, error)
public SqlMigrationService(string name, SqlMigrationServiceArgs args, CustomResourceOptions? opts = null)
public SqlMigrationService(String name, SqlMigrationServiceArgs args)
public SqlMigrationService(String name, SqlMigrationServiceArgs args, CustomResourceOptions options)
type: azure-native:datamigration:SqlMigrationService
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. SqlMigrationServiceArgs
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. SqlMigrationServiceArgs
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. SqlMigrationServiceArgs
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. SqlMigrationServiceArgs
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. SqlMigrationServiceArgs
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 sqlMigrationServiceResource = new AzureNative.DataMigration.SqlMigrationService("sqlMigrationServiceResource", new()
{
    ResourceGroupName = "string",
    Location = "string",
    SqlMigrationServiceName = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := datamigration.NewSqlMigrationService(ctx, "sqlMigrationServiceResource", &datamigration.SqlMigrationServiceArgs{
	ResourceGroupName:       pulumi.String("string"),
	Location:                pulumi.String("string"),
	SqlMigrationServiceName: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var sqlMigrationServiceResource = new SqlMigrationService("sqlMigrationServiceResource", SqlMigrationServiceArgs.builder()
    .resourceGroupName("string")
    .location("string")
    .sqlMigrationServiceName("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
sql_migration_service_resource = azure_native.datamigration.SqlMigrationService("sqlMigrationServiceResource",
    resource_group_name="string",
    location="string",
    sql_migration_service_name="string",
    tags={
        "string": "string",
    })
Copy
const sqlMigrationServiceResource = new azure_native.datamigration.SqlMigrationService("sqlMigrationServiceResource", {
    resourceGroupName: "string",
    location: "string",
    sqlMigrationServiceName: "string",
    tags: {
        string: "string",
    },
});
Copy
type: azure-native:datamigration:SqlMigrationService
properties:
    location: string
    resourceGroupName: string
    sqlMigrationServiceName: string
    tags:
        string: string
Copy

SqlMigrationService 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 SqlMigrationService resource accepts the following input properties:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
Location Changes to this property will trigger replacement. string
SqlMigrationServiceName Changes to this property will trigger replacement. string
Name of the SQL Migration Service.
Tags Dictionary<string, string>
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
Location Changes to this property will trigger replacement. string
SqlMigrationServiceName Changes to this property will trigger replacement. string
Name of the SQL Migration Service.
Tags map[string]string
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location Changes to this property will trigger replacement. String
sqlMigrationServiceName Changes to this property will trigger replacement. String
Name of the SQL Migration Service.
tags Map<String,String>
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location Changes to this property will trigger replacement. string
sqlMigrationServiceName Changes to this property will trigger replacement. string
Name of the SQL Migration Service.
tags {[key: string]: string}
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location Changes to this property will trigger replacement. str
sql_migration_service_name Changes to this property will trigger replacement. str
Name of the SQL Migration Service.
tags Mapping[str, str]
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location Changes to this property will trigger replacement. String
sqlMigrationServiceName Changes to this property will trigger replacement. String
Name of the SQL Migration Service.
tags Map<String>

Outputs

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

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
IntegrationRuntimeState string
Current state of the Integration runtime.
Name string
ProvisioningState string
Provisioning state to track the async operation status.
SystemData Pulumi.AzureNative.DataMigration.Outputs.SystemDataResponse
Type string
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
IntegrationRuntimeState string
Current state of the Integration runtime.
Name string
ProvisioningState string
Provisioning state to track the async operation status.
SystemData SystemDataResponse
Type string
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
integrationRuntimeState String
Current state of the Integration runtime.
name String
provisioningState String
Provisioning state to track the async operation status.
systemData SystemDataResponse
type String
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
integrationRuntimeState string
Current state of the Integration runtime.
name string
provisioningState string
Provisioning state to track the async operation status.
systemData SystemDataResponse
type string
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
integration_runtime_state str
Current state of the Integration runtime.
name str
provisioning_state str
Provisioning state to track the async operation status.
system_data SystemDataResponse
type str
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
integrationRuntimeState String
Current state of the Integration runtime.
name String
provisioningState String
Provisioning state to track the async operation status.
systemData Property Map
type String

Supporting Types

SystemDataResponse
, SystemDataResponseArgs

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:datamigration:SqlMigrationService testagent /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataMigration/sqlMigrationServices/{sqlMigrationServiceName} 
Copy

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

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0