workflows

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

Overview

Name	workflows
Type	Resource
Id	azure.storage_sync.workflows

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.
commandName	string	workflow command name.
createdTimestamp	string (date-time)	workflow created timestamp.
lastOperationId	string	workflow last operation identifier.
lastStatusTimestamp	string (date-time)	workflow last status timestamp.
lastStepName	string	last step name.
operation	string	operation direction. Known values are: "do", "undo", and "cancel".
status	string	workflow status. Known values are: "active", "expired", "succeeded", "aborted", and "failed".
steps	string	workflow steps.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_storage_sync_service

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.
commandName	string	workflow command name.
createdTimestamp	string (date-time)	workflow created timestamp.
lastOperationId	string	workflow last operation identifier.
lastStatusTimestamp	string (date-time)	workflow last status timestamp.
lastStepName	string	last step name.
operation	string	operation direction. Known values are: "do", "undo", and "cancel".
status	string	workflow status. Known values are: "active", "expired", "succeeded", "aborted", and "failed".
steps	string	workflow steps.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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_sync_service_name, workflow_id, subscription_id		Get Workflows resource.
list_by_storage_sync_service	select	resource_group_name, storage_sync_service_name, subscription_id		Get a Workflow List.
abort	exec	resource_group_name, storage_sync_service_name, workflow_id, subscription_id		Abort the given workflow.

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_sync_service_name	string	Name of Storage Sync Service resource. Required.
subscription_id	string
workflow_id	string	workflow Id. Required.

SELECT examples

get

Get Workflows resource.

SELECT
id,
name,
commandName,
createdTimestamp,
lastOperationId,
lastStatusTimestamp,
lastStepName,
operation,
status,
steps,
systemData,
type
FROM azure.storage_sync.workflows
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND storage_sync_service_name = '{{ storage_sync_service_name }}' -- required
AND workflow_id = '{{ workflow_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_storage_sync_service

Get a Workflow List.

SELECT
id,
name,
commandName,
createdTimestamp,
lastOperationId,
lastStatusTimestamp,
lastStepName,
operation,
status,
steps,
systemData,
type
FROM azure.storage_sync.workflows
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND storage_sync_service_name = '{{ storage_sync_service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

abort

Abort the given workflow.

EXEC azure.storage_sync.workflows.abort 
@resource_group_name='{{ resource_group_name }}' --required, 
@storage_sync_service_name='{{ storage_sync_service_name }}' --required, 
@workflow_id='{{ workflow_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;