swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector DatabaseMigrations API schemes: - https tags: - name: DatabaseMigrations paths: ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{targetResourceName}/providers/Microsoft.DataMigration/databaseMigrations/{migrationName} : get: tags: - DatabaseMigrations description: Get Database Migration resource. operationId: microsoftAzureDatabasemigrationsmongotocosmosdbrumongoGet parameters: - $ref: '#/parameters/ResourceGroupParameter' - $ref: '#/parameters/TargetResourceNameParameter' - $ref: '#/parameters/MigrationNameParameter' - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/DatabaseMigrationCosmosDbMongo' default: schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse description: "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was provided for parameter '{0}'.\n\n * 400 EmptyRequiredRequestBody - The request body must not be empty.\n\n * 400 GenericUser - User Failure when calling other Resource Provider.\n\n * 400 OperationIdNotFound - Operation ID '{0}' not found.\n\n * 400 OperationTypeNotFound - Operation Type '{0}' not found.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 InvalidLocation - Invalid Location: '{0}'. Location should match selected Azure target location '{1}'.\n\n * 400 DeleteMigrationServiceTaskNotAllowedInProgress - Migration service task '{0}' is currently in progress. To delete the task, please wait until the migration service task has completed or cancel the task manually, and then retry deleting the migration service task. Alternatively, use the force delete option to cancel ongoing operations and delete.\n\n * 400 RequestFailed - Request to the resource '{0}' failed. Error code : '{1}'. HTTP status code : '{2}'. Error message : '{3}'.\n\n * 400 DeleteMigrationNotAllowedMigrationInProgress - Database migration to the target resource '{0}' is currently in progress. To delete the migration, please wait until the migration has completed or cancel the migration manually, and then retry deleting the migration. Alternatively, use the force delete option to cancel ongoing operations and delete\n\n * 400 DeleteMigrationNotAllowedDeleteInProgress - Database migration to the target resource '{0}' is currently deleting. Please wait until the delete operation is complete\n\n * 400 MigrationRetryNotAllowed - Migration is not in a retriable state. Migration must be in state WaitForRetry. Current state: '{0}', Target server:'{1}', Target database: '{2}'.\n\n * 400 TestConnectionFailed - Failed to test connections using provided Integration Runtime. Error details: '{0}'\n\n * 400 MigrationStillValidating - Migration is still being validated. {0} cannot be performed. Target server:'{1}', Target database: '{2}'.\n\n * 400 IntegrationRuntimeIsNotOnline - Integration Runtime '{0}' is not online for resource group '{1}' subscription '{2}'\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 405 SubscriptionNotReady - Subscription is not in Ready state.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 GenericSystem - System Failure when calling other Resource Provider.\n\n * 500 AdfCleanupFailureAfterMigration - Failed to clean up resources after migration has completed successfully. Target server:'{0}', Target database: '{1}', Error details: '{2}'." x-ms-examples: Get Mongo to CosmosDb Mongo(RU) database Migration without the expand parameter.: $ref: ./examples/CosmosDbMongoGetDatabaseMigration.json Get Mongo to CosmosDb Mongo(RU) database Migration with the expand parameter.: $ref: ./examples/CosmosDbMongoGetDatabaseMigrationExpanded.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Documentdb Databaseaccounts Targetresourcename Providers Microsoft Datamigration Databasemigrations Migrationname put: tags: - DatabaseMigrations description: Create or Update Database Migration resource. operationId: microsoftAzureDatabasemigrationsmongotocosmosdbrumongoCreate parameters: - $ref: '#/parameters/ResourceGroupParameter' - $ref: '#/parameters/TargetResourceNameParameter' - $ref: '#/parameters/MigrationNameParameter' - name: parameters in: body description: Details of CosmosDB for Mongo API Migration resource. required: true schema: $ref: '#/definitions/DatabaseMigrationCosmosDbMongo' - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Updated database migration resource schema: $ref: '#/definitions/DatabaseMigrationCosmosDbMongo' '201': description: Created database migration resource schema: $ref: '#/definitions/DatabaseMigrationCosmosDbMongo' default: schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse description: "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was provided for parameter '{0}'.\n\n * 400 EmptyRequiredRequestBody - The request body must not be empty.\n\n * 400 GenericUser - User Failure when calling other Resource Provider.\n\n * 400 OperationIdNotFound - Operation ID '{0}' not found.\n\n * 400 OperationTypeNotFound - Operation Type '{0}' not found.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 InvalidLocation - Invalid Location: '{0}'. Location should match selected Azure target location '{1}'.\n\n * 400 DeleteMigrationServiceTaskNotAllowedInProgress - Migration service task '{0}' is currently in progress. To delete the task, please wait until the migration service task has completed or cancel the task manually, and then retry deleting the migration service task. Alternatively, use the force delete option to cancel ongoing operations and delete.\n\n * 400 RequestFailed - Request to the resource '{0}' failed. Error code : '{1}'. HTTP status code : '{2}'. Error message : '{3}'.\n\n * 400 DeleteMigrationNotAllowedMigrationInProgress - Database migration to the target resource '{0}' is currently in progress. To delete the migration, please wait until the migration has completed or cancel the migration manually, and then retry deleting the migration. Alternatively, use the force delete option to cancel ongoing operations and delete\n\n * 400 DeleteMigrationNotAllowedDeleteInProgress - Database migration to the target resource '{0}' is currently deleting. Please wait until the delete operation is complete\n\n * 400 MigrationRetryNotAllowed - Migration is not in a retriable state. Migration must be in state WaitForRetry. Current state: '{0}', Target server:'{1}', Target database: '{2}'.\n\n * 400 TestConnectionFailed - Failed to test connections using provided Integration Runtime. Error details: '{0}'\n\n * 400 MigrationStillValidating - Migration is still being validated. {0} cannot be performed. Target server:'{1}', Target database: '{2}'.\n\n * 400 IntegrationRuntimeIsNotOnline - Integration Runtime '{0}' is not online for resource group '{1}' subscription '{2}'\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 405 SubscriptionNotReady - Subscription is not in Ready state.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 GenericSystem - System Failure when calling other Resource Provider.\n\n * 500 AdfCleanupFailureAfterMigration - Failed to clean up resources after migration has completed successfully. Target server:'{0}', Target database: '{1}', Error details: '{2}'." x-ms-long-running-operation: true x-ms-examples: Create Mongo to CosmosDb Mongo(RU) Database Migration resource with Minimum parameters.: $ref: ./examples/CosmosDbMongoCreateOrUpdateDatabaseMigrationMIN.json Create Mongo to CosmosDb Mongo(RU) Database Migration resource with Maximum parameters.: $ref: ./examples/CosmosDbMongoCreateOrUpdateDatabaseMigrationMAX.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Documentdb Databaseaccounts Targetresourcename Providers Microsoft Datamigration Databasemigrations Migrationname delete: tags: - DatabaseMigrations description: Delete Database Migration resource. operationId: microsoftAzureDatabasemigrationsmongotocosmosdbrumongoDelete parameters: - $ref: '#/parameters/ResourceGroupParameter' - $ref: '#/parameters/TargetResourceNameParameter' - $ref: '#/parameters/MigrationNameParameter' - name: force in: query description: Optional force delete boolean. If this is provided as true, migration will be deleted even if active. required: false type: boolean - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '202': description: Accepted headers: Location: type: string '204': description: No Content default: schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse description: "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was provided for parameter '{0}'.\n\n * 400 EmptyRequiredRequestBody - The request body must not be empty.\n\n * 400 GenericUser - User Failure when calling other Resource Provider.\n\n * 400 OperationIdNotFound - Operation ID '{0}' not found.\n\n * 400 OperationTypeNotFound - Operation Type '{0}' not found.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 InvalidLocation - Invalid Location: '{0}'. Location should match selected Azure target location '{1}'.\n\n * 400 DeleteMigrationServiceTaskNotAllowedInProgress - Migration service task '{0}' is currently in progress. To delete the task, please wait until the migration service task has completed or cancel the task manually, and then retry deleting the migration service task. Alternatively, use the force delete option to cancel ongoing operations and delete.\n\n * 400 RequestFailed - Request to the resource '{0}' failed. Error code : '{1}'. HTTP status code : '{2}'. Error message : '{3}'.\n\n * 400 DeleteMigrationNotAllowedMigrationInProgress - Database migration to the target resource '{0}' is currently in progress. To delete the migration, please wait until the migration has completed or cancel the migration manually, and then retry deleting the migration. Alternatively, use the force delete option to cancel ongoing operations and delete\n\n * 400 DeleteMigrationNotAllowedDeleteInProgress - Database migration to the target resource '{0}' is currently deleting. Please wait until the delete operation is complete\n\n * 400 MigrationRetryNotAllowed - Migration is not in a retriable state. Migration must be in state WaitForRetry. Current state: '{0}', Target server:'{1}', Target database: '{2}'.\n\n * 400 TestConnectionFailed - Failed to test connections using provided Integration Runtime. Error details: '{0}'\n\n * 400 MigrationStillValidating - Migration is still being validated. {0} cannot be performed. Target server:'{1}', Target database: '{2}'.\n\n * 400 IntegrationRuntimeIsNotOnline - Integration Runtime '{0}' is not online for resource group '{1}' subscription '{2}'\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 405 SubscriptionNotReady - Subscription is not in Ready state.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 GenericSystem - System Failure when calling other Resource Provider.\n\n * 500 AdfCleanupFailureAfterMigration - Failed to clean up resources after migration has completed successfully. Target server:'{0}', Target database: '{1}', Error details: '{2}'." x-ms-long-running-operation: true x-ms-examples: Delete Mongo to CosmosDb Mongo(RU) Database Migration resource.: $ref: ./examples/CosmosDbMongoDeleteDatabaseMigration.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Documentdb Databaseaccounts Targetresourcename Providers Microsoft Datamigration Databasemigrations Migrationname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{targetResourceName}/providers/Microsoft.DataMigration/databaseMigrations : get: tags: - DatabaseMigrations description: Get Database Migration resources for the scope. operationId: microsoftAzureDatabasemigrationsmongotocosmosdbrumongoGetforscope parameters: - $ref: '#/parameters/ResourceGroupParameter' - $ref: '#/parameters/TargetResourceNameParameter' - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/DatabaseMigrationCosmosDbMongoListResult' default: schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse description: "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was provided for parameter '{0}'.\n\n * 400 EmptyRequiredRequestBody - The request body must not be empty.\n\n * 400 GenericUser - User Failure when calling other Resource Provider.\n\n * 400 OperationIdNotFound - Operation ID '{0}' not found.\n\n * 400 OperationTypeNotFound - Operation Type '{0}' not found.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 InvalidLocation - Invalid Location: '{0}'. Location should match selected Azure target location '{1}'.\n\n * 400 DeleteMigrationServiceTaskNotAllowedInProgress - Migration service task '{0}' is currently in progress. To delete the task, please wait until the migration service task has completed or cancel the task manually, and then retry deleting the migration service task. Alternatively, use the force delete option to cancel ongoing operations and delete.\n\n * 400 RequestFailed - Request to the resource '{0}' failed. Error code : '{1}'. HTTP status code : '{2}'. Error message : '{3}'.\n\n * 400 DeleteMigrationNotAllowedMigrationInProgress - Database migration to the target resource '{0}' is currently in progress. To delete the migration, please wait until the migration has completed or cancel the migration manually, and then retry deleting the migration. Alternatively, use the force delete option to cancel ongoing operations and delete\n\n * 400 DeleteMigrationNotAllowedDeleteInProgress - Database migration to the target resource '{0}' is currently deleting. Please wait until the delete operation is complete\n\n * 400 MigrationRetryNotAllowed - Migration is not in a retriable state. Migration must be in state WaitForRetry. Current state: '{0}', Target server:'{1}', Target database: '{2}'.\n\n * 400 TestConnectionFailed - Failed to test connections using provided Integration Runtime. Error details: '{0}'\n\n * 400 MigrationStillValidating - Migration is still being validated. {0} cannot be performed. Target server:'{1}', Target database: '{2}'.\n\n * 400 IntegrationRuntimeIsNotOnline - Integration Runtime '{0}' is not online for resource group '{1}' subscription '{2}'\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 405 SubscriptionNotReady - Subscription is not in Ready state.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 GenericSystem - System Failure when calling other Resource Provider.\n\n * 500 AdfCleanupFailureAfterMigration - Failed to clean up resources after migration has completed successfully. Target server:'{0}', Target database: '{1}', Error details: '{2}'." x-ms-pageable: nextLinkName: nextLink x-ms-examples: Get Mongo to CosmosDb Mongo(RU) database Migration without the expand parameter.: $ref: ./examples/CosmosDbMongoListByScopeDatabaseMigration.json Get Mongo to CosmosDb Mongo(RU) database Migration with the expand parameter.: $ref: ./examples/CosmosDbMongoListByScopeDatabaseMigration.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Documentdb Databaseaccounts Targetresourcename Providers Microsoft Datamigration Databasemigrations ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{targetResourceName}/providers/Microsoft.DataMigration/databaseMigrations/{migrationName} : get: tags: - DatabaseMigrations description: Get Database Migration resource. operationId: microsoftAzureDatabasemigrationsmongotocosmosdbvcoremongoGet parameters: - $ref: '#/parameters/ResourceGroupParameter' - $ref: '#/parameters/TargetResourceNameParameter' - $ref: '#/parameters/MigrationNameParameter' - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/DatabaseMigrationCosmosDbMongo' default: schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse description: "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was provided for parameter '{0}'.\n\n * 400 EmptyRequiredRequestBody - The request body must not be empty.\n\n * 400 GenericUser - User Failure when calling other Resource Provider.\n\n * 400 OperationIdNotFound - Operation ID '{0}' not found.\n\n * 400 OperationTypeNotFound - Operation Type '{0}' not found.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 InvalidLocation - Invalid Location: '{0}'. Location should match selected Azure target location '{1}'.\n\n * 400 DeleteMigrationServiceTaskNotAllowedInProgress - Migration service task '{0}' is currently in progress. To delete the task, please wait until the migration service task has completed or cancel the task manually, and then retry deleting the migration service task. Alternatively, use the force delete option to cancel ongoing operations and delete.\n\n * 400 RequestFailed - Request to the resource '{0}' failed. Error code : '{1}'. HTTP status code : '{2}'. Error message : '{3}'.\n\n * 400 DeleteMigrationNotAllowedMigrationInProgress - Database migration to the target resource '{0}' is currently in progress. To delete the migration, please wait until the migration has completed or cancel the migration manually, and then retry deleting the migration. Alternatively, use the force delete option to cancel ongoing operations and delete\n\n * 400 DeleteMigrationNotAllowedDeleteInProgress - Database migration to the target resource '{0}' is currently deleting. Please wait until the delete operation is complete\n\n * 400 MigrationRetryNotAllowed - Migration is not in a retriable state. Migration must be in state WaitForRetry. Current state: '{0}', Target server:'{1}', Target database: '{2}'.\n\n * 400 TestConnectionFailed - Failed to test connections using provided Integration Runtime. Error details: '{0}'\n\n * 400 MigrationStillValidating - Migration is still being validated. {0} cannot be performed. Target server:'{1}', Target database: '{2}'.\n\n * 400 IntegrationRuntimeIsNotOnline - Integration Runtime '{0}' is not online for resource group '{1}' subscription '{2}'\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 405 SubscriptionNotReady - Subscription is not in Ready state.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 GenericSystem - System Failure when calling other Resource Provider.\n\n * 500 AdfCleanupFailureAfterMigration - Failed to clean up resources after migration has completed successfully. Target server:'{0}', Target database: '{1}', Error details: '{2}'." x-ms-examples: Get Mongo to CosmosDb Mongo(vCore) database Migration without the expand parameter.: $ref: ./examples/CosmosDbMongoGetDatabaseMigration.json Get Mongo to CosmosDb Mongo(vCore) database Migration with the expand parameter.: $ref: ./examples/CosmosDbMongoGetDatabaseMigrationExpanded.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Documentdb Mongoclusters Targetresourcename Providers Microsoft Datamigration Databasemigrations Migrationname put: tags: - DatabaseMigrations description: Create or Update Database Migration resource. operationId: microsoftAzureDatabasemigrationsmongotocosmosdbvcoremongoCreate parameters: - $ref: '#/parameters/ResourceGroupParameter' - $ref: '#/parameters/TargetResourceNameParameter' - $ref: '#/parameters/MigrationNameParameter' - name: parameters in: body description: Details of CosmosDB for Mongo API Migration resource. required: true schema: $ref: '#/definitions/DatabaseMigrationCosmosDbMongo' - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Successfully updated the Database Migration resource. schema: $ref: '#/definitions/DatabaseMigrationCosmosDbMongo' '201': description: Created database migration resource schema: $ref: '#/definitions/DatabaseMigrationCosmosDbMongo' default: schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse description: "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was provided for parameter '{0}'.\n\n * 400 EmptyRequiredRequestBody - The request body must not be empty.\n\n * 400 GenericUser - User Failure when calling other Resource Provider.\n\n * 400 OperationIdNotFound - Operation ID '{0}' not found.\n\n * 400 OperationTypeNotFound - Operation Type '{0}' not found.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 InvalidLocation - Invalid Location: '{0}'. Location should match selected Azure target location '{1}'.\n\n * 400 DeleteMigrationServiceTaskNotAllowedInProgress - Migration service task '{0}' is currently in progress. To delete the task, please wait until the migration service task has completed or cancel the task manually, and then retry deleting the migration service task. Alternatively, use the force delete option to cancel ongoing operations and delete.\n\n * 400 RequestFailed - Request to the resource '{0}' failed. Error code : '{1}'. HTTP status code : '{2}'. Error message : '{3}'.\n\n * 400 DeleteMigrationNotAllowedMigrationInProgress - Database migration to the target resource '{0}' is currently in progress. To delete the migration, please wait until the migration has completed or cancel the migration manually, and then retry deleting the migration. Alternatively, use the force delete option to cancel ongoing operations and delete\n\n * 400 DeleteMigrationNotAllowedDeleteInProgress - Database migration to the target resource '{0}' is currently deleting. Please wait until the delete operation is complete\n\n * 400 MigrationRetryNotAllowed - Migration is not in a retriable state. Migration must be in state WaitForRetry. Current state: '{0}', Target server:'{1}', Target database: '{2}'.\n\n * 400 TestConnectionFailed - Failed to test connections using provided Integration Runtime. Error details: '{0}'\n\n * 400 MigrationStillValidating - Migration is still being validated. {0} cannot be performed. Target server:'{1}', Target database: '{2}'.\n\n * 400 IntegrationRuntimeIsNotOnline - Integration Runtime '{0}' is not online for resource group '{1}' subscription '{2}'\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 405 SubscriptionNotReady - Subscription is not in Ready state.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 GenericSystem - System Failure when calling other Resource Provider.\n\n * 500 AdfCleanupFailureAfterMigration - Failed to clean up resources after migration has completed successfully. Target server:'{0}', Target database: '{1}', Error details: '{2}'." x-ms-long-running-operation: true x-ms-examples: Create Mongo to CosmosDb Mongo(vCore) Database Migration resource with Minimum parameters.: $ref: ./examples/CosmosDbMongoCreateOrUpdateDatabaseMigrationMIN.json Create Mongo to CosmosDb Mongo(vCore) Database Migration resource with Maximum parameters.: $ref: ./examples/CosmosDbMongoCreateOrUpdateDatabaseMigrationMAX.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Documentdb Mongoclusters Targetresourcename Providers Microsoft Datamigration Databasemigrations Migrationname delete: tags: - DatabaseMigrations description: Delete Database Migration resource. operationId: microsoftAzureDatabasemigrationsmongotocosmosdbvcoremongoDelete parameters: - $ref: '#/parameters/ResourceGroupParameter' - $ref: '#/parameters/TargetResourceNameParameter' - $ref: '#/parameters/MigrationNameParameter' - name: force in: query description: Optional force delete boolean. If this is provided as true, migration will be deleted even if active. required: false type: boolean - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '202': description: Accepted headers: Location: type: string '204': description: No Content default: schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse description: "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was provided for parameter '{0}'.\n\n * 400 EmptyRequiredRequestBody - The request body must not be empty.\n\n * 400 GenericUser - User Failure when calling other Resource Provider.\n\n * 400 OperationIdNotFound - Operation ID '{0}' not found.\n\n * 400 OperationTypeNotFound - Operation Type '{0}' not found.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 InvalidLocation - Invalid Location: '{0}'. Location should match selected Azure target location '{1}'.\n\n * 400 DeleteMigrationServiceTaskNotAllowedInProgress - Migration service task '{0}' is currently in progress. To delete the task, please wait until the migration service task has completed or cancel the task manually, and then retry deleting the migration service task. Alternatively, use the force delete option to cancel ongoing operations and delete.\n\n * 400 RequestFailed - Request to the resource '{0}' failed. Error code : '{1}'. HTTP status code : '{2}'. Error message : '{3}'.\n\n * 400 DeleteMigrationNotAllowedMigrationInProgress - Database migration to the target resource '{0}' is currently in progress. To delete the migration, please wait until the migration has completed or cancel the migration manually, and then retry deleting the migration. Alternatively, use the force delete option to cancel ongoing operations and delete\n\n * 400 DeleteMigrationNotAllowedDeleteInProgress - Database migration to the target resource '{0}' is currently deleting. Please wait until the delete operation is complete\n\n * 400 MigrationRetryNotAllowed - Migration is not in a retriable state. Migration must be in state WaitForRetry. Current state: '{0}', Target server:'{1}', Target database: '{2}'.\n\n * 400 TestConnectionFailed - Failed to test connections using provided Integration Runtime. Error details: '{0}'\n\n * 400 MigrationStillValidating - Migration is still being validated. {0} cannot be performed. Target server:'{1}', Target database: '{2}'.\n\n * 400 IntegrationRuntimeIsNotOnline - Integration Runtime '{0}' is not online for resource group '{1}' subscription '{2}'\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 405 SubscriptionNotReady - Subscription is not in Ready state.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 GenericSystem - System Failure when calling other Resource Provider.\n\n * 500 AdfCleanupFailureAfterMigration - Failed to clean up resources after migration has completed successfully. Target server:'{0}', Target database: '{1}', Error details: '{2}'." x-ms-long-running-operation: true x-ms-examples: Delete Mongo to CosmosDb Mongo(vCore) Database Migration resource.: $ref: ./examples/CosmosDbMongoDeleteDatabaseMigration.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Documentdb Mongoclusters Targetresourcename Providers Microsoft Datamigration Databasemigrations Migrationname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{targetResourceName}/providers/Microsoft.DataMigration/databaseMigrations : get: tags: - DatabaseMigrations description: Get Database Migration resources for the scope. operationId: microsoftAzureDatabasemigrationsmongotocosmosdbvcoremongoGetforscope parameters: - $ref: '#/parameters/ResourceGroupParameter' - $ref: '#/parameters/TargetResourceNameParameter' - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/DatabaseMigrationCosmosDbMongoListResult' default: schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse description: "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was provided for parameter '{0}'.\n\n * 400 EmptyRequiredRequestBody - The request body must not be empty.\n\n * 400 GenericUser - User Failure when calling other Resource Provider.\n\n * 400 OperationIdNotFound - Operation ID '{0}' not found.\n\n * 400 OperationTypeNotFound - Operation Type '{0}' not found.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 InvalidLocation - Invalid Location: '{0}'. Location should match selected Azure target location '{1}'.\n\n * 400 DeleteMigrationServiceTaskNotAllowedInProgress - Migration service task '{0}' is currently in progress. To delete the task, please wait until the migration service task has completed or cancel the task manually, and then retry deleting the migration service task. Alternatively, use the force delete option to cancel ongoing operations and delete.\n\n * 400 RequestFailed - Request to the resource '{0}' failed. Error code : '{1}'. HTTP status code : '{2}'. Error message : '{3}'.\n\n * 400 DeleteMigrationNotAllowedMigrationInProgress - Database migration to the target resource '{0}' is currently in progress. To delete the migration, please wait until the migration has completed or cancel the migration manually, and then retry deleting the migration. Alternatively, use the force delete option to cancel ongoing operations and delete\n\n * 400 DeleteMigrationNotAllowedDeleteInProgress - Database migration to the target resource '{0}' is currently deleting. Please wait until the delete operation is complete\n\n * 400 MigrationRetryNotAllowed - Migration is not in a retriable state. Migration must be in state WaitForRetry. Current state: '{0}', Target server:'{1}', Target database: '{2}'.\n\n * 400 TestConnectionFailed - Failed to test connections using provided Integration Runtime. Error details: '{0}'\n\n * 400 MigrationStillValidating - Migration is still being validated. {0} cannot be performed. Target server:'{1}', Target database: '{2}'.\n\n * 400 IntegrationRuntimeIsNotOnline - Integration Runtime '{0}' is not online for resource group '{1}' subscription '{2}'\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 405 SubscriptionNotReady - Subscription is not in Ready state.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 GenericSystem - System Failure when calling other Resource Provider.\n\n * 500 AdfCleanupFailureAfterMigration - Failed to clean up ADF resources after migration has completed successfully. Target server:'{0}', Target database: '{1}', Error details: '{2}'." x-ms-pageable: nextLinkName: nextLink x-ms-examples: Get Mongo to CosmosDb Mongo(vCore) database Migration without the expand parameter.: $ref: ./examples/CosmosDbMongoListByScopeDatabaseMigration.json Get Mongo to CosmosDb Mongo(vCore) database Migration with the expand parameter.: $ref: ./examples/CosmosDbMongoListByScopeDatabaseMigration.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Documentdb Mongoclusters Targetresourcename Providers Microsoft Datamigration Databasemigrations ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{sqlDbInstanceName}/providers/Microsoft.DataMigration/databaseMigrations/{targetDbName} : get: tags: - DatabaseMigrations description: Retrieve the Database Migration resource. operationId: microsoftAzureDatabasemigrationssqldbGet parameters: - $ref: '#/parameters/ResourceGroupParameter' - name: sqlDbInstanceName in: path required: true type: string - $ref: '#/parameters/TargetDbNameParameter' - name: migrationOperationId in: query 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. required: false type: string format: uuid - name: $expand in: query description: Complete migration details be included in the response. required: false type: string - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Successfully retrieved the Database Migration resource. schema: $ref: '#/definitions/DatabaseMigrationSqlDb' default: description: "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was provided for parameter '{0}'.\n\n * 400 GenericUser - User Failure when calling other Resource Provider.\n\n * 400 OperationIdNotFound - Operation ID '{0}' not found.\n\n * 400 OperationTypeNotFound - Operation Type '{0}' not found.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 TestConnectionFailed - Failed to test connections using provided Integration Runtime. Error details: '{0}'\n\n * 400 CutoverNotAllowedMigrationCompleteError - Cutover is not allowed as migration for database '{0}' is already complete\n\n * 400 IntegrationRuntimeIsNotOnline - Integration Runtime '{0}' is not online for resource group '{1}' subscription '{2}'\n\n * 400 InvalidStorageAccount - Invalid storage account: '{0}'. Only BlockBlobStorage kind is supported for premium tier.\n\n * 400 InvalidLocation - Invalid Location: '{0}'. Location should match selected Azure target location '{1}'.\n\n * 400 MigrationNotReadyForCancelError - Database '{0}' is not ready for Cancel operation\n\n * 400 RestoreJobCompletedDuringCancel - Migration cannot be canceled as Restore Job was completed during the cancel process. Target server:'{0}', Target database: '{1}'.\n\n * 400 SqlVmGenericUserError - {0}\n\n * 400 RequestFailed - Request to the resource '{0}' failed. Error code : '{1}'. HTTP status code : '{2}'. Error message : '{3}'.\n\n * 400 InvalidContainerName - Invalid storage account container name: '{0}'. Container name 'backup' is not supported in SQL Managed Instance.\n\n * 400 IntegrationRuntimeIsNotSelfHosted - Integration Runtime is not self-hosted for subscription '{0}' resource group '{1}' and name '{2}'\n\n * 400 MigrationNotReadyForCutoverError - Database '{0}' is not ready for Cutover operation\n\n * 400 CutoverFailedOrCancelled - Cutover failed or cancelled for database '{0}'. Error details: '{1}'\n\n * 400 MigrationCancelFailed - Cancel could not be performed on operation '{0}' for database '{1}'. This can happen if the migration with MigrationId '{0}' is already completed or canceled. Please check the migration for details.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 405 SubscriptionNotReady - Subscription is not in Ready state.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 GenericSystem - System Failure when calling other Resource Provider.\n\n * 500 CancelVmRestoreJobFailed - Failed to cancel VM restore job. Target server:'{0}', Target database: '{1}', Error details: '{2}'.\n\n * 500 AdfCleanupFailureAfterMigration - Failed to clean up ADF resources after migration has completed successfully. Target server:'{0}', Target database: '{1}', Error details: '{2}'.\n\n * 500 CancelMigrationFailed - Failed to cancel migration. Target server:'{0}', Target database: '{1}', Migration Id: '{2}', Error details: '{3}'." x-ms-examples: Get Sql DB database Migration without the expand parameter.: $ref: ./examples/SqlDbGetDatabaseMigration.json Get Sql DB database Migration with the expand parameter.: $ref: ./examples/SqlDbGetDatabaseMigrationExpanded.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Sql Servers Sqldbinstancename Providers Microsoft Datamigration Databasemigrations Targetdbname put: tags: - DatabaseMigrations description: Create or Update Database Migration resource. operationId: microsoftAzureDatabasemigrationssqldbCreateorupdate parameters: - $ref: '#/parameters/ResourceGroupParameter' - name: sqlDbInstanceName in: path required: true type: string - $ref: '#/parameters/TargetDbNameParameter' - name: parameters in: body description: Details of Sql Db migration resource. required: true schema: $ref: '#/definitions/DatabaseMigrationSqlDb' - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Successfully updated the Database Migration resource. schema: $ref: '#/definitions/DatabaseMigrationSqlDb' '201': description: Successfully created the Database Migration resource. schema: $ref: '#/definitions/DatabaseMigrationSqlDb' default: description: "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was provided for parameter '{0}'.\n\n * 400 GenericUser - User Failure when calling other Resource Provider.\n\n * 400 OperationIdNotFound - Operation ID '{0}' not found.\n\n * 400 OperationTypeNotFound - Operation Type '{0}' not found.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 TestConnectionFailed - Failed to test connections using provided Integration Runtime. Error details: '{0}'\n\n * 400 CutoverNotAllowedMigrationCompleteError - Cutover is not allowed as migration for database '{0}' is already complete\n\n * 400 IntegrationRuntimeIsNotOnline - Integration Runtime '{0}' is not online for resource group '{1}' subscription '{2}'\n\n * 400 InvalidStorageAccount - Invalid storage account: '{0}'. Only BlockBlobStorage kind is supported for premium tier.\n\n * 400 InvalidLocation - Invalid Location: '{0}'. Location should match selected Azure target location '{1}'.\n\n * 400 MigrationNotReadyForCancelError - Database '{0}' is not ready for Cancel operation\n\n * 400 RestoreJobCompletedDuringCancel - Migration cannot be canceled as Restore Job was completed during the cancel process. Target server:'{0}', Target database: '{1}'.\n\n * 400 SqlVmGenericUserError - {0}\n\n * 400 RequestFailed - Request to the resource '{0}' failed. Error code : '{1}'. HTTP status code : '{2}'. Error message : '{3}'.\n\n * 400 InvalidContainerName - Invalid storage account container name: '{0}'. Container name 'backup' is not supported in SQL Managed Instance.\n\n * 400 IntegrationRuntimeIsNotSelfHosted - Integration Runtime is not self-hosted for subscription '{0}' resource group '{1}' and name '{2}'\n\n * 400 MigrationNotReadyForCutoverError - Database '{0}' is not ready for Cutover operation\n\n * 400 CutoverFailedOrCancelled - Cutover failed or cancelled for database '{0}'. Error details: '{1}'\n\n * 400 MigrationCancelFailed - Cancel could not be performed on operation '{0}' for database '{1}'. This can happen if the migration with MigrationId '{0}' is already completed or canceled. Please check the migration for details.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 405 SubscriptionNotReady - Subscription is not in Ready state.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 GenericSystem - System Failure when calling other Resource Provider.\n\n * 500 CancelVmRestoreJobFailed - Failed to cancel VM restore job. Target server:'{0}', Target database: '{1}', Error details: '{2}'.\n\n * 500 AdfCleanupFailureAfterMigration - Failed to clean up ADF resources after migration has completed successfully. Target server:'{0}', Target database: '{1}', Error details: '{2}'.\n\n * 500 CancelMigrationFailed - Failed to cancel migration. Target server:'{0}', Target database: '{1}', Migration Id: '{2}', Error details: '{3}'." x-ms-long-running-operation: true x-ms-examples: Create or Update Database Migration resource with Minimum parameters.: $ref: ./examples/SqlDbCreateOrUpdateDatabaseMigrationMIN.json Create or Update Database Migration resource with Maximum parameters.: $ref: ./examples/SqlDbCreateOrUpdateDatabaseMigrationMAX.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Sql Servers Sqldbinstancename Providers Microsoft Datamigration Databasemigrations Targetdbname delete: tags: - DatabaseMigrations description: Delete Database Migration resource. operationId: microsoftAzureDatabasemigrationssqldbDelete parameters: - $ref: '#/parameters/ResourceGroupParameter' - name: sqlDbInstanceName in: path required: true type: string - $ref: '#/parameters/TargetDbNameParameter' - name: force in: query description: Optional force delete boolean. If this is provided as true, migration will be deleted even if active. required: false type: boolean - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Successfully deleted the Database Migration resource. '202': description: Deleting the Database Migration resource. '204': description: The specified Database Migration resource does not exist. default: description: "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was provided for parameter '{0}'.\n\n * 400 GenericUser - User Failure when calling other Resource Provider.\n\n * 400 OperationIdNotFound - Operation ID '{0}' not found.\n\n * 400 OperationTypeNotFound - Operation Type '{0}' not found.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 TestConnectionFailed - Failed to test connections using provided Integration Runtime. Error details: '{0}'\n\n * 400 CutoverNotAllowedMigrationCompleteError - Cutover is not allowed as migration for database '{0}' is already complete\n\n * 400 IntegrationRuntimeIsNotOnline - Integration Runtime '{0}' is not online for resource group '{1}' subscription '{2}'\n\n * 400 InvalidStorageAccount - Invalid storage account: '{0}'. Only BlockBlobStorage kind is supported for premium tier.\n\n * 400 InvalidLocation - Invalid Location: '{0}'. Location should match selected Azure target location '{1}'.\n\n * 400 MigrationNotReadyForCancelError - Database '{0}' is not ready for Cancel operation\n\n * 400 RestoreJobCompletedDuringCancel - Migration cannot be canceled as Restore Job was completed during the cancel process. Target server:'{0}', Target database: '{1}'.\n\n * 400 SqlVmGenericUserError - {0}\n\n * 400 RequestFailed - Request to the resource '{0}' failed. Error code : '{1}'. HTTP status code : '{2}'. Error message : '{3}'.\n\n * 400 InvalidContainerName - Invalid storage account container name: '{0}'. Container name 'backup' is not supported in SQL Managed Instance.\n\n * 400 IntegrationRuntimeIsNotSelfHosted - Integration Runtime is not self-hosted for subscription '{0}' resource group '{1}' and name '{2}'\n\n * 400 MigrationNotReadyForCutoverError - Database '{0}' is not ready for Cutover operation\n\n * 400 CutoverFailedOrCancelled - Cutover failed or cancelled for database '{0}'. Error details: '{1}'\n\n * 400 MigrationCancelFailed - Cancel could not be performed on operation '{0}' for database '{1}'. This can happen if the migration with MigrationId '{0}' is already completed or canceled. Please check the migration for details.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 405 SubscriptionNotReady - Subscription is not in Ready state.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 GenericSystem - System Failure when calling other Resource Provider.\n\n * 500 CancelVmRestoreJobFailed - Failed to cancel VM restore job. Target server:'{0}', Target database: '{1}', Error details: '{2}'.\n\n * 500 AdfCleanupFailureAfterMigration - Failed to clean up ADF resources after migration has completed successfully. Target server:'{0}', Target database: '{1}', Error details: '{2}'.\n\n * 500 CancelMigrationFailed - Failed to cancel migration. Target server:'{0}', Target database: '{1}', Migration Id: '{2}', Error details: '{3}'." x-ms-long-running-operation: true x-ms-examples: Delete Database Migration resource.: $ref: ./examples/SqlDbDeleteDatabaseMigration.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Sql Servers Sqldbinstancename Providers Microsoft Datamigration Databasemigrations Targetdbname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{sqlDbInstanceName}/providers/Microsoft.DataMigration/databaseMigrations/{targetDbName}/cancel : post: tags: - DatabaseMigrations description: Stop on going migration for the database. operationId: microsoftAzureDatabasemigrationssqldbCancel parameters: - $ref: '#/parameters/ResourceGroupParameter' - name: sqlDbInstanceName in: path required: true type: string - $ref: '#/parameters/TargetDbNameParameter' - name: parameters in: body description: Required migration operation ID for which cancel will be initiated. required: true schema: $ref: '#/definitions/MigrationOperationInput' - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Successfully canceled ongoing migration. '202': description: Accepted cancellation of ongoing migration. default: description: "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was provided for parameter '{0}'.\n\n * 400 GenericUser - User Failure when calling other Resource Provider.\n\n * 400 OperationIdNotFound - Operation ID '{0}' not found.\n\n * 400 OperationTypeNotFound - Operation Type '{0}' not found.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 TestConnectionFailed - Failed to test connections using provided Integration Runtime. Error details: '{0}'\n\n * 400 CutoverNotAllowedMigrationCompleteError - Cutover is not allowed as migration for database '{0}' is already complete\n\n * 400 IntegrationRuntimeIsNotOnline - Integration Runtime '{0}' is not online for resource group '{1}' subscription '{2}'\n\n * 400 InvalidStorageAccount - Invalid storage account: '{0}'. Only BlockBlobStorage kind is supported for premium tier.\n\n * 400 InvalidLocation - Invalid Location: '{0}'. Location should match selected Azure target location '{1}'.\n\n * 400 MigrationNotReadyForCancelError - Database '{0}' is not ready for Cancel operation\n\n * 400 RestoreJobCompletedDuringCancel - Migration cannot be canceled as Restore Job was completed during the cancel process. Target server:'{0}', Target database: '{1}'.\n\n * 400 SqlVmGenericUserError - {0}\n\n * 400 RequestFailed - Request to the resource '{0}' failed. Error code : '{1}'. HTTP status code : '{2}'. Error message : '{3}'.\n\n * 400 InvalidContainerName - Invalid storage account container name: '{0}'. Container name 'backup' is not supported in SQL Managed Instance.\n\n * 400 IntegrationRuntimeIsNotSelfHosted - Integration Runtime is not self-hosted for subscription '{0}' resource group '{1}' and name '{2}'\n\n * 400 MigrationNotReadyForCutoverError - Database '{0}' is not ready for Cutover operation\n\n * 400 CutoverFailedOrCancelled - Cutover failed or cancelled for database '{0}'. Error details: '{1}'\n\n * 400 MigrationCancelFailed - Cancel could not be performed on operation '{0}' for database '{1}'. This can happen if the migration with MigrationId '{0}' is already completed or canceled. Please check the migration for details.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 405 SubscriptionNotReady - Subscription is not in Ready state.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 GenericSystem - System Failure when calling other Resource Provider.\n\n * 500 CancelVmRestoreJobFailed - Failed to cancel VM restore job. Target server:'{0}', Target database: '{1}', Error details: '{2}'.\n\n * 500 AdfCleanupFailureAfterMigration - Failed to clean up ADF resources after migration has completed successfully. Target server:'{0}', Target database: '{1}', Error details: '{2}'.\n\n * 500 CancelMigrationFailed - Failed to cancel migration. Target server:'{0}', Target database: '{1}', Migration Id: '{2}', Error details: '{3}'." x-ms-long-running-operation: true x-ms-examples: Stop ongoing migration for the database.: $ref: ./examples/SqlDbCancelDatabaseMigration.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Sql Servers Sqldbinstancename Providers Microsoft Datamigration Databasemigrations Targetdbname Cancel ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/providers/Microsoft.DataMigration/databaseMigrations/{targetDbName} : get: tags: - DatabaseMigrations description: Retrieve the specified database migration for a given SQL Managed Instance. operationId: microsoftAzureDatabasemigrationssqlmiGet parameters: - $ref: '#/parameters/ResourceGroupParameter' - name: managedInstanceName in: path required: true type: string - $ref: '#/parameters/TargetDbNameParameter' - name: migrationOperationId in: query 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. required: false type: string format: uuid - name: $expand in: query description: Complete migration details be included in the response. required: false type: string - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Successfully retrieved the Database Migration resource. schema: $ref: '#/definitions/DatabaseMigrationSqlMi' default: description: "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was provided for parameter '{0}'.\n\n * 400 GenericUser - User Failure when calling other Resource Provider.\n\n * 400 OperationIdNotFound - Operation ID '{0}' not found.\n\n * 400 OperationTypeNotFound - Operation Type '{0}' not found.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 InvalidStorageAccount - Invalid storage account: '{0}'. Only BlockBlobStorage kind is supported for premium tier.\n\n * 400 InvalidLocation - Invalid Location: '{0}'. Location should match selected Azure target location '{1}'.\n\n * 400 MigrationNotReadyForCancelError - Database '{0}' is not ready for Cancel operation\n\n * 400 RestoreJobCompletedDuringCancel - Migration cannot be canceled as Restore Job was completed during the cancel process. Target server:'{0}', Target database: '{1}'.\n\n * 400 SqlVmGenericUserError - \n\n * 400 IntegrationRuntimeIsNotSelfHosted - Integration Runtime is not self-hosted for subscription '{0}' resource group '{1}' and name '{2}'\n\n * 400 MigrationNotReadyForCutoverError - Database '{0}' is not ready for Cutover operation\n\n * 400 CutoverFailedOrCancelled - Cutover failed or cancelled for database '{0}'. Error details: '{1}'\n\n * 400 MigrationCancelFailed - Cancel could not be performed on operation '{0}' for database '{1}'. This can happen if the migration with MigrationId '{0}' is already completed or canceled. Please check the migration for details.\n\n * 400 TestConnectionFailed - Failed to test connections using provided Integration Runtime. Error details: '{0}'\n\n * 400 CutoverNotAllowedMigrationCompleteError - Cutover is not allowed as migration for database '{0}' is already complete\n\n * 400 IntegrationRuntimeIsNotOnline - Integration Runtime '{0}' is not online for resource group '{1}' subscription '{2}'\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 GenericSystem - System Failure when calling other Resource Provider.\n\n * 500 CancelVmRestoreJobFailed - Failed to cancel VM restore job. Target server:'{0}', Target database: '{1}', Error details: '{2}'.\n\n * 500 AdfCleanupFailureAfterMigration - Failed to clean up ADF resources after migration has completed successfully. Target server:'{0}', Target database: '{1}', Error details: '{2}'.\n\n * 500 CancelMigrationFailed - Failed to cancel migration. Target server:'{0}', Target database: '{1}', Migration Id: '{2}', Error details: '{3}'." x-ms-examples: Get Sql MI database Migration without the expand parameter.: $ref: ./examples/SqlMiGetDatabaseMigration.json Get Sql MI database Migration with the expand parameter.: $ref: ./examples/SqlMiGetDatabaseMigrationExpanded.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Sql Managedinstances Managedinstancename Providers Microsoft Datamigration Databasemigrations Targetdbname put: tags: - DatabaseMigrations description: Create a new database migration to a given SQL Managed Instance. operationId: microsoftAzureDatabasemigrationssqlmiCreateorupdate parameters: - $ref: '#/parameters/ResourceGroupParameter' - name: managedInstanceName in: path required: true type: string - $ref: '#/parameters/TargetDbNameParameter' - name: parameters in: body description: Details of SqlMigrationService resource. required: true schema: $ref: '#/definitions/DatabaseMigrationSqlMi' - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Successfully updated the Database Migration resource. schema: $ref: '#/definitions/DatabaseMigrationSqlMi' '201': description: Successfully created the Database Migration resource. schema: $ref: '#/definitions/DatabaseMigrationSqlMi' default: description: "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was provided for parameter '{0}'.\n\n * 400 GenericUser - User Failure when calling other Resource Provider.\n\n * 400 OperationIdNotFound - Operation ID '{0}' not found.\n\n * 400 OperationTypeNotFound - Operation Type '{0}' not found.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 InvalidStorageAccount - Invalid storage account: '{0}'. Only BlockBlobStorage kind is supported for premium tier.\n\n * 400 InvalidLocation - Invalid Location: '{0}'. Location should match selected Azure target location '{1}'.\n\n * 400 MigrationNotReadyForCancelError - Database '{0}' is not ready for Cancel operation\n\n * 400 RestoreJobCompletedDuringCancel - Migration cannot be canceled as Restore Job was completed during the cancel process. Target server:'{0}', Target database: '{1}'.\n\n * 400 SqlVmGenericUserError - \n\n * 400 IntegrationRuntimeIsNotSelfHosted - Integration Runtime is not self-hosted for subscription '{0}' resource group '{1}' and name '{2}'\n\n * 400 MigrationNotReadyForCutoverError - Database '{0}' is not ready for Cutover operation\n\n * 400 CutoverFailedOrCancelled - Cutover failed or cancelled for database '{0}'. Error details: '{1}'\n\n * 400 MigrationCancelFailed - Cancel could not be performed on operation '{0}' for database '{1}'. This can happen if the migration with MigrationId '{0}' is already completed or canceled. Please check the migration for details.\n\n * 400 TestConnectionFailed - Failed to test connections using provided Integration Runtime. Error details: '{0}'\n\n * 400 CutoverNotAllowedMigrationCompleteError - Cutover is not allowed as migration for database '{0}' is already complete\n\n * 400 IntegrationRuntimeIsNotOnline - Integration Runtime '{0}' is not online for resource group '{1}' subscription '{2}'\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 GenericSystem - System Failure when calling other Resource Provider.\n\n * 500 CancelVmRestoreJobFailed - Failed to cancel VM restore job. Target server:'{0}', Target database: '{1}', Error details: '{2}'.\n\n * 500 AdfCleanupFailureAfterMigration - Failed to clean up ADF resources after migration has completed successfully. Target server:'{0}', Target database: '{1}', Error details: '{2}'.\n\n * 500 CancelMigrationFailed - Failed to cancel migration. Target server:'{0}', Target database: '{1}', Migration Id: '{2}', Error details: '{3}'." x-ms-long-running-operation: true x-ms-examples: Create or Update Database Migration resource with Minimum parameters.: $ref: ./examples/SqlMiCreateOrUpdateDatabaseMigrationMIN.json Create or Update Database Migration resource with Maximum parameters.: $ref: ./examples/SqlMiCreateOrUpdateDatabaseMigrationMAX.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Sql Managedinstances Managedinstancename Providers Microsoft Datamigration Databasemigrations Targetdbname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/providers/Microsoft.DataMigration/databaseMigrations/{targetDbName}/cancel : post: tags: - DatabaseMigrations description: Stop in-progress database migration to SQL Managed Instance. operationId: microsoftAzureDatabasemigrationssqlmiCancel parameters: - $ref: '#/parameters/ResourceGroupParameter' - name: managedInstanceName in: path required: true type: string - $ref: '#/parameters/TargetDbNameParameter' - name: parameters in: body description: Required migration operation ID for which cancel will be initiated. required: true schema: $ref: '#/definitions/MigrationOperationInput' - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Successfully canceled ongoing migration. '202': description: Accepted cancellation of ongoing migration. default: description: "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was provided for parameter '{0}'.\n\n * 400 GenericUser - User Failure when calling other Resource Provider.\n\n * 400 OperationIdNotFound - Operation ID '{0}' not found.\n\n * 400 OperationTypeNotFound - Operation Type '{0}' not found.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 InvalidStorageAccount - Invalid storage account: '{0}'. Only BlockBlobStorage kind is supported for premium tier.\n\n * 400 InvalidLocation - Invalid Location: '{0}'. Location should match selected Azure target location '{1}'.\n\n * 400 MigrationNotReadyForCancelError - Database '{0}' is not ready for Cancel operation\n\n * 400 RestoreJobCompletedDuringCancel - Migration cannot be canceled as Restore Job was completed during the cancel process. Target server:'{0}', Target database: '{1}'.\n\n * 400 SqlVmGenericUserError - \n\n * 400 IntegrationRuntimeIsNotSelfHosted - Integration Runtime is not self-hosted for subscription '{0}' resource group '{1}' and name '{2}'\n\n * 400 MigrationNotReadyForCutoverError - Database '{0}' is not ready for Cutover operation\n\n * 400 CutoverFailedOrCancelled - Cutover failed or cancelled for database '{0}'. Error details: '{1}'\n\n * 400 MigrationCancelFailed - Cancel could not be performed on operation '{0}' for database '{1}'. This can happen if the migration with MigrationId '{0}' is already completed or canceled. Please check the migration for details.\n\n * 400 TestConnectionFailed - Failed to test connections using provided Integration Runtime. Error details: '{0}'\n\n * 400 CutoverNotAllowedMigrationCompleteError - Cutover is not allowed as migration for database '{0}' is already complete\n\n * 400 IntegrationRuntimeIsNotOnline - Integration Runtime '{0}' is not online for resource group '{1}' subscription '{2}'\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 GenericSystem - System Failure when calling other Resource Provider.\n\n * 500 CancelVmRestoreJobFailed - Failed to cancel VM restore job. Target server:'{0}', Target database: '{1}', Error details: '{2}'.\n\n * 500 AdfCleanupFailureAfterMigration - Failed to clean up ADF resources after migration has completed successfully. Target server:'{0}', Target database: '{1}', Error details: '{2}'.\n\n * 500 CancelMigrationFailed - Failed to cancel migration. Target server:'{0}', Target database: '{1}', Migration Id: '{2}', Error details: '{3}'." x-ms-long-running-operation: true x-ms-examples: Stop ongoing migration for the database.: $ref: ./examples/SqlMiCancelDatabaseMigration.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Sql Managedinstances Managedinstancename Providers Microsoft Datamigration Databasemigrations Targetdbname Cancel ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/providers/Microsoft.DataMigration/databaseMigrations/{targetDbName}/cutover : post: tags: - DatabaseMigrations description: Initiate cutover for in-progress online database migration to SQL Managed Instance. operationId: microsoftAzureDatabasemigrationssqlmiCutover parameters: - $ref: '#/parameters/ResourceGroupParameter' - name: managedInstanceName in: path required: true type: string - $ref: '#/parameters/TargetDbNameParameter' - name: parameters in: body description: Required migration operation ID for which cutover will be initiated. required: true schema: $ref: '#/definitions/MigrationOperationInput' - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Successful cutover for ongoing migration. '202': description: Accepted cutover request for ongoing migration. default: description: "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was provided for parameter '{0}'.\n\n * 400 GenericUser - User Failure when calling other Resource Provider.\n\n * 400 OperationIdNotFound - Operation ID '{0}' not found.\n\n * 400 OperationTypeNotFound - Operation Type '{0}' not found.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 InvalidStorageAccount - Invalid storage account: '{0}'. Only BlockBlobStorage kind is supported for premium tier.\n\n * 400 InvalidLocation - Invalid Location: '{0}'. Location should match selected Azure target location '{1}'.\n\n * 400 MigrationNotReadyForCancelError - Database '{0}' is not ready for Cancel operation\n\n * 400 RestoreJobCompletedDuringCancel - Migration cannot be canceled as Restore Job was completed during the cancel process. Target server:'{0}', Target database: '{1}'.\n\n * 400 SqlVmGenericUserError - \n\n * 400 IntegrationRuntimeIsNotSelfHosted - Integration Runtime is not self-hosted for subscription '{0}' resource group '{1}' and name '{2}'\n\n * 400 MigrationNotReadyForCutoverError - Database '{0}' is not ready for Cutover operation\n\n * 400 CutoverFailedOrCancelled - Cutover failed or cancelled for database '{0}'. Error details: '{1}'\n\n * 400 MigrationCancelFailed - Cancel could not be performed on operation '{0}' for database '{1}'. This can happen if the migration with MigrationId '{0}' is already completed or canceled. Please check the migration for details.\n\n * 400 TestConnectionFailed - Failed to test connections using provided Integration Runtime. Error details: '{0}'\n\n * 400 CutoverNotAllowedMigrationCompleteError - Cutover is not allowed as migration for database '{0}' is already complete\n\n * 400 IntegrationRuntimeIsNotOnline - Integration Runtime '{0}' is not online for resource group '{1}' subscription '{2}'\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 GenericSystem - System Failure when calling other Resource Provider.\n\n * 500 CancelVmRestoreJobFailed - Failed to cancel VM restore job. Target server:'{0}', Target database: '{1}', Error details: '{2}'.\n\n * 500 AdfCleanupFailureAfterMigration - Failed to clean up ADF resources after migration has completed successfully. Target server:'{0}', Target database: '{1}', Error details: '{2}'.\n\n * 500 CancelMigrationFailed - Failed to cancel migration. Target server:'{0}', Target database: '{1}', Migration Id: '{2}', Error details: '{3}'." x-ms-long-running-operation: true x-ms-examples: Cutover online migration operation for the database.: $ref: ./examples/SqlMiCutoverDatabaseMigration.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Sql Managedinstances Managedinstancename Providers Microsoft Datamigration Databasemigrations Targetdbname Cutover ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}/providers/Microsoft.DataMigration/databaseMigrations/{targetDbName} : get: tags: - DatabaseMigrations description: Retrieve the specified database migration for a given SQL VM. operationId: microsoftAzureDatabasemigrationssqlvmGet parameters: - $ref: '#/parameters/ResourceGroupParameter' - name: sqlVirtualMachineName in: path required: true type: string - $ref: '#/parameters/TargetDbNameParameter' - name: migrationOperationId in: query 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. required: false type: string format: uuid - name: $expand in: query description: Complete migration details be included in the response. required: false type: string - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Successfully retrieved the Database Migration resource. schema: $ref: '#/definitions/DatabaseMigrationSqlVm' default: description: "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was provided for parameter '{0}'.\n\n * 400 GenericUser - User Failure when calling other Resource Provider.\n\n * 400 OperationIdNotFound - Operation ID '{0}' not found.\n\n * 400 OperationTypeNotFound - Operation Type '{0}' not found.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 TestConnectionFailed - Failed to test connections using provided Integration Runtime. Error details: '{0}'\n\n * 400 CutoverNotAllowedMigrationCompleteError - Cutover is not allowed as migration for database '{0}' is already complete\n\n * 400 IntegrationRuntimeIsNotOnline - Integration Runtime '{0}' is not online for resource group '{1}' subscription '{2}'\n\n * 400 InvalidStorageAccount - Invalid storage account: '{0}'. Only BlockBlobStorage kind is supported for premium tier.\n\n * 400 InvalidLocation - Invalid Location: '{0}'. Location should match selected Azure target location '{1}'.\n\n * 400 MigrationNotReadyForCancelError - Database '{0}' is not ready for Cancel operation\n\n * 400 RestoreJobCompletedDuringCancel - Migration cannot be canceled as Restore Job was completed during the cancel process. Target server:'{0}', Target database: '{1}'.\n\n * 400 SqlVmGenericUserError - {0}\n\n * 400 RequestFailed - Request to the resource '{0}' failed. Error code : '{1}'. HTTP status code : '{2}'. Error message : '{3}'.\n\n * 400 InvalidContainerName - Invalid storage account container name: '{0}'. Container name 'backup' is not supported in SQL Managed Instance.\n\n * 400 IntegrationRuntimeIsNotSelfHosted - Integration Runtime is not self-hosted for subscription '{0}' resource group '{1}' and name '{2}'\n\n * 400 MigrationNotReadyForCutoverError - Database '{0}' is not ready for Cutover operation\n\n * 400 CutoverFailedOrCancelled - Cutover failed or cancelled for database '{0}'. Error details: '{1}'\n\n * 400 MigrationCancelFailed - Cancel could not be performed on operation '{0}' for database '{1}'. This can happen if the migration with MigrationId '{0}' is already completed or canceled. Please check the migration for details.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 405 SubscriptionNotReady - Subscription is not in Ready state.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 GenericSystem - System Failure when calling other Resource Provider.\n\n * 500 CancelVmRestoreJobFailed - Failed to cancel VM restore job. Target server:'{0}', Target database: '{1}', Error details: '{2}'.\n\n * 500 AdfCleanupFailureAfterMigration - Failed to clean up ADF resources after migration has completed successfully. Target server:'{0}', Target database: '{1}', Error details: '{2}'.\n\n * 500 CancelMigrationFailed - Failed to cancel migration. Target server:'{0}', Target database: '{1}', Migration Id: '{2}', Error details: '{3}'." x-ms-examples: Get Sql VM database Migration without the expand parameter.: $ref: ./examples/SqlVmGetDatabaseMigration.json Get Sql VM database Migration with the expand parameter.: $ref: ./examples/SqlVmGetDatabaseMigrationExpanded.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Sqlvirtualmachine Sqlvirtualmachines Sqlvirtualmachinename Providers Microsoft Datamigration Databasemigrations Targetdbname put: tags: - DatabaseMigrations description: Create a new database migration to a given SQL VM. operationId: microsoftAzureDatabasemigrationssqlvmCreateorupdate parameters: - $ref: '#/parameters/ResourceGroupParameter' - name: sqlVirtualMachineName in: path required: true type: string - $ref: '#/parameters/TargetDbNameParameter' - name: parameters in: body description: Details of SqlMigrationService resource. required: true schema: $ref: '#/definitions/DatabaseMigrationSqlVm' - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Successfully updated the Database Migration resource. schema: $ref: '#/definitions/DatabaseMigrationSqlVm' '201': description: Successfully created the Database Migration resource. schema: $ref: '#/definitions/DatabaseMigrationSqlVm' default: description: "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was provided for parameter '{0}'.\n\n * 400 GenericUser - User Failure when calling other Resource Provider.\n\n * 400 OperationIdNotFound - Operation ID '{0}' not found.\n\n * 400 OperationTypeNotFound - Operation Type '{0}' not found.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 TestConnectionFailed - Failed to test connections using provided Integration Runtime. Error details: '{0}'\n\n * 400 CutoverNotAllowedMigrationCompleteError - Cutover is not allowed as migration for database '{0}' is already complete\n\n * 400 IntegrationRuntimeIsNotOnline - Integration Runtime '{0}' is not online for resource group '{1}' subscription '{2}'\n\n * 400 InvalidStorageAccount - Invalid storage account: '{0}'. Only BlockBlobStorage kind is supported for premium tier.\n\n * 400 InvalidLocation - Invalid Location: '{0}'. Location should match selected Azure target location '{1}'.\n\n * 400 MigrationNotReadyForCancelError - Database '{0}' is not ready for Cancel operation\n\n * 400 RestoreJobCompletedDuringCancel - Migration cannot be canceled as Restore Job was completed during the cancel process. Target server:'{0}', Target database: '{1}'.\n\n * 400 SqlVmGenericUserError - {0}\n\n * 400 RequestFailed - Request to the resource '{0}' failed. Error code : '{1}'. HTTP status code : '{2}'. Error message : '{3}'.\n\n * 400 InvalidContainerName - Invalid storage account container name: '{0}'. Container name 'backup' is not supported in SQL Managed Instance.\n\n * 400 IntegrationRuntimeIsNotSelfHosted - Integration Runtime is not self-hosted for subscription '{0}' resource group '{1}' and name '{2}'\n\n * 400 MigrationNotReadyForCutoverError - Database '{0}' is not ready for Cutover operation\n\n * 400 CutoverFailedOrCancelled - Cutover failed or cancelled for database '{0}'. Error details: '{1}'\n\n * 400 MigrationCancelFailed - Cancel could not be performed on operation '{0}' for database '{1}'. This can happen if the migration with MigrationId '{0}' is already completed or canceled. Please check the migration for details.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 405 SubscriptionNotReady - Subscription is not in Ready state.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 GenericSystem - System Failure when calling other Resource Provider.\n\n * 500 CancelVmRestoreJobFailed - Failed to cancel VM restore job. Target server:'{0}', Target database: '{1}', Error details: '{2}'.\n\n * 500 AdfCleanupFailureAfterMigration - Failed to clean up ADF resources after migration has completed successfully. Target server:'{0}', Target database: '{1}', Error details: '{2}'.\n\n * 500 CancelMigrationFailed - Failed to cancel migration. Target server:'{0}', Target database: '{1}', Migration Id: '{2}', Error details: '{3}'." x-ms-long-running-operation: true x-ms-examples: Create or Update Database Migration resource with Minimum parameters.: $ref: ./examples/SqlVmCreateOrUpdateDatabaseMigrationMIN.json Create or Update Database Migration resource with Maximum parameters.: $ref: ./examples/SqlVmCreateOrUpdateDatabaseMigrationMAX.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Sqlvirtualmachine Sqlvirtualmachines Sqlvirtualmachinename Providers Microsoft Datamigration Databasemigrations Targetdbname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}/providers/Microsoft.DataMigration/databaseMigrations/{targetDbName}/cancel : post: tags: - DatabaseMigrations description: Stop in-progress database migration to SQL VM. operationId: microsoftAzureDatabasemigrationssqlvmCancel parameters: - $ref: '#/parameters/ResourceGroupParameter' - name: sqlVirtualMachineName in: path required: true type: string - $ref: '#/parameters/TargetDbNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/MigrationOperationInput' - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Successfully canceled ongoing migration. '202': description: Accepted cancellation of ongoing migration. default: description: "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was provided for parameter '{0}'.\n\n * 400 GenericUser - User Failure when calling other Resource Provider.\n\n * 400 OperationIdNotFound - Operation ID '{0}' not found.\n\n * 400 OperationTypeNotFound - Operation Type '{0}' not found.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 TestConnectionFailed - Failed to test connections using provided Integration Runtime. Error details: '{0}'\n\n * 400 CutoverNotAllowedMigrationCompleteError - Cutover is not allowed as migration for database '{0}' is already complete\n\n * 400 IntegrationRuntimeIsNotOnline - Integration Runtime '{0}' is not online for resource group '{1}' subscription '{2}'\n\n * 400 InvalidStorageAccount - Invalid storage account: '{0}'. Only BlockBlobStorage kind is supported for premium tier.\n\n * 400 InvalidLocation - Invalid Location: '{0}'. Location should match selected Azure target location '{1}'.\n\n * 400 MigrationNotReadyForCancelError - Database '{0}' is not ready for Cancel operation\n\n * 400 RestoreJobCompletedDuringCancel - Migration cannot be canceled as Restore Job was completed during the cancel process. Target server:'{0}', Target database: '{1}'.\n\n * 400 SqlVmGenericUserError - {0}\n\n * 400 RequestFailed - Request to the resource '{0}' failed. Error code : '{1}'. HTTP status code : '{2}'. Error message : '{3}'.\n\n * 400 InvalidContainerName - Invalid storage account container name: '{0}'. Container name 'backup' is not supported in SQL Managed Instance.\n\n * 400 IntegrationRuntimeIsNotSelfHosted - Integration Runtime is not self-hosted for subscription '{0}' resource group '{1}' and name '{2}'\n\n * 400 MigrationNotReadyForCutoverError - Database '{0}' is not ready for Cutover operation\n\n * 400 CutoverFailedOrCancelled - Cutover failed or cancelled for database '{0}'. Error details: '{1}'\n\n * 400 MigrationCancelFailed - Cancel could not be performed on operation '{0}' for database '{1}'. This can happen if the migration with MigrationId '{0}' is already completed or canceled. Please check the migration for details.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 405 SubscriptionNotReady - Subscription is not in Ready state.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 GenericSystem - System Failure when calling other Resource Provider.\n\n * 500 CancelVmRestoreJobFailed - Failed to cancel VM restore job. Target server:'{0}', Target database: '{1}', Error details: '{2}'.\n\n * 500 AdfCleanupFailureAfterMigration - Failed to clean up ADF resources after migration has completed successfully. Target server:'{0}', Target database: '{1}', Error details: '{2}'.\n\n * 500 CancelMigrationFailed - Failed to cancel migration. Target server:'{0}', Target database: '{1}', Migration Id: '{2}', Error details: '{3}'." x-ms-long-running-operation: true x-ms-examples: Stop ongoing migration for the database.: $ref: ./examples/SqlVmCancelDatabaseMigration.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Sqlvirtualmachine Sqlvirtualmachines Sqlvirtualmachinename Providers Microsoft Datamigration Databasemigrations Targetdbname Cancel ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}/providers/Microsoft.DataMigration/databaseMigrations/{targetDbName}/cutover : post: tags: - DatabaseMigrations description: Initiate cutover for in-progress online database migration to SQL VM. operationId: microsoftAzureDatabasemigrationssqlvmCutover parameters: - $ref: '#/parameters/ResourceGroupParameter' - name: sqlVirtualMachineName in: path required: true type: string - $ref: '#/parameters/TargetDbNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/MigrationOperationInput' - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Successful cutover for ongoing migration. '202': description: Accepted cutover request for ongoing migration. default: description: "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was provided for parameter '{0}'.\n\n * 400 GenericUser - User Failure when calling other Resource Provider.\n\n * 400 OperationIdNotFound - Operation ID '{0}' not found.\n\n * 400 OperationTypeNotFound - Operation Type '{0}' not found.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 TestConnectionFailed - Failed to test connections using provided Integration Runtime. Error details: '{0}'\n\n * 400 CutoverNotAllowedMigrationCompleteError - Cutover is not allowed as migration for database '{0}' is already complete\n\n * 400 IntegrationRuntimeIsNotOnline - Integration Runtime '{0}' is not online for resource group '{1}' subscription '{2}'\n\n * 400 InvalidStorageAccount - Invalid storage account: '{0}'. Only BlockBlobStorage kind is supported for premium tier.\n\n * 400 InvalidLocation - Invalid Location: '{0}'. Location should match selected Azure target location '{1}'.\n\n * 400 MigrationNotReadyForCancelError - Database '{0}' is not ready for Cancel operation\n\n * 400 RestoreJobCompletedDuringCancel - Migration cannot be canceled as Restore Job was completed during the cancel process. Target server:'{0}', Target database: '{1}'.\n\n * 400 SqlVmGenericUserError - {0}\n\n * 400 RequestFailed - Request to the resource '{0}' failed. Error code : '{1}'. HTTP status code : '{2}'. Error message : '{3}'.\n\n * 400 InvalidContainerName - Invalid storage account container name: '{0}'. Container name 'backup' is not supported in SQL Managed Instance.\n\n * 400 IntegrationRuntimeIsNotSelfHosted - Integration Runtime is not self-hosted for subscription '{0}' resource group '{1}' and name '{2}'\n\n * 400 MigrationNotReadyForCutoverError - Database '{0}' is not ready for Cutover operation\n\n * 400 CutoverFailedOrCancelled - Cutover failed or cancelled for database '{0}'. Error details: '{1}'\n\n * 400 MigrationCancelFailed - Cancel could not be performed on operation '{0}' for database '{1}'. This can happen if the migration with MigrationId '{0}' is already completed or canceled. Please check the migration for details.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 405 SubscriptionNotReady - Subscription is not in Ready state.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 GenericSystem - System Failure when calling other Resource Provider.\n\n * 500 CancelVmRestoreJobFailed - Failed to cancel VM restore job. Target server:'{0}', Target database: '{1}', Error details: '{2}'.\n\n * 500 AdfCleanupFailureAfterMigration - Failed to clean up ADF resources after migration has completed successfully. Target server:'{0}', Target database: '{1}', Error details: '{2}'.\n\n * 500 CancelMigrationFailed - Failed to cancel migration. Target server:'{0}', Target database: '{1}', Migration Id: '{2}', Error details: '{3}'." x-ms-long-running-operation: true x-ms-examples: Cutover online migration operation for the database.: $ref: ./examples/SqlVmCutoverDatabaseMigration.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Sqlvirtualmachine Sqlvirtualmachines Sqlvirtualmachinename Providers Microsoft Datamigration Databasemigrations Targetdbname Cutover definitions: ProxyResource: type: object properties: id: type: string readOnly: true name: type: string readOnly: true type: type: string readOnly: true systemData: $ref: '#/definitions/SystemData' description: Metadata pertaining to creation and last modification of the resource. readOnly: true MongoMigrationProgressDetails: description: Detailed status of collection migration. type: object properties: migrationStatus: enum: - NotStarted - InProgress - Completed - Failed - Canceled type: string readOnly: true x-ms-enum: name: MongoMigrationStatus modelAsString: true description: Migration Status migrationError: description: Migration Error type: string readOnly: true sourceDocumentCount: format: int64 description: Source Document Count type: integer readOnly: true processedDocumentCount: format: int64 description: Processed Document Count type: integer readOnly: true durationInSeconds: format: int32 description: Migration duration type: integer readOnly: true ErrorInfo: description: Error details type: object properties: code: description: Error code. type: string readOnly: true message: description: Error message. type: string readOnly: true DatabaseMigrationSqlVm: description: Database Migration Resource for SQL Virtual Machine. type: object allOf: - $ref: '#/definitions/ProxyResource' properties: properties: $ref: '#/definitions/DatabaseMigrationPropertiesSqlVm' x-ms-client-flatten: false x-ms-azure-resource: true CopyProgressDetails: description: Details on progress of ADF copy activity type: object properties: tableName: description: Table Name type: string readOnly: true status: description: Status of the Copy activity (InProgress, Succeeded, Failed, Canceled). type: string readOnly: true parallelCopyType: description: Type of parallel copy (Dynamic range, Physical partition, none). type: string readOnly: true usedParallelCopies: format: int32 description: The degree of parallelization. type: integer readOnly: true dataRead: format: int64 description: Bytes read type: integer readOnly: true dataWritten: format: int64 description: Bytes written type: integer readOnly: true rowsRead: format: int64 description: Rows read type: integer readOnly: true rowsCopied: format: int64 description: Rows Copied type: integer readOnly: true copyStart: format: date-time description: Copy Start type: string readOnly: true copyThroughput: format: double description: Copy throughput in KBps type: number readOnly: true copyDuration: format: int32 description: Copy Duration in seconds type: integer readOnly: true DatabaseMigrationSqlMi: description: Database Migration Resource for SQL Managed Instance. type: object allOf: - $ref: '#/definitions/ProxyResource' properties: properties: $ref: '#/definitions/DatabaseMigrationPropertiesSqlMi' x-ms-client-flatten: false x-ms-azure-resource: true AzureBlob: description: Azure Blob Details type: object properties: storageAccountResourceId: description: Resource Id of the storage account where backups are stored. type: string accountKey: description: Storage Account Key. type: string x-ms-secret: true blobContainerName: description: Blob container name where backups are stored. type: string OfflineConfiguration: description: Offline configuration type: object properties: offline: description: Offline migration type: 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. type: string DatabaseMigrationCosmosDbMongo: description: Database Migration Resource for Mongo to CosmosDb. type: object allOf: - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource properties: properties: $ref: '#/definitions/DatabaseMigrationPropertiesCosmosDbMongo' x-ms-client-flatten: true x-ms-azure-resource: true MigrationStatusDetails: description: Detailed status of current migration. type: object properties: migrationState: description: Current State of Migration. type: string readOnly: true fullBackupSetInfo: $ref: '#/definitions/SqlBackupSetInfo' description: Details of full backup set. readOnly: true lastRestoredBackupSetInfo: $ref: '#/definitions/SqlBackupSetInfo' description: Last applied backup set information. readOnly: true activeBackupSets: description: Backup sets that are currently active. type: array items: $ref: '#/definitions/SqlBackupSetInfo' readOnly: true invalidFiles: description: Files that are not valid backup files. type: array items: type: string readOnly: true blobContainerName: description: Name of blob container. type: string readOnly: true isFullBackupRestored: description: Whether full backup has been applied to the target database or not. type: boolean readOnly: true restoreBlockingReason: description: Restore blocking reason, if any type: string readOnly: true completeRestoreErrorMessage: description: Complete restore error message, if any type: string readOnly: true fileUploadBlockingErrors: description: File upload blocking errors, if any. type: array items: type: string readOnly: true currentRestoringFilename: description: File name that is currently being restored. type: string readOnly: true lastRestoredFilename: description: Last restored file name. type: string readOnly: true pendingLogBackupsCount: format: int32 description: Total pending log backups. type: integer readOnly: true SystemData: type: object readOnly: true properties: createdBy: type: string createdByType: enum: - User - Application - ManagedIdentity - Key type: string x-ms-enum: name: createdByType modelAsString: true createdAt: format: date-time type: string lastModifiedBy: type: string lastModifiedByType: enum: - User - Application - ManagedIdentity - Key type: string x-ms-enum: name: createdByType modelAsString: true lastModifiedAt: format: date-time type: string SqlFileShare: description: File share type: object properties: path: description: Location as SMB share or local drive where backups are placed. type: string username: description: Username to access the file share location for backups. type: string password: description: Password for username to access file share location. type: string format: password x-ms-secret: true x-ms-mutability: - create - update SqlBackupSetInfo: description: Information of backup set type: object properties: backupSetId: format: uuid description: Backup set id. type: string readOnly: true firstLSN: description: First LSN of the backup set. type: string readOnly: true lastLSN: description: Last LSN of the backup set. type: string readOnly: true backupType: description: Backup type. type: string readOnly: true listOfBackupFiles: description: List of files in the backup set. type: array items: $ref: '#/definitions/SqlBackupFileInfo' readOnly: true backupStartDate: format: date-time description: Backup start date. type: string readOnly: true backupFinishDate: format: date-time description: Backup end time. type: string readOnly: true isBackupRestored: description: Whether this backup set has been restored or not. type: boolean readOnly: true hasBackupChecksums: description: Has Backup Checksums type: boolean readOnly: true familyCount: format: int32 description: Media family count type: integer readOnly: true ignoreReasons: description: The reasons why the backup set is ignored type: array items: type: string readOnly: true SqlBackupFileInfo: description: Information of backup file type: object properties: fileName: description: File name. type: string readOnly: true status: description: Status of the file. (Initial, Uploading, Uploaded, Restoring, Restored or Skipped) type: string readOnly: true totalSize: format: int64 description: File size in bytes type: integer readOnly: true dataRead: format: int64 description: Bytes read type: integer readOnly: true dataWritten: format: int64 description: Bytes written type: integer readOnly: true copyThroughput: format: double description: Copy throughput in KBps type: number readOnly: true copyDuration: format: int32 description: Copy Duration in seconds type: integer readOnly: true familySequenceNumber: format: int32 description: Media family sequence number type: integer readOnly: true BackupConfiguration: description: Backup Configuration type: object properties: sourceLocation: $ref: '#/definitions/SourceLocation' description: Source location of backups. targetLocation: $ref: '#/definitions/TargetLocation' description: Target location for copying backups. DatabaseMigrationPropertiesSqlMi: x-ms-discriminator-value: SqlMi allOf: - $ref: '#/definitions/DatabaseMigrationProperties' description: Database Migration Resource properties for SQL Managed Instance. type: object properties: migrationStatusDetails: $ref: '#/definitions/MigrationStatusDetails' description: Detailed migration status. Not included by default. readOnly: true backupConfiguration: $ref: '#/definitions/BackupConfiguration' description: Backup configuration info. offlineConfiguration: $ref: '#/definitions/OfflineConfiguration' description: Offline configuration. DatabaseMigrationProperties: required: - kind allOf: - $ref: '#/definitions/DatabaseMigrationBaseProperties' description: Database Migration Resource properties. type: object properties: sourceSqlConnection: $ref: '#/definitions/SqlConnectionInformation' description: Source SQL Server connection details. sourceDatabaseName: description: Name of the source database. type: string sourceServerName: description: Name of the source sql server. type: string readOnly: true targetDatabaseCollation: description: Database collation to be used for the target database. type: string discriminator: kind TargetLocation: description: Target Location details for optional copy of backups type: object properties: storageAccountResourceId: description: Resource Id of the storage account copying backups. type: string accountKey: description: Storage Account Key. type: string SourceLocation: description: Source Location details of backups. type: object properties: fileShare: $ref: '#/definitions/SqlFileShare' description: Source File share. azureBlob: $ref: '#/definitions/AzureBlob' description: Source Azure Blob. fileStorageType: description: Backup storage Type. type: string readOnly: true SqlDbMigrationStatusDetails: description: Detailed status of current Sql Db migration. type: object properties: migrationState: description: Current State of Migration. type: string readOnly: true sqlDataCopyErrors: description: Sql Data Copy errors, if any. type: array items: type: string readOnly: true listOfCopyProgressDetails: description: Details on progress of ADF copy activities. type: array items: $ref: '#/definitions/CopyProgressDetails' x-ms-identifiers: [] readOnly: true SqlDbOfflineConfiguration: description: Offline configuration type: object properties: offline: description: Offline migration type: boolean readOnly: true DatabaseMigrationPropertiesCosmosDbMongo: x-ms-discriminator-value: MongoToCosmosDbMongo allOf: - $ref: '#/definitions/DatabaseMigrationBaseProperties' description: Database Migration Resource properties for CosmosDb for Mongo. type: object properties: sourceMongoConnection: $ref: '#/definitions/MongoConnectionInformation' description: Source Mongo connection details. targetMongoConnection: $ref: '#/definitions/MongoConnectionInformation' description: Target Cosmos DB Mongo connection details. collectionList: description: List of Mongo Collections to be migrated. type: array items: $ref: '#/definitions/MongoMigrationCollection' DatabaseMigrationSqlDb: description: Database Migration Resource for SQL Database. type: object allOf: - $ref: '#/definitions/ProxyResource' properties: properties: $ref: '#/definitions/DatabaseMigrationPropertiesSqlDb' x-ms-client-flatten: false x-ms-azure-resource: true DatabaseMigrationBaseProperties: required: - kind description: Database Migration Base Resource properties. type: object properties: kind: enum: - SqlMi - SqlVm - SqlDb - MongoToCosmosDbMongo type: string x-ms-enum: name: ResourceType modelAsString: true scope: description: Resource Id of the target resource. type: string x-ms-mutability: - read - create provisioningState: enum: - Provisioning - Updating - Succeeded - Failed - Canceled type: string readOnly: true x-ms-enum: name: ProvisioningState modelAsString: true description: Provisioning State of migration. ProvisioningState as Succeeded implies that validations have been performed and migration has started. migrationStatus: description: Migration status. type: string readOnly: true startedOn: format: date-time description: Database migration start time. type: string readOnly: true endedOn: format: date-time description: Database migration end time. type: string readOnly: true migrationService: description: Resource Id of the Migration Service. type: string format: arm-id x-ms-arm-id-details: allowedResources: - type: Microsoft.DataMigration/migrationServices - type: Microsoft.DataMigration/sqlMigrationServices migrationOperationId: description: ID for current migration operation. type: string migrationFailureError: $ref: '#/definitions/ErrorInfo' description: Error details in case of migration failure. readOnly: true provisioningError: description: Error message for migration provisioning failure, if any. type: string discriminator: kind DatabaseMigrationPropertiesSqlVm: x-ms-discriminator-value: SqlVm allOf: - $ref: '#/definitions/DatabaseMigrationProperties' description: Database Migration Resource properties for SQL Virtual Machine. type: object properties: migrationStatusDetails: $ref: '#/definitions/MigrationStatusDetails' description: Detailed migration status. Not included by default. readOnly: true backupConfiguration: $ref: '#/definitions/BackupConfiguration' description: Backup configuration info. offlineConfiguration: $ref: '#/definitions/OfflineConfiguration' description: Offline configuration. MongoMigrationCollection: description: Mongo source and target database and collection details. type: object properties: sourceDatabase: description: Source database name. type: string sourceCollection: description: Source collection name. type: string targetDatabase: description: Target database name. type: string targetCollection: description: Target collection name. type: string migrationProgressDetails: $ref: '#/definitions/MongoMigrationProgressDetails' description: Detailed migration status. Not included by default. readOnly: true MigrationOperationInput: description: Migration Operation Input type: object properties: migrationOperationId: format: uuid description: ID tracking migration operation. type: string DatabaseMigrationPropertiesSqlDb: x-ms-discriminator-value: SqlDb allOf: - $ref: '#/definitions/DatabaseMigrationProperties' description: Database Migration Resource properties for SQL database. type: object properties: migrationStatusDetails: $ref: '#/definitions/SqlDbMigrationStatusDetails' description: Detailed migration status. Not included by default. readOnly: true targetSqlConnection: $ref: '#/definitions/SqlConnectionInformation' description: Target SQL DB connection details. offlineConfiguration: $ref: '#/definitions/SqlDbOfflineConfiguration' description: Offline configuration. readOnly: true tableList: description: List of tables to copy. type: array items: type: string DatabaseMigrationCosmosDbMongoListResult: description: A list of Database Migrations. type: object properties: value: type: array items: $ref: '#/definitions/DatabaseMigrationCosmosDbMongo' readOnly: true nextLink: type: string readOnly: true SqlConnectionInformation: description: Source SQL Connection type: object properties: dataSource: description: Data source. type: string authentication: description: Authentication type. type: string userName: description: User name to connect to source SQL. type: string password: description: Password to connect to source SQL. type: string format: password x-ms-secret: true encryptConnection: description: Whether to encrypt connection or not. type: boolean trustServerCertificate: description: Whether to trust server certificate or not. type: boolean MongoConnectionInformation: description: Mongo Connection type: object properties: host: description: Host of mongo connection. type: string port: format: int32 description: Port of mongo connection. type: integer userName: description: User name to connect to Mongo. type: string x-ms-mutability: - create - update password: description: Password to connect to Mongo. type: string format: password x-ms-secret: true x-ms-mutability: - create - update useSsl: description: Whether to UseSsl or UseTls to connect to Mongo. Default is true. type: boolean x-ms-mutability: - create - update connectionString: description: ConnectionString to connect to Mongo. type: string x-ms-secret: true x-ms-mutability: - create - update parameters: TargetDbNameParameter: name: targetDbName in: path description: The name of the target database. required: true type: string x-ms-parameter-location: method TargetResourceNameParameter: name: targetResourceName in: path description: The name of the target resource/account. required: true type: string pattern: ^[A-Za-z][A-Za-z0-9_-]*$ x-ms-parameter-location: method ApiVersionParameter: name: api-version in: query description: API version to use for the request. required: true type: string x-ms-parameter-location: client SubscriptionIdParameter: name: subscriptionId in: path description: Subscription ID that identifies an Azure subscription. required: true type: string x-ms-parameter-location: client ResourceGroupParameter: name: resourceGroupName in: path 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 type: string x-ms-parameter-location: method MigrationNameParameter: name: migrationName in: path description: Name of the migration. required: true type: string pattern: ^[A-Za-z][A-Za-z0-9_-]*$ x-ms-parameter-location: method x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'