Custom roles for SQL Server to Azure SQL Managed Instance migrations using ADS
This article explains how to set up a custom role in Azure for SQL Server database migrations. The custom role only has the permissions necessary to create and run an instance of Azure Database Migration Service with Azure SQL Managed Instance as a target.
Use the AssignableScopes
section of the role definition JSON string to control where the permissions appear in the Add role assignment UI in the Azure portal. To avoid cluttering the UI with extra roles, you might want to define the role at the level of the resource group, or even the level of the resource. The resource that the custom role applies to doesn't perform the actual role assignment.
{
"properties": {
"roleName": "DmsCustomRoleDemoForMI",
"description": "",
"assignableScopes": [
"/subscriptions/<storageSubscription>/resourceGroups/<storageAccountRG>",
"/subscriptions/<ManagedInstanceSubscription>/resourceGroups/<managedInstanceRG>",
"/subscriptions/<DMSSubscription>/resourceGroups/<dmsServiceRG>"
],
"permissions": [
{
"actions": [
"Microsoft.Storage/storageAccounts/read",
"Microsoft.Storage/storageAccounts/listkeys/action",
"Microsoft.Storage/storageAccounts/blobServices/read",
"Microsoft.Storage/storageAccounts/blobServices/write",
"Microsoft.Storage/storageAccounts/blobServices/containers/read",
"Microsoft.Sql/managedInstances/read",
"Microsoft.Sql/managedInstances/write",
"Microsoft.Sql/managedInstances/databases/read",
"Microsoft.Sql/managedInstances/databases/write",
"Microsoft.Sql/managedInstances/databases/delete",
"Microsoft.DataMigration/locations/operationResults/read",
"Microsoft.DataMigration/locations/operationStatuses/read",
"Microsoft.DataMigration/locations/sqlMigrationServiceOperationResults/read",
"Microsoft.DataMigration/databaseMigrations/write",
"Microsoft.DataMigration/databaseMigrations/read",
"Microsoft.DataMigration/databaseMigrations/delete",
"Microsoft.DataMigration/databaseMigrations/cancel/action",
"Microsoft.DataMigration/databaseMigrations/cutover/action",
"Microsoft.DataMigration/sqlMigrationServices/write",
"Microsoft.DataMigration/sqlMigrationServices/delete",
"Microsoft.DataMigration/sqlMigrationServices/read",
"Microsoft.DataMigration/sqlMigrationServices/listAuthKeys/action",
"Microsoft.DataMigration/sqlMigrationServices/regenerateAuthKeys/action",
"Microsoft.DataMigration/sqlMigrationServices/deleteNode/action",
"Microsoft.DataMigration/sqlMigrationServices/listMonitoringData/action",
"Microsoft.DataMigration/sqlMigrationServices/listMigrations/read",
"Microsoft.DataMigration/sqlMigrationServices/MonitoringData/read"
],
"notActions": [],
"dataActions": [],
"notDataActions": []
}
]
}
}
You can use either the Azure portal, Azure PowerShell, Azure CLI, or Azure REST API to create the roles.
For more information, see Create or update Azure custom roles using the Azure portal and Azure custom roles.
Description of permissions needed to migrate to Azure SQL Managed Instance
Permission action | Description |
---|---|
Microsoft.Storage/storageAccounts/read |
Returns the list of storage accounts or gets the properties for the specified storage account. |
Microsoft.Storage/storageAccounts/listkeys/action |
Returns the access keys for the specified storage account. |
Microsoft.Storage/storageAccounts/blobServices/read |
List blob services. |
Microsoft.Storage/storageAccounts/blobServices/write |
Returns the result of put blob service properties. |
Microsoft.Storage/storageAccounts/blobServices/containers/read |
Returns list of containers. |
Microsoft.Sql/managedInstances/read |
Return the list of managed instances or gets the properties for the specified managed instance. |
Microsoft.Sql/managedInstances/write |
Creates a managed instance with the specified parameters or update the properties or tags for the specified managed instance. |
Microsoft.Sql/managedInstances/databases/read |
Gets existing managed database. |
Microsoft.Sql/managedInstances/databases/write |
Creates a new database or updates an existing database. |
Microsoft.Sql/managedInstances/databases/delete |
Deletes an existing managed database. |
Microsoft.DataMigration/locations/operationResults/read |
Get the status of a long-running operation related to a 202 Accepted response. |
Microsoft.DataMigration/locations/operationStatuses/read |
Get the status of a long-running operation related to a 202 Accepted response. |
Microsoft.DataMigration/locations/sqlMigrationServiceOperationResults/read |
Retrieve Service Operation Results. |
Microsoft.DataMigration/databaseMigrations/write |
Create or Update Database Migration resource. |
Microsoft.DataMigration/databaseMigrations/read |
Retrieve the Database Migration resource. |
Microsoft.DataMigration/databaseMigrations/delete |
Delete Database Migration resource. |
Microsoft.DataMigration/databaseMigrations/cancel/action |
Stop ongoing migration for the database. |
Microsoft.DataMigration/databaseMigrations/cutover/action |
Cutover online migration operation for the database. |
Microsoft.DataMigration/sqlMigrationServices/write |
Create a new or change properties of existing Service |
Microsoft.DataMigration/sqlMigrationServices/delete |
Delete existing Service. |
Microsoft.DataMigration/sqlMigrationServices/read |
Retrieve details of Migration Service. |
Microsoft.DataMigration/sqlMigrationServices/listAuthKeys/action |
Retrieve the List of Authentication Keys. |
Microsoft.DataMigration/sqlMigrationServices/regenerateAuthKeys/action |
Regenerate the Authentication Keys. |
Microsoft.DataMigration/sqlMigrationServices/deleteNode/action |
Deregister the IR node. |
Microsoft.DataMigration/sqlMigrationServices/listMonitoringData/action |
Lists the Monitoring Data for all migrations. |
Microsoft.DataMigration/sqlMigrationServices/listMigrations/read |
Lists the migrations for the user. |
Microsoft.DataMigration/sqlMigrationServices/MonitoringData/read |
Retrieve the Monitoring Data. |
Microsoft.SqlVirtualMachine/sqlVirtualMachines/read |
Retrieve details of SQL virtual machine. |
Microsoft.SqlVirtualMachine/sqlVirtualMachines/write |
Create a new or change properties of existing SQL virtual machine. |
You can get a sample script to create a login and provision it with the necessary permissions, for VMware, Hyper-V, or physical servers, using Windows authentication or SQL Server authentication.
Role assignment
To assign a role to a user or an app ID:
In the Azure portal, go to the resource.
In the left menu, select Access control (IAM), and then scroll to find the custom roles you created.
Select the roles to assign, select the user or app ID, and then save the changes.
The user or app ID now appears on the Role assignments tab.