database_migrations_sql_dbs

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

Overview

Name	database_migrations_sql_dbs
Type	Resource
Id	azure.data_migration.database_migrations_sql_dbs

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the Database Migration resource.

Name	Datatype	Description
id	string
name	string
properties	object	Database Migration Resource properties for SQL database. (x-ms-discriminator-value: SqlDb)
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, sqlDbInstanceName, targetDbName, subscriptionId	migrationOperationId, $expand	Retrieve the Database Migration resource.
create_or_update	insert	resourceGroupName, sqlDbInstanceName, targetDbName, subscriptionId		Create or Update Database Migration resource.
delete	delete	resourceGroupName, sqlDbInstanceName, targetDbName, subscriptionId	force	Delete Database Migration resource.
cancel	exec	resourceGroupName, sqlDbInstanceName, targetDbName, subscriptionId		Stop 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
resourceGroupName	string	Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
sqlDbInstanceName	string
subscriptionId	string	Subscription ID that identifies an Azure subscription.
targetDbName	string	The name of the target database.
$expand	string	Complete migration details be included in the response.
force	boolean	Optional force delete boolean. If this is provided as true, migration will be deleted even if active.
migrationOperationId	string (uuid)	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.

SELECT examples

get

Retrieve the Database Migration resource.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_migration.database_migrations_sql_dbs
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND sqlDbInstanceName = '{{ sqlDbInstanceName }}' -- required
AND targetDbName = '{{ targetDbName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- 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_dbs (
data__properties,
resourceGroupName,
sqlDbInstanceName,
targetDbName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ sqlDbInstanceName }}',
'{{ targetDbName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: database_migrations_sql_dbs
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the database_migrations_sql_dbs resource.
    - name: sqlDbInstanceName
      value: string
      description: Required parameter for the database_migrations_sql_dbs resource.
    - name: targetDbName
      value: string
      description: Required parameter for the database_migrations_sql_dbs resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the database_migrations_sql_dbs resource.
    - name: properties
      value: object
      description: |
        Database Migration Resource properties for SQL database.

DELETE examples

delete

Delete Database Migration resource.

DELETE FROM azure.data_migration.database_migrations_sql_dbs
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND sqlDbInstanceName = '{{ sqlDbInstanceName }}' --required
AND targetDbName = '{{ targetDbName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND force = '{{ force }}'
;

Lifecycle Methods

cancel

Stop on going migration for the database.

EXEC azure.data_migration.database_migrations_sql_dbs.cancel 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@sqlDbInstanceName='{{ sqlDbInstanceName }}' --required, 
@targetDbName='{{ targetDbName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"migrationOperationId": "{{ migrationOperationId }}"
}'
;