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

The following fields are returned by SELECT queries:

get

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

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, moveCollectionName	api-version	Gets the move collection.
create	insert	subscriptionId, resourceGroupName, moveCollectionName	api-version	Creates or updates a move collection.
update	update	subscriptionId, resourceGroupName, moveCollectionName	api-version	Updates a move collection.
delete	delete	subscriptionId, resourceGroupName, moveCollectionName	api-version	Deletes a move collection.
prepare	exec	subscriptionId, resourceGroupName, moveCollectionName, moveResources	api-version	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.
initiate_move	exec	subscriptionId, resourceGroupName, moveCollectionName, moveResources	api-version	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.
commit	exec	subscriptionId, resourceGroupName, moveCollectionName, moveResources	api-version	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	subscriptionId, resourceGroupName, moveCollectionName, moveResources	api-version	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.
resolve_dependencies	exec	subscriptionId, resourceGroupName, moveCollectionName	api-version	Computes, resolves and validate the dependencies of the moveResources in the move collection.
bulk_remove	exec	subscriptionId, resourceGroupName, moveCollectionName	api-version	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.

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
moveCollectionName	string
resourceGroupName	string
subscriptionId	string	The Subscription ID.
api-version	string	Client Api Version.

SELECT examples

get

Gets the move collection.

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

INSERT examples

create

Creates or updates a move collection.

INSERT INTO azure.resource_mover.move_collections (
data__tags,
data__location,
data__identity,
data__properties,
subscriptionId,
resourceGroupName,
moveCollectionName,
api-version
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ identity }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ moveCollectionName }}',
'{{ api-version }}'
RETURNING
id,
name,
etag,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: move_collections
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the move_collections resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the move_collections resource.
    - name: moveCollectionName
      value: string
      description: Required parameter for the move_collections resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives.
    - name: identity
      value: object
      description: |
        Defines the MSI properties of the Move Collection.
    - name: properties
      value: object
      description: |
        Defines the move collection properties.
    - name: api-version
      value: string
      description: Client Api Version.

UPDATE examples

update

Updates a move collection.

UPDATE azure.resource_mover.move_collections
SET 
data__tags = '{{ tags }}',
data__identity = '{{ identity }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND moveCollectionName = '{{ moveCollectionName }}' --required
AND api-version = '{{ api-version}}'
RETURNING
id,
name,
etag,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a move collection.

DELETE FROM azure.resource_mover.move_collections
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND moveCollectionName = '{{ moveCollectionName }}' --required
AND api-version = '{{ api-version }}'
;

Lifecycle Methods

prepare

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.

EXEC azure.resource_mover.move_collections.prepare 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@moveCollectionName='{{ moveCollectionName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"validateOnly": {{ validateOnly }}, 
"moveResources": "{{ moveResources }}", 
"moveResourceInputType": "{{ moveResourceInputType }}"
}'
;

initiate_move

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.

EXEC azure.resource_mover.move_collections.initiate_move 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@moveCollectionName='{{ moveCollectionName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"validateOnly": {{ validateOnly }}, 
"moveResources": "{{ moveResources }}", 
"moveResourceInputType": "{{ moveResourceInputType }}"
}'
;

commit

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.

EXEC azure.resource_mover.move_collections.commit 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@moveCollectionName='{{ moveCollectionName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"validateOnly": {{ validateOnly }}, 
"moveResources": "{{ moveResources }}", 
"moveResourceInputType": "{{ moveResourceInputType }}"
}'
;

discard

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.

EXEC azure.resource_mover.move_collections.discard 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@moveCollectionName='{{ moveCollectionName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"validateOnly": {{ validateOnly }}, 
"moveResources": "{{ moveResources }}", 
"moveResourceInputType": "{{ moveResourceInputType }}"
}'
;

resolve_dependencies

Computes, resolves and validate the dependencies of the moveResources in the move collection.

EXEC azure.resource_mover.move_collections.resolve_dependencies 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@moveCollectionName='{{ moveCollectionName }}' --required, 
@api-version='{{ api-version }}'
;

bulk_remove

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.

EXEC azure.resource_mover.move_collections.bulk_remove 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@moveCollectionName='{{ moveCollectionName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"validateOnly": {{ validateOnly }}, 
"moveResources": "{{ moveResources }}", 
"moveResourceInputType": "{{ moveResourceInputType }}"
}'
;