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:

list_required_for

Name	Datatype	Description
sourceIds	array	Gets or sets the list of source Ids for which the input resource is required.

get

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
errors	object	Defines the move collection errors.
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.
moveRegion	string	Gets or sets the move region which indicates the region where the VM Regional to Zonal move will be conducted.
moveType	string	Defines the MoveType. Known values are: "RegionToRegion" and "RegionToZone".
provisioningState	string	Defines the provisioning states. Known values are: "Succeeded", "Updating", "Creating", and "Failed".
sourceRegion	string	Gets or sets the source region.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.
targetRegion	string	Gets or sets the target region.
type	string	The type of the resource.
version	string	Gets or sets the version of move collection.

list_move_collections_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
errors	object	Defines the move collection errors.
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.
moveRegion	string	Gets or sets the move region which indicates the region where the VM Regional to Zonal move will be conducted.
moveType	string	Defines the MoveType. Known values are: "RegionToRegion" and "RegionToZone".
provisioningState	string	Defines the provisioning states. Known values are: "Succeeded", "Updating", "Creating", and "Failed".
sourceRegion	string	Gets or sets the source region.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.
targetRegion	string	Gets or sets the target region.
type	string	The type of the resource.
version	string	Gets or sets the version of move collection.

list_move_collections_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
errors	object	Defines the move collection errors.
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.
moveRegion	string	Gets or sets the move region which indicates the region where the VM Regional to Zonal move will be conducted.
moveType	string	Defines the MoveType. Known values are: "RegionToRegion" and "RegionToZone".
provisioningState	string	Defines the provisioning states. Known values are: "Succeeded", "Updating", "Creating", and "Failed".
sourceRegion	string	Gets or sets the source region.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.
targetRegion	string	Gets or sets the target region.
type	string	The type of the resource.
version	string	Gets or sets the version of move collection.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_required_for	select	resource_group_name, move_collection_name, subscription_id, sourceId		List of the move resources for which an arm resource is required for.
get	select	resource_group_name, move_collection_name, subscription_id		Gets the move collection.
list_move_collections_by_resource_group	select	resource_group_name, subscription_id		Get all Move Collections. Get all the Move Collections in the resource group.
list_move_collections_by_subscription	select	subscription_id		Get all Move Collections. Get all the Move Collections in the subscription.
create	insert	resource_group_name, move_collection_name, subscription_id		Creates or updates a move collection.
update	update	resource_group_name, move_collection_name, subscription_id		Updates a move collection.
delete	delete	resource_group_name, move_collection_name, subscription_id		Deletes a move collection.
prepare	exec	resource_group_name, move_collection_name, subscription_id, 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.
initiate_move	exec	resource_group_name, move_collection_name, subscription_id, 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.
commit	exec	resource_group_name, move_collection_name, subscription_id, 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	resource_group_name, move_collection_name, subscription_id, 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.
resolve_dependencies	exec	resource_group_name, move_collection_name, subscription_id		Computes, resolves and validate the dependencies of the moveResources in the move collection.
bulk_remove	exec	resource_group_name, move_collection_name, subscription_id		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
move_collection_name	string	Required.
resource_group_name	string	Required.
sourceId	string	The sourceId for which the api is invoked. Required.
subscription_id	string

SELECT examples

list_required_for

List of the move resources for which an arm resource is required for.

SELECT
sourceIds
FROM azure.resource_mover.move_collections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND move_collection_name = '{{ move_collection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND sourceId = '{{ sourceId }}' -- required
;

get

Gets the move collection.

SELECT
id,
name,
errors,
etag,
identity,
location,
moveRegion,
moveType,
provisioningState,
sourceRegion,
systemData,
tags,
targetRegion,
type,
version
FROM azure.resource_mover.move_collections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND move_collection_name = '{{ move_collection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_move_collections_by_resource_group

Get all Move Collections. Get all the Move Collections in the resource group.

SELECT
id,
name,
errors,
etag,
identity,
location,
moveRegion,
moveType,
provisioningState,
sourceRegion,
systemData,
tags,
targetRegion,
type,
version
FROM azure.resource_mover.move_collections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_move_collections_by_subscription

Get all Move Collections. Get all the Move Collections in the subscription.

SELECT
id,
name,
errors,
etag,
identity,
location,
moveRegion,
moveType,
provisioningState,
sourceRegion,
systemData,
tags,
targetRegion,
type,
version
FROM azure.resource_mover.move_collections
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates or updates a move collection.

INSERT INTO azure.resource_mover.move_collections (
tags,
location,
identity,
properties,
resource_group_name,
move_collection_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ identity }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ move_collection_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: move_collections
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the move_collections resource.
  - name: move_collection_name
    value: "{{ move_collection_name }}"
    description: Required parameter for the move_collections resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the move_collections resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives.
  - name: identity
    description: |
      Defines the MSI properties of the Move Collection.
    value:
      type: "{{ type }}"
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
  - name: properties
    description: |
      Defines the move collection properties.
    value:
      sourceRegion: "{{ sourceRegion }}"
      targetRegion: "{{ targetRegion }}"
      moveRegion: "{{ moveRegion }}"
      provisioningState: "{{ provisioningState }}"
      version: "{{ version }}"
      moveType: "{{ moveType }}"
      errors:
        properties:
          code: "{{ code }}"
          message: "{{ message }}"
          target: "{{ target }}"
          details:
            - code: "{{ code }}"
              message: "{{ message }}"
              target: "{{ target }}"
              details: "{{ details }}"

UPDATE examples

update

Updates a move collection.

UPDATE azure.resource_mover.move_collections
SET 
tags = '{{ tags }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND move_collection_name = '{{ move_collection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
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 resource_group_name = '{{ resource_group_name }}' --required
AND move_collection_name = '{{ move_collection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

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 
@resource_group_name='{{ resource_group_name }}' --required, 
@move_collection_name='{{ move_collection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@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 
@resource_group_name='{{ resource_group_name }}' --required, 
@move_collection_name='{{ move_collection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@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 
@resource_group_name='{{ resource_group_name }}' --required, 
@move_collection_name='{{ move_collection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@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 
@resource_group_name='{{ resource_group_name }}' --required, 
@move_collection_name='{{ move_collection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@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 
@resource_group_name='{{ resource_group_name }}' --required, 
@move_collection_name='{{ move_collection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

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 
@resource_group_name='{{ resource_group_name }}' --required, 
@move_collection_name='{{ move_collection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"validateOnly": {{ validateOnly }}, 
"moveResources": "{{ moveResources }}", 
"moveResourceInputType": "{{ moveResourceInputType }}"
}'
;