Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The services/projects resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Usage Examples
Bicep Samples
A basic example of deploying Azure Database Migration Project instance.
param resourceName string = 'acctest0001'
param location string = 'westeurope'
resource service 'Microsoft.DataMigration/services@2018-04-19' = {
name: resourceName
location: location
sku: {
name: 'Standard_1vCores'
}
kind: 'Cloud'
properties: {
virtualSubnetId: subnet.id
}
}
resource virtualNetwork 'Microsoft.Network/virtualNetworks@2022-07-01' = {
name: resourceName
location: location
properties: {
addressSpace: {
addressPrefixes: [
'10.0.0.0/16'
]
}
dhcpOptions: {
dnsServers: []
}
subnets: []
}
}
resource project 'Microsoft.DataMigration/services/projects@2018-04-19' = {
name: resourceName
location: location
parent: service
properties: {
sourcePlatform: 'SQL'
targetPlatform: 'SQLDB'
}
}
resource subnet 'Microsoft.Network/virtualNetworks/subnets@2022-07-01' = {
name: resourceName
parent: virtualNetwork
properties: {
addressPrefix: '10.0.1.0/24'
delegations: []
privateEndpointNetworkPolicies: 'Enabled'
privateLinkServiceNetworkPolicies: 'Enabled'
serviceEndpointPolicies: []
serviceEndpoints: []
}
}
Resource format
To create a Microsoft.DataMigration/services/projects resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DataMigration/services/projects@2025-09-01-preview' = {
parent: resourceSymbolicName
etag: 'string'
location: 'string'
name: 'string'
properties: {
azureAuthenticationInfo: {
appKey: 'string'
applicationId: 'string'
ignoreAzurePermissions: bool
tenantId: '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'
authentication: 'string'
connectionString: 'string'
dataSource: 'string'
encryptConnection: bool
enforceSSL: bool
port: int
serverBrandVersion: 'string'
serverName: 'string'
serverVersion: 'string'
trustServerCertificate: bool
type: 'MongoDbConnectionInfo'
}
For MySqlConnectionInfo, use:
{
additionalSettings: 'string'
authentication: 'string'
dataSource: 'string'
encryptConnection: bool
port: int
serverName: 'string'
type: 'MySqlConnectionInfo'
}
For OracleConnectionInfo, use:
{
authentication: 'string'
dataSource: 'string'
port: int
serverName: 'string'
serverVersion: 'string'
type: 'OracleConnectionInfo'
}
For PostgreSqlConnectionInfo, use:
{
additionalSettings: 'string'
authentication: 'string'
databaseName: 'string'
dataSource: 'string'
encryptConnection: bool
port: int
serverBrandVersion: 'string'
serverName: 'string'
serverVersion: 'string'
trustServerCertificate: bool
type: 'PostgreSqlConnectionInfo'
}
For SqlConnectionInfo, use:
{
additionalSettings: 'string'
authentication: 'string'
dataSource: 'string'
encryptConnection: bool
platform: 'string'
port: int
resourceId: 'string'
serverBrandVersion: 'string'
serverName: 'string'
serverVersion: 'string'
trustServerCertificate: bool
type: 'SqlConnectionInfo'
}
Property Values
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 |
AzureActiveDirectoryApp
| Name | Description | Value |
|---|---|---|
| appKey | Key used to authenticate to the Azure Active Directory Application | string |
| applicationId | Application ID of the Azure Active Directory Application | string |
| ignoreAzurePermissions | Ignore checking azure permissions on the AAD app | bool |
| tenantId | Tenant id of the customer | string |
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) |
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 |
| authentication | Authentication type to use for connection | 'ActiveDirectoryIntegrated' 'ActiveDirectoryPassword' 'None' 'SqlAuthentication' 'WindowsAuthentication' |
| 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 |
| serverName | name of the server | string |
| serverVersion | server version | string |
| trustServerCertificate | Whether to trust the server certificate | bool |
| type | Type of connection info | 'MongoDbConnectionInfo' (required) |
MySqlConnectionInfo
| Name | Description | Value |
|---|---|---|
| additionalSettings | Additional connection settings | string |
| authentication | Authentication type to use for connection | 'ActiveDirectoryIntegrated' 'ActiveDirectoryPassword' 'None' 'SqlAuthentication' 'WindowsAuthentication' |
| 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 |
|---|---|---|
| authentication | Authentication type to use for connection | 'ActiveDirectoryIntegrated' 'ActiveDirectoryPassword' 'None' 'SqlAuthentication' 'WindowsAuthentication' |
| dataSource | EZConnect or TNSName connection string. | string (required) |
| port | port for server | int |
| serverName | name of the server | string |
| serverVersion | server version | string |
| type | Type of connection info | 'OracleConnectionInfo' (required) |
PostgreSqlConnectionInfo
| Name | Description | Value |
|---|---|---|
| additionalSettings | Additional connection settings | string |
| authentication | Authentication type to use for connection | 'ActiveDirectoryIntegrated' 'ActiveDirectoryPassword' 'None' 'SqlAuthentication' 'WindowsAuthentication' |
| databaseName | Name of the database | string |
| dataSource | Data source | string |
| encryptConnection | Whether to encrypt the connection | bool |
| port | Port for Server | int (required) |
| serverBrandVersion | server brand version | string |
| 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 | AzureActiveDirectoryApp |
| 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) |
ProjectTags
| Name | Description | Value |
|---|
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 | int |
| resourceId | Represents the ID of an HTTP resource represented by an Azure resource provider. | string |
| serverBrandVersion | server brand version | string |
| serverName | name of the server | string |
| serverVersion | server version | string |
| trustServerCertificate | Whether to trust the server certificate | bool |
| type | Type of connection info | 'SqlConnectionInfo' (required) |
ARM template resource definition
The services/projects resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands For a list of changed properties in each API version, see change log.
Usage Examples
Resource format
To create a Microsoft.DataMigration/services/projects resource, add the following JSON to your template.
{
"type": "Microsoft.DataMigration/services/projects",
"apiVersion": "2025-09-01-preview",
"name": "string",
"etag": "string",
"location": "string",
"properties": {
"azureAuthenticationInfo": {
"appKey": "string",
"applicationId": "string",
"ignoreAzurePermissions": "bool",
"tenantId": "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",
"authentication": "string",
"connectionString": "string",
"dataSource": "string",
"encryptConnection": "bool",
"enforceSSL": "bool",
"port": "int",
"serverBrandVersion": "string",
"serverName": "string",
"serverVersion": "string",
"trustServerCertificate": "bool",
"type": "MongoDbConnectionInfo"
}
For MySqlConnectionInfo, use:
{
"additionalSettings": "string",
"authentication": "string",
"dataSource": "string",
"encryptConnection": "bool",
"port": "int",
"serverName": "string",
"type": "MySqlConnectionInfo"
}
For OracleConnectionInfo, use:
{
"authentication": "string",
"dataSource": "string",
"port": "int",
"serverName": "string",
"serverVersion": "string",
"type": "OracleConnectionInfo"
}
For PostgreSqlConnectionInfo, use:
{
"additionalSettings": "string",
"authentication": "string",
"databaseName": "string",
"dataSource": "string",
"encryptConnection": "bool",
"port": "int",
"serverBrandVersion": "string",
"serverName": "string",
"serverVersion": "string",
"trustServerCertificate": "bool",
"type": "PostgreSqlConnectionInfo"
}
For SqlConnectionInfo, use:
{
"additionalSettings": "string",
"authentication": "string",
"dataSource": "string",
"encryptConnection": "bool",
"platform": "string",
"port": "int",
"resourceId": "string",
"serverBrandVersion": "string",
"serverName": "string",
"serverVersion": "string",
"trustServerCertificate": "bool",
"type": "SqlConnectionInfo"
}
Property Values
Microsoft.DataMigration/services/projects
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2025-09-01-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' |
AzureActiveDirectoryApp
| Name | Description | Value |
|---|---|---|
| appKey | Key used to authenticate to the Azure Active Directory Application | string |
| applicationId | Application ID of the Azure Active Directory Application | string |
| ignoreAzurePermissions | Ignore checking azure permissions on the AAD app | bool |
| tenantId | Tenant id of the customer | string |
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) |
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 |
| authentication | Authentication type to use for connection | 'ActiveDirectoryIntegrated' 'ActiveDirectoryPassword' 'None' 'SqlAuthentication' 'WindowsAuthentication' |
| 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 |
| serverName | name of the server | string |
| serverVersion | server version | string |
| trustServerCertificate | Whether to trust the server certificate | bool |
| type | Type of connection info | 'MongoDbConnectionInfo' (required) |
MySqlConnectionInfo
| Name | Description | Value |
|---|---|---|
| additionalSettings | Additional connection settings | string |
| authentication | Authentication type to use for connection | 'ActiveDirectoryIntegrated' 'ActiveDirectoryPassword' 'None' 'SqlAuthentication' 'WindowsAuthentication' |
| 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 |
|---|---|---|
| authentication | Authentication type to use for connection | 'ActiveDirectoryIntegrated' 'ActiveDirectoryPassword' 'None' 'SqlAuthentication' 'WindowsAuthentication' |
| dataSource | EZConnect or TNSName connection string. | string (required) |
| port | port for server | int |
| serverName | name of the server | string |
| serverVersion | server version | string |
| type | Type of connection info | 'OracleConnectionInfo' (required) |
PostgreSqlConnectionInfo
| Name | Description | Value |
|---|---|---|
| additionalSettings | Additional connection settings | string |
| authentication | Authentication type to use for connection | 'ActiveDirectoryIntegrated' 'ActiveDirectoryPassword' 'None' 'SqlAuthentication' 'WindowsAuthentication' |
| databaseName | Name of the database | string |
| dataSource | Data source | string |
| encryptConnection | Whether to encrypt the connection | bool |
| port | Port for Server | int (required) |
| serverBrandVersion | server brand version | string |
| 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 | AzureActiveDirectoryApp |
| 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) |
ProjectTags
| Name | Description | Value |
|---|
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 | int |
| resourceId | Represents the ID of an HTTP resource represented by an Azure resource provider. | string |
| serverBrandVersion | server brand version | string |
| serverName | name of the server | string |
| serverVersion | server version | string |
| trustServerCertificate | Whether to trust the server certificate | bool |
| type | Type of connection info | 'SqlConnectionInfo' (required) |
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.
Usage Examples
Terraform Samples
A basic example of deploying Azure Database Migration Project instance.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "westeurope"
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = var.resource_name
location = var.location
}
resource "azapi_resource" "virtualNetwork" {
type = "Microsoft.Network/virtualNetworks@2022-07-01"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
properties = {
addressSpace = {
addressPrefixes = [
"10.0.0.0/16",
]
}
dhcpOptions = {
dnsServers = [
]
}
subnets = [
]
}
}
schema_validation_enabled = false
response_export_values = ["*"]
lifecycle {
ignore_changes = [body.properties.subnets]
}
}
resource "azapi_resource" "subnet" {
type = "Microsoft.Network/virtualNetworks/subnets@2022-07-01"
parent_id = azapi_resource.virtualNetwork.id
name = var.resource_name
body = {
properties = {
addressPrefix = "10.0.1.0/24"
delegations = [
]
privateEndpointNetworkPolicies = "Enabled"
privateLinkServiceNetworkPolicies = "Enabled"
serviceEndpointPolicies = [
]
serviceEndpoints = [
]
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
resource "azapi_resource" "service" {
type = "Microsoft.DataMigration/services@2018-04-19"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
kind = "Cloud"
properties = {
virtualSubnetId = azapi_resource.subnet.id
}
sku = {
name = "Standard_1vCores"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
resource "azapi_resource" "project" {
type = "Microsoft.DataMigration/services/projects@2018-04-19"
parent_id = azapi_resource.service.id
name = var.resource_name
location = var.location
body = {
properties = {
sourcePlatform = "SQL"
targetPlatform = "SQLDB"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
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@2025-09-01-preview"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
etag = "string"
properties = {
azureAuthenticationInfo = {
appKey = "string"
applicationId = "string"
ignoreAzurePermissions = bool
tenantId = "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"
authentication = "string"
connectionString = "string"
dataSource = "string"
encryptConnection = bool
enforceSSL = bool
port = int
serverBrandVersion = "string"
serverName = "string"
serverVersion = "string"
trustServerCertificate = bool
type = "MongoDbConnectionInfo"
}
For MySqlConnectionInfo, use:
{
additionalSettings = "string"
authentication = "string"
dataSource = "string"
encryptConnection = bool
port = int
serverName = "string"
type = "MySqlConnectionInfo"
}
For OracleConnectionInfo, use:
{
authentication = "string"
dataSource = "string"
port = int
serverName = "string"
serverVersion = "string"
type = "OracleConnectionInfo"
}
For PostgreSqlConnectionInfo, use:
{
additionalSettings = "string"
authentication = "string"
databaseName = "string"
dataSource = "string"
encryptConnection = bool
port = int
serverBrandVersion = "string"
serverName = "string"
serverVersion = "string"
trustServerCertificate = bool
type = "PostgreSqlConnectionInfo"
}
For SqlConnectionInfo, use:
{
additionalSettings = "string"
authentication = "string"
dataSource = "string"
encryptConnection = bool
platform = "string"
port = int
resourceId = "string"
serverBrandVersion = "string"
serverName = "string"
serverVersion = "string"
trustServerCertificate = bool
type = "SqlConnectionInfo"
}
Property Values
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@2025-09-01-preview" |
AzureActiveDirectoryApp
| Name | Description | Value |
|---|---|---|
| appKey | Key used to authenticate to the Azure Active Directory Application | string |
| applicationId | Application ID of the Azure Active Directory Application | string |
| ignoreAzurePermissions | Ignore checking azure permissions on the AAD app | bool |
| tenantId | Tenant id of the customer | string |
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) |
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 |
| authentication | Authentication type to use for connection | 'ActiveDirectoryIntegrated' 'ActiveDirectoryPassword' 'None' 'SqlAuthentication' 'WindowsAuthentication' |
| 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 |
| serverName | name of the server | string |
| serverVersion | server version | string |
| trustServerCertificate | Whether to trust the server certificate | bool |
| type | Type of connection info | 'MongoDbConnectionInfo' (required) |
MySqlConnectionInfo
| Name | Description | Value |
|---|---|---|
| additionalSettings | Additional connection settings | string |
| authentication | Authentication type to use for connection | 'ActiveDirectoryIntegrated' 'ActiveDirectoryPassword' 'None' 'SqlAuthentication' 'WindowsAuthentication' |
| 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 |
|---|---|---|
| authentication | Authentication type to use for connection | 'ActiveDirectoryIntegrated' 'ActiveDirectoryPassword' 'None' 'SqlAuthentication' 'WindowsAuthentication' |
| dataSource | EZConnect or TNSName connection string. | string (required) |
| port | port for server | int |
| serverName | name of the server | string |
| serverVersion | server version | string |
| type | Type of connection info | 'OracleConnectionInfo' (required) |
PostgreSqlConnectionInfo
| Name | Description | Value |
|---|---|---|
| additionalSettings | Additional connection settings | string |
| authentication | Authentication type to use for connection | 'ActiveDirectoryIntegrated' 'ActiveDirectoryPassword' 'None' 'SqlAuthentication' 'WindowsAuthentication' |
| databaseName | Name of the database | string |
| dataSource | Data source | string |
| encryptConnection | Whether to encrypt the connection | bool |
| port | Port for Server | int (required) |
| serverBrandVersion | server brand version | string |
| 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 | AzureActiveDirectoryApp |
| 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) |
ProjectTags
| Name | Description | Value |
|---|
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 | int |
| resourceId | Represents the ID of an HTTP resource represented by an Azure resource provider. | string |
| serverBrandVersion | server brand version | string |
| serverName | name of the server | string |
| serverVersion | server version | string |
| trustServerCertificate | Whether to trust the server certificate | bool |
| type | Type of connection info | 'SqlConnectionInfo' (required) |