Microsoft.DataMigration (preview:2018-03-31)

2025/09/26 • 26 new, 26 deleted methods

ResourceSkus_ListSkus (new)
Description :  The skus action returns the list of SKUs that DMS supports.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DataMigration/skus
{
subscriptionId:
{
Description: Identifier of the subscription ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of SKUs available for the subscription. ,
Required: True ,
}
[
{
resourceType:
{
Description: The type of resource the SKU applies to. ,
Required: False ,
}
string ,
name:
{
Description: The name of SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of DMS in a scale set. ,
Required: False ,
}
string ,
size:
{
Description: The Size of the SKU. ,
Required: False ,
}
string ,
family:
{
Description: The Family of this particular SKU. ,
Required: False ,
}
string ,
kind:
{
Description: The Kind of resources that are supported in this SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Not used. ,
Required: False ,
}
{
minimum:
{
Description: The minimum capacity. ,
Format: int64 ,
Required: False ,
}
integer ,
maximum:
{
Description: The maximum capacity. ,
Format: int64 ,
Required: False ,
}
integer ,
default:
{
Description: The default capacity. ,
Format: int64 ,
Required: False ,
}
integer ,
scaleType:
{
Description: The scale type applicable to the SKU. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
locations:
{
Description: The set of locations that the SKU is available. ,
Required: False ,
}
[
string ,
]
,
apiVersions:
{
Description: The api versions that support this SKU. ,
Required: False ,
}
[
string ,
]
,
costs:
{
Description: Metadata for retrieving price info. ,
Required: False ,
}
[
{
meterID:
{
Description: Used for querying price from commerce. ,
Required: False ,
}
string ,
quantity:
{
Description: The multiplier is needed to extend the base metered cost. ,
Format: int64 ,
Required: False ,
}
integer ,
extendedUnit:
{
Description: An invariant to show the extended unit. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: A name value pair to describe the capability. ,
Required: False ,
}
[
{
name:
{
Description: An invariant to describe the feature. ,
Required: False ,
}
string ,
value:
{
Description: An invariant if the feature is measured by quantity. ,
Required: False ,
}
string ,
}
,
]
,
restrictions:
{
Description: The restrictions because of which SKU cannot be used. This is empty if there are no restrictions. ,
Required: False ,
}
[
{
type:
{
Description: The type of restrictions. ,
Enum:
{
location: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted. ,
Required: False ,
}
[
string ,
]
,
reasonCode:
{
Description: The reason code for restriction. ,
Enum:
{
QuotaId: No description available. ,
NotAvailableForSubscription: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of DMS SKUs. Call ListNext() with this to fetch the next page of DMS SKUs. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Services_CreateOrUpdate (new)
Description :  The 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. When a service is updated, existing child resources (i.e. tasks) are unaffected. Services currently support a single kind, "vm", which refers to a VM-based service, although other kinds may be added in the future. This method can change the kind, SKU, and network of the service, but if tasks are currently running (i.e. the service is busy), this will fail with 400 Bad Request ("ServiceIsBusy"). The provider will reply when successful with 200 OK or 201 Created. Long-running operations use the provisioningState property.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}
{
parameters:
{
Description: Information about the service ,
Required: True ,
}
{
etag:
{
Description: HTTP strong entity tag value. Ignored if submitted ,
Required: False ,
}
string ,
kind:
{
Description: The resource kind. Only 'vm' (the default) is supported. ,
Required: False ,
}
string ,
properties:
{
Description: Custom service properties ,
Required: False ,
}
{
provisioningState:
{
Description: The resource's provisioning state ,
Enum:
{
Accepted: No description available. ,
Deleting: No description available. ,
Deploying: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
Starting: No description available. ,
FailedToStart: No description available. ,
FailedToStop: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
publicKey:
{
Description: The public key of the service, used to encrypt secrets sent to the service ,
Required: False ,
}
string ,
virtualSubnetId:
{
Description: The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined ,
Required: True ,
}
string ,
}
,
sku:
{
Description: Service SKU ,
Required: False ,
}
{
name:
{
Description: The unique name of the SKU, such as 'P3' ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the SKU, such as 'Free', 'Basic', 'Standard', or 'Premium' ,
Required: False ,
}
string ,
family:
{
Description: The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines ,
Required: False ,
}
string ,
size:
{
Description: The size of the SKU, used when the name alone does not denote a service size or when a SKU has multiple performance classes within a family, e.g. 'A1' for virtual machines ,
Required: False ,
}
string ,
capacity:
{
Description: The capacity of the SKU, if it supports scaling ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
etag:
{
Description: HTTP strong entity tag value. Ignored if submitted ,
Required: False ,
}
string ,
kind:
{
Description: The resource kind. Only 'vm' (the default) is supported. ,
Required: False ,
}
string ,
properties:
{
Description: Custom service properties ,
Required: False ,
}
{
provisioningState:
{
Description: The resource's provisioning state ,
Enum:
{
Accepted: No description available. ,
Deleting: No description available. ,
Deploying: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
Starting: No description available. ,
FailedToStart: No description available. ,
FailedToStop: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
publicKey:
{
Description: The public key of the service, used to encrypt secrets sent to the service ,
Required: False ,
}
string ,
virtualSubnetId:
{
Description: The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined ,
Required: True ,
}
string ,
}
,
sku:
{
Description: Service SKU ,
Required: False ,
}
{
name:
{
Description: The unique name of the SKU, such as 'P3' ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the SKU, such as 'Free', 'Basic', 'Standard', or 'Premium' ,
Required: False ,
}
string ,
family:
{
Description: The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines ,
Required: False ,
}
string ,
size:
{
Description: The size of the SKU, used when the name alone does not denote a service size or when a SKU has multiple performance classes within a family, e.g. 'A1' for virtual machines ,
Required: False ,
}
string ,
capacity:
{
Description: The capacity of the SKU, if it supports scaling ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
etag:
{
Description: HTTP strong entity tag value. Ignored if submitted ,
Required: False ,
}
string ,
kind:
{
Description: The resource kind. Only 'vm' (the default) is supported. ,
Required: False ,
}
string ,
properties:
{
Description: Custom service properties ,
Required: False ,
}
{
provisioningState:
{
Description: The resource's provisioning state ,
Enum:
{
Accepted: No description available. ,
Deleting: No description available. ,
Deploying: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
Starting: No description available. ,
FailedToStart: No description available. ,
FailedToStop: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
publicKey:
{
Description: The public key of the service, used to encrypt secrets sent to the service ,
Required: False ,
}
string ,
virtualSubnetId:
{
Description: The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined ,
Required: True ,
}
string ,
}
,
sku:
{
Description: Service SKU ,
Required: False ,
}
{
name:
{
Description: The unique name of the SKU, such as 'P3' ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the SKU, such as 'Free', 'Basic', 'Standard', or 'Premium' ,
Required: False ,
}
string ,
family:
{
Description: The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines ,
Required: False ,
}
string ,
size:
{
Description: The size of the SKU, used when the name alone does not denote a service size or when a SKU has multiple performance classes within a family, e.g. 'A1' for virtual machines ,
Required: False ,
}
string ,
capacity:
{
Description: The capacity of the SKU, if it supports scaling ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Services_Get (new)
Description :  The services resource is the top-level resource that represents the Data Migration Service. The GET method retrieves information about a service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}
{}

⚐ Response (200)

{
etag:
{
Description: HTTP strong entity tag value. Ignored if submitted ,
Required: False ,
}
string ,
kind:
{
Description: The resource kind. Only 'vm' (the default) is supported. ,
Required: False ,
}
string ,
properties:
{
Description: Custom service properties ,
Required: False ,
}
{
provisioningState:
{
Description: The resource's provisioning state ,
Enum:
{
Accepted: No description available. ,
Deleting: No description available. ,
Deploying: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
Starting: No description available. ,
FailedToStart: No description available. ,
FailedToStop: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
publicKey:
{
Description: The public key of the service, used to encrypt secrets sent to the service ,
Required: False ,
}
string ,
virtualSubnetId:
{
Description: The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined ,
Required: True ,
}
string ,
}
,
sku:
{
Description: Service SKU ,
Required: False ,
}
{
name:
{
Description: The unique name of the SKU, such as 'P3' ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the SKU, such as 'Free', 'Basic', 'Standard', or 'Premium' ,
Required: False ,
}
string ,
family:
{
Description: The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines ,
Required: False ,
}
string ,
size:
{
Description: The size of the SKU, used when the name alone does not denote a service size or when a SKU has multiple performance classes within a family, e.g. 'A1' for virtual machines ,
Required: False ,
}
string ,
capacity:
{
Description: The capacity of the SKU, if it supports scaling ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Services_Delete (new)
Description :  The services resource is the top-level resource that represents the Data Migration Service. The DELETE method deletes a service. Any running tasks will be canceled.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}
{
deleteRunningTasks:
{
Description: Delete the resource even if it contains running tasks ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Services_Update (new)
Description :  The services resource is the top-level resource that represents the Data Migration Service. The PATCH method updates an existing service. This method can change the kind, SKU, and network of the service, but if tasks are currently running (i.e. the service is busy), this will fail with 400 Bad Request ("ServiceIsBusy").
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}
{
parameters:
{
Description: Information about the service ,
Required: True ,
}
{
etag:
{
Description: HTTP strong entity tag value. Ignored if submitted ,
Required: False ,
}
string ,
kind:
{
Description: The resource kind. Only 'vm' (the default) is supported. ,
Required: False ,
}
string ,
properties:
{
Description: Custom service properties ,
Required: False ,
}
{
provisioningState:
{
Description: The resource's provisioning state ,
Enum:
{
Accepted: No description available. ,
Deleting: No description available. ,
Deploying: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
Starting: No description available. ,
FailedToStart: No description available. ,
FailedToStop: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
publicKey:
{
Description: The public key of the service, used to encrypt secrets sent to the service ,
Required: False ,
}
string ,
virtualSubnetId:
{
Description: The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined ,
Required: True ,
}
string ,
}
,
sku:
{
Description: Service SKU ,
Required: False ,
}
{
name:
{
Description: The unique name of the SKU, such as 'P3' ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the SKU, such as 'Free', 'Basic', 'Standard', or 'Premium' ,
Required: False ,
}
string ,
family:
{
Description: The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines ,
Required: False ,
}
string ,
size:
{
Description: The size of the SKU, used when the name alone does not denote a service size or when a SKU has multiple performance classes within a family, e.g. 'A1' for virtual machines ,
Required: False ,
}
string ,
capacity:
{
Description: The capacity of the SKU, if it supports scaling ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
etag:
{
Description: HTTP strong entity tag value. Ignored if submitted ,
Required: False ,
}
string ,
kind:
{
Description: The resource kind. Only 'vm' (the default) is supported. ,
Required: False ,
}
string ,
properties:
{
Description: Custom service properties ,
Required: False ,
}
{
provisioningState:
{
Description: The resource's provisioning state ,
Enum:
{
Accepted: No description available. ,
Deleting: No description available. ,
Deploying: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
Starting: No description available. ,
FailedToStart: No description available. ,
FailedToStop: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
publicKey:
{
Description: The public key of the service, used to encrypt secrets sent to the service ,
Required: False ,
}
string ,
virtualSubnetId:
{
Description: The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined ,
Required: True ,
}
string ,
}
,
sku:
{
Description: Service SKU ,
Required: False ,
}
{
name:
{
Description: The unique name of the SKU, such as 'P3' ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the SKU, such as 'Free', 'Basic', 'Standard', or 'Premium' ,
Required: False ,
}
string ,
family:
{
Description: The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines ,
Required: False ,
}
string ,
size:
{
Description: The size of the SKU, used when the name alone does not denote a service size or when a SKU has multiple performance classes within a family, e.g. 'A1' for virtual machines ,
Required: False ,
}
string ,
capacity:
{
Description: The capacity of the SKU, if it supports scaling ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Services_CheckStatus (new)
Description :  The 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 service and virtual machine size.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/checkStatus
{
subscriptionId:
{
Description: Identifier of the subscription ,
Required: True ,
}
string ,
groupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
serviceName:
{
Description: Name of the service ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
agentVersion:
{
Description: The DMS instance agent version ,
Required: False ,
}
string ,
status:
{
Description: The machine-readable status, such as 'Initializing', 'Offline', 'Online', 'Deploying', 'Deleting', 'Stopped', 'Stopping', 'Starting', 'FailedToStart', 'FailedToStop' or 'Failed' ,
Required: False ,
}
string ,
vmSize:
{
Description: The services virtual machine size, such as 'Standard_D2_v2' ,
Required: False ,
}
string ,
supportedTaskTypes:
{
Description: The list of supported task types ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Services_Start (new)
Description :  The 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 data migration.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/start
{
subscriptionId:
{
Description: Identifier of the subscription ,
Required: True ,
}
string ,
groupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
serviceName:
{
Description: Name of the service ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Services_Stop (new)
Description :  The 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 data migration. The service owner won't be billed when the service is stopped.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/stop
{
subscriptionId:
{
Description: Identifier of the subscription ,
Required: True ,
}
string ,
groupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
serviceName:
{
Description: Name of the service ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Services_ListSkus (new)
Description :  The 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 can be updated to.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/skus
{
subscriptionId:
{
Description: Identifier of the subscription ,
Required: True ,
}
string ,
groupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
serviceName:
{
Description: Name of the service ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of service SKUs ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type, including the provider namespace ,
Required: False ,
}
string ,
sku:
{
Description: SKU name, tier, etc. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU ,
Required: False ,
}
string ,
family:
{
Description: SKU family ,
Required: False ,
}
string ,
size:
{
Description: SKU size ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the SKU, such as "Free", "Basic", "Standard", or "Premium" ,
Required: False ,
}
string ,
}
,
capacity:
{
Description: A description of the scaling capacities of the SKU ,
Required: False ,
}
{
minimum:
{
Description: The minimum capacity, usually 0 or 1. ,
Required: False ,
}
integer ,
maximum:
{
Description: The maximum capacity ,
Required: False ,
}
integer ,
default:
{
Description: The default capacity ,
Required: False ,
}
integer ,
scaleType:
{
Description: The scalability approach ,
Enum:
{
none: No description available. ,
manual: No description available. ,
automatic: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to load the next page of service SKUs ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Tasks_List (new)
Description :  The 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. Some tasks may have a status of Unknown, which indicates that an error occurred while querying the status of that task.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/projects/{projectName}/tasks
{
subscriptionId:
{
Description: Identifier of the subscription ,
Required: True ,
}
string ,
groupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
serviceName:
{
Description: Name of the service ,
Required: True ,
}
string ,
projectName:
{
Description: Name of the project ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API ,
Required: True ,
}
string ,
taskType:
{
Description: Filter tasks by task type ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of tasks ,
Required: False ,
}
[
{
etag:
{
Description: HTTP strong entity tag value. This is ignored if submitted. ,
Required: False ,
}
string ,
properties:
{
Description: Custom task properties ,
Required: False ,
}
{
taskType:
{
Description: Task type. ,
Required: True ,
}
string ,
errors:
{
Description: Array of errors. This is ignored if submitted. ,
Required: False ,
}
[
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
state:
{
Description: The state of the task. This is ignored if submitted. ,
Enum:
{
Unknown: No description available. ,
Queued: No description available. ,
Running: No description available. ,
Canceled: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
FailedInputValidation: No description available. ,
Faulted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to load the next page of tasks ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Services_CheckChildrenNameAvailability (new)
Description :  This method checks whether a proposed nested resource name is valid and available.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/checkNameAvailability
{
subscriptionId:
{
Description: Identifier of the subscription ,
Required: True ,
}
string ,
groupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API ,
Required: True ,
}
string ,
serviceName:
{
Description: Name of the service ,
Required: True ,
}
string ,
parameters:
{
Description: Requested name to validate ,
Required: True ,
}
{
name:
{
Description: The proposed resource name ,
Required: False ,
}
string ,
type:
{
Description: The resource type chain (e.g. virtualMachines/extensions) ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: If true, the name is valid and available. If false, 'reason' describes why not. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason why the name is not available, if nameAvailable is false ,
Enum:
{
AlreadyExists: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The localized reason why the name is not available, if nameAvailable is false ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Services_ListByResourceGroup (new)
Description :  The 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.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services
{
subscriptionId:
{
Description: Identifier of the subscription ,
Required: True ,
}
string ,
groupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of services ,
Required: False ,
}
[
{
etag:
{
Description: HTTP strong entity tag value. Ignored if submitted ,
Required: False ,
}
string ,
kind:
{
Description: The resource kind. Only 'vm' (the default) is supported. ,
Required: False ,
}
string ,
properties:
{
Description: Custom service properties ,
Required: False ,
}
{
provisioningState:
{
Description: The resource's provisioning state ,
Enum:
{
Accepted: No description available. ,
Deleting: No description available. ,
Deploying: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
Starting: No description available. ,
FailedToStart: No description available. ,
FailedToStop: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
publicKey:
{
Description: The public key of the service, used to encrypt secrets sent to the service ,
Required: False ,
}
string ,
virtualSubnetId:
{
Description: The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined ,
Required: True ,
}
string ,
}
,
sku:
{
Description: Service SKU ,
Required: False ,
}
{
name:
{
Description: The unique name of the SKU, such as 'P3' ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the SKU, such as 'Free', 'Basic', 'Standard', or 'Premium' ,
Required: False ,
}
string ,
family:
{
Description: The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines ,
Required: False ,
}
string ,
size:
{
Description: The size of the SKU, used when the name alone does not denote a service size or when a SKU has multiple performance classes within a family, e.g. 'A1' for virtual machines ,
Required: False ,
}
string ,
capacity:
{
Description: The capacity of the SKU, if it supports scaling ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: URL to load the next page of services ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Services_List (new)
Description :  The services resource is the top-level resource that represents the Data Migration Service. This method returns a list of service resources in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DataMigration/services
{
subscriptionId:
{
Description: Identifier of the subscription ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of services ,
Required: False ,
}
[
{
etag:
{
Description: HTTP strong entity tag value. Ignored if submitted ,
Required: False ,
}
string ,
kind:
{
Description: The resource kind. Only 'vm' (the default) is supported. ,
Required: False ,
}
string ,
properties:
{
Description: Custom service properties ,
Required: False ,
}
{
provisioningState:
{
Description: The resource's provisioning state ,
Enum:
{
Accepted: No description available. ,
Deleting: No description available. ,
Deploying: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
Starting: No description available. ,
FailedToStart: No description available. ,
FailedToStop: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
publicKey:
{
Description: The public key of the service, used to encrypt secrets sent to the service ,
Required: False ,
}
string ,
virtualSubnetId:
{
Description: The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined ,
Required: True ,
}
string ,
}
,
sku:
{
Description: Service SKU ,
Required: False ,
}
{
name:
{
Description: The unique name of the SKU, such as 'P3' ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the SKU, such as 'Free', 'Basic', 'Standard', or 'Premium' ,
Required: False ,
}
string ,
family:
{
Description: The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines ,
Required: False ,
}
string ,
size:
{
Description: The size of the SKU, used when the name alone does not denote a service size or when a SKU has multiple performance classes within a family, e.g. 'A1' for virtual machines ,
Required: False ,
}
string ,
capacity:
{
Description: The capacity of the SKU, if it supports scaling ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: URL to load the next page of services ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Tasks_CreateOrUpdate (new)
Description :  The 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 one, although since tasks have no mutable custom properties, there is little reason to update an existing one.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/projects/{projectName}/tasks/{taskName}
{
parameters:
{
Description: Information about the task ,
Required: True ,
}
{
etag:
{
Description: HTTP strong entity tag value. This is ignored if submitted. ,
Required: False ,
}
string ,
properties:
{
Description: Custom task properties ,
Required: False ,
}
{
taskType:
{
Description: Task type. ,
Required: True ,
}
string ,
errors:
{
Description: Array of errors. This is ignored if submitted. ,
Required: False ,
}
[
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
state:
{
Description: The state of the task. This is ignored if submitted. ,
Enum:
{
Unknown: No description available. ,
Queued: No description available. ,
Running: No description available. ,
Canceled: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
FailedInputValidation: No description available. ,
Faulted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
etag:
{
Description: HTTP strong entity tag value. This is ignored if submitted. ,
Required: False ,
}
string ,
properties:
{
Description: Custom task properties ,
Required: False ,
}
{
taskType:
{
Description: Task type. ,
Required: True ,
}
string ,
errors:
{
Description: Array of errors. This is ignored if submitted. ,
Required: False ,
}
[
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
state:
{
Description: The state of the task. This is ignored if submitted. ,
Enum:
{
Unknown: No description available. ,
Queued: No description available. ,
Running: No description available. ,
Canceled: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
FailedInputValidation: No description available. ,
Faulted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
etag:
{
Description: HTTP strong entity tag value. This is ignored if submitted. ,
Required: False ,
}
string ,
properties:
{
Description: Custom task properties ,
Required: False ,
}
{
taskType:
{
Description: Task type. ,
Required: True ,
}
string ,
errors:
{
Description: Array of errors. This is ignored if submitted. ,
Required: False ,
}
[
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
state:
{
Description: The state of the task. This is ignored if submitted. ,
Enum:
{
Unknown: No description available. ,
Queued: No description available. ,
Running: No description available. ,
Canceled: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
FailedInputValidation: No description available. ,
Faulted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Tasks_Get (new)
Description :  The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The GET method retrieves information about a task.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/projects/{projectName}/tasks/{taskName}
{
$expand:
{
Description: Expand the response ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: HTTP strong entity tag value. This is ignored if submitted. ,
Required: False ,
}
string ,
properties:
{
Description: Custom task properties ,
Required: False ,
}
{
taskType:
{
Description: Task type. ,
Required: True ,
}
string ,
errors:
{
Description: Array of errors. This is ignored if submitted. ,
Required: False ,
}
[
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
state:
{
Description: The state of the task. This is ignored if submitted. ,
Enum:
{
Unknown: No description available. ,
Queued: No description available. ,
Running: No description available. ,
Canceled: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
FailedInputValidation: No description available. ,
Faulted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Tasks_Delete (new)
Description :  The 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 it's running.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/projects/{projectName}/tasks/{taskName}
{
deleteRunningTasks:
{
Description: Delete the resource even if it contains running tasks ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Tasks_Update (new)
Description :  The 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 have no mutable custom properties, there is little reason to do so.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/projects/{projectName}/tasks/{taskName}
{
parameters:
{
Description: Information about the task ,
Required: True ,
}
{
etag:
{
Description: HTTP strong entity tag value. This is ignored if submitted. ,
Required: False ,
}
string ,
properties:
{
Description: Custom task properties ,
Required: False ,
}
{
taskType:
{
Description: Task type. ,
Required: True ,
}
string ,
errors:
{
Description: Array of errors. This is ignored if submitted. ,
Required: False ,
}
[
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
state:
{
Description: The state of the task. This is ignored if submitted. ,
Enum:
{
Unknown: No description available. ,
Queued: No description available. ,
Running: No description available. ,
Canceled: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
FailedInputValidation: No description available. ,
Faulted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
etag:
{
Description: HTTP strong entity tag value. This is ignored if submitted. ,
Required: False ,
}
string ,
properties:
{
Description: Custom task properties ,
Required: False ,
}
{
taskType:
{
Description: Task type. ,
Required: True ,
}
string ,
errors:
{
Description: Array of errors. This is ignored if submitted. ,
Required: False ,
}
[
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
state:
{
Description: The state of the task. This is ignored if submitted. ,
Enum:
{
Unknown: No description available. ,
Queued: No description available. ,
Running: No description available. ,
Canceled: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
FailedInputValidation: No description available. ,
Faulted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Tasks_Cancel (new)
Description :  The 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 running.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/projects/{projectName}/tasks/{taskName}/cancel
{
subscriptionId:
{
Description: Identifier of the subscription ,
Required: True ,
}
string ,
groupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
serviceName:
{
Description: Name of the service ,
Required: True ,
}
string ,
projectName:
{
Description: Name of the project ,
Required: True ,
}
string ,
taskName:
{
Description: Name of the Task ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: HTTP strong entity tag value. This is ignored if submitted. ,
Required: False ,
}
string ,
properties:
{
Description: Custom task properties ,
Required: False ,
}
{
taskType:
{
Description: Task type. ,
Required: True ,
}
string ,
errors:
{
Description: Array of errors. This is ignored if submitted. ,
Required: False ,
}
[
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
state:
{
Description: The state of the task. This is ignored if submitted. ,
Enum:
{
Unknown: No description available. ,
Queued: No description available. ,
Running: No description available. ,
Canceled: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
FailedInputValidation: No description available. ,
Faulted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Projects_List (new)
Description :  The project resource is a nested resource representing a stored migration project. This method returns a list of projects owned by a service resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/projects
{
subscriptionId:
{
Description: Identifier of the subscription ,
Required: True ,
}
string ,
groupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
serviceName:
{
Description: Name of the service ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of projects ,
Required: False ,
}
[
{
properties:
{
Description: Project properties ,
Required: False ,
}
{
sourcePlatform:
{
Description: Source platform for the project ,
Enum:
{
SQL: No description available. ,
Unknown: No description available. ,
}
,
Required: True ,
}
enum ,
targetPlatform:
{
Description: Target platform for the project ,
Enum:
{
SQLDB: No description available. ,
SQLMI: No description available. ,
Unknown: No description available. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: UTC Date and time when project was created ,
Format: date-time ,
Required: False ,
}
string ,
sourceConnectionInfo:
{
Description: Information for connecting to source ,
Required: False ,
}
{
type:
{
Description: Type of connection info ,
Required: True ,
}
string ,
userName:
{
Description: User name ,
Required: False ,
}
string ,
password:
{
Description: Password credential. ,
Required: False ,
}
string ,
}
,
targetConnectionInfo:
{
Description: Information for connecting to target ,
Required: False ,
}
{
type:
{
Description: Type of connection info ,
Required: True ,
}
string ,
userName:
{
Description: User name ,
Required: False ,
}
string ,
password:
{
Description: Password credential. ,
Required: False ,
}
string ,
}
,
databasesInfo:
{
Description: List of DatabaseInfo ,
Required: False ,
}
[
{
sourceDatabaseName:
{
Description: Name of the database ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The project's provisioning state ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to load the next page of projects ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Projects_CreateOrUpdate (new)
Description :  The project resource is a nested resource representing a stored migration project. The PUT method creates a new project or updates an existing one.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/projects/{projectName}
{
parameters:
{
Description: Information about the project ,
Required: True ,
}
{
properties:
{
Description: Project properties ,
Required: False ,
}
{
sourcePlatform:
{
Description: Source platform for the project ,
Enum:
{
SQL: No description available. ,
Unknown: No description available. ,
}
,
Required: True ,
}
enum ,
targetPlatform:
{
Description: Target platform for the project ,
Enum:
{
SQLDB: No description available. ,
SQLMI: No description available. ,
Unknown: No description available. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: UTC Date and time when project was created ,
Format: date-time ,
Required: False ,
}
string ,
sourceConnectionInfo:
{
Description: Information for connecting to source ,
Required: False ,
}
{
type:
{
Description: Type of connection info ,
Required: True ,
}
string ,
userName:
{
Description: User name ,
Required: False ,
}
string ,
password:
{
Description: Password credential. ,
Required: False ,
}
string ,
}
,
targetConnectionInfo:
{
Description: Information for connecting to target ,
Required: False ,
}
{
type:
{
Description: Type of connection info ,
Required: True ,
}
string ,
userName:
{
Description: User name ,
Required: False ,
}
string ,
password:
{
Description: Password credential. ,
Required: False ,
}
string ,
}
,
databasesInfo:
{
Description: List of DatabaseInfo ,
Required: False ,
}
[
{
sourceDatabaseName:
{
Description: Name of the database ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The project's provisioning state ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Project properties ,
Required: False ,
}
{
sourcePlatform:
{
Description: Source platform for the project ,
Enum:
{
SQL: No description available. ,
Unknown: No description available. ,
}
,
Required: True ,
}
enum ,
targetPlatform:
{
Description: Target platform for the project ,
Enum:
{
SQLDB: No description available. ,
SQLMI: No description available. ,
Unknown: No description available. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: UTC Date and time when project was created ,
Format: date-time ,
Required: False ,
}
string ,
sourceConnectionInfo:
{
Description: Information for connecting to source ,
Required: False ,
}
{
type:
{
Description: Type of connection info ,
Required: True ,
}
string ,
userName:
{
Description: User name ,
Required: False ,
}
string ,
password:
{
Description: Password credential. ,
Required: False ,
}
string ,
}
,
targetConnectionInfo:
{
Description: Information for connecting to target ,
Required: False ,
}
{
type:
{
Description: Type of connection info ,
Required: True ,
}
string ,
userName:
{
Description: User name ,
Required: False ,
}
string ,
password:
{
Description: Password credential. ,
Required: False ,
}
string ,
}
,
databasesInfo:
{
Description: List of DatabaseInfo ,
Required: False ,
}
[
{
sourceDatabaseName:
{
Description: Name of the database ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The project's provisioning state ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Project properties ,
Required: False ,
}
{
sourcePlatform:
{
Description: Source platform for the project ,
Enum:
{
SQL: No description available. ,
Unknown: No description available. ,
}
,
Required: True ,
}
enum ,
targetPlatform:
{
Description: Target platform for the project ,
Enum:
{
SQLDB: No description available. ,
SQLMI: No description available. ,
Unknown: No description available. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: UTC Date and time when project was created ,
Format: date-time ,
Required: False ,
}
string ,
sourceConnectionInfo:
{
Description: Information for connecting to source ,
Required: False ,
}
{
type:
{
Description: Type of connection info ,
Required: True ,
}
string ,
userName:
{
Description: User name ,
Required: False ,
}
string ,
password:
{
Description: Password credential. ,
Required: False ,
}
string ,
}
,
targetConnectionInfo:
{
Description: Information for connecting to target ,
Required: False ,
}
{
type:
{
Description: Type of connection info ,
Required: True ,
}
string ,
userName:
{
Description: User name ,
Required: False ,
}
string ,
password:
{
Description: Password credential. ,
Required: False ,
}
string ,
}
,
databasesInfo:
{
Description: List of DatabaseInfo ,
Required: False ,
}
[
{
sourceDatabaseName:
{
Description: Name of the database ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The project's provisioning state ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Projects_Get (new)
Description :  The project resource is a nested resource representing a stored migration project. The GET method retrieves information about a project.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/projects/{projectName}
{}

⚐ Response (200)

{
properties:
{
Description: Project properties ,
Required: False ,
}
{
sourcePlatform:
{
Description: Source platform for the project ,
Enum:
{
SQL: No description available. ,
Unknown: No description available. ,
}
,
Required: True ,
}
enum ,
targetPlatform:
{
Description: Target platform for the project ,
Enum:
{
SQLDB: No description available. ,
SQLMI: No description available. ,
Unknown: No description available. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: UTC Date and time when project was created ,
Format: date-time ,
Required: False ,
}
string ,
sourceConnectionInfo:
{
Description: Information for connecting to source ,
Required: False ,
}
{
type:
{
Description: Type of connection info ,
Required: True ,
}
string ,
userName:
{
Description: User name ,
Required: False ,
}
string ,
password:
{
Description: Password credential. ,
Required: False ,
}
string ,
}
,
targetConnectionInfo:
{
Description: Information for connecting to target ,
Required: False ,
}
{
type:
{
Description: Type of connection info ,
Required: True ,
}
string ,
userName:
{
Description: User name ,
Required: False ,
}
string ,
password:
{
Description: Password credential. ,
Required: False ,
}
string ,
}
,
databasesInfo:
{
Description: List of DatabaseInfo ,
Required: False ,
}
[
{
sourceDatabaseName:
{
Description: Name of the database ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The project's provisioning state ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Projects_Delete (new)
Description :  The project resource is a nested resource representing a stored migration project. The DELETE method deletes a project.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/projects/{projectName}
{
deleteRunningTasks:
{
Description: Delete the resource even if it contains running tasks ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Projects_Update (new)
Description :  The project resource is a nested resource representing a stored migration project. The PATCH method updates an existing project.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/projects/{projectName}
{
parameters:
{
Description: Information about the project ,
Required: True ,
}
{
properties:
{
Description: Project properties ,
Required: False ,
}
{
sourcePlatform:
{
Description: Source platform for the project ,
Enum:
{
SQL: No description available. ,
Unknown: No description available. ,
}
,
Required: True ,
}
enum ,
targetPlatform:
{
Description: Target platform for the project ,
Enum:
{
SQLDB: No description available. ,
SQLMI: No description available. ,
Unknown: No description available. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: UTC Date and time when project was created ,
Format: date-time ,
Required: False ,
}
string ,
sourceConnectionInfo:
{
Description: Information for connecting to source ,
Required: False ,
}
{
type:
{
Description: Type of connection info ,
Required: True ,
}
string ,
userName:
{
Description: User name ,
Required: False ,
}
string ,
password:
{
Description: Password credential. ,
Required: False ,
}
string ,
}
,
targetConnectionInfo:
{
Description: Information for connecting to target ,
Required: False ,
}
{
type:
{
Description: Type of connection info ,
Required: True ,
}
string ,
userName:
{
Description: User name ,
Required: False ,
}
string ,
password:
{
Description: Password credential. ,
Required: False ,
}
string ,
}
,
databasesInfo:
{
Description: List of DatabaseInfo ,
Required: False ,
}
[
{
sourceDatabaseName:
{
Description: Name of the database ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The project's provisioning state ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Project properties ,
Required: False ,
}
{
sourcePlatform:
{
Description: Source platform for the project ,
Enum:
{
SQL: No description available. ,
Unknown: No description available. ,
}
,
Required: True ,
}
enum ,
targetPlatform:
{
Description: Target platform for the project ,
Enum:
{
SQLDB: No description available. ,
SQLMI: No description available. ,
Unknown: No description available. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: UTC Date and time when project was created ,
Format: date-time ,
Required: False ,
}
string ,
sourceConnectionInfo:
{
Description: Information for connecting to source ,
Required: False ,
}
{
type:
{
Description: Type of connection info ,
Required: True ,
}
string ,
userName:
{
Description: User name ,
Required: False ,
}
string ,
password:
{
Description: Password credential. ,
Required: False ,
}
string ,
}
,
targetConnectionInfo:
{
Description: Information for connecting to target ,
Required: False ,
}
{
type:
{
Description: Type of connection info ,
Required: True ,
}
string ,
userName:
{
Description: User name ,
Required: False ,
}
string ,
password:
{
Description: Password credential. ,
Required: False ,
}
string ,
}
,
databasesInfo:
{
Description: List of DatabaseInfo ,
Required: False ,
}
[
{
sourceDatabaseName:
{
Description: Name of the database ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The project's provisioning state ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Services_CheckNameAvailability (new)
Description :  This method checks whether a proposed top-level resource name is valid and available.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DataMigration/locations/{location}/checkNameAvailability
{
subscriptionId:
{
Description: Identifier of the subscription ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API ,
Required: True ,
}
string ,
location:
{
Description: The Azure region of the operation ,
Required: True ,
}
string ,
parameters:
{
Description: Requested name to validate ,
Required: True ,
}
{
name:
{
Description: The proposed resource name ,
Required: False ,
}
string ,
type:
{
Description: The resource type chain (e.g. virtualMachines/extensions) ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: If true, the name is valid and available. If false, 'reason' describes why not. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason why the name is not available, if nameAvailable is false ,
Enum:
{
AlreadyExists: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The localized reason why the name is not available, if nameAvailable is false ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Usages_List (new)
Description :  This method returns region-specific quotas and resource usage information for the Data Migration Service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DataMigration/locations/{location}/usages
{
subscriptionId:
{
Description: Identifier of the subscription ,
Required: True ,
}
string ,
location:
{
Description: The Azure region of the operation ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of quotas ,
Required: False ,
}
[
{
currentValue:
{
Description: The current value of the quota. If null or missing, the current value cannot be determined in the context of the request. ,
Format: double ,
Required: False ,
}
number ,
id:
{
Description: The resource ID of the quota object ,
Required: False ,
}
string ,
limit:
{
Description: The maximum value of the quota. If null or missing, the quota has no maximum, in which case it merely tracks usage. ,
Format: double ,
Required: False ,
}
number ,
name:
{
Description: The name of the quota ,
Required: False ,
}
{
localizedValue:
{
Description: The localized name of the quota ,
Required: False ,
}
string ,
value:
{
Description: The unlocalized name (or ID) of the quota ,
Required: False ,
}
string ,
}
,
unit:
{
Description: The unit for the quota, such as Count, Bytes, BytesPerSecond, etc. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to load the next page of quotas, or null or missing if this is the last page ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Operations_List (new)
Description :  Lists all available actions exposed by the Data Migration Service resource provider.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DataMigration/operations
{
api-version:
{
Description: Version of the API ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of actions ,
Required: False ,
}
[
{
name:
{
Description: The fully qualified action name, e.g. Microsoft.DataMigration/services/read ,
Required: False ,
}
string ,
display:
{
Description: Localized display text ,
Required: False ,
}
{
provider:
{
Description: The localized resource provider name ,
Required: False ,
}
string ,
resource:
{
Description: The localized resource type name ,
Required: False ,
}
string ,
operation:
{
Description: The localized operation name ,
Required: False ,
}
string ,
description:
{
Description: The localized operation description ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to load the next page of actions ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
ResourceSkus_ListSkus (removed)
Description :  The skus action returns the list of SKUs that DMS supports.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DataMigration/skus
{
subscriptionId:
{
Description: Identifier of the subscription ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of SKUs available for the subscription. ,
Required: True ,
}
[
{
resourceType:
{
Description: The type of resource the SKU applies to. ,
Required: False ,
}
string ,
name:
{
Description: The name of SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of DMS in a scale set. ,
Required: False ,
}
string ,
size:
{
Description: The Size of the SKU. ,
Required: False ,
}
string ,
family:
{
Description: The Family of this particular SKU. ,
Required: False ,
}
string ,
kind:
{
Description: The Kind of resources that are supported in this SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Not used. ,
Required: False ,
}
{
minimum:
{
Description: The minimum capacity. ,
Format: int64 ,
Required: False ,
}
integer ,
maximum:
{
Description: The maximum capacity. ,
Format: int64 ,
Required: False ,
}
integer ,
default:
{
Description: The default capacity. ,
Format: int64 ,
Required: False ,
}
integer ,
scaleType:
{
Description: The scale type applicable to the SKU. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
locations:
{
Description: The set of locations that the SKU is available. ,
Required: False ,
}
[
string ,
]
,
apiVersions:
{
Description: The api versions that support this SKU. ,
Required: False ,
}
[
string ,
]
,
costs:
{
Description: Metadata for retrieving price info. ,
Required: False ,
}
[
{
meterID:
{
Description: Used for querying price from commerce. ,
Required: False ,
}
string ,
quantity:
{
Description: The multiplier is needed to extend the base metered cost. ,
Format: int64 ,
Required: False ,
}
integer ,
extendedUnit:
{
Description: An invariant to show the extended unit. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: A name value pair to describe the capability. ,
Required: False ,
}
[
{
name:
{
Description: An invariant to describe the feature. ,
Required: False ,
}
string ,
value:
{
Description: An invariant if the feature is measured by quantity. ,
Required: False ,
}
string ,
}
,
]
,
restrictions:
{
Description: The restrictions because of which SKU cannot be used. This is empty if there are no restrictions. ,
Required: False ,
}
[
{
type:
{
Description: The type of restrictions. ,
Enum:
{
location: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted. ,
Required: False ,
}
[
string ,
]
,
reasonCode:
{
Description: The reason code for restriction. ,
Enum:
{
QuotaId: No description available. ,
NotAvailableForSubscription: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of DMS SKUs. Call ListNext() with this to fetch the next page of DMS SKUs. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Services_CreateOrUpdate (removed)
Description :  The 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. When a service is updated, existing child resources (i.e. tasks) are unaffected. Services currently support a single kind, "vm", which refers to a VM-based service, although other kinds may be added in the future. This method can change the kind, SKU, and network of the service, but if tasks are currently running (i.e. the service is busy), this will fail with 400 Bad Request ("ServiceIsBusy"). The provider will reply when successful with 200 OK or 201 Created. Long-running operations use the provisioningState property.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}
{
parameters:
{
Description: Information about the service ,
Required: True ,
}
{
etag:
{
Description: HTTP strong entity tag value. Ignored if submitted ,
Required: False ,
}
string ,
kind:
{
Description: The resource kind. Only 'vm' (the default) is supported. ,
Required: False ,
}
string ,
properties:
{
Description: Custom service properties ,
Required: False ,
}
{
provisioningState:
{
Description: The resource's provisioning state ,
Enum:
{
Accepted: No description available. ,
Deleting: No description available. ,
Deploying: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
Starting: No description available. ,
FailedToStart: No description available. ,
FailedToStop: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
publicKey:
{
Description: The public key of the service, used to encrypt secrets sent to the service ,
Required: False ,
}
string ,
virtualSubnetId:
{
Description: The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined ,
Required: True ,
}
string ,
}
,
sku:
{
Description: Service SKU ,
Required: False ,
}
{
name:
{
Description: The unique name of the SKU, such as 'P3' ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the SKU, such as 'Free', 'Basic', 'Standard', or 'Premium' ,
Required: False ,
}
string ,
family:
{
Description: The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines ,
Required: False ,
}
string ,
size:
{
Description: The size of the SKU, used when the name alone does not denote a service size or when a SKU has multiple performance classes within a family, e.g. 'A1' for virtual machines ,
Required: False ,
}
string ,
capacity:
{
Description: The capacity of the SKU, if it supports scaling ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
etag:
{
Description: HTTP strong entity tag value. Ignored if submitted ,
Required: False ,
}
string ,
kind:
{
Description: The resource kind. Only 'vm' (the default) is supported. ,
Required: False ,
}
string ,
properties:
{
Description: Custom service properties ,
Required: False ,
}
{
provisioningState:
{
Description: The resource's provisioning state ,
Enum:
{
Accepted: No description available. ,
Deleting: No description available. ,
Deploying: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
Starting: No description available. ,
FailedToStart: No description available. ,
FailedToStop: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
publicKey:
{
Description: The public key of the service, used to encrypt secrets sent to the service ,
Required: False ,
}
string ,
virtualSubnetId:
{
Description: The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined ,
Required: True ,
}
string ,
}
,
sku:
{
Description: Service SKU ,
Required: False ,
}
{
name:
{
Description: The unique name of the SKU, such as 'P3' ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the SKU, such as 'Free', 'Basic', 'Standard', or 'Premium' ,
Required: False ,
}
string ,
family:
{
Description: The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines ,
Required: False ,
}
string ,
size:
{
Description: The size of the SKU, used when the name alone does not denote a service size or when a SKU has multiple performance classes within a family, e.g. 'A1' for virtual machines ,
Required: False ,
}
string ,
capacity:
{
Description: The capacity of the SKU, if it supports scaling ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
etag:
{
Description: HTTP strong entity tag value. Ignored if submitted ,
Required: False ,
}
string ,
kind:
{
Description: The resource kind. Only 'vm' (the default) is supported. ,
Required: False ,
}
string ,
properties:
{
Description: Custom service properties ,
Required: False ,
}
{
provisioningState:
{
Description: The resource's provisioning state ,
Enum:
{
Accepted: No description available. ,
Deleting: No description available. ,
Deploying: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
Starting: No description available. ,
FailedToStart: No description available. ,
FailedToStop: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
publicKey:
{
Description: The public key of the service, used to encrypt secrets sent to the service ,
Required: False ,
}
string ,
virtualSubnetId:
{
Description: The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined ,
Required: True ,
}
string ,
}
,
sku:
{
Description: Service SKU ,
Required: False ,
}
{
name:
{
Description: The unique name of the SKU, such as 'P3' ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the SKU, such as 'Free', 'Basic', 'Standard', or 'Premium' ,
Required: False ,
}
string ,
family:
{
Description: The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines ,
Required: False ,
}
string ,
size:
{
Description: The size of the SKU, used when the name alone does not denote a service size or when a SKU has multiple performance classes within a family, e.g. 'A1' for virtual machines ,
Required: False ,
}
string ,
capacity:
{
Description: The capacity of the SKU, if it supports scaling ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Services_Get (removed)
Description :  The services resource is the top-level resource that represents the Data Migration Service. The GET method retrieves information about a service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}
{}

⚐ Response (200)

{
etag:
{
Description: HTTP strong entity tag value. Ignored if submitted ,
Required: False ,
}
string ,
kind:
{
Description: The resource kind. Only 'vm' (the default) is supported. ,
Required: False ,
}
string ,
properties:
{
Description: Custom service properties ,
Required: False ,
}
{
provisioningState:
{
Description: The resource's provisioning state ,
Enum:
{
Accepted: No description available. ,
Deleting: No description available. ,
Deploying: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
Starting: No description available. ,
FailedToStart: No description available. ,
FailedToStop: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
publicKey:
{
Description: The public key of the service, used to encrypt secrets sent to the service ,
Required: False ,
}
string ,
virtualSubnetId:
{
Description: The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined ,
Required: True ,
}
string ,
}
,
sku:
{
Description: Service SKU ,
Required: False ,
}
{
name:
{
Description: The unique name of the SKU, such as 'P3' ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the SKU, such as 'Free', 'Basic', 'Standard', or 'Premium' ,
Required: False ,
}
string ,
family:
{
Description: The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines ,
Required: False ,
}
string ,
size:
{
Description: The size of the SKU, used when the name alone does not denote a service size or when a SKU has multiple performance classes within a family, e.g. 'A1' for virtual machines ,
Required: False ,
}
string ,
capacity:
{
Description: The capacity of the SKU, if it supports scaling ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Services_Delete (removed)
Description :  The services resource is the top-level resource that represents the Data Migration Service. The DELETE method deletes a service. Any running tasks will be canceled.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}
{
deleteRunningTasks:
{
Description: Delete the resource even if it contains running tasks ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Services_Update (removed)
Description :  The services resource is the top-level resource that represents the Data Migration Service. The PATCH method updates an existing service. This method can change the kind, SKU, and network of the service, but if tasks are currently running (i.e. the service is busy), this will fail with 400 Bad Request ("ServiceIsBusy").
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}
{
parameters:
{
Description: Information about the service ,
Required: True ,
}
{
etag:
{
Description: HTTP strong entity tag value. Ignored if submitted ,
Required: False ,
}
string ,
kind:
{
Description: The resource kind. Only 'vm' (the default) is supported. ,
Required: False ,
}
string ,
properties:
{
Description: Custom service properties ,
Required: False ,
}
{
provisioningState:
{
Description: The resource's provisioning state ,
Enum:
{
Accepted: No description available. ,
Deleting: No description available. ,
Deploying: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
Starting: No description available. ,
FailedToStart: No description available. ,
FailedToStop: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
publicKey:
{
Description: The public key of the service, used to encrypt secrets sent to the service ,
Required: False ,
}
string ,
virtualSubnetId:
{
Description: The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined ,
Required: True ,
}
string ,
}
,
sku:
{
Description: Service SKU ,
Required: False ,
}
{
name:
{
Description: The unique name of the SKU, such as 'P3' ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the SKU, such as 'Free', 'Basic', 'Standard', or 'Premium' ,
Required: False ,
}
string ,
family:
{
Description: The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines ,
Required: False ,
}
string ,
size:
{
Description: The size of the SKU, used when the name alone does not denote a service size or when a SKU has multiple performance classes within a family, e.g. 'A1' for virtual machines ,
Required: False ,
}
string ,
capacity:
{
Description: The capacity of the SKU, if it supports scaling ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
etag:
{
Description: HTTP strong entity tag value. Ignored if submitted ,
Required: False ,
}
string ,
kind:
{
Description: The resource kind. Only 'vm' (the default) is supported. ,
Required: False ,
}
string ,
properties:
{
Description: Custom service properties ,
Required: False ,
}
{
provisioningState:
{
Description: The resource's provisioning state ,
Enum:
{
Accepted: No description available. ,
Deleting: No description available. ,
Deploying: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
Starting: No description available. ,
FailedToStart: No description available. ,
FailedToStop: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
publicKey:
{
Description: The public key of the service, used to encrypt secrets sent to the service ,
Required: False ,
}
string ,
virtualSubnetId:
{
Description: The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined ,
Required: True ,
}
string ,
}
,
sku:
{
Description: Service SKU ,
Required: False ,
}
{
name:
{
Description: The unique name of the SKU, such as 'P3' ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the SKU, such as 'Free', 'Basic', 'Standard', or 'Premium' ,
Required: False ,
}
string ,
family:
{
Description: The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines ,
Required: False ,
}
string ,
size:
{
Description: The size of the SKU, used when the name alone does not denote a service size or when a SKU has multiple performance classes within a family, e.g. 'A1' for virtual machines ,
Required: False ,
}
string ,
capacity:
{
Description: The capacity of the SKU, if it supports scaling ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Services_CheckStatus (removed)
Description :  The 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 service and virtual machine size.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/checkStatus
{
subscriptionId:
{
Description: Identifier of the subscription ,
Required: True ,
}
string ,
groupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
serviceName:
{
Description: Name of the service ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
agentVersion:
{
Description: The DMS instance agent version ,
Required: False ,
}
string ,
status:
{
Description: The machine-readable status, such as 'Initializing', 'Offline', 'Online', 'Deploying', 'Deleting', 'Stopped', 'Stopping', 'Starting', 'FailedToStart', 'FailedToStop' or 'Failed' ,
Required: False ,
}
string ,
vmSize:
{
Description: The services virtual machine size, such as 'Standard_D2_v2' ,
Required: False ,
}
string ,
supportedTaskTypes:
{
Description: The list of supported task types ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Services_Start (removed)
Description :  The 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 data migration.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/start
{
subscriptionId:
{
Description: Identifier of the subscription ,
Required: True ,
}
string ,
groupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
serviceName:
{
Description: Name of the service ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Services_Stop (removed)
Description :  The 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 data migration. The service owner won't be billed when the service is stopped.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/stop
{
subscriptionId:
{
Description: Identifier of the subscription ,
Required: True ,
}
string ,
groupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
serviceName:
{
Description: Name of the service ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Services_ListSkus (removed)
Description :  The 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 can be updated to.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/skus
{
subscriptionId:
{
Description: Identifier of the subscription ,
Required: True ,
}
string ,
groupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
serviceName:
{
Description: Name of the service ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of service SKUs ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type, including the provider namespace ,
Required: False ,
}
string ,
sku:
{
Description: SKU name, tier, etc. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU ,
Required: False ,
}
string ,
family:
{
Description: SKU family ,
Required: False ,
}
string ,
size:
{
Description: SKU size ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the SKU, such as "Free", "Basic", "Standard", or "Premium" ,
Required: False ,
}
string ,
}
,
capacity:
{
Description: A description of the scaling capacities of the SKU ,
Required: False ,
}
{
minimum:
{
Description: The minimum capacity, usually 0 or 1. ,
Required: False ,
}
integer ,
maximum:
{
Description: The maximum capacity ,
Required: False ,
}
integer ,
default:
{
Description: The default capacity ,
Required: False ,
}
integer ,
scaleType:
{
Description: The scalability approach ,
Enum:
{
none: No description available. ,
manual: No description available. ,
automatic: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to load the next page of service SKUs ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Tasks_List (removed)
Description :  The 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. Some tasks may have a status of Unknown, which indicates that an error occurred while querying the status of that task.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/projects/{projectName}/tasks
{
subscriptionId:
{
Description: Identifier of the subscription ,
Required: True ,
}
string ,
groupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
serviceName:
{
Description: Name of the service ,
Required: True ,
}
string ,
projectName:
{
Description: Name of the project ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API ,
Required: True ,
}
string ,
taskType:
{
Description: Filter tasks by task type ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of tasks ,
Required: False ,
}
[
{
etag:
{
Description: HTTP strong entity tag value. This is ignored if submitted. ,
Required: False ,
}
string ,
properties:
{
Description: Custom task properties ,
Required: False ,
}
{
taskType:
{
Description: Task type. ,
Required: True ,
}
string ,
errors:
{
Description: Array of errors. This is ignored if submitted. ,
Required: False ,
}
[
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
state:
{
Description: The state of the task. This is ignored if submitted. ,
Enum:
{
Unknown: No description available. ,
Queued: No description available. ,
Running: No description available. ,
Canceled: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
FailedInputValidation: No description available. ,
Faulted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to load the next page of tasks ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Services_CheckChildrenNameAvailability (removed)
Description :  This method checks whether a proposed nested resource name is valid and available.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/checkNameAvailability
{
subscriptionId:
{
Description: Identifier of the subscription ,
Required: True ,
}
string ,
groupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API ,
Required: True ,
}
string ,
serviceName:
{
Description: Name of the service ,
Required: True ,
}
string ,
parameters:
{
Description: Requested name to validate ,
Required: True ,
}
{
name:
{
Description: The proposed resource name ,
Required: False ,
}
string ,
type:
{
Description: The resource type chain (e.g. virtualMachines/extensions) ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: If true, the name is valid and available. If false, 'reason' describes why not. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason why the name is not available, if nameAvailable is false ,
Enum:
{
AlreadyExists: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The localized reason why the name is not available, if nameAvailable is false ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Services_ListByResourceGroup (removed)
Description :  The 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.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services
{
subscriptionId:
{
Description: Identifier of the subscription ,
Required: True ,
}
string ,
groupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of services ,
Required: False ,
}
[
{
etag:
{
Description: HTTP strong entity tag value. Ignored if submitted ,
Required: False ,
}
string ,
kind:
{
Description: The resource kind. Only 'vm' (the default) is supported. ,
Required: False ,
}
string ,
properties:
{
Description: Custom service properties ,
Required: False ,
}
{
provisioningState:
{
Description: The resource's provisioning state ,
Enum:
{
Accepted: No description available. ,
Deleting: No description available. ,
Deploying: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
Starting: No description available. ,
FailedToStart: No description available. ,
FailedToStop: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
publicKey:
{
Description: The public key of the service, used to encrypt secrets sent to the service ,
Required: False ,
}
string ,
virtualSubnetId:
{
Description: The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined ,
Required: True ,
}
string ,
}
,
sku:
{
Description: Service SKU ,
Required: False ,
}
{
name:
{
Description: The unique name of the SKU, such as 'P3' ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the SKU, such as 'Free', 'Basic', 'Standard', or 'Premium' ,
Required: False ,
}
string ,
family:
{
Description: The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines ,
Required: False ,
}
string ,
size:
{
Description: The size of the SKU, used when the name alone does not denote a service size or when a SKU has multiple performance classes within a family, e.g. 'A1' for virtual machines ,
Required: False ,
}
string ,
capacity:
{
Description: The capacity of the SKU, if it supports scaling ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: URL to load the next page of services ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Services_List (removed)
Description :  The services resource is the top-level resource that represents the Data Migration Service. This method returns a list of service resources in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DataMigration/services
{
subscriptionId:
{
Description: Identifier of the subscription ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of services ,
Required: False ,
}
[
{
etag:
{
Description: HTTP strong entity tag value. Ignored if submitted ,
Required: False ,
}
string ,
kind:
{
Description: The resource kind. Only 'vm' (the default) is supported. ,
Required: False ,
}
string ,
properties:
{
Description: Custom service properties ,
Required: False ,
}
{
provisioningState:
{
Description: The resource's provisioning state ,
Enum:
{
Accepted: No description available. ,
Deleting: No description available. ,
Deploying: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
Starting: No description available. ,
FailedToStart: No description available. ,
FailedToStop: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
publicKey:
{
Description: The public key of the service, used to encrypt secrets sent to the service ,
Required: False ,
}
string ,
virtualSubnetId:
{
Description: The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined ,
Required: True ,
}
string ,
}
,
sku:
{
Description: Service SKU ,
Required: False ,
}
{
name:
{
Description: The unique name of the SKU, such as 'P3' ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the SKU, such as 'Free', 'Basic', 'Standard', or 'Premium' ,
Required: False ,
}
string ,
family:
{
Description: The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines ,
Required: False ,
}
string ,
size:
{
Description: The size of the SKU, used when the name alone does not denote a service size or when a SKU has multiple performance classes within a family, e.g. 'A1' for virtual machines ,
Required: False ,
}
string ,
capacity:
{
Description: The capacity of the SKU, if it supports scaling ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: URL to load the next page of services ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Tasks_CreateOrUpdate (removed)
Description :  The 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 one, although since tasks have no mutable custom properties, there is little reason to update an existing one.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/projects/{projectName}/tasks/{taskName}
{
parameters:
{
Description: Information about the task ,
Required: True ,
}
{
etag:
{
Description: HTTP strong entity tag value. This is ignored if submitted. ,
Required: False ,
}
string ,
properties:
{
Description: Custom task properties ,
Required: False ,
}
{
taskType:
{
Description: Task type. ,
Required: True ,
}
string ,
errors:
{
Description: Array of errors. This is ignored if submitted. ,
Required: False ,
}
[
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
state:
{
Description: The state of the task. This is ignored if submitted. ,
Enum:
{
Unknown: No description available. ,
Queued: No description available. ,
Running: No description available. ,
Canceled: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
FailedInputValidation: No description available. ,
Faulted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
etag:
{
Description: HTTP strong entity tag value. This is ignored if submitted. ,
Required: False ,
}
string ,
properties:
{
Description: Custom task properties ,
Required: False ,
}
{
taskType:
{
Description: Task type. ,
Required: True ,
}
string ,
errors:
{
Description: Array of errors. This is ignored if submitted. ,
Required: False ,
}
[
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
state:
{
Description: The state of the task. This is ignored if submitted. ,
Enum:
{
Unknown: No description available. ,
Queued: No description available. ,
Running: No description available. ,
Canceled: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
FailedInputValidation: No description available. ,
Faulted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
etag:
{
Description: HTTP strong entity tag value. This is ignored if submitted. ,
Required: False ,
}
string ,
properties:
{
Description: Custom task properties ,
Required: False ,
}
{
taskType:
{
Description: Task type. ,
Required: True ,
}
string ,
errors:
{
Description: Array of errors. This is ignored if submitted. ,
Required: False ,
}
[
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
state:
{
Description: The state of the task. This is ignored if submitted. ,
Enum:
{
Unknown: No description available. ,
Queued: No description available. ,
Running: No description available. ,
Canceled: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
FailedInputValidation: No description available. ,
Faulted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Tasks_Get (removed)
Description :  The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The GET method retrieves information about a task.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/projects/{projectName}/tasks/{taskName}
{
$expand:
{
Description: Expand the response ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: HTTP strong entity tag value. This is ignored if submitted. ,
Required: False ,
}
string ,
properties:
{
Description: Custom task properties ,
Required: False ,
}
{
taskType:
{
Description: Task type. ,
Required: True ,
}
string ,
errors:
{
Description: Array of errors. This is ignored if submitted. ,
Required: False ,
}
[
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
state:
{
Description: The state of the task. This is ignored if submitted. ,
Enum:
{
Unknown: No description available. ,
Queued: No description available. ,
Running: No description available. ,
Canceled: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
FailedInputValidation: No description available. ,
Faulted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Tasks_Delete (removed)
Description :  The 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 it's running.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/projects/{projectName}/tasks/{taskName}
{
deleteRunningTasks:
{
Description: Delete the resource even if it contains running tasks ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Tasks_Update (removed)
Description :  The 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 have no mutable custom properties, there is little reason to do so.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/projects/{projectName}/tasks/{taskName}
{
parameters:
{
Description: Information about the task ,
Required: True ,
}
{
etag:
{
Description: HTTP strong entity tag value. This is ignored if submitted. ,
Required: False ,
}
string ,
properties:
{
Description: Custom task properties ,
Required: False ,
}
{
taskType:
{
Description: Task type. ,
Required: True ,
}
string ,
errors:
{
Description: Array of errors. This is ignored if submitted. ,
Required: False ,
}
[
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
state:
{
Description: The state of the task. This is ignored if submitted. ,
Enum:
{
Unknown: No description available. ,
Queued: No description available. ,
Running: No description available. ,
Canceled: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
FailedInputValidation: No description available. ,
Faulted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
etag:
{
Description: HTTP strong entity tag value. This is ignored if submitted. ,
Required: False ,
}
string ,
properties:
{
Description: Custom task properties ,
Required: False ,
}
{
taskType:
{
Description: Task type. ,
Required: True ,
}
string ,
errors:
{
Description: Array of errors. This is ignored if submitted. ,
Required: False ,
}
[
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
state:
{
Description: The state of the task. This is ignored if submitted. ,
Enum:
{
Unknown: No description available. ,
Queued: No description available. ,
Running: No description available. ,
Canceled: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
FailedInputValidation: No description available. ,
Faulted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Tasks_Cancel (removed)
Description :  The 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 running.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/projects/{projectName}/tasks/{taskName}/cancel
{
subscriptionId:
{
Description: Identifier of the subscription ,
Required: True ,
}
string ,
groupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
serviceName:
{
Description: Name of the service ,
Required: True ,
}
string ,
projectName:
{
Description: Name of the project ,
Required: True ,
}
string ,
taskName:
{
Description: Name of the Task ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: HTTP strong entity tag value. This is ignored if submitted. ,
Required: False ,
}
string ,
properties:
{
Description: Custom task properties ,
Required: False ,
}
{
taskType:
{
Description: Task type. ,
Required: True ,
}
string ,
errors:
{
Description: Array of errors. This is ignored if submitted. ,
Required: False ,
}
[
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
state:
{
Description: The state of the task. This is ignored if submitted. ,
Enum:
{
Unknown: No description available. ,
Queued: No description available. ,
Running: No description available. ,
Canceled: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
FailedInputValidation: No description available. ,
Faulted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Projects_List (removed)
Description :  The project resource is a nested resource representing a stored migration project. This method returns a list of projects owned by a service resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/projects
{
subscriptionId:
{
Description: Identifier of the subscription ,
Required: True ,
}
string ,
groupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
serviceName:
{
Description: Name of the service ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of projects ,
Required: False ,
}
[
{
properties:
{
Description: Project properties ,
Required: False ,
}
{
sourcePlatform:
{
Description: Source platform for the project ,
Enum:
{
SQL: No description available. ,
Unknown: No description available. ,
}
,
Required: True ,
}
enum ,
targetPlatform:
{
Description: Target platform for the project ,
Enum:
{
SQLDB: No description available. ,
SQLMI: No description available. ,
Unknown: No description available. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: UTC Date and time when project was created ,
Format: date-time ,
Required: False ,
}
string ,
sourceConnectionInfo:
{
Description: Information for connecting to source ,
Required: False ,
}
{
type:
{
Description: Type of connection info ,
Required: True ,
}
string ,
userName:
{
Description: User name ,
Required: False ,
}
string ,
password:
{
Description: Password credential. ,
Required: False ,
}
string ,
}
,
targetConnectionInfo:
{
Description: Information for connecting to target ,
Required: False ,
}
{
type:
{
Description: Type of connection info ,
Required: True ,
}
string ,
userName:
{
Description: User name ,
Required: False ,
}
string ,
password:
{
Description: Password credential. ,
Required: False ,
}
string ,
}
,
databasesInfo:
{
Description: List of DatabaseInfo ,
Required: False ,
}
[
{
sourceDatabaseName:
{
Description: Name of the database ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The project's provisioning state ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to load the next page of projects ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Projects_CreateOrUpdate (removed)
Description :  The project resource is a nested resource representing a stored migration project. The PUT method creates a new project or updates an existing one.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/projects/{projectName}
{
parameters:
{
Description: Information about the project ,
Required: True ,
}
{
properties:
{
Description: Project properties ,
Required: False ,
}
{
sourcePlatform:
{
Description: Source platform for the project ,
Enum:
{
SQL: No description available. ,
Unknown: No description available. ,
}
,
Required: True ,
}
enum ,
targetPlatform:
{
Description: Target platform for the project ,
Enum:
{
SQLDB: No description available. ,
SQLMI: No description available. ,
Unknown: No description available. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: UTC Date and time when project was created ,
Format: date-time ,
Required: False ,
}
string ,
sourceConnectionInfo:
{
Description: Information for connecting to source ,
Required: False ,
}
{
type:
{
Description: Type of connection info ,
Required: True ,
}
string ,
userName:
{
Description: User name ,
Required: False ,
}
string ,
password:
{
Description: Password credential. ,
Required: False ,
}
string ,
}
,
targetConnectionInfo:
{
Description: Information for connecting to target ,
Required: False ,
}
{
type:
{
Description: Type of connection info ,
Required: True ,
}
string ,
userName:
{
Description: User name ,
Required: False ,
}
string ,
password:
{
Description: Password credential. ,
Required: False ,
}
string ,
}
,
databasesInfo:
{
Description: List of DatabaseInfo ,
Required: False ,
}
[
{
sourceDatabaseName:
{
Description: Name of the database ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The project's provisioning state ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Project properties ,
Required: False ,
}
{
sourcePlatform:
{
Description: Source platform for the project ,
Enum:
{
SQL: No description available. ,
Unknown: No description available. ,
}
,
Required: True ,
}
enum ,
targetPlatform:
{
Description: Target platform for the project ,
Enum:
{
SQLDB: No description available. ,
SQLMI: No description available. ,
Unknown: No description available. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: UTC Date and time when project was created ,
Format: date-time ,
Required: False ,
}
string ,
sourceConnectionInfo:
{
Description: Information for connecting to source ,
Required: False ,
}
{
type:
{
Description: Type of connection info ,
Required: True ,
}
string ,
userName:
{
Description: User name ,
Required: False ,
}
string ,
password:
{
Description: Password credential. ,
Required: False ,
}
string ,
}
,
targetConnectionInfo:
{
Description: Information for connecting to target ,
Required: False ,
}
{
type:
{
Description: Type of connection info ,
Required: True ,
}
string ,
userName:
{
Description: User name ,
Required: False ,
}
string ,
password:
{
Description: Password credential. ,
Required: False ,
}
string ,
}
,
databasesInfo:
{
Description: List of DatabaseInfo ,
Required: False ,
}
[
{
sourceDatabaseName:
{
Description: Name of the database ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The project's provisioning state ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Project properties ,
Required: False ,
}
{
sourcePlatform:
{
Description: Source platform for the project ,
Enum:
{
SQL: No description available. ,
Unknown: No description available. ,
}
,
Required: True ,
}
enum ,
targetPlatform:
{
Description: Target platform for the project ,
Enum:
{
SQLDB: No description available. ,
SQLMI: No description available. ,
Unknown: No description available. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: UTC Date and time when project was created ,
Format: date-time ,
Required: False ,
}
string ,
sourceConnectionInfo:
{
Description: Information for connecting to source ,
Required: False ,
}
{
type:
{
Description: Type of connection info ,
Required: True ,
}
string ,
userName:
{
Description: User name ,
Required: False ,
}
string ,
password:
{
Description: Password credential. ,
Required: False ,
}
string ,
}
,
targetConnectionInfo:
{
Description: Information for connecting to target ,
Required: False ,
}
{
type:
{
Description: Type of connection info ,
Required: True ,
}
string ,
userName:
{
Description: User name ,
Required: False ,
}
string ,
password:
{
Description: Password credential. ,
Required: False ,
}
string ,
}
,
databasesInfo:
{
Description: List of DatabaseInfo ,
Required: False ,
}
[
{
sourceDatabaseName:
{
Description: Name of the database ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The project's provisioning state ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Projects_Get (removed)
Description :  The project resource is a nested resource representing a stored migration project. The GET method retrieves information about a project.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/projects/{projectName}
{}

⚐ Response (200)

{
properties:
{
Description: Project properties ,
Required: False ,
}
{
sourcePlatform:
{
Description: Source platform for the project ,
Enum:
{
SQL: No description available. ,
Unknown: No description available. ,
}
,
Required: True ,
}
enum ,
targetPlatform:
{
Description: Target platform for the project ,
Enum:
{
SQLDB: No description available. ,
SQLMI: No description available. ,
Unknown: No description available. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: UTC Date and time when project was created ,
Format: date-time ,
Required: False ,
}
string ,
sourceConnectionInfo:
{
Description: Information for connecting to source ,
Required: False ,
}
{
type:
{
Description: Type of connection info ,
Required: True ,
}
string ,
userName:
{
Description: User name ,
Required: False ,
}
string ,
password:
{
Description: Password credential. ,
Required: False ,
}
string ,
}
,
targetConnectionInfo:
{
Description: Information for connecting to target ,
Required: False ,
}
{
type:
{
Description: Type of connection info ,
Required: True ,
}
string ,
userName:
{
Description: User name ,
Required: False ,
}
string ,
password:
{
Description: Password credential. ,
Required: False ,
}
string ,
}
,
databasesInfo:
{
Description: List of DatabaseInfo ,
Required: False ,
}
[
{
sourceDatabaseName:
{
Description: Name of the database ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The project's provisioning state ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Projects_Delete (removed)
Description :  The project resource is a nested resource representing a stored migration project. The DELETE method deletes a project.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/projects/{projectName}
{
deleteRunningTasks:
{
Description: Delete the resource even if it contains running tasks ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Projects_Update (removed)
Description :  The project resource is a nested resource representing a stored migration project. The PATCH method updates an existing project.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/projects/{projectName}
{
parameters:
{
Description: Information about the project ,
Required: True ,
}
{
properties:
{
Description: Project properties ,
Required: False ,
}
{
sourcePlatform:
{
Description: Source platform for the project ,
Enum:
{
SQL: No description available. ,
Unknown: No description available. ,
}
,
Required: True ,
}
enum ,
targetPlatform:
{
Description: Target platform for the project ,
Enum:
{
SQLDB: No description available. ,
SQLMI: No description available. ,
Unknown: No description available. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: UTC Date and time when project was created ,
Format: date-time ,
Required: False ,
}
string ,
sourceConnectionInfo:
{
Description: Information for connecting to source ,
Required: False ,
}
{
type:
{
Description: Type of connection info ,
Required: True ,
}
string ,
userName:
{
Description: User name ,
Required: False ,
}
string ,
password:
{
Description: Password credential. ,
Required: False ,
}
string ,
}
,
targetConnectionInfo:
{
Description: Information for connecting to target ,
Required: False ,
}
{
type:
{
Description: Type of connection info ,
Required: True ,
}
string ,
userName:
{
Description: User name ,
Required: False ,
}
string ,
password:
{
Description: Password credential. ,
Required: False ,
}
string ,
}
,
databasesInfo:
{
Description: List of DatabaseInfo ,
Required: False ,
}
[
{
sourceDatabaseName:
{
Description: Name of the database ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The project's provisioning state ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Project properties ,
Required: False ,
}
{
sourcePlatform:
{
Description: Source platform for the project ,
Enum:
{
SQL: No description available. ,
Unknown: No description available. ,
}
,
Required: True ,
}
enum ,
targetPlatform:
{
Description: Target platform for the project ,
Enum:
{
SQLDB: No description available. ,
SQLMI: No description available. ,
Unknown: No description available. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: UTC Date and time when project was created ,
Format: date-time ,
Required: False ,
}
string ,
sourceConnectionInfo:
{
Description: Information for connecting to source ,
Required: False ,
}
{
type:
{
Description: Type of connection info ,
Required: True ,
}
string ,
userName:
{
Description: User name ,
Required: False ,
}
string ,
password:
{
Description: Password credential. ,
Required: False ,
}
string ,
}
,
targetConnectionInfo:
{
Description: Information for connecting to target ,
Required: False ,
}
{
type:
{
Description: Type of connection info ,
Required: True ,
}
string ,
userName:
{
Description: User name ,
Required: False ,
}
string ,
password:
{
Description: Password credential. ,
Required: False ,
}
string ,
}
,
databasesInfo:
{
Description: List of DatabaseInfo ,
Required: False ,
}
[
{
sourceDatabaseName:
{
Description: Name of the database ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The project's provisioning state ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Services_CheckNameAvailability (removed)
Description :  This method checks whether a proposed top-level resource name is valid and available.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DataMigration/locations/{location}/checkNameAvailability
{
subscriptionId:
{
Description: Identifier of the subscription ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API ,
Required: True ,
}
string ,
location:
{
Description: The Azure region of the operation ,
Required: True ,
}
string ,
parameters:
{
Description: Requested name to validate ,
Required: True ,
}
{
name:
{
Description: The proposed resource name ,
Required: False ,
}
string ,
type:
{
Description: The resource type chain (e.g. virtualMachines/extensions) ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: If true, the name is valid and available. If false, 'reason' describes why not. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason why the name is not available, if nameAvailable is false ,
Enum:
{
AlreadyExists: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The localized reason why the name is not available, if nameAvailable is false ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Usages_List (removed)
Description :  This method returns region-specific quotas and resource usage information for the Data Migration Service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DataMigration/locations/{location}/usages
{
subscriptionId:
{
Description: Identifier of the subscription ,
Required: True ,
}
string ,
location:
{
Description: The Azure region of the operation ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of quotas ,
Required: False ,
}
[
{
currentValue:
{
Description: The current value of the quota. If null or missing, the current value cannot be determined in the context of the request. ,
Format: double ,
Required: False ,
}
number ,
id:
{
Description: The resource ID of the quota object ,
Required: False ,
}
string ,
limit:
{
Description: The maximum value of the quota. If null or missing, the quota has no maximum, in which case it merely tracks usage. ,
Format: double ,
Required: False ,
}
number ,
name:
{
Description: The name of the quota ,
Required: False ,
}
{
localizedValue:
{
Description: The localized name of the quota ,
Required: False ,
}
string ,
value:
{
Description: The unlocalized name (or ID) of the quota ,
Required: False ,
}
string ,
}
,
unit:
{
Description: The unit for the quota, such as Count, Bytes, BytesPerSecond, etc. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to load the next page of quotas, or null or missing if this is the last page ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}
Operations_List (removed)
Description :  Lists all available actions exposed by the Data Migration Service resource provider.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DataMigration/operations
{
api-version:
{
Description: Version of the API ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of actions ,
Required: False ,
}
[
{
name:
{
Description: The fully qualified action name, e.g. Microsoft.DataMigration/services/read ,
Required: False ,
}
string ,
display:
{
Description: Localized display text ,
Required: False ,
}
{
provider:
{
Description: The localized resource provider name ,
Required: False ,
}
string ,
resource:
{
Description: The localized resource type name ,
Required: False ,
}
string ,
operation:
{
Description: The localized operation name ,
Required: False ,
}
string ,
description:
{
Description: The localized operation description ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to load the next page of actions ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information in OData format ,
Required: False ,
}
{
code:
{
Description: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' ,
Required: False ,
}
string ,
message:
{
Description: The human-readable description of the error ,
Required: False ,
}
string ,
details:
{
Description: Inner errors that caused this error ,
Required: False ,
}
[
string ,
]
,
}
,
}