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
properties	object	Defines the move resource properties.
systemData	object	Metadata pertaining to creation and last modification 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
properties	object	Defines the move resource properties.
systemData	object	Metadata pertaining to creation and last modification 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	subscriptionId, resourceGroupName, moveCollectionName, moveResourceName	api-version	Gets the Move Resource.
list	select	subscriptionId, resourceGroupName, moveCollectionName	api-version, $filter	Lists the Move Resources in the move collection.
create	insert	subscriptionId, resourceGroupName, moveCollectionName, moveResourceName	api-version	Creates or updates a Move Resource in the move collection.
delete	delete	subscriptionId, resourceGroupName, moveCollectionName, moveResourceName	api-version	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
moveCollectionName	string	The Move Collection Name.
moveResourceName	string	The Move Resource Name.
resourceGroupName	string	The Resource Group Name.
subscriptionId	string	The Subscription ID.
$filter	string	The filter to apply on the operation. For example, you can use $filter=Properties/ProvisioningState eq 'Succeeded'.
api-version	string	Client Api Version.

SELECT examples

get

Gets the Move Resource.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.resource_mover.move_resources
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND moveCollectionName = '{{ moveCollectionName }}' -- required
AND moveResourceName = '{{ moveResourceName }}' -- required
AND api-version = '{{ api-version }}'
;

list

Lists the Move Resources in the move collection.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.resource_mover.move_resources
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND moveCollectionName = '{{ moveCollectionName }}' -- required
AND api-version = '{{ api-version }}'
AND $filter = '{{ $filter }}'
;

INSERT examples

create

Creates or updates a Move Resource in the move collection.

INSERT INTO azure.resource_mover.move_resources (
data__properties,
subscriptionId,
resourceGroupName,
moveCollectionName,
moveResourceName,
api-version
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ moveCollectionName }}',
'{{ moveResourceName }}',
'{{ api-version }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: move_resources
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the move_resources resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the move_resources resource.
    - name: moveCollectionName
      value: string
      description: Required parameter for the move_resources resource.
    - name: moveResourceName
      value: string
      description: Required parameter for the move_resources resource.
    - name: properties
      value: object
      description: |
        Defines the move resource properties.
    - name: api-version
      value: string
      description: Client Api Version.

DELETE examples

delete

Deletes a Move Resource from the move collection.

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