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
- list_by_storage_sync_service
Workflow object
| Name | Datatype | Description |
|---|---|---|
properties | object | Workflow properties. |
Array of Workflow resources in Storage Sync Service
| Name | Datatype | Description |
|---|---|---|
properties | object | Workflow properties. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | subscriptionId, resourceGroupName, storageSyncServiceName, workflowId | Get Workflows resource | |
list_by_storage_sync_service | select | subscriptionId, resourceGroupName, storageSyncServiceName | Get a Workflow List | |
abort | exec | subscriptionId, resourceGroupName, storageSyncServiceName, workflowId | 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 |
|---|---|---|
resourceGroupName | string | The name of the resource group. The name is case insensitive. |
storageSyncServiceName | string | Name of Storage Sync Service resource. |
subscriptionId | string (uuid) | The ID of the target subscription. The value must be an UUID. |
workflowId | string | workflow Id |
SELECT examples
- get
- list_by_storage_sync_service
Get Workflows resource
SELECT
properties
FROM azure.storage_sync.workflows
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND storageSyncServiceName = '{{ storageSyncServiceName }}' -- required
AND workflowId = '{{ workflowId }}' -- required
;
Get a Workflow List
SELECT
properties
FROM azure.storage_sync.workflows
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND storageSyncServiceName = '{{ storageSyncServiceName }}' -- required
;
Lifecycle Methods
- abort
Abort the given workflow.
EXEC azure.storage_sync.workflows.abort
@subscriptionId='{{ subscriptionId }}' --required,
@resourceGroupName='{{ resourceGroupName }}' --required,
@storageSyncServiceName='{{ storageSyncServiceName }}' --required,
@workflowId='{{ workflowId }}' --required
;