projects

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

Overview

Name	projects
Type	Resource
Id	azure.data_migration.projects

Fields

The following fields are returned by SELECT queries:

get

A project resource

Name	Datatype	Description
id	string
name	string
etag	string	HTTP strong entity tag value. This is ignored if submitted.
location	string
properties	object	Project properties
systemData	object
tags	object
type	string

list

List of projects

Name	Datatype	Description
id	string
name	string
etag	string	HTTP strong entity tag value. This is ignored if submitted.
location	string
properties	object	Project 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			The project resource is a nested resource representing a stored migration project. The GET method retrieves information about a project.
list	select	subscriptionId, groupName, serviceName	api-version	The project resource is a nested resource representing a stored migration project. This method returns a list of projects owned by a service resource.
create_or_update	insert			The project resource is a nested resource representing a stored migration project. The PUT method creates a new project or updates an existing one.
update	update			The project resource is a nested resource representing a stored migration project. The PATCH method updates an existing project.
delete	delete		deleteRunningTasks	The project resource is a nested resource representing a stored migration project. The DELETE method deletes a project.

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.
api-version	string	Version of the API
deleteRunningTasks	boolean	Delete the resource even if it contains running tasks

SELECT examples

get

The project resource is a nested resource representing a stored migration project. The GET method retrieves information about a project.

SELECT
id,
name,
etag,
location,
properties,
systemData,
tags,
type
FROM azure.data_migration.projects
;

list

The project resource is a nested resource representing a stored migration project. This method returns a list of projects owned by a service resource.

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

INSERT examples

create_or_update

The project resource is a nested resource representing a stored migration project. The PUT method creates a new project or updates an existing one.

INSERT INTO azure.data_migration.projects (
data__properties,
data__etag,
data__location,
data__tags
)
SELECT 
'{{ properties }}',
'{{ etag }}',
'{{ location }}',
'{{ tags }}'
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type
;

Manifest

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

UPDATE examples

update

The project resource is a nested resource representing a stored migration project. The PATCH method updates an existing project.

UPDATE azure.data_migration.projects
SET 
data__properties = '{{ properties }}',
data__etag = '{{ etag }}',
data__location = '{{ location }}',
data__tags = '{{ tags }}'
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

The project resource is a nested resource representing a stored migration project. The DELETE method deletes a project.

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