move_collections

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

Overview

Name	move_collections
Type	Resource
Id	azure.resource_mover.move_collections

Fields

vw_move_collections

Name	Datatype	Description
id	text	Fully qualified resource Id for the resource.
name	text	The name of the resource
errors	text	field from the properties object
etag	text	The etag of the resource.
identity	text	Defines the MSI properties of the Move Collection.
location	text	The geo-location where the resource lives.
moveCollectionName	text	field from the properties object
move_region	text	field from the properties object
move_type	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
source_region	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
tags	text	Resource tags.
target_region	text	field from the properties object
type	text	The type of the resource.
version	text	field from the properties object

move_collections

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource
etag	string	The etag of the resource.
identity	object	Defines the MSI properties of the Move Collection.
location	string	The geo-location where the resource lives.
properties	object	Defines the move collection properties.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.
type	string	The type of the resource.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	moveCollectionName, resourceGroupName, subscriptionId	Gets the move collection.
create	INSERT	moveCollectionName, resourceGroupName, subscriptionId	Creates or updates a move collection.
delete	DELETE	moveCollectionName, resourceGroupName, subscriptionId	Deletes a move collection.
update	UPDATE	moveCollectionName, resourceGroupName, subscriptionId	Updates a move collection.
bulk_remove	EXEC	moveCollectionName, resourceGroupName, subscriptionId	Removes the set of move resources included in the request body from move collection. The orchestration is done by service. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.
commit	EXEC	moveCollectionName, resourceGroupName, subscriptionId, data__moveResources	Commits the set of resources included in the request body. The commit operation is triggered on the moveResources in the moveState 'CommitPending' or 'CommitFailed', on a successful completion the moveResource moveState do a transition to Committed. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.
discard	EXEC	moveCollectionName, resourceGroupName, subscriptionId, data__moveResources	Discards the set of resources included in the request body. The discard operation is triggered on the moveResources in the moveState 'CommitPending' or 'DiscardFailed', on a successful completion the moveResource moveState do a transition to MovePending. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.
initiate_move	EXEC	moveCollectionName, resourceGroupName, subscriptionId, data__moveResources	Moves the set of resources included in the request body. The move operation is triggered after the moveResources are in the moveState 'MovePending' or 'MoveFailed', on a successful completion the moveResource moveState do a transition to CommitPending. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.
prepare	EXEC	moveCollectionName, resourceGroupName, subscriptionId, data__moveResources	Initiates prepare for the set of resources included in the request body. The prepare operation is on the moveResources that are in the moveState 'PreparePending' or 'PrepareFailed', on a successful completion the moveResource moveState do a transition to MovePending. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.
resolve_dependencies	EXEC	moveCollectionName, resourceGroupName, subscriptionId	Computes, resolves and validate the dependencies of the moveResources in the move collection.

SELECT examples

Gets the move collection.

vw_move_collections

SELECT
id,
name,
errors,
etag,
identity,
location,
moveCollectionName,
move_region,
move_type,
provisioning_state,
resourceGroupName,
source_region,
subscriptionId,
system_data,
tags,
target_region,
type,
version
FROM azure.resource_mover.vw_move_collections
WHERE moveCollectionName = '{{ moveCollectionName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

move_collections

SELECT
id,
name,
etag,
identity,
location,
properties,
systemData,
tags,
type
FROM azure.resource_mover.move_collections
WHERE moveCollectionName = '{{ moveCollectionName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new move_collections resource.

All Properties

/*+ create */
INSERT INTO azure.resource_mover.move_collections (
moveCollectionName,
resourceGroupName,
subscriptionId,
tags,
location,
identity,
properties
)
SELECT 
'{{ moveCollectionName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ tags }}',
'{{ location }}',
'{{ identity }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: etag
      value: string
    - name: tags
      value: object
    - name: location
      value: string
    - name: identity
      value:
        - name: type
          value: []
        - name: principalId
          value: string
        - name: tenantId
          value: string
    - name: properties
      value:
        - name: sourceRegion
          value: string
        - name: targetRegion
          value: string
        - name: moveRegion
          value: string
        - name: provisioningState
          value: []
        - name: version
          value: string
        - name: moveType
          value: []
        - name: errors
          value: string
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string

UPDATE example

Updates a move_collections resource.

/*+ update */
UPDATE azure.resource_mover.move_collections
SET 
tags = '{{ tags }}',
identity = '{{ identity }}'
WHERE 
moveCollectionName = '{{ moveCollectionName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified move_collections resource.

/*+ delete */
DELETE FROM azure.resource_mover.move_collections
WHERE moveCollectionName = '{{ moveCollectionName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';