Microsoft Azure Azure Data Migration Service Resource Provider
Browse all Azure APIs★ Only Publicly Available OpenAPI DocumentStorageDatabaseoauth226 EndpointsREST
For Agents
Provision Azure Data Migration Service instances, manage migration projects, and run typed migration tasks that move databases from on-premises or older platforms into Azure. Supports 26 endpoints across services, projects, tasks, SKUs, and usages.
Use for: I need to migrate a SQL Server database to Azure SQL Database, Provision a new Data Migration Service in eastus2 bound to my VNet, List all DMS services in resource group rg-migration, Retrieve the status of a specific migration task
Not supported: Does not provision target Azure SQL databases, run continuous ETL pipelines, or manage Azure Data Factory triggers — use for DMS service, project, and task lifecycle only.
The Azure Data Migration Service (DMS) Resource Provider API manages DMS service instances and the projects and tasks they execute to move databases into Azure. It exposes 26 endpoints covering service CRUD, project lifecycle, generic migration tasks with typed inputs and outputs, SKU listings, name availability checks, and quota usage. Tasks are deliberately generic so new migration scenarios can be added without provider updates.
Install Jentic One Beta
Connect the Azure Data Migration Service Resource Provider to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Azure Data Migration Service Resource Provider, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Azure Data Migration Service Resource Provider API.
Provision a Data Migration Service instance bound to a virtual network
List DMS services across a subscription or scoped to a resource group
Create migration projects under a service and group related migration tasks
Run migration tasks with typed inputs (e.g. SQL Server to Azure SQL) and inspect outputs
Cancel a running migration task without tearing down the project
Check whether a candidate DMS service or project name is available in a region
List supported SKUs and current quota usage for a region
Use Cases
Patterns agents use Azure Data Migration Service Resource Provider API for, with concrete tasks.
★ On-Prem SQL Server to Azure SQL Migration
Move a SQL Server database from an on-premises VM into Azure SQL Database using a DMS service joined to the customer VNet. The Resource Provider API provisions the service, creates a project with sourcePlatform=SQL and targetPlatform=SQLDB, and runs a typed migration task whose input describes connection strings and selected databases. The task's output reports per-database progress and any validation issues, replacing manual schema-and-data export workflows.
Create a DMS project named SqlToAzure under service acme-dms, then start a Migrate.SqlServer.AzureSqlDb task with the source SQL Server connection and the target Azure SQL Database name.
Capacity and Region Planning
Pick the right region and SKU for a Data Migration Service before provisioning. The API exposes Skus_ListSkus and Usages_List endpoints that report supported SKU tiers per region and current subscription usage against quotas. Procurement and platform teams can call these read-only endpoints to choose Standard or Premium SKUs without raising support tickets.
Call Skus_ListSkus for subscription 1111-2222 and Usages_List for location=westeurope, then return the available Premium SKUs and remaining quota.
Long-Running Migration Lifecycle Control
Drive a long-running migration end to end without portal interaction: create a project, start a task, poll its state, and cancel cleanly if a stop condition fires. The DMS API models tasks as resources with state and output fields, so an agent can implement deterministic polling and error-handling loops. Teams typically wrap this in a runbook that handles retries and notifications.
Create and start a migration task, poll the task resource until state is Succeeded or Failed, and call the cancel operation if state stays Running for longer than the configured timeout.
Agent-Driven Migration Orchestration
A Jentic agent orchestrates a fleet of database migrations: it lists candidate sources, calls checkNameAvailability per service, creates DMS instances and projects, and starts the appropriate typed task per source platform. The agent uses the same 26 endpoints in this spec to coordinate the migration, replacing portal-driven runbooks with a structured tool-using loop.
For each entry in a migration plan list, check name availability, provision a DMS service if missing, create the project, and start a Migrate.SqlServer.AzureSqlDb task with the supplied connection details.
Key Endpoints
26 endpoints — the azure data migration service (dms) resource provider api manages dms service instances and the projects and tasks they execute to move databases into azure.
METHOD
PATH
DESCRIPTION
GET
/subscriptions/{subscriptionId}/providers/Microsoft.DataMigration/services
List DMS services in a subscription
GET
/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services
List DMS services in a resource group
GET
/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}
Get a single DMS service
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}
Delete a DMS service
POST
/subscriptions/{subscriptionId}/providers/Microsoft.DataMigration/locations/{location}/checkNameAvailability
Check service or project name availability
GET
/subscriptions/{subscriptionId}/providers/Microsoft.DataMigration/skus
List supported DMS SKUs
GET
/subscriptions/{subscriptionId}/providers/Microsoft.DataMigration/locations/{location}/usages
Get DMS quota usages for a region
GET
/subscriptions/{subscriptionId}/providers/Microsoft.DataMigration/services
List DMS services in a subscription
GET
/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services
List DMS services in a resource group
GET
/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}
Get a single DMS service
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}
Delete a DMS service
POST
/subscriptions/{subscriptionId}/providers/Microsoft.DataMigration/locations/{location}/checkNameAvailability
Check service or project name availability
GET
/subscriptions/{subscriptionId}/providers/Microsoft.DataMigration/skus
List supported DMS SKUs
GET
/subscriptions/{subscriptionId}/providers/Microsoft.DataMigration/locations/{location}/usages
Get DMS quota usages for a region
Why Jentic?
Three things that make agents converge on Jentic-routed access.
Credential isolation
Azure AD service principal credentials stay in the Jentic MAXsystem vault. Source-database credentials in task inputs can also be vaulted, with the agent receiving scoped tokens or pointers at execution time so neither AAD nor database secrets enter the prompt.
Intent-based discovery
Agents search Jentic by intent (e.g. "migrate sql server to azure sql") and Jentic returns the matching tasks createOrUpdate operation with the full task input schema for that taskType, so the agent does not need to assemble JSON from documentation.
Time to first call
Direct integration: 2-3 days for AAD setup, ARM long-running operation polling, and per-taskType input modelling. Through Jentic: under 1 hour — search, load schema, execute.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Azure Data Migration Service Resource Provider API through Jentic.
What authentication does the Azure Data Migration Service API use?
Azure Active Directory OAuth 2.0 via the azure_auth scheme (user_impersonation scope) on https://management.azure.com/. With Jentic, AAD client credentials live in the MAXsystem vault and the agent receives a runtime bearer token rather than the secret.
Can I migrate SQL Server to Azure SQL with this API?
Yes. Provision a DMS service via PUT under Microsoft.DataMigration/services, create a project, then start a typed task such as Migrate.SqlServer.AzureSqlDb with the source connection and target database name in the task's input block.
What are the rate limits for the Azure DMS API?
Azure Resource Manager subscription throttling applies, typically 12,000 reads and 1,200 writes per hour per subscription. Long-running migration tasks themselves are not rate-limited by ARM; their progress is polled via the task resource's state field.
How do I start a migration task through Jentic?
Search Jentic for "start azure database migration task", load the schema for the tasks createOrUpdate operation, set the typed input block (taskType plus connection details), and execute. Sign up at https://app.jentic.com/sign-up to get an API key.
How is connectivity to source databases handled?
The DMS service is joined to a customer-supplied virtual network at provisioning time. Connectivity from the service workers to source databases is the customer's responsibility through that VNet, including any required DNS, firewall, and ExpressRoute or VPN configuration.
Why are tasks generic instead of typed per scenario?
The resource provider models tasks generically with a taskType, input, and output so Microsoft can add new migration scenarios (e.g. MongoDB to Cosmos DB) without versioning the resource provider. Clients pick the right taskType and matching input schema for the specific migration.
GET STARTED