sql_migration_services

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

Overview

Name	sql_migration_services
Type	Resource
Id	azure.data_migration.sql_migration_services

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the Migration Service.

Name	Datatype	Description
id	string
name	string
location	string
properties	object	The SQL Migration Service properties.
systemData	object
tags	object
type	string

list_by_resource_group

Successfully retrieved the Migration SErvices in the resource group.

Name	Datatype	Description
id	string
name	string
location	string
properties	object	The SQL Migration Service properties.
systemData	object
tags	object
type	string

list_by_subscription

Successfully retrieved the Migration Services in the Subscription.

Name	Datatype	Description
id	string
name	string
location	string
properties	object	The SQL Migration Service properties.
systemData	object
tags	object
type	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, sqlMigrationServiceName, subscriptionId		Retrieve the Database Migration Service
list_by_resource_group	select	resourceGroupName, subscriptionId		Retrieve all SQL migration services in the resource group.
list_by_subscription	select	subscriptionId		Retrieve all SQL migration services in the subscriptions.
create_or_update	insert	resourceGroupName, sqlMigrationServiceName, subscriptionId		Create or Update Database Migration Service.
update	update	resourceGroupName, sqlMigrationServiceName, subscriptionId		Update Database Migration Service.
delete	delete	resourceGroupName, sqlMigrationServiceName, subscriptionId		Delete Database Migration Service.
regenerate_auth_keys	exec	resourceGroupName, sqlMigrationServiceName, subscriptionId		Regenerate a new set of Authentication Keys for Self Hosted Integration Runtime.
delete_node	exec	resourceGroupName, sqlMigrationServiceName, subscriptionId		Delete the integration runtime node.

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.
sqlMigrationServiceName	string	Name of the SQL Migration Service.
subscriptionId	string	Subscription ID that identifies an Azure subscription.

SELECT examples

get

Retrieve the Database Migration Service

SELECT
id,
name,
location,
properties,
systemData,
tags,
type
FROM azure.data_migration.sql_migration_services
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND sqlMigrationServiceName = '{{ sqlMigrationServiceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_resource_group

Retrieve all SQL migration services in the resource group.

SELECT
id,
name,
location,
properties,
systemData,
tags,
type
FROM azure.data_migration.sql_migration_services
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_subscription

Retrieve all SQL migration services in the subscriptions.

SELECT
id,
name,
location,
properties,
systemData,
tags,
type
FROM azure.data_migration.sql_migration_services
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create or Update Database Migration Service.

INSERT INTO azure.data_migration.sql_migration_services (
data__location,
data__tags,
data__properties,
resourceGroupName,
sqlMigrationServiceName,
subscriptionId
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ sqlMigrationServiceName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: sql_migration_services
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the sql_migration_services resource.
    - name: sqlMigrationServiceName
      value: string
      description: Required parameter for the sql_migration_services resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the sql_migration_services resource.
    - name: location
      value: string
    - name: tags
      value: object
    - name: properties
      value: object
      description: |
        The SQL Migration Service properties.

UPDATE examples

update

Update Database Migration Service.

UPDATE azure.data_migration.sql_migration_services
SET 
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND sqlMigrationServiceName = '{{ sqlMigrationServiceName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete Database Migration Service.

DELETE FROM azure.data_migration.sql_migration_services
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND sqlMigrationServiceName = '{{ sqlMigrationServiceName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

regenerate_auth_keys

Regenerate a new set of Authentication Keys for Self Hosted Integration Runtime.

EXEC azure.data_migration.sql_migration_services.regenerate_auth_keys 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@sqlMigrationServiceName='{{ sqlMigrationServiceName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"keyName": "{{ keyName }}", 
"authKey1": "{{ authKey1 }}", 
"authKey2": "{{ authKey2 }}"
}'
;

delete_node

Delete the integration runtime node.

EXEC azure.data_migration.sql_migration_services.delete_node 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@sqlMigrationServiceName='{{ sqlMigrationServiceName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"nodeName": "{{ nodeName }}", 
"integrationRuntimeName": "{{ integrationRuntimeName }}"
}'
;