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

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.
integrationRuntimeState	string	Current state of the Integration runtime.
location	string	:vartype location: str
provisioningState	string	Provisioning state to track the async operation status.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	:vartype tags: dict[str, str]
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

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.
integrationRuntimeState	string	Current state of the Integration runtime.
location	string	:vartype location: str
provisioningState	string	Provisioning state to track the async operation status.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	:vartype tags: dict[str, str]
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

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.
integrationRuntimeState	string	Current state of the Integration runtime.
location	string	:vartype location: str
provisioningState	string	Provisioning state to track the async operation status.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	:vartype tags: dict[str, str]
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_migration_service_name, subscription_id		Retrieve the Database Migration Service.
list_by_resource_group	select	resource_group_name, subscription_id		Retrieve all SQL migration services in the resource group.
list_by_subscription	select	subscription_id		Retrieve all SQL migration services in the subscriptions.
create_or_update	insert	resource_group_name, sql_migration_service_name, subscription_id		Create or Update Database Migration Service.
update	update	resource_group_name, sql_migration_service_name, subscription_id		Update Database Migration Service.
create_or_update	replace	resource_group_name, sql_migration_service_name, subscription_id		Create or Update Database Migration Service.
delete	delete	resource_group_name, sql_migration_service_name, subscription_id		Delete Database Migration Service.
list_auth_keys	exec	resource_group_name, sql_migration_service_name, subscription_id		Retrieve the List of Authentication Keys for Self Hosted Integration Runtime.
list_migrations	exec	resource_group_name, sql_migration_service_name, subscription_id		Retrieve the List of database migrations attached to the service.
list_monitoring_data	exec	resource_group_name, sql_migration_service_name, subscription_id		Retrieve the registered Integration Runtime nodes and their monitoring data for a given Database Migration Service.
regenerate_auth_keys	exec	resource_group_name, sql_migration_service_name, subscription_id		Regenerate a new set of Authentication Keys for Self Hosted Integration Runtime.
delete_node	exec	resource_group_name, sql_migration_service_name, subscription_id		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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
sql_migration_service_name	string	Name of the SQL Migration Service. Required.
subscription_id	string

SELECT examples

get

Retrieve the Database Migration Service.

SELECT
id,
name,
integrationRuntimeState,
location,
provisioningState,
systemData,
tags,
type
FROM azure.data_migration.sql_migration_services
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND sql_migration_service_name = '{{ sql_migration_service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Retrieve all SQL migration services in the resource group.

SELECT
id,
name,
integrationRuntimeState,
location,
provisioningState,
systemData,
tags,
type
FROM azure.data_migration.sql_migration_services
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Retrieve all SQL migration services in the subscriptions.

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

INSERT examples

create_or_update

Create or Update Database Migration Service.

INSERT INTO azure.data_migration.sql_migration_services (
properties,
location,
tags,
resource_group_name,
sql_migration_service_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ location }}',
'{{ tags }}',
'{{ resource_group_name }}',
'{{ sql_migration_service_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: sql_migration_services
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the sql_migration_services resource.
  - name: sql_migration_service_name
    value: "{{ sql_migration_service_name }}"
    description: Required parameter for the sql_migration_services resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the sql_migration_services resource.
  - name: properties
    description: |
      The SQL Migration Service properties.
    value:
      provisioningState: "{{ provisioningState }}"
      integrationRuntimeState: "{{ integrationRuntimeState }}"
  - name: location
    value: "{{ location }}"
    description: |
      :vartype location: str
  - name: tags
    value: "{{ tags }}"
    description: |
      :vartype tags: dict[str, str]

UPDATE examples

update

Update Database Migration Service.

UPDATE azure.data_migration.sql_migration_services
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND sql_migration_service_name = '{{ sql_migration_service_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create or Update Database Migration Service.

REPLACE azure.data_migration.sql_migration_services
SET 
properties = '{{ properties }}',
location = '{{ location }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND sql_migration_service_name = '{{ sql_migration_service_name }}' --required
AND subscription_id = '{{ subscription_id }}' --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 resource_group_name = '{{ resource_group_name }}' --required
AND sql_migration_service_name = '{{ sql_migration_service_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_auth_keys

Retrieve the List of Authentication Keys for Self Hosted Integration Runtime.

EXEC azure.data_migration.sql_migration_services.list_auth_keys 
@resource_group_name='{{ resource_group_name }}' --required, 
@sql_migration_service_name='{{ sql_migration_service_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_migrations

Retrieve the List of database migrations attached to the service.

EXEC azure.data_migration.sql_migration_services.list_migrations 
@resource_group_name='{{ resource_group_name }}' --required, 
@sql_migration_service_name='{{ sql_migration_service_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_monitoring_data

Retrieve the registered Integration Runtime nodes and their monitoring data for a given Database Migration Service.

EXEC azure.data_migration.sql_migration_services.list_monitoring_data 
@resource_group_name='{{ resource_group_name }}' --required, 
@sql_migration_service_name='{{ sql_migration_service_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

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 
@resource_group_name='{{ resource_group_name }}' --required, 
@sql_migration_service_name='{{ sql_migration_service_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"keyName": "{{ keyName }}", 
"authKey1": "{{ authKey1 }}", 
"authKey2": "{{ authKey2 }}"
}'
;

delete_node

Delete the integration runtime node.

EXEC azure.data_migration.sql_migration_services.delete_node 
@resource_group_name='{{ resource_group_name }}' --required, 
@sql_migration_service_name='{{ sql_migration_service_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"nodeName": "{{ nodeName }}", 
"integrationRuntimeName": "{{ integrationRuntimeName }}"
}'
;