Partager via


Microsoft.DataMigration services/projects 2021-10-30-preview

Bicep resource definition

The services/projects 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/services/projects resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DataMigration/services/projects@2021-10-30-preview' = {
  parent: resourceSymbolicName
  eTag: 'string'
  location: 'string'
  name: 'string'
  properties: {
    azureAuthenticationInfo: 'string'
    databasesInfo: [
      {
        sourceDatabaseName: 'string'
      }
    ]
    sourceConnectionInfo: {
      password: 'string'
      userName: 'string'
      type: 'string'
      // For remaining properties, see ConnectionInfo objects
    }
    sourcePlatform: 'string'
    targetConnectionInfo: {
      password: 'string'
      userName: 'string'
      type: 'string'
      // For remaining properties, see ConnectionInfo objects
    }
    targetPlatform: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

ConnectionInfo objects

Set the type property to specify the type of object.

For MiSqlConnectionInfo, use:

{
  managedInstanceResourceId: 'string'
  type: 'MiSqlConnectionInfo'
}

For MongoDbConnectionInfo, use:

{
  additionalSettings: 'string'
  connectionString: 'string'
  dataSource: 'string'
  encryptConnection: bool
  enforceSSL: bool
  port: int
  serverBrandVersion: 'string'
  type: 'MongoDbConnectionInfo'
}

For MySqlConnectionInfo, use:

{
  dataSource: 'string'
  encryptConnection: bool
  port: int
  serverName: 'string'
  type: 'MySqlConnectionInfo'
}

For OracleConnectionInfo, use:

{
  dataSource: 'string'
  type: 'OracleConnectionInfo'
}

For PostgreSqlConnectionInfo, use:

{
  databaseName: 'string'
  dataSource: 'string'
  encryptConnection: bool
  port: int
  serverName: 'string'
  serverVersion: 'string'
  trustServerCertificate: bool
  type: 'PostgreSqlConnectionInfo'
}

For SqlConnectionInfo, use:

{
  additionalSettings: 'string'
  authentication: 'string'
  dataSource: 'string'
  encryptConnection: bool
  platform: 'string'
  port: 'string'
  resourceId: 'string'
  serverName: 'string'
  trustServerCertificate: bool
  type: 'SqlConnectionInfo'
}

Property Values

ConnectionInfo

Name Description Value
password Password credential. string
type Set to 'MiSqlConnectionInfo' for type MiSqlConnectionInfo. Set to 'MongoDbConnectionInfo' for type MongoDbConnectionInfo. Set to 'MySqlConnectionInfo' for type MySqlConnectionInfo. Set to 'OracleConnectionInfo' for type OracleConnectionInfo. Set to 'PostgreSqlConnectionInfo' for type PostgreSqlConnectionInfo. Set to 'SqlConnectionInfo' for type SqlConnectionInfo. 'MiSqlConnectionInfo'
'MongoDbConnectionInfo'
'MySqlConnectionInfo'
'OracleConnectionInfo'
'PostgreSqlConnectionInfo'
'SqlConnectionInfo' (required)
userName User name string

DatabaseInfo

Name Description Value
sourceDatabaseName Name of the database string (required)

Microsoft.DataMigration/services/projects

Name Description Value
eTag HTTP strong entity tag value. This is ignored if submitted. string
location string
name The resource name string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.
Symbolic name for resource of type: services
properties Project properties ProjectProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

MiSqlConnectionInfo

Name Description Value
managedInstanceResourceId Resource id for Azure SQL database Managed instance string (required)
type Type of connection info 'MiSqlConnectionInfo' (required)

MongoDbConnectionInfo

Name Description Value
additionalSettings Additional connection settings string
connectionString A MongoDB connection string or blob container URL. The user name and password can be specified here or in the userName and password properties string (required)
dataSource Data source string
encryptConnection Whether to encrypt the connection bool
enforceSSL bool
port port for server int
serverBrandVersion server brand version string
type Type of connection info 'MongoDbConnectionInfo' (required)

MySqlConnectionInfo

Name Description Value
dataSource Data source string
encryptConnection Whether to encrypt the connection bool
port Port for Server int (required)
serverName Name of the server string (required)
type Type of connection info 'MySqlConnectionInfo' (required)

OracleConnectionInfo

Name Description Value
dataSource EZConnect or TNSName connection string. string (required)
type Type of connection info 'OracleConnectionInfo' (required)

PostgreSqlConnectionInfo

Name Description Value
databaseName Name of the database string
dataSource Data source string
encryptConnection Whether to encrypt the connection bool
port Port for Server int (required)
serverName Name of the server string (required)
serverVersion server version string
trustServerCertificate Whether to trust the server certificate bool
type Type of connection info 'PostgreSqlConnectionInfo' (required)

ProjectProperties

Name Description Value
azureAuthenticationInfo Field that defines the Azure active directory application info, used to connect to the target Azure resource string
databasesInfo List of DatabaseInfo DatabaseInfo[]
sourceConnectionInfo Information for connecting to source ConnectionInfo
sourcePlatform Source platform for the project 'MongoDb'
'MySQL'
'PostgreSql'
'SQL'
'Unknown' (required)
targetConnectionInfo Information for connecting to target ConnectionInfo
targetPlatform Target platform for the project 'AzureDbForMySql'
'AzureDbForPostgreSql'
'MongoDb'
'SQLDB'
'SQLMI'
'Unknown' (required)

SqlConnectionInfo

Name Description Value
additionalSettings Additional connection settings string
authentication Authentication type to use for connection 'ActiveDirectoryIntegrated'
'ActiveDirectoryPassword'
'None'
'SqlAuthentication'
'WindowsAuthentication'
dataSource Data source in the format Protocol:MachineName\SQLServerInstanceName,PortNumber string (required)
encryptConnection Whether to encrypt the connection bool
platform Server platform type for connection 'SqlOnPrem'
port port for server string
resourceId Represents the ID of an HTTP resource represented by an Azure resource provider. string
serverName name of the server string
trustServerCertificate Whether to trust the server certificate bool
type Type of connection info 'SqlConnectionInfo' (required)

TrackedResourceTags

Name Description Value

ARM template resource definition

The services/projects 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/services/projects resource, add the following JSON to your template.

{
  "type": "Microsoft.DataMigration/services/projects",
  "apiVersion": "2021-10-30-preview",
  "name": "string",
  "eTag": "string",
  "location": "string",
  "properties": {
    "azureAuthenticationInfo": "string",
    "databasesInfo": [
      {
        "sourceDatabaseName": "string"
      }
    ],
    "sourceConnectionInfo": {
      "password": "string",
      "userName": "string",
      "type": "string"
      // For remaining properties, see ConnectionInfo objects
    },
    "sourcePlatform": "string",
    "targetConnectionInfo": {
      "password": "string",
      "userName": "string",
      "type": "string"
      // For remaining properties, see ConnectionInfo objects
    },
    "targetPlatform": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

ConnectionInfo objects

Set the type property to specify the type of object.

For MiSqlConnectionInfo, use:

{
  "managedInstanceResourceId": "string",
  "type": "MiSqlConnectionInfo"
}

For MongoDbConnectionInfo, use:

{
  "additionalSettings": "string",
  "connectionString": "string",
  "dataSource": "string",
  "encryptConnection": "bool",
  "enforceSSL": "bool",
  "port": "int",
  "serverBrandVersion": "string",
  "type": "MongoDbConnectionInfo"
}

For MySqlConnectionInfo, use:

{
  "dataSource": "string",
  "encryptConnection": "bool",
  "port": "int",
  "serverName": "string",
  "type": "MySqlConnectionInfo"
}

For OracleConnectionInfo, use:

{
  "dataSource": "string",
  "type": "OracleConnectionInfo"
}

For PostgreSqlConnectionInfo, use:

{
  "databaseName": "string",
  "dataSource": "string",
  "encryptConnection": "bool",
  "port": "int",
  "serverName": "string",
  "serverVersion": "string",
  "trustServerCertificate": "bool",
  "type": "PostgreSqlConnectionInfo"
}

For SqlConnectionInfo, use:

{
  "additionalSettings": "string",
  "authentication": "string",
  "dataSource": "string",
  "encryptConnection": "bool",
  "platform": "string",
  "port": "string",
  "resourceId": "string",
  "serverName": "string",
  "trustServerCertificate": "bool",
  "type": "SqlConnectionInfo"
}

Property Values

ConnectionInfo

Name Description Value
password Password credential. string
type Set to 'MiSqlConnectionInfo' for type MiSqlConnectionInfo. Set to 'MongoDbConnectionInfo' for type MongoDbConnectionInfo. Set to 'MySqlConnectionInfo' for type MySqlConnectionInfo. Set to 'OracleConnectionInfo' for type OracleConnectionInfo. Set to 'PostgreSqlConnectionInfo' for type PostgreSqlConnectionInfo. Set to 'SqlConnectionInfo' for type SqlConnectionInfo. 'MiSqlConnectionInfo'
'MongoDbConnectionInfo'
'MySqlConnectionInfo'
'OracleConnectionInfo'
'PostgreSqlConnectionInfo'
'SqlConnectionInfo' (required)
userName User name string

DatabaseInfo

Name Description Value
sourceDatabaseName Name of the database string (required)

Microsoft.DataMigration/services/projects

Name Description Value
apiVersion The api version '2021-10-30-preview'
eTag HTTP strong entity tag value. This is ignored if submitted. string
location string
name The resource name string (required)
properties Project properties ProjectProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.DataMigration/services/projects'

MiSqlConnectionInfo

Name Description Value
managedInstanceResourceId Resource id for Azure SQL database Managed instance string (required)
type Type of connection info 'MiSqlConnectionInfo' (required)

MongoDbConnectionInfo

Name Description Value
additionalSettings Additional connection settings string
connectionString A MongoDB connection string or blob container URL. The user name and password can be specified here or in the userName and password properties string (required)
dataSource Data source string
encryptConnection Whether to encrypt the connection bool
enforceSSL bool
port port for server int
serverBrandVersion server brand version string
type Type of connection info 'MongoDbConnectionInfo' (required)

MySqlConnectionInfo

Name Description Value
dataSource Data source string
encryptConnection Whether to encrypt the connection bool
port Port for Server int (required)
serverName Name of the server string (required)
type Type of connection info 'MySqlConnectionInfo' (required)

OracleConnectionInfo

Name Description Value
dataSource EZConnect or TNSName connection string. string (required)
type Type of connection info 'OracleConnectionInfo' (required)

PostgreSqlConnectionInfo

Name Description Value
databaseName Name of the database string
dataSource Data source string
encryptConnection Whether to encrypt the connection bool
port Port for Server int (required)
serverName Name of the server string (required)
serverVersion server version string
trustServerCertificate Whether to trust the server certificate bool
type Type of connection info 'PostgreSqlConnectionInfo' (required)

ProjectProperties

Name Description Value
azureAuthenticationInfo Field that defines the Azure active directory application info, used to connect to the target Azure resource string
databasesInfo List of DatabaseInfo DatabaseInfo[]
sourceConnectionInfo Information for connecting to source ConnectionInfo
sourcePlatform Source platform for the project 'MongoDb'
'MySQL'
'PostgreSql'
'SQL'
'Unknown' (required)
targetConnectionInfo Information for connecting to target ConnectionInfo
targetPlatform Target platform for the project 'AzureDbForMySql'
'AzureDbForPostgreSql'
'MongoDb'
'SQLDB'
'SQLMI'
'Unknown' (required)

SqlConnectionInfo

Name Description Value
additionalSettings Additional connection settings string
authentication Authentication type to use for connection 'ActiveDirectoryIntegrated'
'ActiveDirectoryPassword'
'None'
'SqlAuthentication'
'WindowsAuthentication'
dataSource Data source in the format Protocol:MachineName\SQLServerInstanceName,PortNumber string (required)
encryptConnection Whether to encrypt the connection bool
platform Server platform type for connection 'SqlOnPrem'
port port for server string
resourceId Represents the ID of an HTTP resource represented by an Azure resource provider. string
serverName name of the server string
trustServerCertificate Whether to trust the server certificate bool
type Type of connection info 'SqlConnectionInfo' (required)

TrackedResourceTags

Name Description Value

Exemples d’utilisation

Terraform (AzAPI provider) resource definition

The services/projects resource type can be deployed with operations that target:

  • Resource groups

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

Resource format

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DataMigration/services/projects@2021-10-30-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    eTag = "string"
    properties = {
      azureAuthenticationInfo = "string"
      databasesInfo = [
        {
          sourceDatabaseName = "string"
        }
      ]
      sourceConnectionInfo = {
        password = "string"
        userName = "string"
        type = "string"
        // For remaining properties, see ConnectionInfo objects
      }
      sourcePlatform = "string"
      targetConnectionInfo = {
        password = "string"
        userName = "string"
        type = "string"
        // For remaining properties, see ConnectionInfo objects
      }
      targetPlatform = "string"
    }
  }
}

ConnectionInfo objects

Set the type property to specify the type of object.

For MiSqlConnectionInfo, use:

{
  managedInstanceResourceId = "string"
  type = "MiSqlConnectionInfo"
}

For MongoDbConnectionInfo, use:

{
  additionalSettings = "string"
  connectionString = "string"
  dataSource = "string"
  encryptConnection = bool
  enforceSSL = bool
  port = int
  serverBrandVersion = "string"
  type = "MongoDbConnectionInfo"
}

For MySqlConnectionInfo, use:

{
  dataSource = "string"
  encryptConnection = bool
  port = int
  serverName = "string"
  type = "MySqlConnectionInfo"
}

For OracleConnectionInfo, use:

{
  dataSource = "string"
  type = "OracleConnectionInfo"
}

For PostgreSqlConnectionInfo, use:

{
  databaseName = "string"
  dataSource = "string"
  encryptConnection = bool
  port = int
  serverName = "string"
  serverVersion = "string"
  trustServerCertificate = bool
  type = "PostgreSqlConnectionInfo"
}

For SqlConnectionInfo, use:

{
  additionalSettings = "string"
  authentication = "string"
  dataSource = "string"
  encryptConnection = bool
  platform = "string"
  port = "string"
  resourceId = "string"
  serverName = "string"
  trustServerCertificate = bool
  type = "SqlConnectionInfo"
}

Property Values

ConnectionInfo

Name Description Value
password Password credential. string
type Set to 'MiSqlConnectionInfo' for type MiSqlConnectionInfo. Set to 'MongoDbConnectionInfo' for type MongoDbConnectionInfo. Set to 'MySqlConnectionInfo' for type MySqlConnectionInfo. Set to 'OracleConnectionInfo' for type OracleConnectionInfo. Set to 'PostgreSqlConnectionInfo' for type PostgreSqlConnectionInfo. Set to 'SqlConnectionInfo' for type SqlConnectionInfo. 'MiSqlConnectionInfo'
'MongoDbConnectionInfo'
'MySqlConnectionInfo'
'OracleConnectionInfo'
'PostgreSqlConnectionInfo'
'SqlConnectionInfo' (required)
userName User name string

DatabaseInfo

Name Description Value
sourceDatabaseName Name of the database string (required)

Microsoft.DataMigration/services/projects

Name Description Value
eTag HTTP strong entity tag value. This is ignored if submitted. string
location string
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: services
properties Project properties ProjectProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.DataMigration/services/projects@2021-10-30-preview"

MiSqlConnectionInfo

Name Description Value
managedInstanceResourceId Resource id for Azure SQL database Managed instance string (required)
type Type of connection info 'MiSqlConnectionInfo' (required)

MongoDbConnectionInfo

Name Description Value
additionalSettings Additional connection settings string
connectionString A MongoDB connection string or blob container URL. The user name and password can be specified here or in the userName and password properties string (required)
dataSource Data source string
encryptConnection Whether to encrypt the connection bool
enforceSSL bool
port port for server int
serverBrandVersion server brand version string
type Type of connection info 'MongoDbConnectionInfo' (required)

MySqlConnectionInfo

Name Description Value
dataSource Data source string
encryptConnection Whether to encrypt the connection bool
port Port for Server int (required)
serverName Name of the server string (required)
type Type of connection info 'MySqlConnectionInfo' (required)

OracleConnectionInfo

Name Description Value
dataSource EZConnect or TNSName connection string. string (required)
type Type of connection info 'OracleConnectionInfo' (required)

PostgreSqlConnectionInfo

Name Description Value
databaseName Name of the database string
dataSource Data source string
encryptConnection Whether to encrypt the connection bool
port Port for Server int (required)
serverName Name of the server string (required)
serverVersion server version string
trustServerCertificate Whether to trust the server certificate bool
type Type of connection info 'PostgreSqlConnectionInfo' (required)

ProjectProperties

Name Description Value
azureAuthenticationInfo Field that defines the Azure active directory application info, used to connect to the target Azure resource string
databasesInfo List of DatabaseInfo DatabaseInfo[]
sourceConnectionInfo Information for connecting to source ConnectionInfo
sourcePlatform Source platform for the project 'MongoDb'
'MySQL'
'PostgreSql'
'SQL'
'Unknown' (required)
targetConnectionInfo Information for connecting to target ConnectionInfo
targetPlatform Target platform for the project 'AzureDbForMySql'
'AzureDbForPostgreSql'
'MongoDb'
'SQLDB'
'SQLMI'
'Unknown' (required)

SqlConnectionInfo

Name Description Value
additionalSettings Additional connection settings string
authentication Authentication type to use for connection 'ActiveDirectoryIntegrated'
'ActiveDirectoryPassword'
'None'
'SqlAuthentication'
'WindowsAuthentication'
dataSource Data source in the format Protocol:MachineName\SQLServerInstanceName,PortNumber string (required)
encryptConnection Whether to encrypt the connection bool
platform Server platform type for connection 'SqlOnPrem'
port port for server string
resourceId Represents the ID of an HTTP resource represented by an Azure resource provider. string
serverName name of the server string
trustServerCertificate Whether to trust the server certificate bool
type Type of connection info 'SqlConnectionInfo' (required)

TrackedResourceTags

Name Description Value