workflows

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

Overview

Name	workflows
Type	Resource
Id	azure.logic_apps.workflows

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The resource id.
name	string	Gets the resource name.
identity	object	Managed service identity properties.
location	string	The resource location.
properties	object	The workflow properties.
tags	object	The resource tags.
type	string	Gets the resource type.

list_by_resource_group

Name	Datatype	Description
id	string	The resource id.
name	string	Gets the resource name.
identity	object	Managed service identity properties.
location	string	The resource location.
properties	object	The workflow properties.
tags	object	The resource tags.
type	string	Gets the resource type.

list_by_subscription

Name	Datatype	Description
id	string	The resource id.
name	string	Gets the resource name.
identity	object	Managed service identity properties.
location	string	The resource location.
properties	object	The workflow properties.
tags	object	The resource tags.
type	string	Gets the resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, workflowName	api-version	Gets a workflow.
list_by_resource_group	select	subscriptionId, resourceGroupName	api-version, $top, $filter	Gets a list of workflows by resource group.
list_by_subscription	select	subscriptionId	api-version, $top, $filter	Gets a list of workflows by subscription.
create_or_update	insert	subscriptionId, resourceGroupName, workflowName	api-version	Creates or updates a workflow.
update	update	subscriptionId, resourceGroupName, workflowName	api-version	Updates a workflow.
delete	delete	subscriptionId, resourceGroupName, workflowName	api-version	Deletes a workflow.
disable	exec	subscriptionId, resourceGroupName, workflowName	api-version	Disables a workflow.
enable	exec	subscriptionId, resourceGroupName, workflowName	api-version	Enables a workflow.
generate_upgraded_definition	exec	subscriptionId, resourceGroupName, workflowName	api-version	Generates the upgraded definition for a workflow.
move	exec	subscriptionId, resourceGroupName, workflowName	api-version	Moves an existing workflow.
regenerate_access_key	exec	subscriptionId, resourceGroupName, workflowName	api-version	Regenerates the callback URL access key for request triggers.
validate_by_resource_group	exec	subscriptionId, resourceGroupName, workflowName	api-version	Validates the workflow.
validate_by_location	exec	subscriptionId, resourceGroupName, location, workflowName	api-version	Validates the workflow definition.

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 workflow location.
resourceGroupName	string	The resource group name.
subscriptionId	string	The subscription id.
workflowName	string	The workflow name.
$filter	string	The filter to apply on the operation. Options for filters include: State, Trigger, and ReferencedResourceId.
$top	integer (int32)	The number of items to be included in the result.
api-version	string	The API version.

SELECT examples

get

Gets a workflow.

SELECT
id,
name,
identity,
location,
properties,
tags,
type
FROM azure.logic_apps.workflows
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workflowName = '{{ workflowName }}' -- required
AND api-version = '{{ api-version }}'
;

list_by_resource_group

Gets a list of workflows by resource group.

SELECT
id,
name,
identity,
location,
properties,
tags,
type
FROM azure.logic_apps.workflows
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND api-version = '{{ api-version }}'
AND $top = '{{ $top }}'
AND $filter = '{{ $filter }}'
;

list_by_subscription

Gets a list of workflows by subscription.

SELECT
id,
name,
identity,
location,
properties,
tags,
type
FROM azure.logic_apps.workflows
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
AND $top = '{{ $top }}'
AND $filter = '{{ $filter }}'
;

INSERT examples

create_or_update

Creates or updates a workflow.

INSERT INTO azure.logic_apps.workflows (
data__properties,
data__identity,
data__location,
data__tags,
subscriptionId,
resourceGroupName,
workflowName,
api-version
)
SELECT 
'{{ properties }}',
'{{ identity }}',
'{{ location }}',
'{{ tags }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workflowName }}',
'{{ api-version }}'
RETURNING
id,
name,
identity,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: workflows
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the workflows resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the workflows resource.
    - name: workflowName
      value: string
      description: Required parameter for the workflows resource.
    - name: properties
      value: object
      description: |
        The workflow properties.
    - name: identity
      value: object
      description: |
        Managed service identity properties.
    - name: location
      value: string
      description: |
        The resource location.
    - name: tags
      value: object
      description: |
        The resource tags.
    - name: api-version
      value: string
      description: The API version.

UPDATE examples

update

Updates a workflow.

UPDATE azure.logic_apps.workflows
SET 
-- No updatable properties
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workflowName = '{{ workflowName }}' --required
AND api-version = '{{ api-version}}'
RETURNING
id,
name,
identity,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes a workflow.

DELETE FROM azure.logic_apps.workflows
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workflowName = '{{ workflowName }}' --required
AND api-version = '{{ api-version }}'
;

Lifecycle Methods

disable

Disables a workflow.

EXEC azure.logic_apps.workflows.disable 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workflowName='{{ workflowName }}' --required, 
@api-version='{{ api-version }}'
;

enable

Enables a workflow.

EXEC azure.logic_apps.workflows.enable 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workflowName='{{ workflowName }}' --required, 
@api-version='{{ api-version }}'
;

generate_upgraded_definition

Generates the upgraded definition for a workflow.

EXEC azure.logic_apps.workflows.generate_upgraded_definition 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workflowName='{{ workflowName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"targetSchemaVersion": "{{ targetSchemaVersion }}"
}'
;

move

Moves an existing workflow.

EXEC azure.logic_apps.workflows.move 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workflowName='{{ workflowName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"id": "{{ id }}"
}'
;

regenerate_access_key

Regenerates the callback URL access key for request triggers.

EXEC azure.logic_apps.workflows.regenerate_access_key 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workflowName='{{ workflowName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"keyType": "{{ keyType }}"
}'
;

validate_by_resource_group

Validates the workflow.

EXEC azure.logic_apps.workflows.validate_by_resource_group 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workflowName='{{ workflowName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"properties": "{{ properties }}", 
"identity": "{{ identity }}", 
"location": "{{ location }}", 
"tags": "{{ tags }}"
}'
;

validate_by_location

Validates the workflow definition.

EXEC azure.logic_apps.workflows.validate_by_location 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@location='{{ location }}' --required, 
@workflowName='{{ workflowName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"properties": "{{ properties }}", 
"identity": "{{ identity }}", 
"location": "{{ location }}", 
"tags": "{{ tags }}"
}'
;