database_migrations_sql_db

Creates, updates, deletes, gets or lists a database_migrations_sql_db resource.

Overview

Name	database_migrations_sql_db
Type	Resource
Id	azure.data_migration.database_migrations_sql_db

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
endedOn	string (date-time)	Database migration end time.
kind	string	Required. SqlDb.
migrationFailureError	object	Error details in case of migration failure.
migrationOperationId	string	ID for current migration operation.
migrationService	string	Resource Id of the Migration Service.
migrationStatus	string	Migration status.
migrationStatusDetails	object	Detailed migration status. Not included by default.
offlineConfiguration	object	Offline configuration.
provisioningError	string	Error message for migration provisioning failure, if any.
provisioningState	string	Provisioning State of migration. ProvisioningState as Succeeded implies that validations have been performed and migration has started. Known values are: "Provisioning", "Updating", "Succeeded", "Failed", and "Canceled". (Provisioning, Updating, Succeeded, Failed, Canceled)
scope	string	Resource Id of the target resource.
sourceDatabaseName	string	Name of the source database.
sourceServerName	string	Name of the source sql server.
sourceSqlConnection	object	Source SQL Server connection details.
sqlServerInstanceId	string	Optional property - Resource Id for the source Sql server instance. Validations are performed on this property to ensure that it follows the correct format.
startedOn	string (date-time)	Database migration start time.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tableList	array	List of tables to copy.
targetDatabaseCollation	string	Database collation to be used for the target database.
targetSqlConnection	object	Target SQL DB connection details.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, sql_db_instance_name, target_db_name, subscription_id	migrationOperationId, $expand	Retrieve the Database Migration resource.
create_or_update	insert	resource_group_name, sql_db_instance_name, target_db_name, subscription_id		Create or Update Database Migration resource.
create_or_update	replace	resource_group_name, sql_db_instance_name, target_db_name, subscription_id		Create or Update Database Migration resource.
delete	delete	resource_group_name, sql_db_instance_name, target_db_name, subscription_id	force	Delete Database Migration resource.
cancel	exec	resource_group_name, sql_db_instance_name, target_db_name, subscription_id		Stop on going migration for the database.
retry	exec	resource_group_name, sql_db_instance_name, target_db_name, subscription_id		Retry on going migration for the database.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
sql_db_instance_name	string	The name of the target SQL DB instance. Required.
subscription_id	string
target_db_name	string	The name of the target database. Required.
$expand	string	Complete migration details be included in the response. Default value is None.
force	boolean	Optional force delete boolean. If this is provided as true, migration will be deleted even if active. Default value is None.
migrationOperationId	string	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. Default value is None.

SELECT examples

get

Retrieve the Database Migration resource.

SELECT
id,
name,
endedOn,
kind,
migrationFailureError,
migrationOperationId,
migrationService,
migrationStatus,
migrationStatusDetails,
offlineConfiguration,
provisioningError,
provisioningState,
scope,
sourceDatabaseName,
sourceServerName,
sourceSqlConnection,
sqlServerInstanceId,
startedOn,
systemData,
tableList,
targetDatabaseCollation,
targetSqlConnection,
type
FROM azure.data_migration.database_migrations_sql_db
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND sql_db_instance_name = '{{ sql_db_instance_name }}' -- required
AND target_db_name = '{{ target_db_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND migrationOperationId = '{{ migrationOperationId }}'
AND $expand = '{{ $expand }}'
;

INSERT examples

create_or_update

Create or Update Database Migration resource.

INSERT INTO azure.data_migration.database_migrations_sql_db (
properties,
resource_group_name,
sql_db_instance_name,
target_db_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ sql_db_instance_name }}',
'{{ target_db_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: database_migrations_sql_db
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the database_migrations_sql_db resource.
  - name: sql_db_instance_name
    value: "{{ sql_db_instance_name }}"
    description: Required parameter for the database_migrations_sql_db resource.
  - name: target_db_name
    value: "{{ target_db_name }}"
    description: Required parameter for the database_migrations_sql_db resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the database_migrations_sql_db resource.
  - name: properties
    description: |
      Database Migration Resource properties for SQL database.
    value:
      kind: "{{ kind }}"
      scope: "{{ scope }}"
      provisioningState: "{{ provisioningState }}"
      migrationStatus: "{{ migrationStatus }}"
      startedOn: "{{ startedOn }}"
      endedOn: "{{ endedOn }}"
      migrationService: "{{ migrationService }}"
      migrationOperationId: "{{ migrationOperationId }}"
      migrationFailureError:
        code: "{{ code }}"
        message: "{{ message }}"
      provisioningError: "{{ provisioningError }}"
      sourceSqlConnection:
        dataSource: "{{ dataSource }}"
        authentication: "{{ authentication }}"
        userName: "{{ userName }}"
        password: "{{ password }}"
        encryptConnection: {{ encryptConnection }}
        trustServerCertificate: {{ trustServerCertificate }}
      sourceDatabaseName: "{{ sourceDatabaseName }}"
      sourceServerName: "{{ sourceServerName }}"
      targetDatabaseCollation: "{{ targetDatabaseCollation }}"
      sqlServerInstanceId: "{{ sqlServerInstanceId }}"
      migrationStatusDetails:
        migrationState: "{{ migrationState }}"
        sqlDataCopyErrors:
          - "{{ sqlDataCopyErrors }}"
        listOfCopyProgressDetails:
          - tableName: "{{ tableName }}"
            status: "{{ status }}"
            parallelCopyType: "{{ parallelCopyType }}"
            usedParallelCopies: {{ usedParallelCopies }}
            dataRead: {{ dataRead }}
            dataWritten: {{ dataWritten }}
            rowsRead: {{ rowsRead }}
            rowsCopied: {{ rowsCopied }}
            copyStart: "{{ copyStart }}"
            copyThroughput: {{ copyThroughput }}
            copyDuration: {{ copyDuration }}
      targetSqlConnection:
        dataSource: "{{ dataSource }}"
        authentication: "{{ authentication }}"
        userName: "{{ userName }}"
        password: "{{ password }}"
        encryptConnection: {{ encryptConnection }}
        trustServerCertificate: {{ trustServerCertificate }}
      offlineConfiguration:
        offline: {{ offline }}
      tableList:
        - "{{ tableList }}"

REPLACE examples

create_or_update

Create or Update Database Migration resource.

REPLACE azure.data_migration.database_migrations_sql_db
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND sql_db_instance_name = '{{ sql_db_instance_name }}' --required
AND target_db_name = '{{ target_db_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete Database Migration resource.

DELETE FROM azure.data_migration.database_migrations_sql_db
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND sql_db_instance_name = '{{ sql_db_instance_name }}' --required
AND target_db_name = '{{ target_db_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND force = '{{ force }}'
;

Lifecycle Methods

cancel

Stop on going migration for the database.

EXEC azure.data_migration.database_migrations_sql_db.cancel 
@resource_group_name='{{ resource_group_name }}' --required, 
@sql_db_instance_name='{{ sql_db_instance_name }}' --required, 
@target_db_name='{{ target_db_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"migrationOperationId": "{{ migrationOperationId }}"
}'
;

retry

Retry on going migration for the database.

EXEC azure.data_migration.database_migrations_sql_db.retry 
@resource_group_name='{{ resource_group_name }}' --required, 
@sql_db_instance_name='{{ sql_db_instance_name }}' --required, 
@target_db_name='{{ target_db_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"migrationOperationId": "{{ migrationOperationId }}"
}'
;