move_resources

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

Overview

Name	move_resources
Type	Resource
Id	azure.resource_mover.move_resources

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.
dependsOn	array	Gets or sets the move resource dependencies.
dependsOnOverrides	array	Gets or sets the move resource dependencies overrides.
errors	object	Defines the move resource errors.
existingTargetId	string	Gets or sets the existing target ARM Id of the resource.
isResolveRequired	boolean	Gets a value indicating whether the resolve action is required over the move collection.
moveStatus	object	Defines the move resource status.
provisioningState	string	Defines the provisioning states. Known values are: "Succeeded", "Updating", "Creating", and "Failed".
resourceSettings	object	Gets or sets the resource settings.
sourceId	string	Gets or sets the Source ARM Id of the resource. Required.
sourceResourceSettings	object	Gets or sets the source resource settings.
systemData	object	Metadata pertaining to creation and last modification of the resource.
targetId	string	Gets or sets the Target ARM Id of the resource.
type	string	The type of the resource.

list

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
dependsOn	array	Gets or sets the move resource dependencies.
dependsOnOverrides	array	Gets or sets the move resource dependencies overrides.
errors	object	Defines the move resource errors.
existingTargetId	string	Gets or sets the existing target ARM Id of the resource.
isResolveRequired	boolean	Gets a value indicating whether the resolve action is required over the move collection.
moveStatus	object	Defines the move resource status.
provisioningState	string	Defines the provisioning states. Known values are: "Succeeded", "Updating", "Creating", and "Failed".
resourceSettings	object	Gets or sets the resource settings.
sourceId	string	Gets or sets the Source ARM Id of the resource. Required.
sourceResourceSettings	object	Gets or sets the source resource settings.
systemData	object	Metadata pertaining to creation and last modification of the resource.
targetId	string	Gets or sets the Target ARM Id of the resource.
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	resource_group_name, move_collection_name, move_resource_name, subscription_id		Gets the Move Resource.
list	select	resource_group_name, move_collection_name, subscription_id	$filter	Lists the Move Resources in the move collection.
create	insert	resource_group_name, move_collection_name, move_resource_name, subscription_id		Creates or updates a Move Resource in the move collection.
delete	delete	resource_group_name, move_collection_name, move_resource_name, subscription_id		Deletes a Move Resource from the move collection.

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	The Move Collection Name. Required.
move_resource_name	string	The Move Resource Name. Required.
resource_group_name	string	The Resource Group Name. Required.
subscription_id	string
$filter	string	The filter to apply on the operation. For example, you can use $filter=Properties/ProvisioningState eq 'Succeeded'. Default value is None.

SELECT examples

get

Gets the Move Resource.

SELECT
id,
name,
dependsOn,
dependsOnOverrides,
errors,
existingTargetId,
isResolveRequired,
moveStatus,
provisioningState,
resourceSettings,
sourceId,
sourceResourceSettings,
systemData,
targetId,
type
FROM azure.resource_mover.move_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND move_collection_name = '{{ move_collection_name }}' -- required
AND move_resource_name = '{{ move_resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists the Move Resources in the move collection.

SELECT
id,
name,
dependsOn,
dependsOnOverrides,
errors,
existingTargetId,
isResolveRequired,
moveStatus,
provisioningState,
resourceSettings,
sourceId,
sourceResourceSettings,
systemData,
targetId,
type
FROM azure.resource_mover.move_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND move_collection_name = '{{ move_collection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create

Creates or updates a Move Resource in the move collection.

INSERT INTO azure.resource_mover.move_resources (
properties,
resource_group_name,
move_collection_name,
move_resource_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ move_collection_name }}',
'{{ move_resource_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: move_resources
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the move_resources resource.
  - name: move_collection_name
    value: "{{ move_collection_name }}"
    description: Required parameter for the move_resources resource.
  - name: move_resource_name
    value: "{{ move_resource_name }}"
    description: Required parameter for the move_resources resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the move_resources resource.
  - name: properties
    description: |
      Defines the move resource properties.
    value:
      provisioningState: "{{ provisioningState }}"
      sourceId: "{{ sourceId }}"
      targetId: "{{ targetId }}"
      existingTargetId: "{{ existingTargetId }}"
      resourceSettings:
        resourceType: "{{ resourceType }}"
        targetResourceName: "{{ targetResourceName }}"
        targetResourceGroupName: "{{ targetResourceGroupName }}"
      sourceResourceSettings:
        resourceType: "{{ resourceType }}"
        targetResourceName: "{{ targetResourceName }}"
        targetResourceGroupName: "{{ targetResourceGroupName }}"
      moveStatus:
        moveState: "{{ moveState }}"
        jobStatus:
          jobName: "{{ jobName }}"
          jobProgress: "{{ jobProgress }}"
        errors:
          properties:
            code: "{{ code }}"
            message: "{{ message }}"
            target: "{{ target }}"
            details:
              - code: "{{ code }}"
                message: "{{ message }}"
                target: "{{ target }}"
                details: "{{ details }}"
      dependsOn:
        - id: "{{ id }}"
          resolutionStatus: "{{ resolutionStatus }}"
          resolutionType: "{{ resolutionType }}"
          dependencyType: "{{ dependencyType }}"
          manualResolution:
            targetId: "{{ targetId }}"
          automaticResolution:
            moveResourceId: "{{ moveResourceId }}"
          isOptional: "{{ isOptional }}"
      dependsOnOverrides:
        - id: "{{ id }}"
          targetId: "{{ targetId }}"
      isResolveRequired: {{ isResolveRequired }}
      errors:
        properties:
          code: "{{ code }}"
          message: "{{ message }}"
          target: "{{ target }}"
          details:
            - code: "{{ code }}"
              message: "{{ message }}"
              target: "{{ target }}"
              details: "{{ details }}"

DELETE examples

delete

Deletes a Move Resource from the move collection.

DELETE FROM azure.resource_mover.move_resources
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND move_collection_name = '{{ move_collection_name }}' --required
AND move_resource_name = '{{ move_resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;