workflows

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

Overview

Name	workflows
Type	Resource
Id	azure.app_service.workflows

Fields

The following fields are returned by SELECT queries:

get

Workflow information returned.

Name	Datatype	Description
id	string	The resource id.
name	string	Gets the resource name.
kind	string	The resource kind.
location	string	The resource location.
properties	object	Additional workflow properties.
type	string	Gets the resource type.

list

Workflow information returned.

Name	Datatype	Description
id	string	The resource id.
name	string	Gets the resource name.
kind	string	The resource kind.
location	string	The resource location.
properties	object	Additional workflow properties.
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, name, workflowName
list	select	subscriptionId, resourceGroupName, name
regenerate_access_key	exec	subscriptionId, resourceGroupName, name, workflowName		Regenerates the callback URL access key for request triggers.
validate	exec	subscriptionId, resourceGroupName, name, workflowName		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
name	string	Site name.
resourceGroupName	string	Name of the resource group to which the resource belongs.
subscriptionId	string	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
workflowName	string	The workflow name.

SELECT examples

get

Workflow information returned.

SELECT
id,
name,
kind,
location,
properties,
type
FROM azure.app_service.workflows
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
AND workflowName = '{{ workflowName }}' -- required
;

list

Workflow information returned.

SELECT
id,
name,
kind,
location,
properties,
type
FROM azure.app_service.workflows
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
;

Lifecycle Methods

regenerate_access_key

Regenerates the callback URL access key for request triggers.

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

validate

Validates the workflow definition.

EXEC azure.app_service.workflows.validate 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@name='{{ name }}' --required, 
@workflowName='{{ workflowName }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"identity": "{{ identity }}", 
"location": "{{ location }}", 
"tags": "{{ tags }}"
}'
;