storage_tasks

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

Overview

Name	storage_tasks
Type	Resource
Id	azure.storageactions.storage_tasks

Fields

The following fields are returned by SELECT queries:

get

OK -- properties retrieved successfully for the storage task.

Name	Datatype	Description
identity	object	The managed service identity of the resource.
location	string	The geo-location where the resource lives
properties	object	Properties of the storage task.
tags	object	Resource tags.

list_by_resource_group

OK -- List of storage tasks in the given resource group retrieved and returned successfully.

Name	Datatype	Description
identity	object	The managed service identity of the resource.
location	string	The geo-location where the resource lives
properties	object	Properties of the storage task.
tags	object	Resource tags.

list_by_subscription

OK -- List of storage tasks was retrieved and returned successfully.

Name	Datatype	Description
identity	object	The managed service identity of the resource.
location	string	The geo-location where the resource lives
properties	object	Properties of the storage task.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, storageTaskName, subscriptionId		Get the storage task properties
list_by_resource_group	select	resourceGroupName, subscriptionId		Lists all the storage tasks available under the given resource group.
list_by_subscription	select	subscriptionId		Lists all the storage tasks available under the subscription.
create	insert	resourceGroupName, storageTaskName, subscriptionId, data__identity, data__properties		Asynchronously creates a new storage task resource with the specified parameters. If a storage task is already created and a subsequent create request is issued with different properties, the storage task properties will be updated. If a storage task is already created and a subsequent create or update request is issued with the exact same set of properties, the request will succeed.
update	update	resourceGroupName, storageTaskName, subscriptionId		Update storage task properties
delete	delete	resourceGroupName, storageTaskName, subscriptionId		Delete the storage task resource.
preview_actions	exec	subscriptionId, location, properties		Runs the input conditions against input object metadata properties and designates matched objects in response.

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
location	string	The location to perform preview of the actions.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
storageTaskName	string	The name of the storage task within the specified resource group. Storage task names must be between 3 and 18 characters in length and use numbers and lower-case letters only.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Get the storage task properties

SELECT
identity,
location,
properties,
tags
FROM azure.storageactions.storage_tasks
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND storageTaskName = '{{ storageTaskName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_resource_group

Lists all the storage tasks available under the given resource group.

SELECT
identity,
location,
properties,
tags
FROM azure.storageactions.storage_tasks
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_subscription

Lists all the storage tasks available under the subscription.

SELECT
identity,
location,
properties,
tags
FROM azure.storageactions.storage_tasks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Asynchronously creates a new storage task resource with the specified parameters. If a storage task is already created and a subsequent create request is issued with different properties, the storage task properties will be updated. If a storage task is already created and a subsequent create or update request is issued with the exact same set of properties, the request will succeed.

INSERT INTO azure.storageactions.storage_tasks (
data__identity,
data__properties,
data__tags,
data__location,
resourceGroupName,
storageTaskName,
subscriptionId
)
SELECT 
'{{ identity }}' /* required */,
'{{ properties }}' /* required */,
'{{ tags }}',
'{{ location }}',
'{{ resourceGroupName }}',
'{{ storageTaskName }}',
'{{ subscriptionId }}'
RETURNING
identity,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: storage_tasks
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the storage_tasks resource.
    - name: storageTaskName
      value: string
      description: Required parameter for the storage_tasks resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the storage_tasks resource.
    - name: identity
      value: object
      description: |
        The managed service identity of the resource.
    - name: properties
      value: object
      description: |
        Properties of the storage task.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Update storage task properties

UPDATE azure.storageactions.storage_tasks
SET 
data__identity = '{{ identity }}',
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND storageTaskName = '{{ storageTaskName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
identity,
location,
properties,
tags;

DELETE examples

delete

Delete the storage task resource.

DELETE FROM azure.storageactions.storage_tasks
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND storageTaskName = '{{ storageTaskName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

preview_actions

Runs the input conditions against input object metadata properties and designates matched objects in response.

EXEC azure.storageactions.storage_tasks.preview_actions 
@subscriptionId='{{ subscriptionId }}' --required, 
@location='{{ location }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;