1. Docs
  2. Reference
  3. API
  4. @pulumi/azure
  5. databasemigration

Module databasemigration

This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.

Resources

Functions

Others

Resources

Resource Project

class Project extends CustomResource

Manage a Azure Database Migration Project.

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

Example Usage

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
    addressSpaces: ["10.0.0.0/16"],
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleSubnet = new azure.network.Subnet("exampleSubnet", {
    resourceGroupName: exampleResourceGroup.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefix: "10.0.1.0/24",
});
const exampleService = new azure.databasemigration.Service("exampleService", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    virtualSubnetId: exampleSubnet.id,
    skuName: "Standard_1vCores",
});
const exampleProject = new azure.databasemigration.Project("exampleProject", {
    serviceName: exampleService.name,
    resourceGroupName: exampleResourceGroup.name,
    location: zurerm_resource_group.example.location,
    sourcePlatform: "SQL",
    targetPlatform: "SQLDB",
});

constructor

new Project(name: string, args: ProjectArgs, opts?: pulumi.CustomResourceOptions)

Create a Project resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ProjectState, opts?: pulumi.CustomResourceOptions): Project

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Project

Returns true if the given object is an instance of Project. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

public name: pulumi.Output<string>;

Specify the name of the database migration project. Changing this forces a new resource to be created.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

Name of the resource group in which to create the database migration project. Changing this forces a new resource to be created.

property serviceName

public serviceName: pulumi.Output<string>;

Name of the database migration service where resource belongs to. Changing this forces a new resource to be created.

property sourcePlatform

public sourcePlatform: pulumi.Output<string>;

The platform type of the migration source. Currently only support: SQL(on-premises SQL Server). Changing this forces a new resource to be created.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assigned to the resource.

property targetPlatform

public targetPlatform: pulumi.Output<string>;

The platform type of the migration target. Currently only support: SQLDB(Azure SQL Database). Changing this forces a new resource to be created.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Service

class Service extends CustomResource

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 exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
    addressSpaces: ["10.0.0.0/16"],
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleSubnet = new azure.network.Subnet("exampleSubnet", {
    resourceGroupName: exampleResourceGroup.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefix: "10.0.1.0/24",
});
const exampleService = new azure.databasemigration.Service("exampleService", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    subnetId: exampleSubnet.id,
    skuName: "Standard_1vCores",
});

constructor

new Service(name: string, args: ServiceArgs, opts?: pulumi.CustomResourceOptions)

Create a Service resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ServiceState, opts?: pulumi.CustomResourceOptions): Service

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Service

Returns true if the given object is an instance of Service. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

public name: pulumi.Output<string>;

Specify the name of the database migration service. Changing this forces a new resource to be created.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

Name of the resource group in which to create the database migration service. Changing this forces a new resource to be created.

property skuName

public skuName: pulumi.Output<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.

property subnetId

public subnetId: pulumi.Output<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.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assigned to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Functions

Function getProject

getProject(args: GetProjectArgs, opts?: pulumi.InvokeOptions): Promise<GetProjectResult>

Use this data source to access information about an existing Database Migration Project.

Example Usage

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

const example = pulumi.output(azure.databasemigration.getProject({
    name: "example-dbms-project",
    resourceGroupName: "example-rg",
    serviceName: "example-dbms",
}, { async: true }));

export const name = example.name;

Function getService

getService(args: GetServiceArgs, opts?: pulumi.InvokeOptions): Promise<GetServiceResult>

Use this data source to access information about an existing Database Migration Service.

Example Usage

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

const example = pulumi.output(azure.databasemigration.getService({
    name: "example-dms",
    resourceGroupName: "example-rg",
}, { async: true }));

export const azurermDmsId = example.id;

Others

interface GetProjectArgs

interface GetProjectArgs

A collection of arguments for invoking getProject.

property name

name: string;

Name of the database migration project.

property resourceGroupName

resourceGroupName: string;

Name of the resource group where resource belongs to.

property serviceName

serviceName: string;

Name of the database migration service where resource belongs to.

interface GetProjectResult

interface GetProjectResult

A collection of values returned by getProject.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property location

location: string;

Azure location where the resource exists.

property name

name: string;

property resourceGroupName

resourceGroupName: string;

property serviceName

serviceName: string;

property sourcePlatform

sourcePlatform: string;

The platform type of the migration source.

property tags

tags: {[key: string]: string};

A mapping of tags to assigned to the resource.

property targetPlatform

targetPlatform: string;

The platform type of the migration target.

interface GetServiceArgs

interface GetServiceArgs

A collection of arguments for invoking getService.

property name

name: string;

Specify the name of the database migration service.

property resourceGroupName

resourceGroupName: string;

Specifies the Name of the Resource Group within which the database migration service exists

interface GetServiceResult

interface GetServiceResult

A collection of values returned by getService.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property location

location: string;

Azure location where the resource exists.

property name

name: string;

property resourceGroupName

resourceGroupName: string;

property skuName

skuName: string;

The sku name of database migration service.

property subnetId

subnetId: string;

The ID of the virtual subnet resource to which the database migration service exists.

property tags

tags: {[key: string]: string};

A mapping of tags to assigned to the resource.

interface ProjectArgs

interface ProjectArgs

The set of arguments for constructing a Project resource.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specify the name of the database migration project. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

Name of the resource group in which to create the database migration project. Changing this forces a new resource to be created.

property serviceName

serviceName: pulumi.Input<string>;

Name of the database migration service where resource belongs to. Changing this forces a new resource to be created.

property sourcePlatform

sourcePlatform: pulumi.Input<string>;

The platform type of the migration source. Currently only support: SQL(on-premises SQL Server). Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assigned to the resource.

property targetPlatform

targetPlatform: pulumi.Input<string>;

The platform type of the migration target. Currently only support: SQLDB(Azure SQL Database). Changing this forces a new resource to be created.

interface ProjectState

interface ProjectState

Input properties used for looking up and filtering Project resources.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specify the name of the database migration project. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

Name of the resource group in which to create the database migration project. Changing this forces a new resource to be created.

property serviceName

serviceName?: pulumi.Input<string>;

Name of the database migration service where resource belongs to. Changing this forces a new resource to be created.

property sourcePlatform

sourcePlatform?: pulumi.Input<string>;

The platform type of the migration source. Currently only support: SQL(on-premises SQL Server). Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assigned to the resource.

property targetPlatform

targetPlatform?: pulumi.Input<string>;

The platform type of the migration target. Currently only support: SQLDB(Azure SQL Database). Changing this forces a new resource to be created.

interface ServiceArgs

interface ServiceArgs

The set of arguments for constructing a Service resource.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specify the name of the database migration service. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

Name of the resource group in which to create the database migration service. Changing this forces a new resource to be created.

property skuName

skuName: pulumi.Input<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.

property subnetId

subnetId: pulumi.Input<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.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assigned to the resource.

interface ServiceState

interface ServiceState

Input properties used for looking up and filtering Service resources.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specify the name of the database migration service. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

Name of the resource group in which to create the database migration service. Changing this forces a new resource to be created.

property skuName

skuName?: pulumi.Input<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.

property subnetId

subnetId?: pulumi.Input<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.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assigned to the resource.