migration_services

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

Overview

Name	migration_services
Type	Resource
Id	azure.data_migration.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	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning state to track the async operation status. Known values are: "Provisioning", "Updating", "Succeeded", "Failed", and "Canceled". (Provisioning, Updating, Succeeded, Failed, Canceled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning state to track the async operation status. Known values are: "Provisioning", "Updating", "Succeeded", "Failed", and "Canceled". (Provisioning, Updating, Succeeded, Failed, Canceled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning state to track the async operation status. Known values are: "Provisioning", "Updating", "Succeeded", "Failed", and "Canceled". (Provisioning, Updating, Succeeded, Failed, Canceled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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, migration_service_name, subscription_id		Retrieve the Database Migration Service.
list_by_resource_group	select	resource_group_name, subscription_id		Retrieve all migration services in the resource group.
list_by_subscription	select	subscription_id		Retrieve all migration services in the subscriptions.
create_or_update	insert	resource_group_name, migration_service_name, subscription_id, location		Create or Update Database Migration Service.
update	update	resource_group_name, migration_service_name, subscription_id		Update Database Migration Service.
create_or_update	replace	resource_group_name, migration_service_name, subscription_id, location		Create or Update Database Migration Service.
delete	delete	resource_group_name, migration_service_name, subscription_id		Delete Database Migration Service.
list_migrations	exec	resource_group_name, migration_service_name, subscription_id		Retrieve the List of database migrations attached to the service.

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
migration_service_name	string	Name of the Migration Service. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. 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.migration_services
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND migration_service_name = '{{ migration_service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Retrieve all migration services in the resource group.

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

list_by_subscription

Retrieve all migration services in the subscriptions.

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

INSERT examples

create_or_update

Create or Update Database Migration Service.

INSERT INTO azure.data_migration.migration_services (
tags,
location,
properties,
resource_group_name,
migration_service_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ migration_service_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: migration_services
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the migration_services resource.
  - name: migration_service_name
    value: "{{ migration_service_name }}"
    description: Required parameter for the migration_services resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the migration_services resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The Migration Service properties.
    value:
      provisioningState: "{{ provisioningState }}"
      integrationRuntimeState: "{{ integrationRuntimeState }}"

UPDATE examples

update

Update Database Migration Service.

UPDATE azure.data_migration.migration_services
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND migration_service_name = '{{ 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.migration_services
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND migration_service_name = '{{ migration_service_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete Database Migration Service.

DELETE FROM azure.data_migration.migration_services
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND migration_service_name = '{{ migration_service_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_migrations

Retrieve the List of database migrations attached to the service.

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