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

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.
azureAuthenticationInfo	object	Field that defines the Azure active directory application info, used to connect to the target Azure resource.
creationTime	string (date-time)	UTC Date and time when project was created.
databasesInfo	array	List of DatabaseInfo.
etag	string	HTTP strong entity tag value. This is ignored if submitted.
location	string	:vartype location: str
provisioningState	string	The project's provisioning state. Known values are: "Deleting" and "Succeeded". (Deleting, Succeeded)
sourceConnectionInfo	object	Information for connecting to source.
sourcePlatform	string	Source platform for the project. Required. Known values are: "SQL", "MySQL", "PostgreSql", "MongoDb", and "Unknown". (SQL, MySQL, PostgreSql, MongoDb, Unknown)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	:vartype tags: dict[str, str]
targetConnectionInfo	object	Information for connecting to target.
targetPlatform	string	Target platform for the project. Required. Known values are: "SQLDB", "SQLMI", "AzureDbForMySql", "AzureDbForPostgreSql", "MongoDb", and "Unknown". (SQLDB, SQLMI, AzureDbForMySql, AzureDbForPostgreSql, MongoDb, Unknown)
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

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.
azureAuthenticationInfo	object	Field that defines the Azure active directory application info, used to connect to the target Azure resource.
creationTime	string (date-time)	UTC Date and time when project was created.
databasesInfo	array	List of DatabaseInfo.
etag	string	HTTP strong entity tag value. This is ignored if submitted.
location	string	:vartype location: str
provisioningState	string	The project's provisioning state. Known values are: "Deleting" and "Succeeded". (Deleting, Succeeded)
sourceConnectionInfo	object	Information for connecting to source.
sourcePlatform	string	Source platform for the project. Required. Known values are: "SQL", "MySQL", "PostgreSql", "MongoDb", and "Unknown". (SQL, MySQL, PostgreSql, MongoDb, Unknown)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	:vartype tags: dict[str, str]
targetConnectionInfo	object	Information for connecting to target.
targetPlatform	string	Target platform for the project. Required. Known values are: "SQLDB", "SQLMI", "AzureDbForMySql", "AzureDbForPostgreSql", "MongoDb", and "Unknown". (SQLDB, SQLMI, AzureDbForMySql, AzureDbForPostgreSql, MongoDb, Unknown)
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	group_name, service_name, project_name, subscription_id		Get project information. The project resource is a nested resource representing a stored migration project. The GET method retrieves information about a project.
list	select	group_name, service_name, subscription_id		Get projects in a service. 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	group_name, service_name, project_name, subscription_id		Create or update project. 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	group_name, service_name, project_name, subscription_id		Update project. The project resource is a nested resource representing a stored migration project. The PATCH method updates an existing project.
create_or_update	replace	group_name, service_name, project_name, subscription_id		Create or update project. The project resource is a nested resource representing a stored migration project. The PUT method creates a new project or updates an existing one.
delete	delete	group_name, service_name, project_name, subscription_id	deleteRunningTasks	Delete project. 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
group_name	string	Name of the resource group. Required.
project_name	string	Name of the project. Required.
service_name	string	Name of the service. Required.
subscription_id	string
deleteRunningTasks	boolean	Delete the resource even if it contains running tasks. Default value is None.

SELECT examples

get

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

SELECT
id,
name,
azureAuthenticationInfo,
creationTime,
databasesInfo,
etag,
location,
provisioningState,
sourceConnectionInfo,
sourcePlatform,
systemData,
tags,
targetConnectionInfo,
targetPlatform,
type
FROM azure.data_migration.projects
WHERE group_name = '{{ group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND project_name = '{{ project_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Get projects in a service. 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,
azureAuthenticationInfo,
creationTime,
databasesInfo,
etag,
location,
provisioningState,
sourceConnectionInfo,
sourcePlatform,
systemData,
tags,
targetConnectionInfo,
targetPlatform,
type
FROM azure.data_migration.projects
WHERE group_name = '{{ group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update project. 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 (
properties,
etag,
location,
tags,
group_name,
service_name,
project_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ etag }}',
'{{ location }}',
'{{ tags }}',
'{{ group_name }}',
'{{ service_name }}',
'{{ project_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: projects
props:
  - name: group_name
    value: "{{ group_name }}"
    description: Required parameter for the projects resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the projects resource.
  - name: project_name
    value: "{{ project_name }}"
    description: Required parameter for the projects resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the projects resource.
  - name: properties
    description: |
      Project properties.
    value:
      sourcePlatform: "{{ sourcePlatform }}"
      azureAuthenticationInfo:
        applicationId: "{{ applicationId }}"
        appKey: "{{ appKey }}"
        tenantId: "{{ tenantId }}"
        ignoreAzurePermissions: {{ ignoreAzurePermissions }}
      targetPlatform: "{{ targetPlatform }}"
      creationTime: "{{ creationTime }}"
      sourceConnectionInfo:
        type: "{{ type }}"
        userName: "{{ userName }}"
        password: "{{ password }}"
      targetConnectionInfo:
        type: "{{ type }}"
        userName: "{{ userName }}"
        password: "{{ password }}"
      databasesInfo:
        - sourceDatabaseName: "{{ sourceDatabaseName }}"
      provisioningState: "{{ provisioningState }}"
  - name: etag
    value: "{{ etag }}"
    description: |
      HTTP strong entity tag value. This is ignored if submitted.
  - name: location
    value: "{{ location }}"
    description: |
      :vartype location: str
  - name: tags
    value: "{{ tags }}"
    description: |
      :vartype tags: dict[str, str]

UPDATE examples

update

Update project. 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 
properties = '{{ properties }}',
etag = '{{ etag }}',
location = '{{ location }}',
tags = '{{ tags }}'
WHERE 
group_name = '{{ group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND project_name = '{{ project_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

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

REPLACE azure.data_migration.projects
SET 
properties = '{{ properties }}',
etag = '{{ etag }}',
location = '{{ location }}',
tags = '{{ tags }}'
WHERE 
group_name = '{{ group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND project_name = '{{ project_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete project. 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 group_name = '{{ group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND project_name = '{{ project_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND deleteRunningTasks = '{{ deleteRunningTasks }}'
;