Azure Data Migration Service Resource Provider
The Data Migration Service helps people migrate their data from on-premise database servers to Azure, or from older database software to newer software. The…
Data & analytics#openapi#cloud
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The Data Migration Service helps people migrate their data from on-premise database servers to Azure, or from older database software to newer software. The service manages one or more workers that are joined to a customer's virtual network, which is assumed to provide connectivity to their databases. To avoid frequent updates to the resource provider, data migration tasks are implemented by the resource provider in a generic way as task resources, each of which has a task type (which identifies the type of work to run), input, and output. The client is responsible for providing appropriate task type and inputs, which will be passed through unexamined to the machines that implement the functionality, and for understanding the output, which is passed back unexamined to the client.
Endpoints 26
Standard operation
- GETGet available resource provider actions (operations)
/providers/Microsoft.DataMigration/operations?api-version=stringLists all available actions exposed by the Data Migration Service resource provider. - POSTCheck name validity and availability
/subscriptions/:subscriptionId/providers/Microsoft.DataMigration/locations/:location/checkNameAvailability?api-version=stringThis method checks whether a proposed top-level resource name is valid and available. - GETGet resource quotas and usage information
/subscriptions/:subscriptionId/providers/Microsoft.DataMigration/locations/:location/usages?api-version=stringThis method returns region-specific quotas and resource usage information for the Data Migration Service. - GETGet supported SKUs
/subscriptions/:subscriptionId/providers/Microsoft.DataMigration/skus?api-version=stringThe skus action returns the list of SKUs that DMS supports.
Service resource
- GETGet services in subscription
/subscriptions/:subscriptionId/providers/Microsoft.DataMigration/services?api-version=stringThe services resource is the top-level resource that represents the Data Migration Service. This method returns a list of service resources in a subscription. - GETGet services in resource group
/subscriptions/:subscriptionId/resourceGroups/:groupName/providers/Microsoft.DataMigration/services?api-version=stringThe Services resource is the top-level resource that represents the Data Migration Service. This method returns a list of service resources in a resource group. - GETGet DMS Service Instance
/subscriptions/:subscriptionId/resourceGroups/:groupName/providers/Microsoft.DataMigration/services/:serviceName?api-version=stringThe services resource is the top-level resource that represents the Data Migration Service. The GET method retrieves information about a service instance. - PUTCreate or update DMS Instance
/subscriptions/:subscriptionId/resourceGroups/:groupName/providers/Microsoft.DataMigration/services/:serviceName?api-version=stringThe services resource is the top-level resource that represents the Data Migration Service. The PUT method creates a new service or updates an existing one.… - DELETEDelete DMS Service Instance
/subscriptions/:subscriptionId/resourceGroups/:groupName/providers/Microsoft.DataMigration/services/:serviceName?api-version=string&deleteRunningTasks=trueThe services resource is the top-level resource that represents the Data Migration Service. The DELETE method deletes a service. Any running tasks will be… - PATCHCreate or update DMS Service Instance
/subscriptions/:subscriptionId/resourceGroups/:groupName/providers/Microsoft.DataMigration/services/:serviceName?api-version=stringThe services resource is the top-level resource that represents the Data Migration Service. The PATCH method updates an existing service. This method can… - POSTCheck service health status
/subscriptions/:subscriptionId/resourceGroups/:groupName/providers/Microsoft.DataMigration/services/:serviceName/checkStatus?api-version=stringThe services resource is the top-level resource that represents the Data Migration Service. This action performs a health check and returns the status of the… - GETGet tasks in a service
/subscriptions/:subscriptionId/resourceGroups/:groupName/providers/Microsoft.DataMigration/services/:serviceName/projects/:projectName/tasks?api-version=string&taskType=stringThe services resource is the top-level resource that represents the Data Migration Service. This method returns a list of tasks owned by a service resource.… - GETGet compatible SKUs
/subscriptions/:subscriptionId/resourceGroups/:groupName/providers/Microsoft.DataMigration/services/:serviceName/skus?api-version=stringThe services resource is the top-level resource that represents the Data Migration Service. The skus action returns the list of SKUs that a service resource… - POSTStart service
/subscriptions/:subscriptionId/resourceGroups/:groupName/providers/Microsoft.DataMigration/services/:serviceName/start?api-version=stringThe services resource is the top-level resource that represents the Data Migration Service. This action starts the service and the service can be used for… - POSTStop service
/subscriptions/:subscriptionId/resourceGroups/:groupName/providers/Microsoft.DataMigration/services/:serviceName/stop?api-version=stringThe services resource is the top-level resource that represents the Data Migration Service. This action stops the service and the service cannot be used for…
Custom operation
- POSTCheck nested resource name validity and availability
/subscriptions/:subscriptionId/resourceGroups/:groupName/providers/Microsoft.DataMigration/services/:serviceName/checkNameAvailability?api-version=stringThis method checks whether a proposed nested resource name is valid and available.
Project resource
- GETGet projects in a service
/subscriptions/:subscriptionId/resourceGroups/:groupName/providers/Microsoft.DataMigration/services/:serviceName/projects?api-version=stringThe project resource is a nested resource representing a stored migration project. This method returns a list of projects owned by a service resource. - GETGet project information
/subscriptions/:subscriptionId/resourceGroups/:groupName/providers/Microsoft.DataMigration/services/:serviceName/projects/:projectName?api-version=stringThe project resource is a nested resource representing a stored migration project. The GET method retrieves information about a project. - PUTCreate or update project
/subscriptions/:subscriptionId/resourceGroups/:groupName/providers/Microsoft.DataMigration/services/:serviceName/projects/:projectName?api-version=stringThe project resource is a nested resource representing a stored migration project. The PUT method creates a new project or updates an existing one. - DELETEDelete project
/subscriptions/:subscriptionId/resourceGroups/:groupName/providers/Microsoft.DataMigration/services/:serviceName/projects/:projectName?api-version=string&deleteRunningTasks=trueThe project resource is a nested resource representing a stored migration project. The DELETE method deletes a project. - PATCHUpdate project
/subscriptions/:subscriptionId/resourceGroups/:groupName/providers/Microsoft.DataMigration/services/:serviceName/projects/:projectName?api-version=stringThe project resource is a nested resource representing a stored migration project. The PATCH method updates an existing project.
Task resource
- GETGet task information
/subscriptions/:subscriptionId/resourceGroups/:groupName/providers/Microsoft.DataMigration/services/:serviceName/projects/:projectName/tasks/:taskName?api-version=string&$expand=stringThe tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The GET method retrieves information about a task. - PUTCreate or update task
/subscriptions/:subscriptionId/resourceGroups/:groupName/providers/Microsoft.DataMigration/services/:serviceName/projects/:projectName/tasks/:taskName?api-version=stringThe tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The PUT method creates a new task or updates an existing… - DELETEDelete task
/subscriptions/:subscriptionId/resourceGroups/:groupName/providers/Microsoft.DataMigration/services/:serviceName/projects/:projectName/tasks/:taskName?api-version=string&deleteRunningTasks=trueThe tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The DELETE method deletes a task, canceling it first if… - PATCHCreate or update task
/subscriptions/:subscriptionId/resourceGroups/:groupName/providers/Microsoft.DataMigration/services/:serviceName/projects/:projectName/tasks/:taskName?api-version=stringThe tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The PATCH method updates an existing task, but since tasks… - POSTCancel a task
/subscriptions/:subscriptionId/resourceGroups/:groupName/providers/Microsoft.DataMigration/services/:serviceName/projects/:projectName/tasks/:taskName/cancel?api-version=stringThe tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. This method cancels a task if it's currently queued or…
API details
- Base URL
https://management.azure.com- Authentication
- OAuth 2.0 (implicit flow) with 1 scope
- Operations
- 26 operations on 17 pathsGET 11POST 6PUT 3PATCH 3DELETE 3
- Main resources
- Standard operation 21GET 11Service resource 11POST 6Custom operation 5Project resource 5Task resource 5DELETE 3PATCH 3PUT 3
- Response formats
application/json- Description format
- Swagger 2.0, API version
2018-03-15-preview - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Azure Data Migration Service Resource Provider in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Data Migration Service Resource Provider collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get available resource provider actions (operations)” (GET /providers/Microsoft.DataMigration/operations?api-version=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Azure Data Migration Service Resource Provider?
The Data Migration Service helps people migrate their data from on-premise database servers to Azure, or from older database software to newer software. The… It is listed under Data & analytics and has 26 endpoints.
Who publishes the Azure Data Migration Service Resource Provider?
It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Azure Data Migration Service Resource Provider?
Requests go to https://management.azure.com. Endpoint paths are added to this base URL.
How do I authenticate with the Azure Data Migration Service Resource Provider?
With OAuth 2.0 (implicit flow) with 1 scope.
How many endpoints does the Azure Data Migration Service Resource Provider have?
26 operations on 17 paths (11 GET, 6 POST, 3 PUT, 3 PATCH, 3 DELETE). The largest groups are Standard operation, GET, Service resource, POST.
Is forking the Azure Data Migration Service Resource Provider free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.