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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
description	string	A description for the Storage Mover.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of this resource. Known values are: "Succeeded", "Canceled", "Failed", and "Deleting". (Succeeded, Canceled, Failed, Deleting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
description	string	A description for the Storage Mover.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of this resource. Known values are: "Succeeded", "Canceled", "Failed", and "Deleting". (Succeeded, Canceled, Failed, Deleting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
description	string	A description for the Storage Mover.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of this resource. Known values are: "Succeeded", "Canceled", "Failed", and "Deleting". (Succeeded, Canceled, Failed, Deleting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, storage_mover_name, subscription_id		Gets a Storage Mover resource.
list	select	resource_group_name, subscription_id		Lists all Storage Movers in a resource group.
list_by_subscription	select	subscription_id		Lists all Storage Movers in a subscription.
create_or_update	insert	resource_group_name, storage_mover_name, subscription_id, location		Creates or updates a top-level Storage Mover resource.
update	update	resource_group_name, storage_mover_name, subscription_id		Updates properties for a Storage Mover resource. Properties not specified in the request body will be unchanged.
create_or_update	replace	resource_group_name, storage_mover_name, subscription_id, location		Creates or updates a top-level Storage Mover resource.
delete	delete	resource_group_name, storage_mover_name, subscription_id		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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
storage_mover_name	string	The name of the Storage Mover resource. Required.
subscription_id	string

SELECT examples

get

Gets a Storage Mover resource.

SELECT
id,
name,
description,
location,
provisioningState,
systemData,
tags,
type
FROM azure.storage_mover.storage_movers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND storage_mover_name = '{{ storage_mover_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all Storage Movers in a resource group.

SELECT
id,
name,
description,
location,
provisioningState,
systemData,
tags,
type
FROM azure.storage_mover.storage_movers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Lists all Storage Movers in a subscription.

SELECT
id,
name,
description,
location,
provisioningState,
systemData,
tags,
type
FROM azure.storage_mover.storage_movers
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a top-level Storage Mover resource.

INSERT INTO azure.storage_mover.storage_movers (
tags,
location,
properties,
resource_group_name,
storage_mover_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ storage_mover_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: storage_movers
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the storage_movers resource.
  - name: storage_mover_name
    value: "{{ storage_mover_name }}"
    description: Required parameter for the storage_movers resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the storage_movers resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource specific properties for the Storage Mover resource.
    value:
      description: "{{ description }}"
      provisioningState: "{{ provisioningState }}"

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 
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND storage_mover_name = '{{ storage_mover_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a top-level Storage Mover resource.

REPLACE azure.storage_mover.storage_movers
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND storage_mover_name = '{{ storage_mover_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a Storage Mover resource.

DELETE FROM azure.storage_mover.storage_movers
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND storage_mover_name = '{{ storage_mover_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;