storage_movers

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

Overview

Name	storage_movers
Type	Resource
Id	azure.storage_mover.storage_movers

Fields

The following fields are returned by SELECT queries:

get

The Storage Mover resource.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The resource specific properties for the Storage Mover resource.
systemData	object	Resource system metadata.
tags	object	Resource tags.

list

The list of Storage Movers.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The resource specific properties for the Storage Mover resource.
systemData	object	Resource system metadata.
tags	object	Resource tags.

list_by_subscription

The list of Storage Movers.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The resource specific properties for the Storage Mover resource.
systemData	object	Resource system metadata.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, storageMoverName		Gets a Storage Mover resource.
list	select	subscriptionId, resourceGroupName		Lists all Storage Movers in a resource group.
list_by_subscription	select	subscriptionId		Lists all Storage Movers in a subscription.
create_or_update	insert	subscriptionId, resourceGroupName, storageMoverName		Creates or updates a top-level Storage Mover resource.
update	update	subscriptionId, resourceGroupName, storageMoverName		Updates properties for a Storage Mover resource. Properties not specified in the request body will be unchanged.
delete	delete	subscriptionId, resourceGroupName, storageMoverName		Deletes a Storage Mover resource.

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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
storageMoverName	string	The name of the Storage Mover resource.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets a Storage Mover resource.

SELECT
location,
properties,
systemData,
tags
FROM azure.storage_mover.storage_movers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND storageMoverName = '{{ storageMoverName }}' -- required
;

list

Lists all Storage Movers in a resource group.

SELECT
location,
properties,
systemData,
tags
FROM azure.storage_mover.storage_movers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Lists all Storage Movers in a subscription.

SELECT
location,
properties,
systemData,
tags
FROM azure.storage_mover.storage_movers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a top-level Storage Mover resource.

INSERT INTO azure.storage_mover.storage_movers (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
storageMoverName
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ storageMoverName }}'
RETURNING
location,
properties,
systemData,
tags
;

Manifest

# Description fields are for documentation purposes
- name: storage_movers
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the storage_movers resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the storage_movers resource.
    - name: storageMoverName
      value: string
      description: Required parameter for the storage_movers resource.
    - name: properties
      value: object
      description: |
        The resource specific properties for the Storage Mover resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Updates properties for a Storage Mover resource. Properties not specified in the request body will be unchanged.

UPDATE azure.storage_mover.storage_movers
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND storageMoverName = '{{ storageMoverName }}' --required
RETURNING
location,
properties,
systemData,
tags;

DELETE examples

delete

Deletes a Storage Mover resource.

DELETE FROM azure.storage_mover.storage_movers
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND storageMoverName = '{{ storageMoverName }}' --required
;