Microsoft.DataMigration databaseMigrations 2022-03-30-preview

Bicep resource definition

The databaseMigrations resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DataMigration/databaseMigrations resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DataMigration/databaseMigrations@2022-03-30-preview' = {
  scope: resourceSymbolicName or scope
  name: 'string'
  properties: {
    kind: 'string'
    migrationOperationId: 'string'
    migrationService: 'string'
    provisioningError: 'string'
    scope: 'string'
    sourceDatabaseName: 'string'
    sourceSqlConnection: {
      authentication: 'string'
      dataSource: 'string'
      encryptConnection: bool
      password: 'string'
      trustServerCertificate: bool
      userName: 'string'
    }
    tableList: [
      'string'
    ]
    targetDatabaseCollation: 'string'
    targetSqlConnection: {
      authentication: 'string'
      dataSource: 'string'
      encryptConnection: bool
      password: 'string'
      trustServerCertificate: bool
      userName: 'string'
    }
  }
}

Property Values

Microsoft.DataMigration/databaseMigrations

Name Description Value
name The resource name string (required)
properties Database Migration Resource properties for SQL database. DatabaseMigrationPropertiesSqlDb
scope Use when creating a resource at a scope that is different than the deployment scope. Set this property to the symbolic name of a resource to apply the extension resource.

DatabaseMigrationPropertiesSqlDb

Name Description Value
kind 'SqlDb'
'SqlMi'
'SqlVm' (required)
migrationOperationId ID tracking current migration operation. string
migrationService Resource Id of the Migration Service. string
provisioningError Error message for migration provisioning failure, if any. string
scope Resource Id of the target resource (SQL VM or SQL Managed Instance). string
sourceDatabaseName Name of the source database. string
sourceSqlConnection Source SQL Server connection details. SqlConnectionInformation
tableList List of tables to copy. string[]
targetDatabaseCollation Database collation to be used for the target database. string
targetSqlConnection Target SQL DB connection details. SqlConnectionInformation

SqlConnectionInformation

Name Description Value
authentication Authentication type. string
dataSource Data source. string
encryptConnection Whether to encrypt connection or not. bool
password Password to connect to source SQL. string

Constraints:
Sensitive value. Pass in as a secure parameter.
trustServerCertificate Whether to trust server certificate or not. bool
userName User name to connect to source SQL. string

ARM template resource definition

The databaseMigrations resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Usage Examples

Resource format

To create a Microsoft.DataMigration/databaseMigrations resource, add the following JSON to your template.

{
  "type": "Microsoft.DataMigration/databaseMigrations",
  "apiVersion": "2022-03-30-preview",
  "name": "string",
  "properties": {
    "kind": "string",
    "migrationOperationId": "string",
    "migrationService": "string",
    "provisioningError": "string",
    "scope": "string",
    "sourceDatabaseName": "string",
    "sourceSqlConnection": {
      "authentication": "string",
      "dataSource": "string",
      "encryptConnection": "bool",
      "password": "string",
      "trustServerCertificate": "bool",
      "userName": "string"
    },
    "tableList": [ "string" ],
    "targetDatabaseCollation": "string",
    "targetSqlConnection": {
      "authentication": "string",
      "dataSource": "string",
      "encryptConnection": "bool",
      "password": "string",
      "trustServerCertificate": "bool",
      "userName": "string"
    }
  }
}

Property Values

Microsoft.DataMigration/databaseMigrations

Name Description Value
apiVersion The api version '2022-03-30-preview'
name The resource name string (required)
properties Database Migration Resource properties for SQL database. DatabaseMigrationPropertiesSqlDb
type The resource type 'Microsoft.DataMigration/databaseMigrations'

DatabaseMigrationPropertiesSqlDb

Name Description Value
kind 'SqlDb'
'SqlMi'
'SqlVm' (required)
migrationOperationId ID tracking current migration operation. string
migrationService Resource Id of the Migration Service. string
provisioningError Error message for migration provisioning failure, if any. string
scope Resource Id of the target resource (SQL VM or SQL Managed Instance). string
sourceDatabaseName Name of the source database. string
sourceSqlConnection Source SQL Server connection details. SqlConnectionInformation
tableList List of tables to copy. string[]
targetDatabaseCollation Database collation to be used for the target database. string
targetSqlConnection Target SQL DB connection details. SqlConnectionInformation

SqlConnectionInformation

Name Description Value
authentication Authentication type. string
dataSource Data source. string
encryptConnection Whether to encrypt connection or not. bool
password Password to connect to source SQL. string

Constraints:
Sensitive value. Pass in as a secure parameter.
trustServerCertificate Whether to trust server certificate or not. bool
userName User name to connect to source SQL. string

Terraform (AzAPI provider) resource definition

The databaseMigrations resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DataMigration/databaseMigrations resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DataMigration/databaseMigrations@2022-03-30-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      kind = "string"
      migrationOperationId = "string"
      migrationService = "string"
      provisioningError = "string"
      scope = "string"
      sourceDatabaseName = "string"
      sourceSqlConnection = {
        authentication = "string"
        dataSource = "string"
        encryptConnection = bool
        password = "string"
        trustServerCertificate = bool
        userName = "string"
      }
      tableList = [
        "string"
      ]
      targetDatabaseCollation = "string"
      targetSqlConnection = {
        authentication = "string"
        dataSource = "string"
        encryptConnection = bool
        password = "string"
        trustServerCertificate = bool
        userName = "string"
      }
    }
  }
}

Property Values

Microsoft.DataMigration/databaseMigrations

Name Description Value
name The resource name string (required)
parent_id The ID of the resource to apply this extension resource to. string (required)
properties Database Migration Resource properties for SQL database. DatabaseMigrationPropertiesSqlDb
type The resource type "Microsoft.DataMigration/databaseMigrations@2022-03-30-preview"

DatabaseMigrationPropertiesSqlDb

Name Description Value
kind 'SqlDb'
'SqlMi'
'SqlVm' (required)
migrationOperationId ID tracking current migration operation. string
migrationService Resource Id of the Migration Service. string
provisioningError Error message for migration provisioning failure, if any. string
scope Resource Id of the target resource (SQL VM or SQL Managed Instance). string
sourceDatabaseName Name of the source database. string
sourceSqlConnection Source SQL Server connection details. SqlConnectionInformation
tableList List of tables to copy. string[]
targetDatabaseCollation Database collation to be used for the target database. string
targetSqlConnection Target SQL DB connection details. SqlConnectionInformation

SqlConnectionInformation

Name Description Value
authentication Authentication type. string
dataSource Data source. string
encryptConnection Whether to encrypt connection or not. bool
password Password to connect to source SQL. string

Constraints:
Sensitive value. Pass in as a secure parameter.
trustServerCertificate Whether to trust server certificate or not. bool
userName User name to connect to source SQL. string
  • Last updated on