database_migrations_sql_vms

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

Overview

Name	database_migrations_sql_vms
Type	Resource
Id	azure.data_migration.database_migrations_sql_vms

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 Virtual Machine. (x-ms-discriminator-value: SqlVm)
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, sqlVirtualMachineName, targetDbName, subscriptionId	migrationOperationId, $expand	Retrieve the specified database migration for a given SQL VM.
create_or_update	insert	resourceGroupName, sqlVirtualMachineName, targetDbName, subscriptionId		Create a new database migration to a given SQL VM.
cancel	exec	resourceGroupName, sqlVirtualMachineName, targetDbName, subscriptionId		Stop in-progress database migration to SQL VM.
cutover	exec	resourceGroupName, sqlVirtualMachineName, targetDbName, subscriptionId		Initiate cutover for in-progress online database migration to SQL VM.

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.
sqlVirtualMachineName	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.
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 specified database migration for a given SQL VM.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_migration.database_migrations_sql_vms
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND sqlVirtualMachineName = '{{ sqlVirtualMachineName }}' -- required
AND targetDbName = '{{ targetDbName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND migrationOperationId = '{{ migrationOperationId }}'
AND $expand = '{{ $expand }}'
;

INSERT examples

create_or_update

Create a new database migration to a given SQL VM.

INSERT INTO azure.data_migration.database_migrations_sql_vms (
data__properties,
resourceGroupName,
sqlVirtualMachineName,
targetDbName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ sqlVirtualMachineName }}',
'{{ targetDbName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

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

Lifecycle Methods

cancel

Stop in-progress database migration to SQL VM.

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

cutover

Initiate cutover for in-progress online database migration to SQL VM.

EXEC azure.data_migration.database_migrations_sql_vms.cutover 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@sqlVirtualMachineName='{{ sqlVirtualMachineName }}' --required, 
@targetDbName='{{ targetDbName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"migrationOperationId": "{{ migrationOperationId }}"
}'
;