workflows

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

Overview

Name	workflows
Type	Resource
Id	azure.logic.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.
accessControl	object	The access control configuration.
accessEndpoint	string	Gets the access endpoint.
changedTime	string (date-time)	Gets the changed time.
createdTime	string (date-time)	Gets the created time.
definition	object	The definition.
endpointsConfiguration	object	The endpoints configuration.
identity	object	Managed service identity properties.
integrationAccount	object	The resource reference. Variables are only populated by the server, and will be ignored when sending a request.
integrationServiceEnvironment	object	The resource reference. Variables are only populated by the server, and will be ignored when sending a request.
location	string	The resource location.
parameters	object	The parameters.
provisioningState	string	Gets the provisioning state. Known values are: "NotSpecified", "Accepted", "Running", "Ready", "Creating", "Created", "Deleting", "Deleted", "Canceled", "Failed", "Succeeded", "Moving", "Updating", "Registering", "Registered", "Unregistering", "Unregistered", "Completed", "Renewing", "Pending", "Waiting", and "InProgress".
sku	object	The sku.
state	string	The state. Known values are: "NotSpecified", "Completed", "Enabled", "Disabled", "Deleted", and "Suspended".
tags	object	The resource tags.
type	string	Gets the resource type.
version	string	Gets the version.

list_by_resource_group

Name	Datatype	Description
id	string	The resource id.
name	string	Gets the resource name.
accessControl	object	The access control configuration.
accessEndpoint	string	Gets the access endpoint.
changedTime	string (date-time)	Gets the changed time.
createdTime	string (date-time)	Gets the created time.
definition	object	The definition.
endpointsConfiguration	object	The endpoints configuration.
identity	object	Managed service identity properties.
integrationAccount	object	The resource reference. Variables are only populated by the server, and will be ignored when sending a request.
integrationServiceEnvironment	object	The resource reference. Variables are only populated by the server, and will be ignored when sending a request.
location	string	The resource location.
parameters	object	The parameters.
provisioningState	string	Gets the provisioning state. Known values are: "NotSpecified", "Accepted", "Running", "Ready", "Creating", "Created", "Deleting", "Deleted", "Canceled", "Failed", "Succeeded", "Moving", "Updating", "Registering", "Registered", "Unregistering", "Unregistered", "Completed", "Renewing", "Pending", "Waiting", and "InProgress".
sku	object	The sku.
state	string	The state. Known values are: "NotSpecified", "Completed", "Enabled", "Disabled", "Deleted", and "Suspended".
tags	object	The resource tags.
type	string	Gets the resource type.
version	string	Gets the version.

list_by_subscription

Name	Datatype	Description
id	string	The resource id.
name	string	Gets the resource name.
accessControl	object	The access control configuration.
accessEndpoint	string	Gets the access endpoint.
changedTime	string (date-time)	Gets the changed time.
createdTime	string (date-time)	Gets the created time.
definition	object	The definition.
endpointsConfiguration	object	The endpoints configuration.
identity	object	Managed service identity properties.
integrationAccount	object	The resource reference. Variables are only populated by the server, and will be ignored when sending a request.
integrationServiceEnvironment	object	The resource reference. Variables are only populated by the server, and will be ignored when sending a request.
location	string	The resource location.
parameters	object	The parameters.
provisioningState	string	Gets the provisioning state. Known values are: "NotSpecified", "Accepted", "Running", "Ready", "Creating", "Created", "Deleting", "Deleted", "Canceled", "Failed", "Succeeded", "Moving", "Updating", "Registering", "Registered", "Unregistering", "Unregistered", "Completed", "Renewing", "Pending", "Waiting", and "InProgress".
sku	object	The sku.
state	string	The state. Known values are: "NotSpecified", "Completed", "Enabled", "Disabled", "Deleted", and "Suspended".
tags	object	The resource tags.
type	string	Gets the resource type.
version	string	Gets the version.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, workflow_name, subscription_id		Gets a workflow.
list_by_resource_group	select	resource_group_name, subscription_id	$top, $filter	Gets a list of workflows by resource group.
list_by_subscription	select	subscription_id	$top, $filter	Gets a list of workflows by subscription.
create_or_update	insert	resource_group_name, workflow_name, subscription_id		Creates or updates a workflow.
update	update	resource_group_name, workflow_name, subscription_id		Updates a workflow.
create_or_update	replace	resource_group_name, workflow_name, subscription_id		Creates or updates a workflow.
delete	delete	resource_group_name, workflow_name, subscription_id		Deletes a workflow.
list_callback_url	exec	resource_group_name, workflow_name, subscription_id		Get the workflow callback Url.
list_swagger	exec	resource_group_name, workflow_name, subscription_id		Gets an OpenAPI definition for the workflow.
disable	exec	resource_group_name, workflow_name, subscription_id		Disables a workflow.
enable	exec	resource_group_name, workflow_name, subscription_id		Enables a workflow.
generate_upgraded_definition	exec	resource_group_name, workflow_name, subscription_id		Generates the upgraded definition for a workflow.
move	exec	resource_group_name, workflow_name, subscription_id		Moves an existing workflow.
regenerate_access_key	exec	resource_group_name, workflow_name, subscription_id		Regenerates the callback URL access key for request triggers.
validate_by_resource_group	exec	resource_group_name, workflow_name, subscription_id		Validates the workflow.
validate_by_location	exec	resource_group_name, location, workflow_name, subscription_id		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. Required.
resource_group_name	string	The resource group name. Required.
subscription_id	string
workflow_name	string	The workflow name. Required.
$filter	string	The filter to apply on the operation. Options for filters include: State, Trigger, and ReferencedResourceId. Default value is None.
$top	integer	The number of items to be included in the result. Default value is None.

SELECT examples

get

Gets a workflow.

SELECT
id,
name,
accessControl,
accessEndpoint,
changedTime,
createdTime,
definition,
endpointsConfiguration,
identity,
integrationAccount,
integrationServiceEnvironment,
location,
parameters,
provisioningState,
sku,
state,
tags,
type,
version
FROM azure.logic.workflows
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workflow_name = '{{ workflow_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Gets a list of workflows by resource group.

SELECT
id,
name,
accessControl,
accessEndpoint,
changedTime,
createdTime,
definition,
endpointsConfiguration,
identity,
integrationAccount,
integrationServiceEnvironment,
location,
parameters,
provisioningState,
sku,
state,
tags,
type,
version
FROM azure.logic.workflows
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $filter = '{{ $filter }}'
;

list_by_subscription

Gets a list of workflows by subscription.

SELECT
id,
name,
accessControl,
accessEndpoint,
changedTime,
createdTime,
definition,
endpointsConfiguration,
identity,
integrationAccount,
integrationServiceEnvironment,
location,
parameters,
provisioningState,
sku,
state,
tags,
type,
version
FROM azure.logic.workflows
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $filter = '{{ $filter }}'
;

INSERT examples

create_or_update

Creates or updates a workflow.

INSERT INTO azure.logic.workflows (
location,
tags,
identity,
properties,
resource_group_name,
workflow_name,
subscription_id
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ identity }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ workflow_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: workflows
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the workflows resource.
  - name: workflow_name
    value: "{{ workflow_name }}"
    description: Required parameter for the workflows resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the workflows resource.
  - name: location
    value: "{{ location }}"
    description: |
      The resource location.
  - name: tags
    value: "{{ tags }}"
    description: |
      The resource tags.
  - name: identity
    description: |
      Managed service identity properties.
    value:
      type: "{{ type }}"
      tenantId: "{{ tenantId }}"
      principalId: "{{ principalId }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
  - name: properties
    value:
      state: "{{ state }}"
      endpointsConfiguration:
        workflow:
          outgoingIpAddresses:
            - address: "{{ address }}"
          accessEndpointIpAddresses:
            - address: "{{ address }}"
        connector:
          outgoingIpAddresses:
            - address: "{{ address }}"
          accessEndpointIpAddresses:
            - address: "{{ address }}"
      accessControl:
        triggers:
          allowedCallerIpAddresses:
            - addressRange: "{{ addressRange }}"
          openAuthenticationPolicies:
            policies: "{{ policies }}"
        contents:
          allowedCallerIpAddresses:
            - addressRange: "{{ addressRange }}"
          openAuthenticationPolicies:
            policies: "{{ policies }}"
        actions:
          allowedCallerIpAddresses:
            - addressRange: "{{ addressRange }}"
          openAuthenticationPolicies:
            policies: "{{ policies }}"
        workflowManagement:
          allowedCallerIpAddresses:
            - addressRange: "{{ addressRange }}"
          openAuthenticationPolicies:
            policies: "{{ policies }}"
      integrationAccount:
        id: "{{ id }}"
        name: "{{ name }}"
        type: "{{ type }}"
      integrationServiceEnvironment:
        id: "{{ id }}"
        name: "{{ name }}"
        type: "{{ type }}"
      definition: "{{ definition }}"
      parameters: "{{ parameters }}"

UPDATE examples

update

Updates a workflow.

UPDATE azure.logic.workflows
SET 
-- No updatable properties
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workflow_name = '{{ workflow_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a workflow.

REPLACE azure.logic.workflows
SET 
location = '{{ location }}',
tags = '{{ tags }}',
identity = '{{ identity }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workflow_name = '{{ workflow_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes a workflow.

DELETE FROM azure.logic.workflows
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND workflow_name = '{{ workflow_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_callback_url

Get the workflow callback Url.

EXEC azure.logic.workflows.list_callback_url 
@resource_group_name='{{ resource_group_name }}' --required, 
@workflow_name='{{ workflow_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"notAfter": "{{ notAfter }}", 
"keyType": "{{ keyType }}"
}'
;

list_swagger

Gets an OpenAPI definition for the workflow.

EXEC azure.logic.workflows.list_swagger 
@resource_group_name='{{ resource_group_name }}' --required, 
@workflow_name='{{ workflow_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

disable

Disables a workflow.

EXEC azure.logic.workflows.disable 
@resource_group_name='{{ resource_group_name }}' --required, 
@workflow_name='{{ workflow_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

enable

Enables a workflow.

EXEC azure.logic.workflows.enable 
@resource_group_name='{{ resource_group_name }}' --required, 
@workflow_name='{{ workflow_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

generate_upgraded_definition

Generates the upgraded definition for a workflow.

EXEC azure.logic.workflows.generate_upgraded_definition 
@resource_group_name='{{ resource_group_name }}' --required, 
@workflow_name='{{ workflow_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"targetSchemaVersion": "{{ targetSchemaVersion }}"
}'
;

move

Moves an existing workflow.

EXEC azure.logic.workflows.move 
@resource_group_name='{{ resource_group_name }}' --required, 
@workflow_name='{{ workflow_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"id": "{{ id }}"
}'
;

regenerate_access_key

Regenerates the callback URL access key for request triggers.

EXEC azure.logic.workflows.regenerate_access_key 
@resource_group_name='{{ resource_group_name }}' --required, 
@workflow_name='{{ workflow_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"keyType": "{{ keyType }}"
}'
;

validate_by_resource_group

Validates the workflow.

EXEC azure.logic.workflows.validate_by_resource_group 
@resource_group_name='{{ resource_group_name }}' --required, 
@workflow_name='{{ workflow_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"location": "{{ location }}", 
"tags": "{{ tags }}", 
"identity": "{{ identity }}", 
"properties": "{{ properties }}"
}'
;

validate_by_location

Validates the workflow definition.

EXEC azure.logic.workflows.validate_by_location 
@resource_group_name='{{ resource_group_name }}' --required, 
@location='{{ location }}' --required, 
@workflow_name='{{ workflow_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"location": "{{ location }}", 
"tags": "{{ tags }}", 
"identity": "{{ identity }}", 
"properties": "{{ properties }}"
}'
;