groups_operations

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

Overview

Name	groups_operations
Type	Resource
Id	azure.migration_assessment.groups_operations

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}. # pylint: disable=line-too-long
name	string	The name of the resource.
areAssessmentsRunning	boolean	If the assessments are in running state.
assessments	array	List of References to Assessments created on this group.
createdTimestamp	string (date-time)	Time when this group was created. Date-Time represented in ISO-8601 format.
groupStatus	string	Whether the group has been created and is valid. Known values are: "Created", "Updated", "Running", "Completed", and "Invalid".
groupType	string	The type of group. Known values are: "Default", "Import", and "Import".
machineCount	integer	Number of machines part of this group.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted".
supportedAssessmentTypes	array	List of assessment types supported on this group.
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".
updatedTimestamp	string (date-time)	Time when this group was last updated. Date-Time represented in ISO-8601 format.

list_by_assessment_project

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
areAssessmentsRunning	boolean	If the assessments are in running state.
assessments	array	List of References to Assessments created on this group.
createdTimestamp	string (date-time)	Time when this group was created. Date-Time represented in ISO-8601 format.
groupStatus	string	Whether the group has been created and is valid. Known values are: "Created", "Updated", "Running", "Completed", and "Invalid".
groupType	string	The type of group. Known values are: "Default", "Import", and "Import".
machineCount	integer	Number of machines part of this group.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted".
supportedAssessmentTypes	array	List of assessment types supported on this group.
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".
updatedTimestamp	string (date-time)	Time when this group was last updated. Date-Time represented in ISO-8601 format.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, project_name, group_name, subscription_id		Get a Group.
list_by_assessment_project	select	resource_group_name, project_name, subscription_id		List Group resources by AssessmentProject.
create	insert	resource_group_name, project_name, group_name, subscription_id		Create a Group.
delete	delete	resource_group_name, project_name, group_name, subscription_id		Delete a Group.
update_machines	exec	resource_group_name, project_name, group_name, subscription_id		Update machines in group. Update machines in group by adding or removing machines.

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	Group ARM name. Required.
project_name	string	Assessment Project Name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a Group.

SELECT
id,
name,
areAssessmentsRunning,
assessments,
createdTimestamp,
groupStatus,
groupType,
machineCount,
provisioningState,
supportedAssessmentTypes,
systemData,
type,
updatedTimestamp
FROM azure.migration_assessment.groups_operations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND project_name = '{{ project_name }}' -- required
AND group_name = '{{ group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_assessment_project

List Group resources by AssessmentProject.

SELECT
id,
name,
areAssessmentsRunning,
assessments,
createdTimestamp,
groupStatus,
groupType,
machineCount,
provisioningState,
supportedAssessmentTypes,
systemData,
type,
updatedTimestamp
FROM azure.migration_assessment.groups_operations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND project_name = '{{ project_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create a Group.

INSERT INTO azure.migration_assessment.groups_operations (
properties,
resource_group_name,
project_name,
group_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ project_name }}',
'{{ group_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: groups_operations
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the groups_operations resource.
  - name: project_name
    value: "{{ project_name }}"
    description: Required parameter for the groups_operations resource.
  - name: group_name
    value: "{{ group_name }}"
    description: Required parameter for the groups_operations resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the groups_operations resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      groupStatus: "{{ groupStatus }}"
      machineCount: {{ machineCount }}
      assessments:
        - "{{ assessments }}"
      supportedAssessmentTypes:
        - "{{ supportedAssessmentTypes }}"
      areAssessmentsRunning: {{ areAssessmentsRunning }}
      createdTimestamp: "{{ createdTimestamp }}"
      updatedTimestamp: "{{ updatedTimestamp }}"
      groupType: "{{ groupType }}"

DELETE examples

delete

Delete a Group.

DELETE FROM azure.migration_assessment.groups_operations
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND project_name = '{{ project_name }}' --required
AND group_name = '{{ group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

update_machines

Update machines in group. Update machines in group by adding or removing machines.

EXEC azure.migration_assessment.groups_operations.update_machines 
@resource_group_name='{{ resource_group_name }}' --required, 
@project_name='{{ project_name }}' --required, 
@group_name='{{ group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"eTag": "{{ eTag }}", 
"properties": "{{ properties }}"
}'
;