Microsoft.DocumentDB (preview:2025-03-15)

2025/04/01 • 39 new methods

DatabaseMigrationsMongoToCosmosDbRUMongo_Get (new)
Description :  Get Database Migration resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{targetResourceName}/providers/Microsoft.DataMigration/databaseMigrations/{migrationName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
targetResourceName:
{
Description: The name of the target resource/account. ,
Required: True ,
}
string ,
migrationName:
{
Description: Name of the migration. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Database Migration Resource properties for CosmosDb for Mongo. ,
Required: False ,
}
{
sourceMongoConnection:
{
Description: Source Mongo connection details. ,
Required: False ,
}
{
host:
{
Description: Host of mongo connection. ,
Required: False ,
}
string ,
port:
{
Description: Port of mongo connection. ,
Format: int32 ,
Required: False ,
}
integer ,
userName:
{
Description: User name to connect to Mongo. ,
Required: False ,
}
string ,
password:
{
Description: Password to connect to Mongo. ,
Format: password ,
Required: False ,
}
string ,
useSsl:
{
Description: Whether to UseSsl or UseTls to connect to Mongo. Default is true. ,
Required: False ,
}
boolean ,
connectionString:
{
Description: ConnectionString to connect to Mongo. ,
Required: False ,
}
string ,
}
,
targetMongoConnection:
{
Description: Target Cosmos DB Mongo connection details. ,
Required: False ,
}
{
host:
{
Description: Host of mongo connection. ,
Required: False ,
}
string ,
port:
{
Description: Port of mongo connection. ,
Format: int32 ,
Required: False ,
}
integer ,
userName:
{
Description: User name to connect to Mongo. ,
Required: False ,
}
string ,
password:
{
Description: Password to connect to Mongo. ,
Format: password ,
Required: False ,
}
string ,
useSsl:
{
Description: Whether to UseSsl or UseTls to connect to Mongo. Default is true. ,
Required: False ,
}
boolean ,
connectionString:
{
Description: ConnectionString to connect to Mongo. ,
Required: False ,
}
string ,
}
,
collectionList:
{
Description: List of Mongo Collections to be migrated. ,
Required: False ,
}
[
{
sourceDatabase:
{
Description: Source database name. ,
Required: False ,
}
string ,
sourceCollection:
{
Description: Source collection name. ,
Required: False ,
}
string ,
targetDatabase:
{
Description: Target database name. ,
Required: False ,
}
string ,
targetCollection:
{
Description: Target collection name. ,
Required: False ,
}
string ,
migrationProgressDetails:
{
Description: Detailed migration status. Not included by default. ,
Required: False ,
}
{
migrationStatus:
{
Description: Migration Status ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
migrationError:
{
Description: Migration Error ,
Required: False ,
}
string ,
sourceDocumentCount:
{
Description: Source Document Count ,
Format: int64 ,
Required: False ,
}
integer ,
processedDocumentCount:
{
Description: Processed Document Count ,
Format: int64 ,
Required: False ,
}
integer ,
durationInSeconds:
{
Description: Migration duration ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseMigrationsMongoToCosmosDbRUMongo_Create (new)
Description :  Create or Update Database Migration resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{targetResourceName}/providers/Microsoft.DataMigration/databaseMigrations/{migrationName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
targetResourceName:
{
Description: The name of the target resource/account. ,
Required: True ,
}
string ,
migrationName:
{
Description: Name of the migration. ,
Required: True ,
}
string ,
parameters:
{
Description: Details of CosmosDB for Mongo API Migration resource. ,
Required: True ,
}
{
properties:
{
Description: Database Migration Resource properties for CosmosDb for Mongo. ,
Required: False ,
}
{
sourceMongoConnection:
{
Description: Source Mongo connection details. ,
Required: False ,
}
{
host:
{
Description: Host of mongo connection. ,
Required: False ,
}
string ,
port:
{
Description: Port of mongo connection. ,
Format: int32 ,
Required: False ,
}
integer ,
userName:
{
Description: User name to connect to Mongo. ,
Required: False ,
}
string ,
password:
{
Description: Password to connect to Mongo. ,
Format: password ,
Required: False ,
}
string ,
useSsl:
{
Description: Whether to UseSsl or UseTls to connect to Mongo. Default is true. ,
Required: False ,
}
boolean ,
connectionString:
{
Description: ConnectionString to connect to Mongo. ,
Required: False ,
}
string ,
}
,
targetMongoConnection:
{
Description: Target Cosmos DB Mongo connection details. ,
Required: False ,
}
{
host:
{
Description: Host of mongo connection. ,
Required: False ,
}
string ,
port:
{
Description: Port of mongo connection. ,
Format: int32 ,
Required: False ,
}
integer ,
userName:
{
Description: User name to connect to Mongo. ,
Required: False ,
}
string ,
password:
{
Description: Password to connect to Mongo. ,
Format: password ,
Required: False ,
}
string ,
useSsl:
{
Description: Whether to UseSsl or UseTls to connect to Mongo. Default is true. ,
Required: False ,
}
boolean ,
connectionString:
{
Description: ConnectionString to connect to Mongo. ,
Required: False ,
}
string ,
}
,
collectionList:
{
Description: List of Mongo Collections to be migrated. ,
Required: False ,
}
[
{
sourceDatabase:
{
Description: Source database name. ,
Required: False ,
}
string ,
sourceCollection:
{
Description: Source collection name. ,
Required: False ,
}
string ,
targetDatabase:
{
Description: Target database name. ,
Required: False ,
}
string ,
targetCollection:
{
Description: Target collection name. ,
Required: False ,
}
string ,
migrationProgressDetails:
{
Description: Detailed migration status. Not included by default. ,
Required: False ,
}
{
migrationStatus:
{
Description: Migration Status ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
migrationError:
{
Description: Migration Error ,
Required: False ,
}
string ,
sourceDocumentCount:
{
Description: Source Document Count ,
Format: int64 ,
Required: False ,
}
integer ,
processedDocumentCount:
{
Description: Processed Document Count ,
Format: int64 ,
Required: False ,
}
integer ,
durationInSeconds:
{
Description: Migration duration ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Database Migration Resource properties for CosmosDb for Mongo. ,
Required: False ,
}
{
sourceMongoConnection:
{
Description: Source Mongo connection details. ,
Required: False ,
}
{
host:
{
Description: Host of mongo connection. ,
Required: False ,
}
string ,
port:
{
Description: Port of mongo connection. ,
Format: int32 ,
Required: False ,
}
integer ,
userName:
{
Description: User name to connect to Mongo. ,
Required: False ,
}
string ,
password:
{
Description: Password to connect to Mongo. ,
Format: password ,
Required: False ,
}
string ,
useSsl:
{
Description: Whether to UseSsl or UseTls to connect to Mongo. Default is true. ,
Required: False ,
}
boolean ,
connectionString:
{
Description: ConnectionString to connect to Mongo. ,
Required: False ,
}
string ,
}
,
targetMongoConnection:
{
Description: Target Cosmos DB Mongo connection details. ,
Required: False ,
}
{
host:
{
Description: Host of mongo connection. ,
Required: False ,
}
string ,
port:
{
Description: Port of mongo connection. ,
Format: int32 ,
Required: False ,
}
integer ,
userName:
{
Description: User name to connect to Mongo. ,
Required: False ,
}
string ,
password:
{
Description: Password to connect to Mongo. ,
Format: password ,
Required: False ,
}
string ,
useSsl:
{
Description: Whether to UseSsl or UseTls to connect to Mongo. Default is true. ,
Required: False ,
}
boolean ,
connectionString:
{
Description: ConnectionString to connect to Mongo. ,
Required: False ,
}
string ,
}
,
collectionList:
{
Description: List of Mongo Collections to be migrated. ,
Required: False ,
}
[
{
sourceDatabase:
{
Description: Source database name. ,
Required: False ,
}
string ,
sourceCollection:
{
Description: Source collection name. ,
Required: False ,
}
string ,
targetDatabase:
{
Description: Target database name. ,
Required: False ,
}
string ,
targetCollection:
{
Description: Target collection name. ,
Required: False ,
}
string ,
migrationProgressDetails:
{
Description: Detailed migration status. Not included by default. ,
Required: False ,
}
{
migrationStatus:
{
Description: Migration Status ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
migrationError:
{
Description: Migration Error ,
Required: False ,
}
string ,
sourceDocumentCount:
{
Description: Source Document Count ,
Format: int64 ,
Required: False ,
}
integer ,
processedDocumentCount:
{
Description: Processed Document Count ,
Format: int64 ,
Required: False ,
}
integer ,
durationInSeconds:
{
Description: Migration duration ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Database Migration Resource properties for CosmosDb for Mongo. ,
Required: False ,
}
{
sourceMongoConnection:
{
Description: Source Mongo connection details. ,
Required: False ,
}
{
host:
{
Description: Host of mongo connection. ,
Required: False ,
}
string ,
port:
{
Description: Port of mongo connection. ,
Format: int32 ,
Required: False ,
}
integer ,
userName:
{
Description: User name to connect to Mongo. ,
Required: False ,
}
string ,
password:
{
Description: Password to connect to Mongo. ,
Format: password ,
Required: False ,
}
string ,
useSsl:
{
Description: Whether to UseSsl or UseTls to connect to Mongo. Default is true. ,
Required: False ,
}
boolean ,
connectionString:
{
Description: ConnectionString to connect to Mongo. ,
Required: False ,
}
string ,
}
,
targetMongoConnection:
{
Description: Target Cosmos DB Mongo connection details. ,
Required: False ,
}
{
host:
{
Description: Host of mongo connection. ,
Required: False ,
}
string ,
port:
{
Description: Port of mongo connection. ,
Format: int32 ,
Required: False ,
}
integer ,
userName:
{
Description: User name to connect to Mongo. ,
Required: False ,
}
string ,
password:
{
Description: Password to connect to Mongo. ,
Format: password ,
Required: False ,
}
string ,
useSsl:
{
Description: Whether to UseSsl or UseTls to connect to Mongo. Default is true. ,
Required: False ,
}
boolean ,
connectionString:
{
Description: ConnectionString to connect to Mongo. ,
Required: False ,
}
string ,
}
,
collectionList:
{
Description: List of Mongo Collections to be migrated. ,
Required: False ,
}
[
{
sourceDatabase:
{
Description: Source database name. ,
Required: False ,
}
string ,
sourceCollection:
{
Description: Source collection name. ,
Required: False ,
}
string ,
targetDatabase:
{
Description: Target database name. ,
Required: False ,
}
string ,
targetCollection:
{
Description: Target collection name. ,
Required: False ,
}
string ,
migrationProgressDetails:
{
Description: Detailed migration status. Not included by default. ,
Required: False ,
}
{
migrationStatus:
{
Description: Migration Status ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
migrationError:
{
Description: Migration Error ,
Required: False ,
}
string ,
sourceDocumentCount:
{
Description: Source Document Count ,
Format: int64 ,
Required: False ,
}
integer ,
processedDocumentCount:
{
Description: Processed Document Count ,
Format: int64 ,
Required: False ,
}
integer ,
durationInSeconds:
{
Description: Migration duration ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseMigrationsMongoToCosmosDbRUMongo_Delete (new)
Description :  Delete Database Migration resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{targetResourceName}/providers/Microsoft.DataMigration/databaseMigrations/{migrationName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
targetResourceName:
{
Description: The name of the target resource/account. ,
Required: True ,
}
string ,
migrationName:
{
Description: Name of the migration. ,
Required: True ,
}
string ,
force:
{
Description: Optional force delete boolean. If this is provided as true, migration will be deleted even if active. ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}
DatabaseMigrationsMongoToCosmosDbRUMongo_GetForScope (new)
Description :  Get Database Migration resources for the scope.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{targetResourceName}/providers/Microsoft.DataMigration/databaseMigrations
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
targetResourceName:
{
Description: The name of the target resource/account. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: Database Migration Resource properties for CosmosDb for Mongo. ,
Required: False ,
}
{
sourceMongoConnection:
{
Description: Source Mongo connection details. ,
Required: False ,
}
{
host:
{
Description: Host of mongo connection. ,
Required: False ,
}
string ,
port:
{
Description: Port of mongo connection. ,
Format: int32 ,
Required: False ,
}
integer ,
userName:
{
Description: User name to connect to Mongo. ,
Required: False ,
}
string ,
password:
{
Description: Password to connect to Mongo. ,
Format: password ,
Required: False ,
}
string ,
useSsl:
{
Description: Whether to UseSsl or UseTls to connect to Mongo. Default is true. ,
Required: False ,
}
boolean ,
connectionString:
{
Description: ConnectionString to connect to Mongo. ,
Required: False ,
}
string ,
}
,
targetMongoConnection:
{
Description: Target Cosmos DB Mongo connection details. ,
Required: False ,
}
{
host:
{
Description: Host of mongo connection. ,
Required: False ,
}
string ,
port:
{
Description: Port of mongo connection. ,
Format: int32 ,
Required: False ,
}
integer ,
userName:
{
Description: User name to connect to Mongo. ,
Required: False ,
}
string ,
password:
{
Description: Password to connect to Mongo. ,
Format: password ,
Required: False ,
}
string ,
useSsl:
{
Description: Whether to UseSsl or UseTls to connect to Mongo. Default is true. ,
Required: False ,
}
boolean ,
connectionString:
{
Description: ConnectionString to connect to Mongo. ,
Required: False ,
}
string ,
}
,
collectionList:
{
Description: List of Mongo Collections to be migrated. ,
Required: False ,
}
[
{
sourceDatabase:
{
Description: Source database name. ,
Required: False ,
}
string ,
sourceCollection:
{
Description: Source collection name. ,
Required: False ,
}
string ,
targetDatabase:
{
Description: Target database name. ,
Required: False ,
}
string ,
targetCollection:
{
Description: Target collection name. ,
Required: False ,
}
string ,
migrationProgressDetails:
{
Description: Detailed migration status. Not included by default. ,
Required: False ,
}
{
migrationStatus:
{
Description: Migration Status ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
migrationError:
{
Description: Migration Error ,
Required: False ,
}
string ,
sourceDocumentCount:
{
Description: Source Document Count ,
Format: int64 ,
Required: False ,
}
integer ,
processedDocumentCount:
{
Description: Processed Document Count ,
Format: int64 ,
Required: False ,
}
integer ,
durationInSeconds:
{
Description: Migration duration ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseMigrationsMongoToCosmosDbvCoreMongo_Get (new)
Description :  Get Database Migration resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{targetResourceName}/providers/Microsoft.DataMigration/databaseMigrations/{migrationName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
targetResourceName:
{
Description: The name of the target resource/account. ,
Required: True ,
}
string ,
migrationName:
{
Description: Name of the migration. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Database Migration Resource properties for CosmosDb for Mongo. ,
Required: False ,
}
{
sourceMongoConnection:
{
Description: Source Mongo connection details. ,
Required: False ,
}
{
host:
{
Description: Host of mongo connection. ,
Required: False ,
}
string ,
port:
{
Description: Port of mongo connection. ,
Format: int32 ,
Required: False ,
}
integer ,
userName:
{
Description: User name to connect to Mongo. ,
Required: False ,
}
string ,
password:
{
Description: Password to connect to Mongo. ,
Format: password ,
Required: False ,
}
string ,
useSsl:
{
Description: Whether to UseSsl or UseTls to connect to Mongo. Default is true. ,
Required: False ,
}
boolean ,
connectionString:
{
Description: ConnectionString to connect to Mongo. ,
Required: False ,
}
string ,
}
,
targetMongoConnection:
{
Description: Target Cosmos DB Mongo connection details. ,
Required: False ,
}
{
host:
{
Description: Host of mongo connection. ,
Required: False ,
}
string ,
port:
{
Description: Port of mongo connection. ,
Format: int32 ,
Required: False ,
}
integer ,
userName:
{
Description: User name to connect to Mongo. ,
Required: False ,
}
string ,
password:
{
Description: Password to connect to Mongo. ,
Format: password ,
Required: False ,
}
string ,
useSsl:
{
Description: Whether to UseSsl or UseTls to connect to Mongo. Default is true. ,
Required: False ,
}
boolean ,
connectionString:
{
Description: ConnectionString to connect to Mongo. ,
Required: False ,
}
string ,
}
,
collectionList:
{
Description: List of Mongo Collections to be migrated. ,
Required: False ,
}
[
{
sourceDatabase:
{
Description: Source database name. ,
Required: False ,
}
string ,
sourceCollection:
{
Description: Source collection name. ,
Required: False ,
}
string ,
targetDatabase:
{
Description: Target database name. ,
Required: False ,
}
string ,
targetCollection:
{
Description: Target collection name. ,
Required: False ,
}
string ,
migrationProgressDetails:
{
Description: Detailed migration status. Not included by default. ,
Required: False ,
}
{
migrationStatus:
{
Description: Migration Status ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
migrationError:
{
Description: Migration Error ,
Required: False ,
}
string ,
sourceDocumentCount:
{
Description: Source Document Count ,
Format: int64 ,
Required: False ,
}
integer ,
processedDocumentCount:
{
Description: Processed Document Count ,
Format: int64 ,
Required: False ,
}
integer ,
durationInSeconds:
{
Description: Migration duration ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseMigrationsMongoToCosmosDbvCoreMongo_Create (new)
Description :  Create or Update Database Migration resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{targetResourceName}/providers/Microsoft.DataMigration/databaseMigrations/{migrationName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
targetResourceName:
{
Description: The name of the target resource/account. ,
Required: True ,
}
string ,
migrationName:
{
Description: Name of the migration. ,
Required: True ,
}
string ,
parameters:
{
Description: Details of CosmosDB for Mongo API Migration resource. ,
Required: True ,
}
{
properties:
{
Description: Database Migration Resource properties for CosmosDb for Mongo. ,
Required: False ,
}
{
sourceMongoConnection:
{
Description: Source Mongo connection details. ,
Required: False ,
}
{
host:
{
Description: Host of mongo connection. ,
Required: False ,
}
string ,
port:
{
Description: Port of mongo connection. ,
Format: int32 ,
Required: False ,
}
integer ,
userName:
{
Description: User name to connect to Mongo. ,
Required: False ,
}
string ,
password:
{
Description: Password to connect to Mongo. ,
Format: password ,
Required: False ,
}
string ,
useSsl:
{
Description: Whether to UseSsl or UseTls to connect to Mongo. Default is true. ,
Required: False ,
}
boolean ,
connectionString:
{
Description: ConnectionString to connect to Mongo. ,
Required: False ,
}
string ,
}
,
targetMongoConnection:
{
Description: Target Cosmos DB Mongo connection details. ,
Required: False ,
}
{
host:
{
Description: Host of mongo connection. ,
Required: False ,
}
string ,
port:
{
Description: Port of mongo connection. ,
Format: int32 ,
Required: False ,
}
integer ,
userName:
{
Description: User name to connect to Mongo. ,
Required: False ,
}
string ,
password:
{
Description: Password to connect to Mongo. ,
Format: password ,
Required: False ,
}
string ,
useSsl:
{
Description: Whether to UseSsl or UseTls to connect to Mongo. Default is true. ,
Required: False ,
}
boolean ,
connectionString:
{
Description: ConnectionString to connect to Mongo. ,
Required: False ,
}
string ,
}
,
collectionList:
{
Description: List of Mongo Collections to be migrated. ,
Required: False ,
}
[
{
sourceDatabase:
{
Description: Source database name. ,
Required: False ,
}
string ,
sourceCollection:
{
Description: Source collection name. ,
Required: False ,
}
string ,
targetDatabase:
{
Description: Target database name. ,
Required: False ,
}
string ,
targetCollection:
{
Description: Target collection name. ,
Required: False ,
}
string ,
migrationProgressDetails:
{
Description: Detailed migration status. Not included by default. ,
Required: False ,
}
{
migrationStatus:
{
Description: Migration Status ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
migrationError:
{
Description: Migration Error ,
Required: False ,
}
string ,
sourceDocumentCount:
{
Description: Source Document Count ,
Format: int64 ,
Required: False ,
}
integer ,
processedDocumentCount:
{
Description: Processed Document Count ,
Format: int64 ,
Required: False ,
}
integer ,
durationInSeconds:
{
Description: Migration duration ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Database Migration Resource properties for CosmosDb for Mongo. ,
Required: False ,
}
{
sourceMongoConnection:
{
Description: Source Mongo connection details. ,
Required: False ,
}
{
host:
{
Description: Host of mongo connection. ,
Required: False ,
}
string ,
port:
{
Description: Port of mongo connection. ,
Format: int32 ,
Required: False ,
}
integer ,
userName:
{
Description: User name to connect to Mongo. ,
Required: False ,
}
string ,
password:
{
Description: Password to connect to Mongo. ,
Format: password ,
Required: False ,
}
string ,
useSsl:
{
Description: Whether to UseSsl or UseTls to connect to Mongo. Default is true. ,
Required: False ,
}
boolean ,
connectionString:
{
Description: ConnectionString to connect to Mongo. ,
Required: False ,
}
string ,
}
,
targetMongoConnection:
{
Description: Target Cosmos DB Mongo connection details. ,
Required: False ,
}
{
host:
{
Description: Host of mongo connection. ,
Required: False ,
}
string ,
port:
{
Description: Port of mongo connection. ,
Format: int32 ,
Required: False ,
}
integer ,
userName:
{
Description: User name to connect to Mongo. ,
Required: False ,
}
string ,
password:
{
Description: Password to connect to Mongo. ,
Format: password ,
Required: False ,
}
string ,
useSsl:
{
Description: Whether to UseSsl or UseTls to connect to Mongo. Default is true. ,
Required: False ,
}
boolean ,
connectionString:
{
Description: ConnectionString to connect to Mongo. ,
Required: False ,
}
string ,
}
,
collectionList:
{
Description: List of Mongo Collections to be migrated. ,
Required: False ,
}
[
{
sourceDatabase:
{
Description: Source database name. ,
Required: False ,
}
string ,
sourceCollection:
{
Description: Source collection name. ,
Required: False ,
}
string ,
targetDatabase:
{
Description: Target database name. ,
Required: False ,
}
string ,
targetCollection:
{
Description: Target collection name. ,
Required: False ,
}
string ,
migrationProgressDetails:
{
Description: Detailed migration status. Not included by default. ,
Required: False ,
}
{
migrationStatus:
{
Description: Migration Status ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
migrationError:
{
Description: Migration Error ,
Required: False ,
}
string ,
sourceDocumentCount:
{
Description: Source Document Count ,
Format: int64 ,
Required: False ,
}
integer ,
processedDocumentCount:
{
Description: Processed Document Count ,
Format: int64 ,
Required: False ,
}
integer ,
durationInSeconds:
{
Description: Migration duration ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Database Migration Resource properties for CosmosDb for Mongo. ,
Required: False ,
}
{
sourceMongoConnection:
{
Description: Source Mongo connection details. ,
Required: False ,
}
{
host:
{
Description: Host of mongo connection. ,
Required: False ,
}
string ,
port:
{
Description: Port of mongo connection. ,
Format: int32 ,
Required: False ,
}
integer ,
userName:
{
Description: User name to connect to Mongo. ,
Required: False ,
}
string ,
password:
{
Description: Password to connect to Mongo. ,
Format: password ,
Required: False ,
}
string ,
useSsl:
{
Description: Whether to UseSsl or UseTls to connect to Mongo. Default is true. ,
Required: False ,
}
boolean ,
connectionString:
{
Description: ConnectionString to connect to Mongo. ,
Required: False ,
}
string ,
}
,
targetMongoConnection:
{
Description: Target Cosmos DB Mongo connection details. ,
Required: False ,
}
{
host:
{
Description: Host of mongo connection. ,
Required: False ,
}
string ,
port:
{
Description: Port of mongo connection. ,
Format: int32 ,
Required: False ,
}
integer ,
userName:
{
Description: User name to connect to Mongo. ,
Required: False ,
}
string ,
password:
{
Description: Password to connect to Mongo. ,
Format: password ,
Required: False ,
}
string ,
useSsl:
{
Description: Whether to UseSsl or UseTls to connect to Mongo. Default is true. ,
Required: False ,
}
boolean ,
connectionString:
{
Description: ConnectionString to connect to Mongo. ,
Required: False ,
}
string ,
}
,
collectionList:
{
Description: List of Mongo Collections to be migrated. ,
Required: False ,
}
[
{
sourceDatabase:
{
Description: Source database name. ,
Required: False ,
}
string ,
sourceCollection:
{
Description: Source collection name. ,
Required: False ,
}
string ,
targetDatabase:
{
Description: Target database name. ,
Required: False ,
}
string ,
targetCollection:
{
Description: Target collection name. ,
Required: False ,
}
string ,
migrationProgressDetails:
{
Description: Detailed migration status. Not included by default. ,
Required: False ,
}
{
migrationStatus:
{
Description: Migration Status ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
migrationError:
{
Description: Migration Error ,
Required: False ,
}
string ,
sourceDocumentCount:
{
Description: Source Document Count ,
Format: int64 ,
Required: False ,
}
integer ,
processedDocumentCount:
{
Description: Processed Document Count ,
Format: int64 ,
Required: False ,
}
integer ,
durationInSeconds:
{
Description: Migration duration ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseMigrationsMongoToCosmosDbvCoreMongo_Delete (new)
Description :  Delete Database Migration resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{targetResourceName}/providers/Microsoft.DataMigration/databaseMigrations/{migrationName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
targetResourceName:
{
Description: The name of the target resource/account. ,
Required: True ,
}
string ,
migrationName:
{
Description: Name of the migration. ,
Required: True ,
}
string ,
force:
{
Description: Optional force delete boolean. If this is provided as true, migration will be deleted even if active. ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}
DatabaseMigrationsMongoToCosmosDbvCoreMongo_GetForScope (new)
Description :  Get Database Migration resources for the scope.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{targetResourceName}/providers/Microsoft.DataMigration/databaseMigrations
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
targetResourceName:
{
Description: The name of the target resource/account. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: Database Migration Resource properties for CosmosDb for Mongo. ,
Required: False ,
}
{
sourceMongoConnection:
{
Description: Source Mongo connection details. ,
Required: False ,
}
{
host:
{
Description: Host of mongo connection. ,
Required: False ,
}
string ,
port:
{
Description: Port of mongo connection. ,
Format: int32 ,
Required: False ,
}
integer ,
userName:
{
Description: User name to connect to Mongo. ,
Required: False ,
}
string ,
password:
{
Description: Password to connect to Mongo. ,
Format: password ,
Required: False ,
}
string ,
useSsl:
{
Description: Whether to UseSsl or UseTls to connect to Mongo. Default is true. ,
Required: False ,
}
boolean ,
connectionString:
{
Description: ConnectionString to connect to Mongo. ,
Required: False ,
}
string ,
}
,
targetMongoConnection:
{
Description: Target Cosmos DB Mongo connection details. ,
Required: False ,
}
{
host:
{
Description: Host of mongo connection. ,
Required: False ,
}
string ,
port:
{
Description: Port of mongo connection. ,
Format: int32 ,
Required: False ,
}
integer ,
userName:
{
Description: User name to connect to Mongo. ,
Required: False ,
}
string ,
password:
{
Description: Password to connect to Mongo. ,
Format: password ,
Required: False ,
}
string ,
useSsl:
{
Description: Whether to UseSsl or UseTls to connect to Mongo. Default is true. ,
Required: False ,
}
boolean ,
connectionString:
{
Description: ConnectionString to connect to Mongo. ,
Required: False ,
}
string ,
}
,
collectionList:
{
Description: List of Mongo Collections to be migrated. ,
Required: False ,
}
[
{
sourceDatabase:
{
Description: Source database name. ,
Required: False ,
}
string ,
sourceCollection:
{
Description: Source collection name. ,
Required: False ,
}
string ,
targetDatabase:
{
Description: Target database name. ,
Required: False ,
}
string ,
targetCollection:
{
Description: Target collection name. ,
Required: False ,
}
string ,
migrationProgressDetails:
{
Description: Detailed migration status. Not included by default. ,
Required: False ,
}
{
migrationStatus:
{
Description: Migration Status ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
migrationError:
{
Description: Migration Error ,
Required: False ,
}
string ,
sourceDocumentCount:
{
Description: Source Document Count ,
Format: int64 ,
Required: False ,
}
integer ,
processedDocumentCount:
{
Description: Processed Document Count ,
Format: int64 ,
Required: False ,
}
integer ,
durationInSeconds:
{
Description: Migration duration ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseMigrationsSqlDb_Get (new)
Description :  Retrieve the Database Migration resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{sqlDbInstanceName}/providers/Microsoft.DataMigration/databaseMigrations/{targetDbName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
sqlDbInstanceName:
{
Required: True ,
}
string ,
targetDbName:
{
Description: The name of the target database. ,
Required: True ,
}
string ,
migrationOperationId:
{
Description: Optional migration operation ID. If this is provided, then details of migration operation for that ID are retrieved. If not provided (default), then details related to most recent or current operation are retrieved. ,
Format: uuid ,
Required: False ,
}
string ,
$expand:
{
Description: Complete migration details be included in the response. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Database Migration Resource properties for SQL database. ,
Required: False ,
}
{
migrationStatusDetails:
{
Description: Detailed migration status. Not included by default. ,
Required: False ,
}
{
migrationState:
{
Description: Current State of Migration. ,
Required: False ,
}
string ,
sqlDataCopyErrors:
{
Description: Sql Data Copy errors, if any. ,
Required: False ,
}
[
string ,
]
,
listOfCopyProgressDetails:
{
Description: Details on progress of ADF copy activities. ,
Required: False ,
}
[
{
tableName:
{
Description: Table Name ,
Required: False ,
}
string ,
status:
{
Description: Status of the Copy activity (InProgress, Succeeded, Failed, Canceled). ,
Required: False ,
}
string ,
parallelCopyType:
{
Description: Type of parallel copy (Dynamic range, Physical partition, none). ,
Required: False ,
}
string ,
usedParallelCopies:
{
Description: The degree of parallelization. ,
Format: int32 ,
Required: False ,
}
integer ,
dataRead:
{
Description: Bytes read ,
Format: int64 ,
Required: False ,
}
integer ,
dataWritten:
{
Description: Bytes written ,
Format: int64 ,
Required: False ,
}
integer ,
rowsRead:
{
Description: Rows read ,
Format: int64 ,
Required: False ,
}
integer ,
rowsCopied:
{
Description: Rows Copied ,
Format: int64 ,
Required: False ,
}
integer ,
copyStart:
{
Description: Copy Start ,
Format: date-time ,
Required: False ,
}
string ,
copyThroughput:
{
Description: Copy throughput in KBps ,
Format: double ,
Required: False ,
}
number ,
copyDuration:
{
Description: Copy Duration in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
targetSqlConnection:
{
Description: Target SQL DB connection details. ,
Required: False ,
}
{
dataSource:
{
Description: Data source. ,
Required: False ,
}
string ,
authentication:
{
Description: Authentication type. ,
Required: False ,
}
string ,
userName:
{
Description: User name to connect to source SQL. ,
Required: False ,
}
string ,
password:
{
Description: Password to connect to source SQL. ,
Format: password ,
Required: False ,
}
string ,
encryptConnection:
{
Description: Whether to encrypt connection or not. ,
Required: False ,
}
boolean ,
trustServerCertificate:
{
Description: Whether to trust server certificate or not. ,
Required: False ,
}
boolean ,
}
,
offlineConfiguration:
{
Description: Offline configuration. ,
Required: False ,
}
{
offline:
{
Description: Offline migration ,
Required: False ,
}
boolean ,
}
,
tableList:
{
Description: List of tables to copy. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{}
DatabaseMigrationsSqlDb_CreateOrUpdate (new)
Description :  Create or Update Database Migration resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{sqlDbInstanceName}/providers/Microsoft.DataMigration/databaseMigrations/{targetDbName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
sqlDbInstanceName:
{
Required: True ,
}
string ,
targetDbName:
{
Description: The name of the target database. ,
Required: True ,
}
string ,
parameters:
{
Description: Details of Sql Db migration resource. ,
Required: True ,
}
{
properties:
{
Description: Database Migration Resource properties for SQL database. ,
Required: False ,
}
{
migrationStatusDetails:
{
Description: Detailed migration status. Not included by default. ,
Required: False ,
}
{
migrationState:
{
Description: Current State of Migration. ,
Required: False ,
}
string ,
sqlDataCopyErrors:
{
Description: Sql Data Copy errors, if any. ,
Required: False ,
}
[
string ,
]
,
listOfCopyProgressDetails:
{
Description: Details on progress of ADF copy activities. ,
Required: False ,
}
[
{
tableName:
{
Description: Table Name ,
Required: False ,
}
string ,
status:
{
Description: Status of the Copy activity (InProgress, Succeeded, Failed, Canceled). ,
Required: False ,
}
string ,
parallelCopyType:
{
Description: Type of parallel copy (Dynamic range, Physical partition, none). ,
Required: False ,
}
string ,
usedParallelCopies:
{
Description: The degree of parallelization. ,
Format: int32 ,
Required: False ,
}
integer ,
dataRead:
{
Description: Bytes read ,
Format: int64 ,
Required: False ,
}
integer ,
dataWritten:
{
Description: Bytes written ,
Format: int64 ,
Required: False ,
}
integer ,
rowsRead:
{
Description: Rows read ,
Format: int64 ,
Required: False ,
}
integer ,
rowsCopied:
{
Description: Rows Copied ,
Format: int64 ,
Required: False ,
}
integer ,
copyStart:
{
Description: Copy Start ,
Format: date-time ,
Required: False ,
}
string ,
copyThroughput:
{
Description: Copy throughput in KBps ,
Format: double ,
Required: False ,
}
number ,
copyDuration:
{
Description: Copy Duration in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
targetSqlConnection:
{
Description: Target SQL DB connection details. ,
Required: False ,
}
{
dataSource:
{
Description: Data source. ,
Required: False ,
}
string ,
authentication:
{
Description: Authentication type. ,
Required: False ,
}
string ,
userName:
{
Description: User name to connect to source SQL. ,
Required: False ,
}
string ,
password:
{
Description: Password to connect to source SQL. ,
Format: password ,
Required: False ,
}
string ,
encryptConnection:
{
Description: Whether to encrypt connection or not. ,
Required: False ,
}
boolean ,
trustServerCertificate:
{
Description: Whether to trust server certificate or not. ,
Required: False ,
}
boolean ,
}
,
offlineConfiguration:
{
Description: Offline configuration. ,
Required: False ,
}
{
offline:
{
Description: Offline migration ,
Required: False ,
}
boolean ,
}
,
tableList:
{
Description: List of tables to copy. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Database Migration Resource properties for SQL database. ,
Required: False ,
}
{
migrationStatusDetails:
{
Description: Detailed migration status. Not included by default. ,
Required: False ,
}
{
migrationState:
{
Description: Current State of Migration. ,
Required: False ,
}
string ,
sqlDataCopyErrors:
{
Description: Sql Data Copy errors, if any. ,
Required: False ,
}
[
string ,
]
,
listOfCopyProgressDetails:
{
Description: Details on progress of ADF copy activities. ,
Required: False ,
}
[
{
tableName:
{
Description: Table Name ,
Required: False ,
}
string ,
status:
{
Description: Status of the Copy activity (InProgress, Succeeded, Failed, Canceled). ,
Required: False ,
}
string ,
parallelCopyType:
{
Description: Type of parallel copy (Dynamic range, Physical partition, none). ,
Required: False ,
}
string ,
usedParallelCopies:
{
Description: The degree of parallelization. ,
Format: int32 ,
Required: False ,
}
integer ,
dataRead:
{
Description: Bytes read ,
Format: int64 ,
Required: False ,
}
integer ,
dataWritten:
{
Description: Bytes written ,
Format: int64 ,
Required: False ,
}
integer ,
rowsRead:
{
Description: Rows read ,
Format: int64 ,
Required: False ,
}
integer ,
rowsCopied:
{
Description: Rows Copied ,
Format: int64 ,
Required: False ,
}
integer ,
copyStart:
{
Description: Copy Start ,
Format: date-time ,
Required: False ,
}
string ,
copyThroughput:
{
Description: Copy throughput in KBps ,
Format: double ,
Required: False ,
}
number ,
copyDuration:
{
Description: Copy Duration in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
targetSqlConnection:
{
Description: Target SQL DB connection details. ,
Required: False ,
}
{
dataSource:
{
Description: Data source. ,
Required: False ,
}
string ,
authentication:
{
Description: Authentication type. ,
Required: False ,
}
string ,
userName:
{
Description: User name to connect to source SQL. ,
Required: False ,
}
string ,
password:
{
Description: Password to connect to source SQL. ,
Format: password ,
Required: False ,
}
string ,
encryptConnection:
{
Description: Whether to encrypt connection or not. ,
Required: False ,
}
boolean ,
trustServerCertificate:
{
Description: Whether to trust server certificate or not. ,
Required: False ,
}
boolean ,
}
,
offlineConfiguration:
{
Description: Offline configuration. ,
Required: False ,
}
{
offline:
{
Description: Offline migration ,
Required: False ,
}
boolean ,
}
,
tableList:
{
Description: List of tables to copy. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{}

⚐ Response (201)

{
properties:
{
Description: Database Migration Resource properties for SQL database. ,
Required: False ,
}
{
migrationStatusDetails:
{
Description: Detailed migration status. Not included by default. ,
Required: False ,
}
{
migrationState:
{
Description: Current State of Migration. ,
Required: False ,
}
string ,
sqlDataCopyErrors:
{
Description: Sql Data Copy errors, if any. ,
Required: False ,
}
[
string ,
]
,
listOfCopyProgressDetails:
{
Description: Details on progress of ADF copy activities. ,
Required: False ,
}
[
{
tableName:
{
Description: Table Name ,
Required: False ,
}
string ,
status:
{
Description: Status of the Copy activity (InProgress, Succeeded, Failed, Canceled). ,
Required: False ,
}
string ,
parallelCopyType:
{
Description: Type of parallel copy (Dynamic range, Physical partition, none). ,
Required: False ,
}
string ,
usedParallelCopies:
{
Description: The degree of parallelization. ,
Format: int32 ,
Required: False ,
}
integer ,
dataRead:
{
Description: Bytes read ,
Format: int64 ,
Required: False ,
}
integer ,
dataWritten:
{
Description: Bytes written ,
Format: int64 ,
Required: False ,
}
integer ,
rowsRead:
{
Description: Rows read ,
Format: int64 ,
Required: False ,
}
integer ,
rowsCopied:
{
Description: Rows Copied ,
Format: int64 ,
Required: False ,
}
integer ,
copyStart:
{
Description: Copy Start ,
Format: date-time ,
Required: False ,
}
string ,
copyThroughput:
{
Description: Copy throughput in KBps ,
Format: double ,
Required: False ,
}
number ,
copyDuration:
{
Description: Copy Duration in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
targetSqlConnection:
{
Description: Target SQL DB connection details. ,
Required: False ,
}
{
dataSource:
{
Description: Data source. ,
Required: False ,
}
string ,
authentication:
{
Description: Authentication type. ,
Required: False ,
}
string ,
userName:
{
Description: User name to connect to source SQL. ,
Required: False ,
}
string ,
password:
{
Description: Password to connect to source SQL. ,
Format: password ,
Required: False ,
}
string ,
encryptConnection:
{
Description: Whether to encrypt connection or not. ,
Required: False ,
}
boolean ,
trustServerCertificate:
{
Description: Whether to trust server certificate or not. ,
Required: False ,
}
boolean ,
}
,
offlineConfiguration:
{
Description: Offline configuration. ,
Required: False ,
}
{
offline:
{
Description: Offline migration ,
Required: False ,
}
boolean ,
}
,
tableList:
{
Description: List of tables to copy. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DatabaseMigrationsSqlDb_Delete (new)
Description :  Delete Database Migration resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{sqlDbInstanceName}/providers/Microsoft.DataMigration/databaseMigrations/{targetDbName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
sqlDbInstanceName:
{
Required: True ,
}
string ,
targetDbName:
{
Description: The name of the target database. ,
Required: True ,
}
string ,
force:
{
Description: Optional force delete boolean. If this is provided as true, migration will be deleted even if active. ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
DatabaseMigrationsSqlDb_cancel (new)
Description :  Stop on going migration for the database.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{sqlDbInstanceName}/providers/Microsoft.DataMigration/databaseMigrations/{targetDbName}/cancel
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
sqlDbInstanceName:
{
Required: True ,
}
string ,
targetDbName:
{
Description: The name of the target database. ,
Required: True ,
}
string ,
parameters:
{
Description: Required migration operation ID for which cancel will be initiated. ,
Required: True ,
}
{
migrationOperationId:
{
Description: ID tracking migration operation. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{}

⚐ Response (202)

{}
DatabaseMigrationsSqlMi_Get (new)
Description :  Retrieve the specified database migration for a given SQL Managed Instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/providers/Microsoft.DataMigration/databaseMigrations/{targetDbName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Required: True ,
}
string ,
targetDbName:
{
Description: The name of the target database. ,
Required: True ,
}
string ,
migrationOperationId:
{
Description: Optional migration operation ID. If this is provided, then details of migration operation for that ID are retrieved. If not provided (default), then details related to most recent or current operation are retrieved. ,
Format: uuid ,
Required: False ,
}
string ,
$expand:
{
Description: Complete migration details be included in the response. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Database Migration Resource properties for SQL Managed Instance. ,
Required: False ,
}
{
migrationStatusDetails:
{
Description: Detailed migration status. Not included by default. ,
Required: False ,
}
{
migrationState:
{
Description: Current State of Migration. ,
Required: False ,
}
string ,
fullBackupSetInfo:
{
Description: Details of full backup set. ,
Required: False ,
}
{
backupSetId:
{
Description: Backup set id. ,
Format: uuid ,
Required: False ,
}
string ,
firstLSN:
{
Description: First LSN of the backup set. ,
Required: False ,
}
string ,
lastLSN:
{
Description: Last LSN of the backup set. ,
Required: False ,
}
string ,
backupType:
{
Description: Backup type. ,
Required: False ,
}
string ,
listOfBackupFiles:
{
Description: List of files in the backup set. ,
Required: False ,
}
[
{
fileName:
{
Description: File name. ,
Required: False ,
}
string ,
status:
{
Description: Status of the file. (Initial, Uploading, Uploaded, Restoring, Restored or Skipped) ,
Required: False ,
}
string ,
totalSize:
{
Description: File size in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
dataRead:
{
Description: Bytes read ,
Format: int64 ,
Required: False ,
}
integer ,
dataWritten:
{
Description: Bytes written ,
Format: int64 ,
Required: False ,
}
integer ,
copyThroughput:
{
Description: Copy throughput in KBps ,
Format: double ,
Required: False ,
}
number ,
copyDuration:
{
Description: Copy Duration in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
familySequenceNumber:
{
Description: Media family sequence number ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
backupStartDate:
{
Description: Backup start date. ,
Format: date-time ,
Required: False ,
}
string ,
backupFinishDate:
{
Description: Backup end time. ,
Format: date-time ,
Required: False ,
}
string ,
isBackupRestored:
{
Description: Whether this backup set has been restored or not. ,
Required: False ,
}
boolean ,
hasBackupChecksums:
{
Description: Has Backup Checksums ,
Required: False ,
}
boolean ,
familyCount:
{
Description: Media family count ,
Format: int32 ,
Required: False ,
}
integer ,
ignoreReasons:
{
Description: The reasons why the backup set is ignored ,
Required: False ,
}
[
string ,
]
,
}
,
lastRestoredBackupSetInfo:
{
Description: Last applied backup set information. ,
Required: False ,
}
{
backupSetId:
{
Description: Backup set id. ,
Format: uuid ,
Required: False ,
}
string ,
firstLSN:
{
Description: First LSN of the backup set. ,
Required: False ,
}
string ,
lastLSN:
{
Description: Last LSN of the backup set. ,
Required: False ,
}
string ,
backupType:
{
Description: Backup type. ,
Required: False ,
}
string ,
listOfBackupFiles:
{
Description: List of files in the backup set. ,
Required: False ,
}
[
{
fileName:
{
Description: File name. ,
Required: False ,
}
string ,
status:
{
Description: Status of the file. (Initial, Uploading, Uploaded, Restoring, Restored or Skipped) ,
Required: False ,
}
string ,
totalSize:
{
Description: File size in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
dataRead:
{
Description: Bytes read ,
Format: int64 ,
Required: False ,
}
integer ,
dataWritten:
{
Description: Bytes written ,
Format: int64 ,
Required: False ,
}
integer ,
copyThroughput:
{
Description: Copy throughput in KBps ,
Format: double ,
Required: False ,
}
number ,
copyDuration:
{
Description: Copy Duration in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
familySequenceNumber:
{
Description: Media family sequence number ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
backupStartDate:
{
Description: Backup start date. ,
Format: date-time ,
Required: False ,
}
string ,
backupFinishDate:
{
Description: Backup end time. ,
Format: date-time ,
Required: False ,
}
string ,
isBackupRestored:
{
Description: Whether this backup set has been restored or not. ,
Required: False ,
}
boolean ,
hasBackupChecksums:
{
Description: Has Backup Checksums ,
Required: False ,
}
boolean ,
familyCount:
{
Description: Media family count ,
Format: int32 ,
Required: False ,
}
integer ,
ignoreReasons:
{
Description: The reasons why the backup set is ignored ,
Required: False ,
}
[
string ,
]
,
}
,
activeBackupSets:
{
Description: Backup sets that are currently active. ,
Required: False ,
}
[
{
backupSetId:
{
Description: Backup set id. ,
Format: uuid ,
Required: False ,
}
string ,
firstLSN:
{
Description: First LSN of the backup set. ,
Required: False ,
}
string ,
lastLSN:
{
Description: Last LSN of the backup set. ,
Required: False ,
}
string ,
backupType:
{
Description: Backup type. ,
Required: False ,
}
string ,
listOfBackupFiles:
{
Description: List of files in the backup set. ,
Required: False ,
}
[
{
fileName:
{
Description: File name. ,
Required: False ,
}
string ,
status:
{
Description: Status of the file. (Initial, Uploading, Uploaded, Restoring, Restored or Skipped) ,
Required: False ,
}
string ,
totalSize:
{
Description: File size in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
dataRead:
{
Description: Bytes read ,
Format: int64 ,
Required: False ,
}
integer ,
dataWritten:
{
Description: Bytes written ,
Format: int64 ,
Required: False ,
}
integer ,
copyThroughput:
{
Description: Copy throughput in KBps ,
Format: double ,
Required: False ,
}
number ,
copyDuration:
{
Description: Copy Duration in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
familySequenceNumber:
{
Description: Media family sequence number ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
backupStartDate:
{
Description: Backup start date. ,
Format: date-time ,
Required: False ,
}
string ,
backupFinishDate:
{
Description: Backup end time. ,
Format: date-time ,
Required: False ,
}
string ,
isBackupRestored:
{
Description: Whether this backup set has been restored or not. ,
Required: False ,
}
boolean ,
hasBackupChecksums:
{
Description: Has Backup Checksums ,
Required: False ,
}
boolean ,
familyCount:
{
Description: Media family count ,
Format: int32 ,
Required: False ,
}
integer ,
ignoreReasons:
{
Description: The reasons why the backup set is ignored ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
invalidFiles:
{
Description: Files that are not valid backup files. ,
Required: False ,
}
[
string ,
]
,
blobContainerName:
{
Description: Name of blob container. ,
Required: False ,
}
string ,
isFullBackupRestored:
{
Description: Whether full backup has been applied to the target database or not. ,
Required: False ,
}
boolean ,
restoreBlockingReason:
{
Description: Restore blocking reason, if any ,
Required: False ,
}
string ,
completeRestoreErrorMessage:
{
Description: Complete restore error message, if any ,
Required: False ,
}
string ,
fileUploadBlockingErrors:
{
Description: File upload blocking errors, if any. ,
Required: False ,
}
[
string ,
]
,
currentRestoringFilename:
{
Description: File name that is currently being restored. ,
Required: False ,
}
string ,
lastRestoredFilename:
{
Description: Last restored file name. ,
Required: False ,
}
string ,
pendingLogBackupsCount:
{
Description: Total pending log backups. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
backupConfiguration:
{
Description: Backup configuration info. ,
Required: False ,
}
{
sourceLocation:
{
Description: Source location of backups. ,
Required: False ,
}
{
fileShare:
{
Description: Source File share. ,
Required: False ,
}
{
path:
{
Description: Location as SMB share or local drive where backups are placed. ,
Required: False ,
}
string ,
username:
{
Description: Username to access the file share location for backups. ,
Required: False ,
}
string ,
password:
{
Description: Password for username to access file share location. ,
Format: password ,
Required: False ,
}
string ,
}
,
azureBlob:
{
Description: Source Azure Blob. ,
Required: False ,
}
{
authType:
{
Description: Authentication type used for accessing Azure Blob Storage. ,
Enum:
{
AccountKey: Use an account key for authentication. ,
ManagedIdentity: Use a managed identity for authentication. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Identity details for authentication using a Managed Identity. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
storageAccountResourceId:
{
Description: Resource Id of the storage account where backups are stored. ,
Required: False ,
}
string ,
accountKey:
{
Description: Storage Account Key. ,
Required: False ,
}
string ,
blobContainerName:
{
Description: Blob container name where backups are stored. ,
Required: False ,
}
string ,
}
,
fileStorageType:
{
Description: Backup storage Type. ,
Required: False ,
}
string ,
}
,
targetLocation:
{
Description: Target location for copying backups. ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: Resource Id of the storage account copying backups. ,
Required: False ,
}
string ,
accountKey:
{
Description: Storage Account Key. ,
Required: False ,
}
string ,
}
,
}
,
offlineConfiguration:
{
Description: Offline configuration. ,
Required: False ,
}
{
offline:
{
Description: Offline migration ,
Required: False ,
}
boolean ,
lastBackupName:
{
Description: Last backup name for offline migration. This is optional for migrations from file share. If it is not provided, then the service will determine the last backup file name based on latest backup files present in file share. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{}
DatabaseMigrationsSqlMi_CreateOrUpdate (new)
Description :  Create a new database migration to a given SQL Managed Instance.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/providers/Microsoft.DataMigration/databaseMigrations/{targetDbName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Required: True ,
}
string ,
targetDbName:
{
Description: The name of the target database. ,
Required: True ,
}
string ,
parameters:
{
Description: Details of SqlMigrationService resource. ,
Required: True ,
}
{
properties:
{
Description: Database Migration Resource properties for SQL Managed Instance. ,
Required: False ,
}
{
migrationStatusDetails:
{
Description: Detailed migration status. Not included by default. ,
Required: False ,
}
{
migrationState:
{
Description: Current State of Migration. ,
Required: False ,
}
string ,
fullBackupSetInfo:
{
Description: Details of full backup set. ,
Required: False ,
}
{
backupSetId:
{
Description: Backup set id. ,
Format: uuid ,
Required: False ,
}
string ,
firstLSN:
{
Description: First LSN of the backup set. ,
Required: False ,
}
string ,
lastLSN:
{
Description: Last LSN of the backup set. ,
Required: False ,
}
string ,
backupType:
{
Description: Backup type. ,
Required: False ,
}
string ,
listOfBackupFiles:
{
Description: List of files in the backup set. ,
Required: False ,
}
[
{
fileName:
{
Description: File name. ,
Required: False ,
}
string ,
status:
{
Description: Status of the file. (Initial, Uploading, Uploaded, Restoring, Restored or Skipped) ,
Required: False ,
}
string ,
totalSize:
{
Description: File size in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
dataRead:
{
Description: Bytes read ,
Format: int64 ,
Required: False ,
}
integer ,
dataWritten:
{
Description: Bytes written ,
Format: int64 ,
Required: False ,
}
integer ,
copyThroughput:
{
Description: Copy throughput in KBps ,
Format: double ,
Required: False ,
}
number ,
copyDuration:
{
Description: Copy Duration in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
familySequenceNumber:
{
Description: Media family sequence number ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
backupStartDate:
{
Description: Backup start date. ,
Format: date-time ,
Required: False ,
}
string ,
backupFinishDate:
{
Description: Backup end time. ,
Format: date-time ,
Required: False ,
}
string ,
isBackupRestored:
{
Description: Whether this backup set has been restored or not. ,
Required: False ,
}
boolean ,
hasBackupChecksums:
{
Description: Has Backup Checksums ,
Required: False ,
}
boolean ,
familyCount:
{
Description: Media family count ,
Format: int32 ,
Required: False ,
}
integer ,
ignoreReasons:
{
Description: The reasons why the backup set is ignored ,
Required: False ,
}
[
string ,
]
,
}
,
lastRestoredBackupSetInfo:
{
Description: Last applied backup set information. ,
Required: False ,
}
{
backupSetId:
{
Description: Backup set id. ,
Format: uuid ,
Required: False ,
}
string ,
firstLSN:
{
Description: First LSN of the backup set. ,
Required: False ,
}
string ,
lastLSN:
{
Description: Last LSN of the backup set. ,
Required: False ,
}
string ,
backupType:
{
Description: Backup type. ,
Required: False ,
}
string ,
listOfBackupFiles:
{
Description: List of files in the backup set. ,
Required: False ,
}
[
{
fileName:
{
Description: File name. ,
Required: False ,
}
string ,
status:
{
Description: Status of the file. (Initial, Uploading, Uploaded, Restoring, Restored or Skipped) ,
Required: False ,
}
string ,
totalSize:
{
Description: File size in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
dataRead:
{
Description: Bytes read ,
Format: int64 ,
Required: False ,
}
integer ,
dataWritten:
{
Description: Bytes written ,
Format: int64 ,
Required: False ,
}
integer ,
copyThroughput:
{
Description: Copy throughput in KBps ,
Format: double ,
Required: False ,
}
number ,
copyDuration:
{
Description: Copy Duration in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
familySequenceNumber:
{
Description: Media family sequence number ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
backupStartDate:
{
Description: Backup start date. ,
Format: date-time ,
Required: False ,
}
string ,
backupFinishDate:
{
Description: Backup end time. ,
Format: date-time ,
Required: False ,
}
string ,
isBackupRestored:
{
Description: Whether this backup set has been restored or not. ,
Required: False ,
}
boolean ,
hasBackupChecksums:
{
Description: Has Backup Checksums ,
Required: False ,
}
boolean ,
familyCount:
{
Description: Media family count ,
Format: int32 ,
Required: False ,
}
integer ,
ignoreReasons:
{
Description: The reasons why the backup set is ignored ,
Required: False ,
}
[
string ,
]
,
}
,
activeBackupSets:
{
Description: Backup sets that are currently active. ,
Required: False ,
}
[
{
backupSetId:
{
Description: Backup set id. ,
Format: uuid ,
Required: False ,
}
string ,
firstLSN:
{
Description: First LSN of the backup set. ,
Required: False ,
}
string ,
lastLSN:
{
Description: Last LSN of the backup set. ,
Required: False ,
}
string ,
backupType:
{
Description: Backup type. ,
Required: False ,
}
string ,
listOfBackupFiles:
{
Description: List of files in the backup set. ,
Required: False ,
}
[
{
fileName:
{
Description: File name. ,
Required: False ,
}
string ,
status:
{
Description: Status of the file. (Initial, Uploading, Uploaded, Restoring, Restored or Skipped) ,
Required: False ,
}
string ,
totalSize:
{
Description: File size in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
dataRead:
{
Description: Bytes read ,
Format: int64 ,
Required: False ,
}
integer ,
dataWritten:
{
Description: Bytes written ,
Format: int64 ,
Required: False ,
}
integer ,
copyThroughput:
{
Description: Copy throughput in KBps ,
Format: double ,
Required: False ,
}
number ,
copyDuration:
{
Description: Copy Duration in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
familySequenceNumber:
{
Description: Media family sequence number ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
backupStartDate:
{
Description: Backup start date. ,
Format: date-time ,
Required: False ,
}
string ,
backupFinishDate:
{
Description: Backup end time. ,
Format: date-time ,
Required: False ,
}
string ,
isBackupRestored:
{
Description: Whether this backup set has been restored or not. ,
Required: False ,
}
boolean ,
hasBackupChecksums:
{
Description: Has Backup Checksums ,
Required: False ,
}
boolean ,
familyCount:
{
Description: Media family count ,
Format: int32 ,
Required: False ,
}
integer ,
ignoreReasons:
{
Description: The reasons why the backup set is ignored ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
invalidFiles:
{
Description: Files that are not valid backup files. ,
Required: False ,
}
[
string ,
]
,
blobContainerName:
{
Description: Name of blob container. ,
Required: False ,
}
string ,
isFullBackupRestored:
{
Description: Whether full backup has been applied to the target database or not. ,
Required: False ,
}
boolean ,
restoreBlockingReason:
{
Description: Restore blocking reason, if any ,
Required: False ,
}
string ,
completeRestoreErrorMessage:
{
Description: Complete restore error message, if any ,
Required: False ,
}
string ,
fileUploadBlockingErrors:
{
Description: File upload blocking errors, if any. ,
Required: False ,
}
[
string ,
]
,
currentRestoringFilename:
{
Description: File name that is currently being restored. ,
Required: False ,
}
string ,
lastRestoredFilename:
{
Description: Last restored file name. ,
Required: False ,
}
string ,
pendingLogBackupsCount:
{
Description: Total pending log backups. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
backupConfiguration:
{
Description: Backup configuration info. ,
Required: False ,
}
{
sourceLocation:
{
Description: Source location of backups. ,
Required: False ,
}
{
fileShare:
{
Description: Source File share. ,
Required: False ,
}
{
path:
{
Description: Location as SMB share or local drive where backups are placed. ,
Required: False ,
}
string ,
username:
{
Description: Username to access the file share location for backups. ,
Required: False ,
}
string ,
password:
{
Description: Password for username to access file share location. ,
Format: password ,
Required: False ,
}
string ,
}
,
azureBlob:
{
Description: Source Azure Blob. ,
Required: False ,
}
{
authType:
{
Description: Authentication type used for accessing Azure Blob Storage. ,
Enum:
{
AccountKey: Use an account key for authentication. ,
ManagedIdentity: Use a managed identity for authentication. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Identity details for authentication using a Managed Identity. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
storageAccountResourceId:
{
Description: Resource Id of the storage account where backups are stored. ,
Required: False ,
}
string ,
accountKey:
{
Description: Storage Account Key. ,
Required: False ,
}
string ,
blobContainerName:
{
Description: Blob container name where backups are stored. ,
Required: False ,
}
string ,
}
,
fileStorageType:
{
Description: Backup storage Type. ,
Required: False ,
}
string ,
}
,
targetLocation:
{
Description: Target location for copying backups. ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: Resource Id of the storage account copying backups. ,
Required: False ,
}
string ,
accountKey:
{
Description: Storage Account Key. ,
Required: False ,
}
string ,
}
,
}
,
offlineConfiguration:
{
Description: Offline configuration. ,
Required: False ,
}
{
offline:
{
Description: Offline migration ,
Required: False ,
}
boolean ,
lastBackupName:
{
Description: Last backup name for offline migration. This is optional for migrations from file share. If it is not provided, then the service will determine the last backup file name based on latest backup files present in file share. ,
Required: False ,
}
string ,
}
,
}
,
}
,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Database Migration Resource properties for SQL Managed Instance. ,
Required: False ,
}
{
migrationStatusDetails:
{
Description: Detailed migration status. Not included by default. ,
Required: False ,
}
{
migrationState:
{
Description: Current State of Migration. ,
Required: False ,
}
string ,
fullBackupSetInfo:
{
Description: Details of full backup set. ,
Required: False ,
}
{
backupSetId:
{
Description: Backup set id. ,
Format: uuid ,
Required: False ,
}
string ,
firstLSN:
{
Description: First LSN of the backup set. ,
Required: False ,
}
string ,
lastLSN:
{
Description: Last LSN of the backup set. ,
Required: False ,
}
string ,
backupType:
{
Description: Backup type. ,
Required: False ,
}
string ,
listOfBackupFiles:
{
Description: List of files in the backup set. ,
Required: False ,
}
[
{
fileName:
{
Description: File name. ,
Required: False ,
}
string ,
status:
{
Description: Status of the file. (Initial, Uploading, Uploaded, Restoring, Restored or Skipped) ,
Required: False ,
}
string ,
totalSize:
{
Description: File size in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
dataRead:
{
Description: Bytes read ,
Format: int64 ,
Required: False ,
}
integer ,
dataWritten:
{
Description: Bytes written ,
Format: int64 ,
Required: False ,
}
integer ,
copyThroughput:
{
Description: Copy throughput in KBps ,
Format: double ,
Required: False ,
}
number ,
copyDuration:
{
Description: Copy Duration in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
familySequenceNumber:
{
Description: Media family sequence number ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
backupStartDate:
{
Description: Backup start date. ,
Format: date-time ,
Required: False ,
}
string ,
backupFinishDate:
{
Description: Backup end time. ,
Format: date-time ,
Required: False ,
}
string ,
isBackupRestored:
{
Description: Whether this backup set has been restored or not. ,
Required: False ,
}
boolean ,
hasBackupChecksums:
{
Description: Has Backup Checksums ,
Required: False ,
}
boolean ,
familyCount:
{
Description: Media family count ,
Format: int32 ,
Required: False ,
}
integer ,
ignoreReasons:
{
Description: The reasons why the backup set is ignored ,
Required: False ,
}
[
string ,
]
,
}
,
lastRestoredBackupSetInfo:
{
Description: Last applied backup set information. ,
Required: False ,
}
{
backupSetId:
{
Description: Backup set id. ,
Format: uuid ,
Required: False ,
}
string ,
firstLSN:
{
Description: First LSN of the backup set. ,
Required: False ,
}
string ,
lastLSN:
{
Description: Last LSN of the backup set. ,
Required: False ,
}
string ,
backupType:
{
Description: Backup type. ,
Required: False ,
}
string ,
listOfBackupFiles:
{
Description: List of files in the backup set. ,
Required: False ,
}
[
{
fileName:
{
Description: File name. ,
Required: False ,
}
string ,
status:
{
Description: Status of the file. (Initial, Uploading, Uploaded, Restoring, Restored or Skipped) ,
Required: False ,
}
string ,
totalSize:
{
Description: File size in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
dataRead:
{
Description: Bytes read ,
Format: int64 ,
Required: False ,
}
integer ,
dataWritten:
{
Description: Bytes written ,
Format: int64 ,
Required: False ,
}
integer ,
copyThroughput:
{
Description: Copy throughput in KBps ,
Format: double ,
Required: False ,
}
number ,
copyDuration:
{
Description: Copy Duration in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
familySequenceNumber:
{
Description: Media family sequence number ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
backupStartDate:
{
Description: Backup start date. ,
Format: date-time ,
Required: False ,
}
string ,
backupFinishDate:
{
Description: Backup end time. ,
Format: date-time ,
Required: False ,
}
string ,
isBackupRestored:
{
Description: Whether this backup set has been restored or not. ,
Required: False ,
}
boolean ,
hasBackupChecksums:
{
Description: Has Backup Checksums ,
Required: False ,
}
boolean ,
familyCount:
{
Description: Media family count ,
Format: int32 ,
Required: False ,
}
integer ,
ignoreReasons:
{
Description: The reasons why the backup set is ignored ,
Required: False ,
}
[
string ,
]
,
}
,
activeBackupSets:
{
Description: Backup sets that are currently active. ,
Required: False ,
}
[
{
backupSetId:
{
Description: Backup set id. ,
Format: uuid ,
Required: False ,
}
string ,
firstLSN:
{
Description: First LSN of the backup set. ,
Required: False ,
}
string ,
lastLSN:
{
Description: Last LSN of the backup set. ,
Required: False ,
}
string ,
backupType:
{
Description: Backup type. ,
Required: False ,
}
string ,
listOfBackupFiles:
{
Description: List of files in the backup set. ,
Required: False ,
}
[
{
fileName:
{
Description: File name. ,
Required: False ,
}
string ,
status:
{
Description: Status of the file. (Initial, Uploading, Uploaded, Restoring, Restored or Skipped) ,
Required: False ,
}
string ,
totalSize:
{
Description: File size in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
dataRead:
{
Description: Bytes read ,
Format: int64 ,
Required: False ,
}
integer ,
dataWritten:
{
Description: Bytes written ,
Format: int64 ,
Required: False ,
}
integer ,
copyThroughput:
{
Description: Copy throughput in KBps ,
Format: double ,
Required: False ,
}
number ,
copyDuration:
{
Description: Copy Duration in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
familySequenceNumber:
{
Description: Media family sequence number ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
backupStartDate:
{
Description: Backup start date. ,
Format: date-time ,
Required: False ,
}
string ,
backupFinishDate:
{
Description: Backup end time. ,
Format: date-time ,
Required: False ,
}
string ,
isBackupRestored:
{
Description: Whether this backup set has been restored or not. ,
Required: False ,
}
boolean ,
hasBackupChecksums:
{
Description: Has Backup Checksums ,
Required: False ,
}
boolean ,
familyCount:
{
Description: Media family count ,
Format: int32 ,
Required: False ,
}
integer ,
ignoreReasons:
{
Description: The reasons why the backup set is ignored ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
invalidFiles:
{
Description: Files that are not valid backup files. ,
Required: False ,
}
[
string ,
]
,
blobContainerName:
{
Description: Name of blob container. ,
Required: False ,
}
string ,
isFullBackupRestored:
{
Description: Whether full backup has been applied to the target database or not. ,
Required: False ,
}
boolean ,
restoreBlockingReason:
{
Description: Restore blocking reason, if any ,
Required: False ,
}
string ,
completeRestoreErrorMessage:
{
Description: Complete restore error message, if any ,
Required: False ,
}
string ,
fileUploadBlockingErrors:
{
Description: File upload blocking errors, if any. ,
Required: False ,
}
[
string ,
]
,
currentRestoringFilename:
{
Description: File name that is currently being restored. ,
Required: False ,
}
string ,
lastRestoredFilename:
{
Description: Last restored file name. ,
Required: False ,
}
string ,
pendingLogBackupsCount:
{
Description: Total pending log backups. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
backupConfiguration:
{
Description: Backup configuration info. ,
Required: False ,
}
{
sourceLocation:
{
Description: Source location of backups. ,
Required: False ,
}
{
fileShare:
{
Description: Source File share. ,
Required: False ,
}
{
path:
{
Description: Location as SMB share or local drive where backups are placed. ,
Required: False ,
}
string ,
username:
{
Description: Username to access the file share location for backups. ,
Required: False ,
}
string ,
password:
{
Description: Password for username to access file share location. ,
Format: password ,
Required: False ,
}
string ,
}
,
azureBlob:
{
Description: Source Azure Blob. ,
Required: False ,
}
{
authType:
{
Description: Authentication type used for accessing Azure Blob Storage. ,
Enum:
{
AccountKey: Use an account key for authentication. ,
ManagedIdentity: Use a managed identity for authentication. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Identity details for authentication using a Managed Identity. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
storageAccountResourceId:
{
Description: Resource Id of the storage account where backups are stored. ,
Required: False ,
}
string ,
accountKey:
{
Description: Storage Account Key. ,
Required: False ,
}
string ,
blobContainerName:
{
Description: Blob container name where backups are stored. ,
Required: False ,
}
string ,
}
,
fileStorageType:
{
Description: Backup storage Type. ,
Required: False ,
}
string ,
}
,
targetLocation:
{
Description: Target location for copying backups. ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: Resource Id of the storage account copying backups. ,
Required: False ,
}
string ,
accountKey:
{
Description: Storage Account Key. ,
Required: False ,
}
string ,
}
,
}
,
offlineConfiguration:
{
Description: Offline configuration. ,
Required: False ,
}
{
offline:
{
Description: Offline migration ,
Required: False ,
}
boolean ,
lastBackupName:
{
Description: Last backup name for offline migration. This is optional for migrations from file share. If it is not provided, then the service will determine the last backup file name based on latest backup files present in file share. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{}

⚐ Response (201)

{
properties:
{
Description: Database Migration Resource properties for SQL Managed Instance. ,
Required: False ,
}
{
migrationStatusDetails:
{
Description: Detailed migration status. Not included by default. ,
Required: False ,
}
{
migrationState:
{
Description: Current State of Migration. ,
Required: False ,
}
string ,
fullBackupSetInfo:
{
Description: Details of full backup set. ,
Required: False ,
}
{
backupSetId:
{
Description: Backup set id. ,
Format: uuid ,
Required: False ,
}
string ,
firstLSN:
{
Description: First LSN of the backup set. ,
Required: False ,
}
string ,
lastLSN:
{
Description: Last LSN of the backup set. ,
Required: False ,
}
string ,
backupType:
{
Description: Backup type. ,
Required: False ,
}
string ,
listOfBackupFiles:
{
Description: List of files in the backup set. ,
Required: False ,
}
[
{
fileName:
{
Description: File name. ,
Required: False ,
}
string ,
status:
{
Description: Status of the file. (Initial, Uploading, Uploaded, Restoring, Restored or Skipped) ,
Required: False ,
}
string ,
totalSize:
{
Description: File size in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
dataRead:
{
Description: Bytes read ,
Format: int64 ,
Required: False ,
}
integer ,
dataWritten:
{
Description: Bytes written ,
Format: int64 ,
Required: False ,
}
integer ,
copyThroughput:
{
Description: Copy throughput in KBps ,
Format: double ,
Required: False ,
}
number ,
copyDuration:
{
Description: Copy Duration in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
familySequenceNumber:
{
Description: Media family sequence number ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
backupStartDate:
{
Description: Backup start date. ,
Format: date-time ,
Required: False ,
}
string ,
backupFinishDate:
{
Description: Backup end time. ,
Format: date-time ,
Required: False ,
}
string ,
isBackupRestored:
{
Description: Whether this backup set has been restored or not. ,
Required: False ,
}
boolean ,
hasBackupChecksums:
{
Description: Has Backup Checksums ,
Required: False ,
}
boolean ,
familyCount:
{
Description: Media family count ,
Format: int32 ,
Required: False ,
}
integer ,
ignoreReasons:
{
Description: The reasons why the backup set is ignored ,
Required: False ,
}
[
string ,
]
,
}
,
lastRestoredBackupSetInfo:
{
Description: Last applied backup set information. ,
Required: False ,
}
{
backupSetId:
{
Description: Backup set id. ,
Format: uuid ,
Required: False ,
}
string ,
firstLSN:
{
Description: First LSN of the backup set. ,
Required: False ,
}
string ,
lastLSN:
{
Description: Last LSN of the backup set. ,
Required: False ,
}
string ,
backupType:
{
Description: Backup type. ,
Required: False ,
}
string ,
listOfBackupFiles:
{
Description: List of files in the backup set. ,
Required: False ,
}
[
{
fileName:
{
Description: File name. ,
Required: False ,
}
string ,
status:
{
Description: Status of the file. (Initial, Uploading, Uploaded, Restoring, Restored or Skipped) ,
Required: False ,
}
string ,
totalSize:
{
Description: File size in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
dataRead:
{
Description: Bytes read ,
Format: int64 ,
Required: False ,
}
integer ,
dataWritten:
{
Description: Bytes written ,
Format: int64 ,
Required: False ,
}
integer ,
copyThroughput:
{
Description: Copy throughput in KBps ,
Format: double ,
Required: False ,
}
number ,
copyDuration:
{
Description: Copy Duration in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
familySequenceNumber:
{
Description: Media family sequence number ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
backupStartDate:
{
Description: Backup start date. ,
Format: date-time ,
Required: False ,
}
string ,
backupFinishDate:
{
Description: Backup end time. ,
Format: date-time ,
Required: False ,
}
string ,
isBackupRestored:
{
Description: Whether this backup set has been restored or not. ,
Required: False ,
}
boolean ,
hasBackupChecksums:
{
Description: Has Backup Checksums ,
Required: False ,
}
boolean ,
familyCount:
{
Description: Media family count ,
Format: int32 ,
Required: False ,
}
integer ,
ignoreReasons:
{
Description: The reasons why the backup set is ignored ,
Required: False ,
}
[
string ,
]
,
}
,
activeBackupSets:
{
Description: Backup sets that are currently active. ,
Required: False ,
}
[
{
backupSetId:
{
Description: Backup set id. ,
Format: uuid ,
Required: False ,
}
string ,
firstLSN:
{
Description: First LSN of the backup set. ,
Required: False ,
}
string ,
lastLSN:
{
Description: Last LSN of the backup set. ,
Required: False ,
}
string ,
backupType:
{
Description: Backup type. ,
Required: False ,
}
string ,
listOfBackupFiles:
{
Description: List of files in the backup set. ,
Required: False ,
}
[
{
fileName:
{
Description: File name. ,
Required: False ,
}
string ,
status:
{
Description: Status of the file. (Initial, Uploading, Uploaded, Restoring, Restored or Skipped) ,
Required: False ,
}
string ,
totalSize:
{
Description: File size in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
dataRead:
{
Description: Bytes read ,
Format: int64 ,
Required: False ,
}
integer ,
dataWritten:
{
Description: Bytes written ,
Format: int64 ,
Required: False ,
}
integer ,
copyThroughput:
{
Description: Copy throughput in KBps ,
Format: double ,
Required: False ,
}
number ,
copyDuration:
{
Description: Copy Duration in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
familySequenceNumber:
{
Description: Media family sequence number ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
backupStartDate:
{
Description: Backup start date. ,
Format: date-time ,
Required: False ,
}
string ,
backupFinishDate:
{
Description: Backup end time. ,
Format: date-time ,
Required: False ,
}
string ,
isBackupRestored:
{
Description: Whether this backup set has been restored or not. ,
Required: False ,
}
boolean ,
hasBackupChecksums:
{
Description: Has Backup Checksums ,
Required: False ,
}
boolean ,
familyCount:
{
Description: Media family count ,
Format: int32 ,
Required: False ,
}
integer ,
ignoreReasons:
{
Description: The reasons why the backup set is ignored ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
invalidFiles:
{
Description: Files that are not valid backup files. ,
Required: False ,
}
[
string ,
]
,
blobContainerName:
{
Description: Name of blob container. ,
Required: False ,
}
string ,
isFullBackupRestored:
{
Description: Whether full backup has been applied to the target database or not. ,
Required: False ,
}
boolean ,
restoreBlockingReason:
{
Description: Restore blocking reason, if any ,
Required: False ,
}
string ,
completeRestoreErrorMessage:
{
Description: Complete restore error message, if any ,
Required: False ,
}
string ,
fileUploadBlockingErrors:
{
Description: File upload blocking errors, if any. ,
Required: False ,
}
[
string ,
]
,
currentRestoringFilename:
{
Description: File name that is currently being restored. ,
Required: False ,
}
string ,
lastRestoredFilename:
{
Description: Last restored file name. ,
Required: False ,
}
string ,
pendingLogBackupsCount:
{
Description: Total pending log backups. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
backupConfiguration:
{
Description: Backup configuration info. ,
Required: False ,
}
{
sourceLocation:
{
Description: Source location of backups. ,
Required: False ,
}
{
fileShare:
{
Description: Source File share. ,
Required: False ,
}
{
path:
{
Description: Location as SMB share or local drive where backups are placed. ,
Required: False ,
}
string ,
username:
{
Description: Username to access the file share location for backups. ,
Required: False ,
}
string ,
password:
{
Description: Password for username to access file share location. ,
Format: password ,
Required: False ,
}
string ,
}
,
azureBlob:
{
Description: Source Azure Blob. ,
Required: False ,
}
{
authType:
{
Description: Authentication type used for accessing Azure Blob Storage. ,
Enum:
{
AccountKey: Use an account key for authentication. ,
ManagedIdentity: Use a managed identity for authentication. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Identity details for authentication using a Managed Identity. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
storageAccountResourceId:
{
Description: Resource Id of the storage account where backups are stored. ,
Required: False ,
}
string ,
accountKey:
{
Description: Storage Account Key. ,
Required: False ,
}
string ,
blobContainerName:
{
Description: Blob container name where backups are stored. ,
Required: False ,
}
string ,
}
,
fileStorageType:
{
Description: Backup storage Type. ,
Required: False ,
}
string ,
}
,
targetLocation:
{
Description: Target location for copying backups. ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: Resource Id of the storage account copying backups. ,
Required: False ,
}
string ,
accountKey:
{
Description: Storage Account Key. ,
Required: False ,
}
string ,
}
,
}
,
offlineConfiguration:
{
Description: Offline configuration. ,
Required: False ,
}
{
offline:
{
Description: Offline migration ,
Required: False ,
}
boolean ,
lastBackupName:
{
Description: Last backup name for offline migration. This is optional for migrations from file share. If it is not provided, then the service will determine the last backup file name based on latest backup files present in file share. ,
Required: False ,
}
string ,
}
,
}
,
}
DatabaseMigrationsSqlMi_cancel (new)
Description :  Stop in-progress database migration to SQL Managed Instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/providers/Microsoft.DataMigration/databaseMigrations/{targetDbName}/cancel
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Required: True ,
}
string ,
targetDbName:
{
Description: The name of the target database. ,
Required: True ,
}
string ,
parameters:
{
Description: Required migration operation ID for which cancel will be initiated. ,
Required: True ,
}
{
migrationOperationId:
{
Description: ID tracking migration operation. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{}

⚐ Response (202)

{}
DatabaseMigrationsSqlMi_cutover (new)
Description :  Initiate cutover for in-progress online database migration to SQL Managed Instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/providers/Microsoft.DataMigration/databaseMigrations/{targetDbName}/cutover
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Required: True ,
}
string ,
targetDbName:
{
Description: The name of the target database. ,
Required: True ,
}
string ,
parameters:
{
Description: Required migration operation ID for which cutover will be initiated. ,
Required: True ,
}
{
migrationOperationId:
{
Description: ID tracking migration operation. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{}

⚐ Response (202)

{}
DatabaseMigrationsSqlVm_Get (new)
Description :  Retrieve the specified database migration for a given SQL VM.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}/providers/Microsoft.DataMigration/databaseMigrations/{targetDbName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
sqlVirtualMachineName:
{
Required: True ,
}
string ,
targetDbName:
{
Description: The name of the target database. ,
Required: True ,
}
string ,
migrationOperationId:
{
Description: Optional migration operation ID. If this is provided, then details of migration operation for that ID are retrieved. If not provided (default), then details related to most recent or current operation are retrieved. ,
Format: uuid ,
Required: False ,
}
string ,
$expand:
{
Description: Complete migration details be included in the response. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Database Migration Resource properties for SQL Virtual Machine. ,
Required: False ,
}
{
migrationStatusDetails:
{
Description: Detailed migration status. Not included by default. ,
Required: False ,
}
{
migrationState:
{
Description: Current State of Migration. ,
Required: False ,
}
string ,
fullBackupSetInfo:
{
Description: Details of full backup set. ,
Required: False ,
}
{
backupSetId:
{
Description: Backup set id. ,
Format: uuid ,
Required: False ,
}
string ,
firstLSN:
{
Description: First LSN of the backup set. ,
Required: False ,
}
string ,
lastLSN:
{
Description: Last LSN of the backup set. ,
Required: False ,
}
string ,
backupType:
{
Description: Backup type. ,
Required: False ,
}
string ,
listOfBackupFiles:
{
Description: List of files in the backup set. ,
Required: False ,
}
[
{
fileName:
{
Description: File name. ,
Required: False ,
}
string ,
status:
{
Description: Status of the file. (Initial, Uploading, Uploaded, Restoring, Restored or Skipped) ,
Required: False ,
}
string ,
totalSize:
{
Description: File size in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
dataRead:
{
Description: Bytes read ,
Format: int64 ,
Required: False ,
}
integer ,
dataWritten:
{
Description: Bytes written ,
Format: int64 ,
Required: False ,
}
integer ,
copyThroughput:
{
Description: Copy throughput in KBps ,
Format: double ,
Required: False ,
}
number ,
copyDuration:
{
Description: Copy Duration in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
familySequenceNumber:
{
Description: Media family sequence number ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
backupStartDate:
{
Description: Backup start date. ,
Format: date-time ,
Required: False ,
}
string ,
backupFinishDate:
{
Description: Backup end time. ,
Format: date-time ,
Required: False ,
}
string ,
isBackupRestored:
{
Description: Whether this backup set has been restored or not. ,
Required: False ,
}
boolean ,
hasBackupChecksums:
{
Description: Has Backup Checksums ,
Required: False ,
}
boolean ,
familyCount:
{
Description: Media family count ,
Format: int32 ,
Required: False ,
}
integer ,
ignoreReasons:
{
Description: The reasons why the backup set is ignored ,
Required: False ,
}
[
string ,
]
,
}
,
lastRestoredBackupSetInfo:
{
Description: Last applied backup set information. ,
Required: False ,
}
{
backupSetId:
{
Description: Backup set id. ,
Format: uuid ,
Required: False ,
}
string ,
firstLSN:
{
Description: First LSN of the backup set. ,
Required: False ,
}
string ,
lastLSN:
{
Description: Last LSN of the backup set. ,
Required: False ,
}
string ,
backupType:
{
Description: Backup type. ,
Required: False ,
}
string ,
listOfBackupFiles:
{
Description: List of files in the backup set. ,
Required: False ,
}
[
{
fileName:
{
Description: File name. ,
Required: False ,
}
string ,
status:
{
Description: Status of the file. (Initial, Uploading, Uploaded, Restoring, Restored or Skipped) ,
Required: False ,
}
string ,
totalSize:
{
Description: File size in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
dataRead:
{
Description: Bytes read ,
Format: int64 ,
Required: False ,
}
integer ,
dataWritten:
{
Description: Bytes written ,
Format: int64 ,
Required: False ,
}
integer ,
copyThroughput:
{
Description: Copy throughput in KBps ,
Format: double ,
Required: False ,
}
number ,
copyDuration:
{
Description: Copy Duration in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
familySequenceNumber:
{
Description: Media family sequence number ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
backupStartDate:
{
Description: Backup start date. ,
Format: date-time ,
Required: False ,
}
string ,
backupFinishDate:
{
Description: Backup end time. ,
Format: date-time ,
Required: False ,
}
string ,
isBackupRestored:
{
Description: Whether this backup set has been restored or not. ,
Required: False ,
}
boolean ,
hasBackupChecksums:
{
Description: Has Backup Checksums ,
Required: False ,
}
boolean ,
familyCount:
{
Description: Media family count ,
Format: int32 ,
Required: False ,
}
integer ,
ignoreReasons:
{
Description: The reasons why the backup set is ignored ,
Required: False ,
}
[
string ,
]
,
}
,
activeBackupSets:
{
Description: Backup sets that are currently active. ,
Required: False ,
}
[
{
backupSetId:
{
Description: Backup set id. ,
Format: uuid ,
Required: False ,
}
string ,
firstLSN:
{
Description: First LSN of the backup set. ,
Required: False ,
}
string ,
lastLSN:
{
Description: Last LSN of the backup set. ,
Required: False ,
}
string ,
backupType:
{
Description: Backup type. ,
Required: False ,
}
string ,
listOfBackupFiles:
{
Description: List of files in the backup set. ,
Required: False ,
}
[
{
fileName:
{
Description: File name. ,
Required: False ,
}
string ,
status:
{
Description: Status of the file. (Initial, Uploading, Uploaded, Restoring, Restored or Skipped) ,
Required: False ,
}
string ,
totalSize:
{
Description: File size in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
dataRead:
{
Description: Bytes read ,
Format: int64 ,
Required: False ,
}
integer ,
dataWritten:
{
Description: Bytes written ,
Format: int64 ,
Required: False ,
}
integer ,
copyThroughput:
{
Description: Copy throughput in KBps ,
Format: double ,
Required: False ,
}
number ,
copyDuration:
{
Description: Copy Duration in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
familySequenceNumber:
{
Description: Media family sequence number ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
backupStartDate:
{
Description: Backup start date. ,
Format: date-time ,
Required: False ,
}
string ,
backupFinishDate:
{
Description: Backup end time. ,
Format: date-time ,
Required: False ,
}
string ,
isBackupRestored:
{
Description: Whether this backup set has been restored or not. ,
Required: False ,
}
boolean ,
hasBackupChecksums:
{
Description: Has Backup Checksums ,
Required: False ,
}
boolean ,
familyCount:
{
Description: Media family count ,
Format: int32 ,
Required: False ,
}
integer ,
ignoreReasons:
{
Description: The reasons why the backup set is ignored ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
invalidFiles:
{
Description: Files that are not valid backup files. ,
Required: False ,
}
[
string ,
]
,
blobContainerName:
{
Description: Name of blob container. ,
Required: False ,
}
string ,
isFullBackupRestored:
{
Description: Whether full backup has been applied to the target database or not. ,
Required: False ,
}
boolean ,
restoreBlockingReason:
{
Description: Restore blocking reason, if any ,
Required: False ,
}
string ,
completeRestoreErrorMessage:
{
Description: Complete restore error message, if any ,
Required: False ,
}
string ,
fileUploadBlockingErrors:
{
Description: File upload blocking errors, if any. ,
Required: False ,
}
[
string ,
]
,
currentRestoringFilename:
{
Description: File name that is currently being restored. ,
Required: False ,
}
string ,
lastRestoredFilename:
{
Description: Last restored file name. ,
Required: False ,
}
string ,
pendingLogBackupsCount:
{
Description: Total pending log backups. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
backupConfiguration:
{
Description: Backup configuration info. ,
Required: False ,
}
{
sourceLocation:
{
Description: Source location of backups. ,
Required: False ,
}
{
fileShare:
{
Description: Source File share. ,
Required: False ,
}
{
path:
{
Description: Location as SMB share or local drive where backups are placed. ,
Required: False ,
}
string ,
username:
{
Description: Username to access the file share location for backups. ,
Required: False ,
}
string ,
password:
{
Description: Password for username to access file share location. ,
Format: password ,
Required: False ,
}
string ,
}
,
azureBlob:
{
Description: Source Azure Blob. ,
Required: False ,
}
{
authType:
{
Description: Authentication type used for accessing Azure Blob Storage. ,
Enum:
{
AccountKey: Use an account key for authentication. ,
ManagedIdentity: Use a managed identity for authentication. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Identity details for authentication using a Managed Identity. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
storageAccountResourceId:
{
Description: Resource Id of the storage account where backups are stored. ,
Required: False ,
}
string ,
accountKey:
{
Description: Storage Account Key. ,
Required: False ,
}
string ,
blobContainerName:
{
Description: Blob container name where backups are stored. ,
Required: False ,
}
string ,
}
,
fileStorageType:
{
Description: Backup storage Type. ,
Required: False ,
}
string ,
}
,
targetLocation:
{
Description: Target location for copying backups. ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: Resource Id of the storage account copying backups. ,
Required: False ,
}
string ,
accountKey:
{
Description: Storage Account Key. ,
Required: False ,
}
string ,
}
,
}
,
offlineConfiguration:
{
Description: Offline configuration. ,
Required: False ,
}
{
offline:
{
Description: Offline migration ,
Required: False ,
}
boolean ,
lastBackupName:
{
Description: Last backup name for offline migration. This is optional for migrations from file share. If it is not provided, then the service will determine the last backup file name based on latest backup files present in file share. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{}
DatabaseMigrationsSqlVm_CreateOrUpdate (new)
Description :  Create a new database migration to a given SQL VM.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}/providers/Microsoft.DataMigration/databaseMigrations/{targetDbName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
sqlVirtualMachineName:
{
Required: True ,
}
string ,
targetDbName:
{
Description: The name of the target database. ,
Required: True ,
}
string ,
parameters:
{
Description: Details of SqlMigrationService resource. ,
Required: True ,
}
{
properties:
{
Description: Database Migration Resource properties for SQL Virtual Machine. ,
Required: False ,
}
{
migrationStatusDetails:
{
Description: Detailed migration status. Not included by default. ,
Required: False ,
}
{
migrationState:
{
Description: Current State of Migration. ,
Required: False ,
}
string ,
fullBackupSetInfo:
{
Description: Details of full backup set. ,
Required: False ,
}
{
backupSetId:
{
Description: Backup set id. ,
Format: uuid ,
Required: False ,
}
string ,
firstLSN:
{
Description: First LSN of the backup set. ,
Required: False ,
}
string ,
lastLSN:
{
Description: Last LSN of the backup set. ,
Required: False ,
}
string ,
backupType:
{
Description: Backup type. ,
Required: False ,
}
string ,
listOfBackupFiles:
{
Description: List of files in the backup set. ,
Required: False ,
}
[
{
fileName:
{
Description: File name. ,
Required: False ,
}
string ,
status:
{
Description: Status of the file. (Initial, Uploading, Uploaded, Restoring, Restored or Skipped) ,
Required: False ,
}
string ,
totalSize:
{
Description: File size in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
dataRead:
{
Description: Bytes read ,
Format: int64 ,
Required: False ,
}
integer ,
dataWritten:
{
Description: Bytes written ,
Format: int64 ,
Required: False ,
}
integer ,
copyThroughput:
{
Description: Copy throughput in KBps ,
Format: double ,
Required: False ,
}
number ,
copyDuration:
{
Description: Copy Duration in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
familySequenceNumber:
{
Description: Media family sequence number ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
backupStartDate:
{
Description: Backup start date. ,
Format: date-time ,
Required: False ,
}
string ,
backupFinishDate:
{
Description: Backup end time. ,
Format: date-time ,
Required: False ,
}
string ,
isBackupRestored:
{
Description: Whether this backup set has been restored or not. ,
Required: False ,
}
boolean ,
hasBackupChecksums:
{
Description: Has Backup Checksums ,
Required: False ,
}
boolean ,
familyCount:
{
Description: Media family count ,
Format: int32 ,
Required: False ,
}
integer ,
ignoreReasons:
{
Description: The reasons why the backup set is ignored ,
Required: False ,
}
[
string ,
]
,
}
,
lastRestoredBackupSetInfo:
{
Description: Last applied backup set information. ,
Required: False ,
}
{
backupSetId:
{
Description: Backup set id. ,
Format: uuid ,
Required: False ,
}
string ,
firstLSN:
{
Description: First LSN of the backup set. ,
Required: False ,
}
string ,
lastLSN:
{
Description: Last LSN of the backup set. ,
Required: False ,
}
string ,
backupType:
{
Description: Backup type. ,
Required: False ,
}
string ,
listOfBackupFiles:
{
Description: List of files in the backup set. ,
Required: False ,
}
[
{
fileName:
{
Description: File name. ,
Required: False ,
}
string ,
status:
{
Description: Status of the file. (Initial, Uploading, Uploaded, Restoring, Restored or Skipped) ,
Required: False ,
}
string ,
totalSize:
{
Description: File size in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
dataRead:
{
Description: Bytes read ,
Format: int64 ,
Required: False ,
}
integer ,
dataWritten:
{
Description: Bytes written ,
Format: int64 ,
Required: False ,
}
integer ,
copyThroughput:
{
Description: Copy throughput in KBps ,
Format: double ,
Required: False ,
}
number ,
copyDuration:
{
Description: Copy Duration in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
familySequenceNumber:
{
Description: Media family sequence number ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
backupStartDate:
{
Description: Backup start date. ,
Format: date-time ,
Required: False ,
}
string ,
backupFinishDate:
{
Description: Backup end time. ,
Format: date-time ,
Required: False ,
}
string ,
isBackupRestored:
{
Description: Whether this backup set has been restored or not. ,
Required: False ,
}
boolean ,
hasBackupChecksums:
{
Description: Has Backup Checksums ,
Required: False ,
}
boolean ,
familyCount:
{
Description: Media family count ,
Format: int32 ,
Required: False ,
}
integer ,
ignoreReasons:
{
Description: The reasons why the backup set is ignored ,
Required: False ,
}
[
string ,
]
,
}
,
activeBackupSets:
{
Description: Backup sets that are currently active. ,
Required: False ,
}
[
{
backupSetId:
{
Description: Backup set id. ,
Format: uuid ,
Required: False ,
}
string ,
firstLSN:
{
Description: First LSN of the backup set. ,
Required: False ,
}
string ,
lastLSN:
{
Description: Last LSN of the backup set. ,
Required: False ,
}
string ,
backupType:
{
Description: Backup type. ,
Required: False ,
}
string ,
listOfBackupFiles:
{
Description: List of files in the backup set. ,
Required: False ,
}
[
{
fileName:
{
Description: File name. ,
Required: False ,
}
string ,
status:
{
Description: Status of the file. (Initial, Uploading, Uploaded, Restoring, Restored or Skipped) ,
Required: False ,
}
string ,
totalSize:
{
Description: File size in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
dataRead:
{
Description: Bytes read ,
Format: int64 ,
Required: False ,
}
integer ,
dataWritten:
{
Description: Bytes written ,
Format: int64 ,
Required: False ,
}
integer ,
copyThroughput:
{
Description: Copy throughput in KBps ,
Format: double ,
Required: False ,
}
number ,
copyDuration:
{
Description: Copy Duration in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
familySequenceNumber:
{
Description: Media family sequence number ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
backupStartDate:
{
Description: Backup start date. ,
Format: date-time ,
Required: False ,
}
string ,
backupFinishDate:
{
Description: Backup end time. ,
Format: date-time ,
Required: False ,
}
string ,
isBackupRestored:
{
Description: Whether this backup set has been restored or not. ,
Required: False ,
}
boolean ,
hasBackupChecksums:
{
Description: Has Backup Checksums ,
Required: False ,
}
boolean ,
familyCount:
{
Description: Media family count ,
Format: int32 ,
Required: False ,
}
integer ,
ignoreReasons:
{
Description: The reasons why the backup set is ignored ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
invalidFiles:
{
Description: Files that are not valid backup files. ,
Required: False ,
}
[
string ,
]
,
blobContainerName:
{
Description: Name of blob container. ,
Required: False ,
}
string ,
isFullBackupRestored:
{
Description: Whether full backup has been applied to the target database or not. ,
Required: False ,
}
boolean ,
restoreBlockingReason:
{
Description: Restore blocking reason, if any ,
Required: False ,
}
string ,
completeRestoreErrorMessage:
{
Description: Complete restore error message, if any ,
Required: False ,
}
string ,
fileUploadBlockingErrors:
{
Description: File upload blocking errors, if any. ,
Required: False ,
}
[
string ,
]
,
currentRestoringFilename:
{
Description: File name that is currently being restored. ,
Required: False ,
}
string ,
lastRestoredFilename:
{
Description: Last restored file name. ,
Required: False ,
}
string ,
pendingLogBackupsCount:
{
Description: Total pending log backups. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
backupConfiguration:
{
Description: Backup configuration info. ,
Required: False ,
}
{
sourceLocation:
{
Description: Source location of backups. ,
Required: False ,
}
{
fileShare:
{
Description: Source File share. ,
Required: False ,
}
{
path:
{
Description: Location as SMB share or local drive where backups are placed. ,
Required: False ,
}
string ,
username:
{
Description: Username to access the file share location for backups. ,
Required: False ,
}
string ,
password:
{
Description: Password for username to access file share location. ,
Format: password ,
Required: False ,
}
string ,
}
,
azureBlob:
{
Description: Source Azure Blob. ,
Required: False ,
}
{
authType:
{
Description: Authentication type used for accessing Azure Blob Storage. ,
Enum:
{
AccountKey: Use an account key for authentication. ,
ManagedIdentity: Use a managed identity for authentication. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Identity details for authentication using a Managed Identity. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
storageAccountResourceId:
{
Description: Resource Id of the storage account where backups are stored. ,
Required: False ,
}
string ,
accountKey:
{
Description: Storage Account Key. ,
Required: False ,
}
string ,
blobContainerName:
{
Description: Blob container name where backups are stored. ,
Required: False ,
}
string ,
}
,
fileStorageType:
{
Description: Backup storage Type. ,
Required: False ,
}
string ,
}
,
targetLocation:
{
Description: Target location for copying backups. ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: Resource Id of the storage account copying backups. ,
Required: False ,
}
string ,
accountKey:
{
Description: Storage Account Key. ,
Required: False ,
}
string ,
}
,
}
,
offlineConfiguration:
{
Description: Offline configuration. ,
Required: False ,
}
{
offline:
{
Description: Offline migration ,
Required: False ,
}
boolean ,
lastBackupName:
{
Description: Last backup name for offline migration. This is optional for migrations from file share. If it is not provided, then the service will determine the last backup file name based on latest backup files present in file share. ,
Required: False ,
}
string ,
}
,
}
,
}
,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Database Migration Resource properties for SQL Virtual Machine. ,
Required: False ,
}
{
migrationStatusDetails:
{
Description: Detailed migration status. Not included by default. ,
Required: False ,
}
{
migrationState:
{
Description: Current State of Migration. ,
Required: False ,
}
string ,
fullBackupSetInfo:
{
Description: Details of full backup set. ,
Required: False ,
}
{
backupSetId:
{
Description: Backup set id. ,
Format: uuid ,
Required: False ,
}
string ,
firstLSN:
{
Description: First LSN of the backup set. ,
Required: False ,
}
string ,
lastLSN:
{
Description: Last LSN of the backup set. ,
Required: False ,
}
string ,
backupType:
{
Description: Backup type. ,
Required: False ,
}
string ,
listOfBackupFiles:
{
Description: List of files in the backup set. ,
Required: False ,
}
[
{
fileName:
{
Description: File name. ,
Required: False ,
}
string ,
status:
{
Description: Status of the file. (Initial, Uploading, Uploaded, Restoring, Restored or Skipped) ,
Required: False ,
}
string ,
totalSize:
{
Description: File size in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
dataRead:
{
Description: Bytes read ,
Format: int64 ,
Required: False ,
}
integer ,
dataWritten:
{
Description: Bytes written ,
Format: int64 ,
Required: False ,
}
integer ,
copyThroughput:
{
Description: Copy throughput in KBps ,
Format: double ,
Required: False ,
}
number ,
copyDuration:
{
Description: Copy Duration in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
familySequenceNumber:
{
Description: Media family sequence number ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
backupStartDate:
{
Description: Backup start date. ,
Format: date-time ,
Required: False ,
}
string ,
backupFinishDate:
{
Description: Backup end time. ,
Format: date-time ,
Required: False ,
}
string ,
isBackupRestored:
{
Description: Whether this backup set has been restored or not. ,
Required: False ,
}
boolean ,
hasBackupChecksums:
{
Description: Has Backup Checksums ,
Required: False ,
}
boolean ,
familyCount:
{
Description: Media family count ,
Format: int32 ,
Required: False ,
}
integer ,
ignoreReasons:
{
Description: The reasons why the backup set is ignored ,
Required: False ,
}
[
string ,
]
,
}
,
lastRestoredBackupSetInfo:
{
Description: Last applied backup set information. ,
Required: False ,
}
{
backupSetId:
{
Description: Backup set id. ,
Format: uuid ,
Required: False ,
}
string ,
firstLSN:
{
Description: First LSN of the backup set. ,
Required: False ,
}
string ,
lastLSN:
{
Description: Last LSN of the backup set. ,
Required: False ,
}
string ,
backupType:
{
Description: Backup type. ,
Required: False ,
}
string ,
listOfBackupFiles:
{
Description: List of files in the backup set. ,
Required: False ,
}
[
{
fileName:
{
Description: File name. ,
Required: False ,
}
string ,
status:
{
Description: Status of the file. (Initial, Uploading, Uploaded, Restoring, Restored or Skipped) ,
Required: False ,
}
string ,
totalSize:
{
Description: File size in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
dataRead:
{
Description: Bytes read ,
Format: int64 ,
Required: False ,
}
integer ,
dataWritten:
{
Description: Bytes written ,
Format: int64 ,
Required: False ,
}
integer ,
copyThroughput:
{
Description: Copy throughput in KBps ,
Format: double ,
Required: False ,
}
number ,
copyDuration:
{
Description: Copy Duration in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
familySequenceNumber:
{
Description: Media family sequence number ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
backupStartDate:
{
Description: Backup start date. ,
Format: date-time ,
Required: False ,
}
string ,
backupFinishDate:
{
Description: Backup end time. ,
Format: date-time ,
Required: False ,
}
string ,
isBackupRestored:
{
Description: Whether this backup set has been restored or not. ,
Required: False ,
}
boolean ,
hasBackupChecksums:
{
Description: Has Backup Checksums ,
Required: False ,
}
boolean ,
familyCount:
{
Description: Media family count ,
Format: int32 ,
Required: False ,
}
integer ,
ignoreReasons:
{
Description: The reasons why the backup set is ignored ,
Required: False ,
}
[
string ,
]
,
}
,
activeBackupSets:
{
Description: Backup sets that are currently active. ,
Required: False ,
}
[
{
backupSetId:
{
Description: Backup set id. ,
Format: uuid ,
Required: False ,
}
string ,
firstLSN:
{
Description: First LSN of the backup set. ,
Required: False ,
}
string ,
lastLSN:
{
Description: Last LSN of the backup set. ,
Required: False ,
}
string ,
backupType:
{
Description: Backup type. ,
Required: False ,
}
string ,
listOfBackupFiles:
{
Description: List of files in the backup set. ,
Required: False ,
}
[
{
fileName:
{
Description: File name. ,
Required: False ,
}
string ,
status:
{
Description: Status of the file. (Initial, Uploading, Uploaded, Restoring, Restored or Skipped) ,
Required: False ,
}
string ,
totalSize:
{
Description: File size in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
dataRead:
{
Description: Bytes read ,
Format: int64 ,
Required: False ,
}
integer ,
dataWritten:
{
Description: Bytes written ,
Format: int64 ,
Required: False ,
}
integer ,
copyThroughput:
{
Description: Copy throughput in KBps ,
Format: double ,
Required: False ,
}
number ,
copyDuration:
{
Description: Copy Duration in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
familySequenceNumber:
{
Description: Media family sequence number ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
backupStartDate:
{
Description: Backup start date. ,
Format: date-time ,
Required: False ,
}
string ,
backupFinishDate:
{
Description: Backup end time. ,
Format: date-time ,
Required: False ,
}
string ,
isBackupRestored:
{
Description: Whether this backup set has been restored or not. ,
Required: False ,
}
boolean ,
hasBackupChecksums:
{
Description: Has Backup Checksums ,
Required: False ,
}
boolean ,
familyCount:
{
Description: Media family count ,
Format: int32 ,
Required: False ,
}
integer ,
ignoreReasons:
{
Description: The reasons why the backup set is ignored ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
invalidFiles:
{
Description: Files that are not valid backup files. ,
Required: False ,
}
[
string ,
]
,
blobContainerName:
{
Description: Name of blob container. ,
Required: False ,
}
string ,
isFullBackupRestored:
{
Description: Whether full backup has been applied to the target database or not. ,
Required: False ,
}
boolean ,
restoreBlockingReason:
{
Description: Restore blocking reason, if any ,
Required: False ,
}
string ,
completeRestoreErrorMessage:
{
Description: Complete restore error message, if any ,
Required: False ,
}
string ,
fileUploadBlockingErrors:
{
Description: File upload blocking errors, if any. ,
Required: False ,
}
[
string ,
]
,
currentRestoringFilename:
{
Description: File name that is currently being restored. ,
Required: False ,
}
string ,
lastRestoredFilename:
{
Description: Last restored file name. ,
Required: False ,
}
string ,
pendingLogBackupsCount:
{
Description: Total pending log backups. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
backupConfiguration:
{
Description: Backup configuration info. ,
Required: False ,
}
{
sourceLocation:
{
Description: Source location of backups. ,
Required: False ,
}
{
fileShare:
{
Description: Source File share. ,
Required: False ,
}
{
path:
{
Description: Location as SMB share or local drive where backups are placed. ,
Required: False ,
}
string ,
username:
{
Description: Username to access the file share location for backups. ,
Required: False ,
}
string ,
password:
{
Description: Password for username to access file share location. ,
Format: password ,
Required: False ,
}
string ,
}
,
azureBlob:
{
Description: Source Azure Blob. ,
Required: False ,
}
{
authType:
{
Description: Authentication type used for accessing Azure Blob Storage. ,
Enum:
{
AccountKey: Use an account key for authentication. ,
ManagedIdentity: Use a managed identity for authentication. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Identity details for authentication using a Managed Identity. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
storageAccountResourceId:
{
Description: Resource Id of the storage account where backups are stored. ,
Required: False ,
}
string ,
accountKey:
{
Description: Storage Account Key. ,
Required: False ,
}
string ,
blobContainerName:
{
Description: Blob container name where backups are stored. ,
Required: False ,
}
string ,
}
,
fileStorageType:
{
Description: Backup storage Type. ,
Required: False ,
}
string ,
}
,
targetLocation:
{
Description: Target location for copying backups. ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: Resource Id of the storage account copying backups. ,
Required: False ,
}
string ,
accountKey:
{
Description: Storage Account Key. ,
Required: False ,
}
string ,
}
,
}
,
offlineConfiguration:
{
Description: Offline configuration. ,
Required: False ,
}
{
offline:
{
Description: Offline migration ,
Required: False ,
}
boolean ,
lastBackupName:
{
Description: Last backup name for offline migration. This is optional for migrations from file share. If it is not provided, then the service will determine the last backup file name based on latest backup files present in file share. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{}

⚐ Response (201)

{
properties:
{
Description: Database Migration Resource properties for SQL Virtual Machine. ,
Required: False ,
}
{
migrationStatusDetails:
{
Description: Detailed migration status. Not included by default. ,
Required: False ,
}
{
migrationState:
{
Description: Current State of Migration. ,
Required: False ,
}
string ,
fullBackupSetInfo:
{
Description: Details of full backup set. ,
Required: False ,
}
{
backupSetId:
{
Description: Backup set id. ,
Format: uuid ,
Required: False ,
}
string ,
firstLSN:
{
Description: First LSN of the backup set. ,
Required: False ,
}
string ,
lastLSN:
{
Description: Last LSN of the backup set. ,
Required: False ,
}
string ,
backupType:
{
Description: Backup type. ,
Required: False ,
}
string ,
listOfBackupFiles:
{
Description: List of files in the backup set. ,
Required: False ,
}
[
{
fileName:
{
Description: File name. ,
Required: False ,
}
string ,
status:
{
Description: Status of the file. (Initial, Uploading, Uploaded, Restoring, Restored or Skipped) ,
Required: False ,
}
string ,
totalSize:
{
Description: File size in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
dataRead:
{
Description: Bytes read ,
Format: int64 ,
Required: False ,
}
integer ,
dataWritten:
{
Description: Bytes written ,
Format: int64 ,
Required: False ,
}
integer ,
copyThroughput:
{
Description: Copy throughput in KBps ,
Format: double ,
Required: False ,
}
number ,
copyDuration:
{
Description: Copy Duration in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
familySequenceNumber:
{
Description: Media family sequence number ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
backupStartDate:
{
Description: Backup start date. ,
Format: date-time ,
Required: False ,
}
string ,
backupFinishDate:
{
Description: Backup end time. ,
Format: date-time ,
Required: False ,
}
string ,
isBackupRestored:
{
Description: Whether this backup set has been restored or not. ,
Required: False ,
}
boolean ,
hasBackupChecksums:
{
Description: Has Backup Checksums ,
Required: False ,
}
boolean ,
familyCount:
{
Description: Media family count ,
Format: int32 ,
Required: False ,
}
integer ,
ignoreReasons:
{
Description: The reasons why the backup set is ignored ,
Required: False ,
}
[
string ,
]
,
}
,
lastRestoredBackupSetInfo:
{
Description: Last applied backup set information. ,
Required: False ,
}
{
backupSetId:
{
Description: Backup set id. ,
Format: uuid ,
Required: False ,
}
string ,
firstLSN:
{
Description: First LSN of the backup set. ,
Required: False ,
}
string ,
lastLSN:
{
Description: Last LSN of the backup set. ,
Required: False ,
}
string ,
backupType:
{
Description: Backup type. ,
Required: False ,
}
string ,
listOfBackupFiles:
{
Description: List of files in the backup set. ,
Required: False ,
}
[
{
fileName:
{
Description: File name. ,
Required: False ,
}
string ,
status:
{
Description: Status of the file. (Initial, Uploading, Uploaded, Restoring, Restored or Skipped) ,
Required: False ,
}
string ,
totalSize:
{
Description: File size in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
dataRead:
{
Description: Bytes read ,
Format: int64 ,
Required: False ,
}
integer ,
dataWritten:
{
Description: Bytes written ,
Format: int64 ,
Required: False ,
}
integer ,
copyThroughput:
{
Description: Copy throughput in KBps ,
Format: double ,
Required: False ,
}
number ,
copyDuration:
{
Description: Copy Duration in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
familySequenceNumber:
{
Description: Media family sequence number ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
backupStartDate:
{
Description: Backup start date. ,
Format: date-time ,
Required: False ,
}
string ,
backupFinishDate:
{
Description: Backup end time. ,
Format: date-time ,
Required: False ,
}
string ,
isBackupRestored:
{
Description: Whether this backup set has been restored or not. ,
Required: False ,
}
boolean ,
hasBackupChecksums:
{
Description: Has Backup Checksums ,
Required: False ,
}
boolean ,
familyCount:
{
Description: Media family count ,
Format: int32 ,
Required: False ,
}
integer ,
ignoreReasons:
{
Description: The reasons why the backup set is ignored ,
Required: False ,
}
[
string ,
]
,
}
,
activeBackupSets:
{
Description: Backup sets that are currently active. ,
Required: False ,
}
[
{
backupSetId:
{
Description: Backup set id. ,
Format: uuid ,
Required: False ,
}
string ,
firstLSN:
{
Description: First LSN of the backup set. ,
Required: False ,
}
string ,
lastLSN:
{
Description: Last LSN of the backup set. ,
Required: False ,
}
string ,
backupType:
{
Description: Backup type. ,
Required: False ,
}
string ,
listOfBackupFiles:
{
Description: List of files in the backup set. ,
Required: False ,
}
[
{
fileName:
{
Description: File name. ,
Required: False ,
}
string ,
status:
{
Description: Status of the file. (Initial, Uploading, Uploaded, Restoring, Restored or Skipped) ,
Required: False ,
}
string ,
totalSize:
{
Description: File size in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
dataRead:
{
Description: Bytes read ,
Format: int64 ,
Required: False ,
}
integer ,
dataWritten:
{
Description: Bytes written ,
Format: int64 ,
Required: False ,
}
integer ,
copyThroughput:
{
Description: Copy throughput in KBps ,
Format: double ,
Required: False ,
}
number ,
copyDuration:
{
Description: Copy Duration in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
familySequenceNumber:
{
Description: Media family sequence number ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
backupStartDate:
{
Description: Backup start date. ,
Format: date-time ,
Required: False ,
}
string ,
backupFinishDate:
{
Description: Backup end time. ,
Format: date-time ,
Required: False ,
}
string ,
isBackupRestored:
{
Description: Whether this backup set has been restored or not. ,
Required: False ,
}
boolean ,
hasBackupChecksums:
{
Description: Has Backup Checksums ,
Required: False ,
}
boolean ,
familyCount:
{
Description: Media family count ,
Format: int32 ,
Required: False ,
}
integer ,
ignoreReasons:
{
Description: The reasons why the backup set is ignored ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
invalidFiles:
{
Description: Files that are not valid backup files. ,
Required: False ,
}
[
string ,
]
,
blobContainerName:
{
Description: Name of blob container. ,
Required: False ,
}
string ,
isFullBackupRestored:
{
Description: Whether full backup has been applied to the target database or not. ,
Required: False ,
}
boolean ,
restoreBlockingReason:
{
Description: Restore blocking reason, if any ,
Required: False ,
}
string ,
completeRestoreErrorMessage:
{
Description: Complete restore error message, if any ,
Required: False ,
}
string ,
fileUploadBlockingErrors:
{
Description: File upload blocking errors, if any. ,
Required: False ,
}
[
string ,
]
,
currentRestoringFilename:
{
Description: File name that is currently being restored. ,
Required: False ,
}
string ,
lastRestoredFilename:
{
Description: Last restored file name. ,
Required: False ,
}
string ,
pendingLogBackupsCount:
{
Description: Total pending log backups. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
backupConfiguration:
{
Description: Backup configuration info. ,
Required: False ,
}
{
sourceLocation:
{
Description: Source location of backups. ,
Required: False ,
}
{
fileShare:
{
Description: Source File share. ,
Required: False ,
}
{
path:
{
Description: Location as SMB share or local drive where backups are placed. ,
Required: False ,
}
string ,
username:
{
Description: Username to access the file share location for backups. ,
Required: False ,
}
string ,
password:
{
Description: Password for username to access file share location. ,
Format: password ,
Required: False ,
}
string ,
}
,
azureBlob:
{
Description: Source Azure Blob. ,
Required: False ,
}
{
authType:
{
Description: Authentication type used for accessing Azure Blob Storage. ,
Enum:
{
AccountKey: Use an account key for authentication. ,
ManagedIdentity: Use a managed identity for authentication. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Identity details for authentication using a Managed Identity. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
storageAccountResourceId:
{
Description: Resource Id of the storage account where backups are stored. ,
Required: False ,
}
string ,
accountKey:
{
Description: Storage Account Key. ,
Required: False ,
}
string ,
blobContainerName:
{
Description: Blob container name where backups are stored. ,
Required: False ,
}
string ,
}
,
fileStorageType:
{
Description: Backup storage Type. ,
Required: False ,
}
string ,
}
,
targetLocation:
{
Description: Target location for copying backups. ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: Resource Id of the storage account copying backups. ,
Required: False ,
}
string ,
accountKey:
{
Description: Storage Account Key. ,
Required: False ,
}
string ,
}
,
}
,
offlineConfiguration:
{
Description: Offline configuration. ,
Required: False ,
}
{
offline:
{
Description: Offline migration ,
Required: False ,
}
boolean ,
lastBackupName:
{
Description: Last backup name for offline migration. This is optional for migrations from file share. If it is not provided, then the service will determine the last backup file name based on latest backup files present in file share. ,
Required: False ,
}
string ,
}
,
}
,
}
DatabaseMigrationsSqlVm_cancel (new)
Description :  Stop in-progress database migration to SQL VM.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}/providers/Microsoft.DataMigration/databaseMigrations/{targetDbName}/cancel
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
sqlVirtualMachineName:
{
Required: True ,
}
string ,
targetDbName:
{
Description: The name of the target database. ,
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
migrationOperationId:
{
Description: ID tracking migration operation. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{}

⚐ Response (202)

{}
DatabaseMigrationsSqlVm_cutover (new)
Description :  Initiate cutover for in-progress online database migration to SQL VM.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}/providers/Microsoft.DataMigration/databaseMigrations/{targetDbName}/cutover
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
sqlVirtualMachineName:
{
Required: True ,
}
string ,
targetDbName:
{
Description: The name of the target database. ,
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
migrationOperationId:
{
Description: ID tracking migration operation. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{}

⚐ Response (202)

{}
Operations_List (new)
Description :  Lists all of the available SQL Migration REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DataMigration/operations
{
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
isDataAction:
{
Description: Indicates whether the operation is a data action ,
Required: False ,
}
boolean ,
display:
{
Required: False ,
}
{
provider:
{
Required: False ,
}
string ,
resource:
{
Required: False ,
}
string ,
operation:
{
Required: False ,
}
string ,
description:
{
Required: False ,
}
string ,
}
,
origin:
{
Enum:
{
user: No description available. ,
system: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{}
MigrationServices_Get (new)
Description :  Retrieve the Database Migration Service
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataMigration/migrationServices/{migrationServiceName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
migrationServiceName:
{
Description: Name of the Migration Service. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Migration Service properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state to track the async operation status. ,
Enum:
{
Provisioning: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
integrationRuntimeState:
{
Description: Current state of the Integration runtime. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MigrationServices_CreateOrUpdate (new)
Description :  Create or Update Database Migration Service.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataMigration/migrationServices/{migrationServiceName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
migrationServiceName:
{
Description: Name of the Migration Service. ,
Required: True ,
}
string ,
parameters:
{
Description: Details of MigrationService resource. ,
Required: True ,
}
{
properties:
{
Description: The Migration Service properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state to track the async operation status. ,
Enum:
{
Provisioning: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
integrationRuntimeState:
{
Description: Current state of the Integration runtime. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Migration Service properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state to track the async operation status. ,
Enum:
{
Provisioning: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
integrationRuntimeState:
{
Description: Current state of the Integration runtime. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The Migration Service properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state to track the async operation status. ,
Enum:
{
Provisioning: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
integrationRuntimeState:
{
Description: Current state of the Integration runtime. ,
Required: False ,
}
string ,
}
,
}
MigrationServices_Delete (new)
Description :  Delete Database Migration Service.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataMigration/migrationServices/{migrationServiceName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
migrationServiceName:
{
Description: Name of the Migration Service. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}
MigrationServices_Update (new)
Description :  Update Database Migration Service.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataMigration/migrationServices/{migrationServiceName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
migrationServiceName:
{
Description: Name of the Migration Service. ,
Required: True ,
}
string ,
parameters:
{
Description: Details of MigrationService resource. ,
Required: True ,
}
{
tags:
{
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Migration Service properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state to track the async operation status. ,
Enum:
{
Provisioning: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
integrationRuntimeState:
{
Description: Current state of the Integration runtime. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
MigrationServices_ListByResourceGroup (new)
Description :  Retrieve all migration services in the resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataMigration/migrationServices
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The Migration Service properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state to track the async operation status. ,
Enum:
{
Provisioning: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
integrationRuntimeState:
{
Description: Current state of the Integration runtime. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MigrationServices_ListBySubscription (new)
Description :  Retrieve all migration services in the subscriptions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DataMigration/migrationServices
{
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The Migration Service properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state to track the async operation status. ,
Enum:
{
Provisioning: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
integrationRuntimeState:
{
Description: Current state of the Integration runtime. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MigrationServices_listMigrations (new)
Description :  Retrieve the List of database migrations attached to the service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataMigration/migrationServices/{migrationServiceName}/listMigrations
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
migrationServiceName:
{
Description: Name of the Migration Service. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: Database Migration Base Resource properties. ,
Required: False ,
}
{
kind:
{
Enum:
{
SqlMi: No description available. ,
SqlVm: No description available. ,
SqlDb: No description available. ,
MongoToCosmosDbMongo: No description available. ,
}
,
Required: True ,
}
enum ,
scope:
{
Description: Resource Id of the target resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning State of migration. ProvisioningState as Succeeded implies that validations have been performed and migration has started. ,
Enum:
{
Provisioning: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
migrationStatus:
{
Description: Migration status. ,
Required: False ,
}
string ,
startedOn:
{
Description: Database migration start time. ,
Format: date-time ,
Required: False ,
}
string ,
endedOn:
{
Description: Database migration end time. ,
Format: date-time ,
Required: False ,
}
string ,
migrationService:
{
Description: Resource Id of the Migration Service. ,
Format: arm-id ,
Required: False ,
}
string ,
migrationOperationId:
{
Description: ID for current migration operation. ,
Required: False ,
}
string ,
migrationFailureError:
{
Description: Error details in case of migration failure. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
provisioningError:
{
Description: Error message for migration provisioning failure, if any. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlMigrationServices_Get (new)
Description :  Retrieve the Database Migration Service
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataMigration/sqlMigrationServices/{sqlMigrationServiceName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
sqlMigrationServiceName:
{
Description: Name of the SQL Migration Service. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The SQL Migration Service properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state to track the async operation status. ,
Required: False ,
}
string ,
integrationRuntimeState:
{
Description: Current state of the Integration runtime. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
SqlMigrationServices_CreateOrUpdate (new)
Description :  Create or Update Database Migration Service.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataMigration/sqlMigrationServices/{sqlMigrationServiceName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
sqlMigrationServiceName:
{
Description: Name of the SQL Migration Service. ,
Required: True ,
}
string ,
parameters:
{
Description: Details of SqlMigrationService resource. ,
Required: True ,
}
{
properties:
{
Description: The SQL Migration Service properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state to track the async operation status. ,
Required: False ,
}
string ,
integrationRuntimeState:
{
Description: Current state of the Integration runtime. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The SQL Migration Service properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state to track the async operation status. ,
Required: False ,
}
string ,
integrationRuntimeState:
{
Description: Current state of the Integration runtime. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}

⚐ Response (201)

{
properties:
{
Description: The SQL Migration Service properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state to track the async operation status. ,
Required: False ,
}
string ,
integrationRuntimeState:
{
Description: Current state of the Integration runtime. ,
Required: False ,
}
string ,
}
,
}
SqlMigrationServices_Delete (new)
Description :  Delete Database Migration Service.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataMigration/sqlMigrationServices/{sqlMigrationServiceName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
sqlMigrationServiceName:
{
Description: Name of the SQL Migration Service. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
SqlMigrationServices_Update (new)
Description :  Update Database Migration Service.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataMigration/sqlMigrationServices/{sqlMigrationServiceName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
sqlMigrationServiceName:
{
Description: Name of the SQL Migration Service. ,
Required: True ,
}
string ,
parameters:
{
Description: Details of SqlMigrationService resource. ,
Required: True ,
}
{
tags:
{
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The SQL Migration Service properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state to track the async operation status. ,
Required: False ,
}
string ,
integrationRuntimeState:
{
Description: Current state of the Integration runtime. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}

⚐ Response (201)

{
properties:
{
Description: The SQL Migration Service properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state to track the async operation status. ,
Required: False ,
}
string ,
integrationRuntimeState:
{
Description: Current state of the Integration runtime. ,
Required: False ,
}
string ,
}
,
}
SqlMigrationServices_ListByResourceGroup (new)
Description :  Retrieve all SQL migration services in the resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataMigration/sqlMigrationServices
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The SQL Migration Service properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state to track the async operation status. ,
Required: False ,
}
string ,
integrationRuntimeState:
{
Description: Current state of the Integration runtime. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{}
SqlMigrationServices_listAuthKeys (new)
Description :  Retrieve the List of Authentication Keys for Self Hosted Integration Runtime.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataMigration/sqlMigrationServices/{sqlMigrationServiceName}/listAuthKeys
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
sqlMigrationServiceName:
{
Description: Name of the SQL Migration Service. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
authKey1:
{
Description: The first authentication key. ,
Required: False ,
}
string ,
authKey2:
{
Description: The second authentication key. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
SqlMigrationServices_regenerateAuthKeys (new)
Description :  Regenerate a new set of Authentication Keys for Self Hosted Integration Runtime.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataMigration/sqlMigrationServices/{sqlMigrationServiceName}/regenerateAuthKeys
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
sqlMigrationServiceName:
{
Description: Name of the SQL Migration Service. ,
Required: True ,
}
string ,
parameters:
{
Description: Details of SqlMigrationService resource. ,
Required: True ,
}
{
keyName:
{
Description: The name of authentication key to generate. ,
Required: False ,
}
string ,
authKey1:
{
Description: The first authentication key. ,
Required: False ,
}
string ,
authKey2:
{
Description: The second authentication key. ,
Required: False ,
}
string ,
}
,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
keyName:
{
Description: The name of authentication key to generate. ,
Required: False ,
}
string ,
authKey1:
{
Description: The first authentication key. ,
Required: False ,
}
string ,
authKey2:
{
Description: The second authentication key. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
SqlMigrationServices_deleteNode (new)
Description :  Delete the integration runtime node.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataMigration/sqlMigrationServices/{sqlMigrationServiceName}/deleteNode
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
sqlMigrationServiceName:
{
Description: Name of the SQL Migration Service. ,
Required: True ,
}
string ,
parameters:
{
Description: Details of SqlMigrationService resource. ,
Required: True ,
}
{
nodeName:
{
Description: The name of node to delete. ,
Required: False ,
}
string ,
integrationRuntimeName:
{
Description: The name of integration runtime. ,
Required: False ,
}
string ,
}
,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nodeName:
{
Description: The name of node to delete. ,
Required: False ,
}
string ,
integrationRuntimeName:
{
Description: The name of integration runtime. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
SqlMigrationServices_listMigrations (new)
Description :  Retrieve the List of database migrations attached to the service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataMigration/sqlMigrationServices/{sqlMigrationServiceName}/listMigrations
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
sqlMigrationServiceName:
{
Description: Name of the SQL Migration Service. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: Database Migration Resource properties. ,
Required: False ,
}
{
sourceSqlConnection:
{
Description: Source SQL Server connection details. ,
Required: False ,
}
{
dataSource:
{
Description: Data source. ,
Required: False ,
}
string ,
authentication:
{
Description: Authentication type. ,
Required: False ,
}
string ,
userName:
{
Description: User name to connect to source SQL. ,
Required: False ,
}
string ,
password:
{
Description: Password to connect to source SQL. ,
Format: password ,
Required: False ,
}
string ,
encryptConnection:
{
Description: Whether to encrypt connection or not. ,
Required: False ,
}
boolean ,
trustServerCertificate:
{
Description: Whether to trust server certificate or not. ,
Required: False ,
}
boolean ,
}
,
sourceDatabaseName:
{
Description: Name of the source database. ,
Required: False ,
}
string ,
sourceServerName:
{
Description: Name of the source sql server. ,
Required: False ,
}
string ,
targetDatabaseCollation:
{
Description: Database collation to be used for the target database. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{}
SqlMigrationServices_listMonitoringData (new)
Description :  Retrieve the registered Integration Runtime nodes and their monitoring data for a given Database Migration Service.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataMigration/sqlMigrationServices/{sqlMigrationServiceName}/listMonitoringData
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
sqlMigrationServiceName:
{
Description: Name of the SQL Migration Service. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The name of Integration Runtime. ,
Required: False ,
}
string ,
nodes:
{
Description: Integration Runtime node monitoring data. ,
Required: False ,
}
[
{
additionalProperties:
{
Description: Unmatched properties from the message are deserialized in this collection. ,
Required: False ,
}
object ,
nodeName:
{
Description: Name of the integration runtime node. ,
Required: False ,
}
string ,
availableMemoryInMB:
{
Description: Available memory (MB) on the integration runtime node. ,
Format: int32 ,
Required: False ,
}
integer ,
cpuUtilization:
{
Description: CPU percentage on the integration runtime node. ,
Format: int32 ,
Required: False ,
}
integer ,
concurrentJobsLimit:
{
Description: Maximum concurrent jobs on the integration runtime node. ,
Format: int32 ,
Required: False ,
}
integer ,
concurrentJobsRunning:
{
Description: The number of jobs currently running on the integration runtime node. ,
Format: int32 ,
Required: False ,
}
integer ,
maxConcurrentJobs:
{
Description: The maximum concurrent jobs in this integration runtime. ,
Format: int32 ,
Required: False ,
}
integer ,
sentBytes:
{
Description: Sent bytes on the integration runtime node. ,
Format: double ,
Required: False ,
}
number ,
receivedBytes:
{
Description: Received bytes on the integration runtime node. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}

⚐ Response (default)

{}
SqlMigrationServices_ListBySubscription (new)
Description :  Retrieve all SQL migration services in the subscriptions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DataMigration/sqlMigrationServices
{
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The SQL Migration Service properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state to track the async operation status. ,
Required: False ,
}
string ,
integrationRuntimeState:
{
Description: Current state of the Integration runtime. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{}