service_tasks

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

Overview

Name	service_tasks
Type	Resource
Id	azure.data_migration.service_tasks

Fields

The following fields are returned by SELECT queries:

get

A service task resource

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	HTTP strong entity tag value. This is ignored if submitted.
properties	object	Custom task properties
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list

Got service tasks

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	HTTP strong entity tag value. This is ignored if submitted.
properties	object	Custom task properties
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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		$expand	The service tasks resource is a nested, proxy-only resource representing work performed by a DMS (classic) instance. The GET method retrieves information about a service task.
list	select	subscriptionId, groupName, serviceName	api-version, taskType	The services resource is the top-level resource that represents the Azure Database Migration Service (classic). This method returns a list of service level tasks owned by a service resource. Some tasks may have a status of Unknown, which indicates that an error occurred while querying the status of that task.
create_or_update	insert			The service tasks resource is a nested, proxy-only resource representing work performed by a DMS (classic) instance. The PUT method creates a new service task or updates an existing one, although since service tasks have no mutable custom properties, there is little reason to update an existing one.
update	update			The service tasks resource is a nested, proxy-only resource representing work performed by a DMS (classic) instance. The PATCH method updates an existing service task, but since service tasks have no mutable custom properties, there is little reason to do so.
delete	delete		deleteRunningTasks	The service tasks resource is a nested, proxy-only resource representing work performed by a DMS (classic) instance. The DELETE method deletes a service task, canceling it first if it's running.
cancel	exec	subscriptionId, groupName, serviceName, taskName	api-version	The service tasks resource is a nested, proxy-only resource representing work performed by a DMS (classic) instance. This method cancels a service task if it's currently queued or running.

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
groupName	string	Name of the resource group
serviceName	string	Name of the service
subscriptionId	string	Subscription ID that identifies an Azure subscription.
taskName	string	Name of the Task
$expand	string	Expand the response
api-version	string	Version of the API
deleteRunningTasks	boolean	Delete the resource even if it contains running tasks
taskType	string	Filter tasks by task type

SELECT examples

get

The service tasks resource is a nested, proxy-only resource representing work performed by a DMS (classic) instance. The GET method retrieves information about a service task.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.data_migration.service_tasks
WHERE $expand = '{{ $expand }}'
;

list

The services resource is the top-level resource that represents the Azure Database Migration Service (classic). This method returns a list of service level tasks owned by a service resource. Some tasks may have a status of Unknown, which indicates that an error occurred while querying the status of that task.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.data_migration.service_tasks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND groupName = '{{ groupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND api-version = '{{ api-version }}'
AND taskType = '{{ taskType }}'
;

INSERT examples

create_or_update

The service tasks resource is a nested, proxy-only resource representing work performed by a DMS (classic) instance. The PUT method creates a new service task or updates an existing one, although since service tasks have no mutable custom properties, there is little reason to update an existing one.

INSERT INTO azure.data_migration.service_tasks (
data__etag,
data__properties
)
SELECT 
'{{ etag }}',
'{{ properties }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: service_tasks
  props:
    - name: etag
      value: string
      description: |
        HTTP strong entity tag value. This is ignored if submitted.
    - name: properties
      value: object
      description: |
        Custom task properties

UPDATE examples

update

The service tasks resource is a nested, proxy-only resource representing work performed by a DMS (classic) instance. The PATCH method updates an existing service task, but since service tasks have no mutable custom properties, there is little reason to do so.

UPDATE azure.data_migration.service_tasks
SET 
data__etag = '{{ etag }}',
data__properties = '{{ properties }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type;

DELETE examples

delete

The service tasks resource is a nested, proxy-only resource representing work performed by a DMS (classic) instance. The DELETE method deletes a service task, canceling it first if it's running.

DELETE FROM azure.data_migration.service_tasks
WHERE deleteRunningTasks = '{{ deleteRunningTasks }}'
;

Lifecycle Methods

cancel

The service tasks resource is a nested, proxy-only resource representing work performed by a DMS (classic) instance. This method cancels a service task if it's currently queued or running.

EXEC azure.data_migration.service_tasks.cancel 
@subscriptionId='{{ subscriptionId }}' --required, 
@groupName='{{ groupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@taskName='{{ taskName }}' --required, 
@api-version='{{ api-version }}'
;