Share via

Microsoft.Logic workflows 2019-05-01

  • Article

Bicep resource definition

The workflows resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Logic/workflows resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Logic/workflows@2019-05-01' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    accessControl: {
      actions: {
        allowedCallerIpAddresses: [
          {
            addressRange: 'string'
          }
        ]
        openAuthenticationPolicies: {
          policies: {
            {customized property}: {
              claims: [
                {
                  name: 'string'
                  value: 'string'
                }
              ]
              type: 'string'
            }
          }
        }
      }
      contents: {
        allowedCallerIpAddresses: [
          {
            addressRange: 'string'
          }
        ]
        openAuthenticationPolicies: {
          policies: {
            {customized property}: {
              claims: [
                {
                  name: 'string'
                  value: 'string'
                }
              ]
              type: 'string'
            }
          }
        }
      }
      triggers: {
        allowedCallerIpAddresses: [
          {
            addressRange: 'string'
          }
        ]
        openAuthenticationPolicies: {
          policies: {
            {customized property}: {
              claims: [
                {
                  name: 'string'
                  value: 'string'
                }
              ]
              type: 'string'
            }
          }
        }
      }
      workflowManagement: {
        allowedCallerIpAddresses: [
          {
            addressRange: 'string'
          }
        ]
        openAuthenticationPolicies: {
          policies: {
            {customized property}: {
              claims: [
                {
                  name: 'string'
                  value: 'string'
                }
              ]
              type: 'string'
            }
          }
        }
      }
    }
    definition: any(Azure.Bicep.Types.Concrete.AnyType)
    endpointsConfiguration: {
      connector: {
        accessEndpointIpAddresses: [
          {
            address: 'string'
          }
        ]
        outgoingIpAddresses: [
          {
            address: 'string'
          }
        ]
      }
      workflow: {
        accessEndpointIpAddresses: [
          {
            address: 'string'
          }
        ]
        outgoingIpAddresses: [
          {
            address: 'string'
          }
        ]
      }
    }
    integrationAccount: {
      id: 'string'
    }
    integrationServiceEnvironment: {
      id: 'string'
    }
    parameters: {
      {customized property}: {
        description: 'string'
        metadata: any(Azure.Bicep.Types.Concrete.AnyType)
        type: 'string'
        value: any(Azure.Bicep.Types.Concrete.AnyType)
      }
    }
    state: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

FlowAccessControlConfiguration

Name Description Value
actions The access control configuration for workflow actions. FlowAccessControlConfigurationPolicy
contents The access control configuration for accessing workflow run contents. FlowAccessControlConfigurationPolicy
triggers The access control configuration for invoking workflow triggers. FlowAccessControlConfigurationPolicy
workflowManagement The access control configuration for workflow management. FlowAccessControlConfigurationPolicy

FlowAccessControlConfigurationPolicy

Name Description Value
allowedCallerIpAddresses The allowed caller IP address ranges. IpAddressRange[]
openAuthenticationPolicies The authentication policies for workflow. OpenAuthenticationAccessPolicies

FlowEndpoints

Name Description Value
accessEndpointIpAddresses The access endpoint ip address. IpAddress[]
outgoingIpAddresses The outgoing ip address. IpAddress[]

FlowEndpointsConfiguration

Name Description Value
connector The connector endpoints. FlowEndpoints
workflow The workflow endpoints. FlowEndpoints

IpAddress

Name Description Value
address The address. string

IpAddressRange

Name Description Value
addressRange The IP address range. string

ManagedServiceIdentity

Name Description Value
type Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. 'None'
'SystemAssigned'
'UserAssigned' (required)
userAssignedIdentities The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name Description Value

Microsoft.Logic/workflows

Name Description Value
identity Managed service identity properties. ManagedServiceIdentity
location The resource location. string
name The resource name string (required)
properties The workflow properties. WorkflowProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

OpenAuthenticationAccessPolicies

Name Description Value
policies Open authentication policies. OpenAuthenticationAccessPolicies

OpenAuthenticationAccessPolicies

Name Description Value

OpenAuthenticationAccessPolicy

Name Description Value
claims The access policy claims. OpenAuthenticationPolicyClaim[]
type Type of provider for OAuth. 'AAD'

OpenAuthenticationPolicyClaim

Name Description Value
name The name of the claim. string
value The value of the claim. string

ResourceReference

Name Description Value
id The resource id. string

ResourceTags

Name Description Value

UserAssignedIdentity

Name Description Value

WorkflowParameter

Name Description Value
description The description. string
metadata The metadata. any
type The type. 'Array'
'Bool'
'Float'
'Int'
'NotSpecified'
'Object'
'SecureObject'
'SecureString'
'String'
value The value. any

WorkflowProperties

Name Description Value
accessControl The access control configuration. FlowAccessControlConfiguration
definition The definition. any
endpointsConfiguration The endpoints configuration. FlowEndpointsConfiguration
integrationAccount The integration account. ResourceReference
integrationServiceEnvironment The integration service environment. ResourceReference
parameters The parameters. WorkflowPropertiesParameters
state The state. 'Completed'
'Deleted'
'Disabled'
'Enabled'
'NotSpecified'
'Suspended'

WorkflowPropertiesParameters

Name Description Value

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File Description
Azure Logic Apps - AS2 Send Receive Creates integration accounts for two partners, Contoso and Fabrikam, including the artifacts for partners and agreements. The template also creates logic apps between Fabrikam Sales and Contoso to demonstrate synchronous AS2 Send Receive. The template also creates logic apps between Fabrikam Finance and Contoso, which demonstrate asynchronous AS2 Send Receive.
Copy FTP files to Azure Blob logic app This template allows you to create a Logic app triggers on files in an FTP server and copies them to an Azure Blob container. You can add an additional triggers or actions to customize it to your needs.
Create a Consumption logic app This template creates an empty logic app that you can use to define workflows.
Retrieve Azure Storage access keys in ARM template This template will create a Storage account, after which it will create a API connection by dynamically retrieving the primary key of the Storage account. The API connection is then used in a Logic App as a trigger polling for blob changes.

ARM template resource definition

The workflows resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Logic/workflows resource, add the following JSON to your template.

{
  "type": "Microsoft.Logic/workflows",
  "apiVersion": "2019-05-01",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "accessControl": {
      "actions": {
        "allowedCallerIpAddresses": [
          {
            "addressRange": "string"
          }
        ],
        "openAuthenticationPolicies": {
          "policies": {
            "{customized property}": {
              "claims": [
                {
                  "name": "string",
                  "value": "string"
                }
              ],
              "type": "string"
            }
          }
        }
      },
      "contents": {
        "allowedCallerIpAddresses": [
          {
            "addressRange": "string"
          }
        ],
        "openAuthenticationPolicies": {
          "policies": {
            "{customized property}": {
              "claims": [
                {
                  "name": "string",
                  "value": "string"
                }
              ],
              "type": "string"
            }
          }
        }
      },
      "triggers": {
        "allowedCallerIpAddresses": [
          {
            "addressRange": "string"
          }
        ],
        "openAuthenticationPolicies": {
          "policies": {
            "{customized property}": {
              "claims": [
                {
                  "name": "string",
                  "value": "string"
                }
              ],
              "type": "string"
            }
          }
        }
      },
      "workflowManagement": {
        "allowedCallerIpAddresses": [
          {
            "addressRange": "string"
          }
        ],
        "openAuthenticationPolicies": {
          "policies": {
            "{customized property}": {
              "claims": [
                {
                  "name": "string",
                  "value": "string"
                }
              ],
              "type": "string"
            }
          }
        }
      }
    },
    "definition": {},
    "endpointsConfiguration": {
      "connector": {
        "accessEndpointIpAddresses": [
          {
            "address": "string"
          }
        ],
        "outgoingIpAddresses": [
          {
            "address": "string"
          }
        ]
      },
      "workflow": {
        "accessEndpointIpAddresses": [
          {
            "address": "string"
          }
        ],
        "outgoingIpAddresses": [
          {
            "address": "string"
          }
        ]
      }
    },
    "integrationAccount": {
      "id": "string"
    },
    "integrationServiceEnvironment": {
      "id": "string"
    },
    "parameters": {
      "{customized property}": {
        "description": "string",
        "metadata": {},
        "type": "string",
        "value": {}
      }
    },
    "state": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

FlowAccessControlConfiguration

Name Description Value
actions The access control configuration for workflow actions. FlowAccessControlConfigurationPolicy
contents The access control configuration for accessing workflow run contents. FlowAccessControlConfigurationPolicy
triggers The access control configuration for invoking workflow triggers. FlowAccessControlConfigurationPolicy
workflowManagement The access control configuration for workflow management. FlowAccessControlConfigurationPolicy

FlowAccessControlConfigurationPolicy

Name Description Value
allowedCallerIpAddresses The allowed caller IP address ranges. IpAddressRange[]
openAuthenticationPolicies The authentication policies for workflow. OpenAuthenticationAccessPolicies

FlowEndpoints

Name Description Value
accessEndpointIpAddresses The access endpoint ip address. IpAddress[]
outgoingIpAddresses The outgoing ip address. IpAddress[]

FlowEndpointsConfiguration

Name Description Value
connector The connector endpoints. FlowEndpoints
workflow The workflow endpoints. FlowEndpoints

IpAddress

Name Description Value
address The address. string

IpAddressRange

Name Description Value
addressRange The IP address range. string

ManagedServiceIdentity

Name Description Value
type Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. 'None'
'SystemAssigned'
'UserAssigned' (required)
userAssignedIdentities The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name Description Value

Microsoft.Logic/workflows

Name Description Value
apiVersion The api version '2019-05-01'
identity Managed service identity properties. ManagedServiceIdentity
location The resource location. string
name The resource name string (required)
properties The workflow properties. WorkflowProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.Logic/workflows'

OpenAuthenticationAccessPolicies

Name Description Value
policies Open authentication policies. OpenAuthenticationAccessPolicies

OpenAuthenticationAccessPolicies

Name Description Value

OpenAuthenticationAccessPolicy

Name Description Value
claims The access policy claims. OpenAuthenticationPolicyClaim[]
type Type of provider for OAuth. 'AAD'

OpenAuthenticationPolicyClaim

Name Description Value
name The name of the claim. string
value The value of the claim. string

ResourceReference

Name Description Value
id The resource id. string

ResourceTags

Name Description Value

UserAssignedIdentity

Name Description Value

WorkflowParameter

Name Description Value
description The description. string
metadata The metadata. any
type The type. 'Array'
'Bool'
'Float'
'Int'
'NotSpecified'
'Object'
'SecureObject'
'SecureString'
'String'
value The value. any

WorkflowProperties

Name Description Value
accessControl The access control configuration. FlowAccessControlConfiguration
definition The definition. any
endpointsConfiguration The endpoints configuration. FlowEndpointsConfiguration
integrationAccount The integration account. ResourceReference
integrationServiceEnvironment The integration service environment. ResourceReference
parameters The parameters. WorkflowPropertiesParameters
state The state. 'Completed'
'Deleted'
'Disabled'
'Enabled'
'NotSpecified'
'Suspended'

WorkflowPropertiesParameters

Name Description Value

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Alert to queue with Logic app

Deploy to Azure		 This template allows you to create a Logic app that has a webhook. When the Logic app is triggered, it will add the payload you pass to an Azure Storage queue that you specify. You can add this webhook to an Azure Alert and then whenever the Alert fires, you'll get that item in the queue.
Alert to Slack with Logic app

Deploy to Azure		 This template allows you to create a Logic app that has a webhook to be used from an Azure Alert. When the Alert is triggered, it will post a message to a slack channel that you specify. You need to have a slack account to use this template.
Alert to text message with Logic app

Deploy to Azure		 This template allows you to create a Logic app that has a webhook to be used from an Azure Alert. When the Alert is triggered, it will send you a text message with the details of the alert. It uses the go.gl URL shortening service to include a link to the portal to see the resource.
Azure Logic App with Function

Deploy to Azure		 This template creates a Serverless app in Azure with Logic Apps and Functions. The Logic App triggers on an HTTP POST, calls the Azure Function, and returns the response.
Azure Logic Apps - AS2 Send Receive

Deploy to Azure		 Creates integration accounts for two partners, Contoso and Fabrikam, including the artifacts for partners and agreements. The template also creates logic apps between Fabrikam Sales and Contoso to demonstrate synchronous AS2 Send Receive. The template also creates logic apps between Fabrikam Finance and Contoso, which demonstrate asynchronous AS2 Send Receive.
Azure Logic Apps - B2B Disaster Recovery replication

Deploy to Azure		 Creates replication Logic Apps for AS2 MIC, generated and received X12 control numbers. Each Logic App's trigger points to a primary site integration account. Each Logic App's action points to a secondary site integration account.
Azure Logic Apps - VETER Pipeline

Deploy to Azure		 Creates an integration account, adds schema/map into it, creates a logic app and associates it with the integration account. The logic app implements a VETER pipeline using Xml Validation, XPath Extract and Transform Xml operations.
Azure Logic Apps - XSLT with parameters

Deploy to Azure		 Creates a request-response Logic App which performs XSLT based transformation. The XSLT map takes primitives (integer, string etc.) as input parameters as uses them during XML transformation.
Call custom APIs from Azure Logic Apps

Deploy to Azure		 Although Logic Apps provides hundreds of connectors for various services, you might want to call APIs that run your own code. One of the easiest and most scalable ways to host your own web APIs is by using Azure App Service. This template deploys a Web app for your custom API and secures that API by using Azure Active Directory authentication.
Copy FTP files to Azure Blob logic app

Deploy to Azure		 This template allows you to create a Logic app triggers on files in an FTP server and copies them to an Azure Blob container. You can add an additional triggers or actions to customize it to your needs.
Correlating messages over Logic Apps using Service Bus

Deploy to Azure		 which shows how we can correlate messages over Logic Apps using Azure Service Bus
Create a Consumption logic app

Deploy to Azure		 This template creates an empty logic app that you can use to define workflows.
Create a Custom Resource for templates with Custom Providers

Deploy to Azure		 This sample shows how to add custom resources to Resource Manager Templates using custom providers and logic apps.
Custom Azure Event Grid Topic/Subscription with CloudEvents

Deploy to Azure		 Creates a custom Azure Event Grid topic, a webhook subscription having CloudEvents schema, and a Logic App as an event handler. Template originally authored by Justin Yoo.
Deploy a sample logic app, to use as Entitlement Management custom extensions

Deploy to Azure		 This template creates a simple logic app with all the authorization policy settings and schema to http trigger that is needed by Entitlement Management custom extension API.
Extend Existing Azure Resources with Custom Providers

Deploy to Azure		 This sample will go into detail on how to extend existing Azure resources and Resource Manager templates to add in custom workloads.
Integration Patterns - Message Router - Logic App

Deploy to Azure		 Solution which shows how we can set up the Message Router pattern using a Logic App
Logic App to email detailed backup reports

Deploy to Azure		 Create a Logic App to send reports on backup instances, usage, jobs, policies, policy adherence, and optimization opportunities via email.
Logic App to email reports on backup and restore jobs

Deploy to Azure		 Create a Logic App to send reports on your backup and restore jobs via email
Logic App to email reports on backup cost optimizmation

Deploy to Azure		 This template deploys a Logic App that sends periodic reports on inactive backup resources, possible backup schedule optimizations and possible backup retention optimizations, to a specified set of email addresses.
Logic App to email reports on backup instances

Deploy to Azure		 Create a Logic App to send reports on backup instances protected using Azure Backup via email
Logic App to email reports on backup policies

Deploy to Azure		 Create a Logic App to send reports on your backup policies via email
Logic App to email reports on backup policy adherence

Deploy to Azure		 Create a Logic App to send reports on backup policy adherence of your backup instances via email
Logic App to email reports on your Azure Backup billing

Deploy to Azure		 This template deploys a Logic App that sends periodic reports on key backup billing parameters (protected instances and backup cloud storage consumed) at a billing-entity level, to a specified set of email addresses.
Logic App to email summary reports on backups

Deploy to Azure		 Create a Logic App to send summary reports on your backups via email.
Retrieve Azure Storage access keys in ARM template

Deploy to Azure		 This template will create a Storage account, after which it will create a API connection by dynamically retrieving the primary key of the Storage account. The API connection is then used in a Logic App as a trigger polling for blob changes.
Run a SQL stored procedure on a schedule via a logic app

Deploy to Azure		 This template allows you to create a Logic App that will run a SQL stored procedure on schedule. Any arguments for the procedure can be put into the body section of the template.
Run timer jobs that execute on a schedule using Logic Apps

Deploy to Azure		 This template creates a pair of Logic Apps that allows you to create scheduled timer job instances.
Send email with Logic app

Deploy to Azure		 This template allows you to create a Logic app that sends an email. You can add an additional triggers or actions to customize it to your needs.

Terraform (AzAPI provider) resource definition

The workflows resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Logic/workflows resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Logic/workflows@2019-05-01"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      accessControl = {
        actions = {
          allowedCallerIpAddresses = [
            {
              addressRange = "string"
            }
          ]
          openAuthenticationPolicies = {
            policies = {
              {customized property} = {
                claims = [
                  {
                    name = "string"
                    value = "string"
                  }
                ]
                type = "string"
              }
            }
          }
        }
        contents = {
          allowedCallerIpAddresses = [
            {
              addressRange = "string"
            }
          ]
          openAuthenticationPolicies = {
            policies = {
              {customized property} = {
                claims = [
                  {
                    name = "string"
                    value = "string"
                  }
                ]
                type = "string"
              }
            }
          }
        }
        triggers = {
          allowedCallerIpAddresses = [
            {
              addressRange = "string"
            }
          ]
          openAuthenticationPolicies = {
            policies = {
              {customized property} = {
                claims = [
                  {
                    name = "string"
                    value = "string"
                  }
                ]
                type = "string"
              }
            }
          }
        }
        workflowManagement = {
          allowedCallerIpAddresses = [
            {
              addressRange = "string"
            }
          ]
          openAuthenticationPolicies = {
            policies = {
              {customized property} = {
                claims = [
                  {
                    name = "string"
                    value = "string"
                  }
                ]
                type = "string"
              }
            }
          }
        }
      }
      definition = ?
      endpointsConfiguration = {
        connector = {
          accessEndpointIpAddresses = [
            {
              address = "string"
            }
          ]
          outgoingIpAddresses = [
            {
              address = "string"
            }
          ]
        }
        workflow = {
          accessEndpointIpAddresses = [
            {
              address = "string"
            }
          ]
          outgoingIpAddresses = [
            {
              address = "string"
            }
          ]
        }
      }
      integrationAccount = {
        id = "string"
      }
      integrationServiceEnvironment = {
        id = "string"
      }
      parameters = {
        {customized property} = {
          description = "string"
          metadata = ?
          type = "string"
          value = ?
        }
      }
      state = "string"
    }
  })
}

Property values

FlowAccessControlConfiguration

Name Description Value
actions The access control configuration for workflow actions. FlowAccessControlConfigurationPolicy
contents The access control configuration for accessing workflow run contents. FlowAccessControlConfigurationPolicy
triggers The access control configuration for invoking workflow triggers. FlowAccessControlConfigurationPolicy
workflowManagement The access control configuration for workflow management. FlowAccessControlConfigurationPolicy

FlowAccessControlConfigurationPolicy

Name Description Value
allowedCallerIpAddresses The allowed caller IP address ranges. IpAddressRange[]
openAuthenticationPolicies The authentication policies for workflow. OpenAuthenticationAccessPolicies

FlowEndpoints

Name Description Value
accessEndpointIpAddresses The access endpoint ip address. IpAddress[]
outgoingIpAddresses The outgoing ip address. IpAddress[]

FlowEndpointsConfiguration

Name Description Value
connector The connector endpoints. FlowEndpoints
workflow The workflow endpoints. FlowEndpoints

IpAddress

Name Description Value
address The address. string

IpAddressRange

Name Description Value
addressRange The IP address range. string

ManagedServiceIdentity

Name Description Value
type Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. 'None'
'SystemAssigned'
'UserAssigned' (required)
userAssignedIdentities The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name Description Value

Microsoft.Logic/workflows

Name Description Value
identity Managed service identity properties. ManagedServiceIdentity
location The resource location. string
name The resource name string (required)
properties The workflow properties. WorkflowProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Logic/workflows@2019-05-01"

OpenAuthenticationAccessPolicies

Name Description Value
policies Open authentication policies. OpenAuthenticationAccessPolicies

OpenAuthenticationAccessPolicies

Name Description Value

OpenAuthenticationAccessPolicy

Name Description Value
claims The access policy claims. OpenAuthenticationPolicyClaim[]
type Type of provider for OAuth. 'AAD'

OpenAuthenticationPolicyClaim

Name Description Value
name The name of the claim. string
value The value of the claim. string

ResourceReference

Name Description Value
id The resource id. string

ResourceTags

Name Description Value

UserAssignedIdentity

Name Description Value

WorkflowParameter

Name Description Value
description The description. string
metadata The metadata. any
type The type. 'Array'
'Bool'
'Float'
'Int'
'NotSpecified'
'Object'
'SecureObject'
'SecureString'
'String'
value The value. any

WorkflowProperties

Name Description Value
accessControl The access control configuration. FlowAccessControlConfiguration
definition The definition. any
endpointsConfiguration The endpoints configuration. FlowEndpointsConfiguration
integrationAccount The integration account. ResourceReference
integrationServiceEnvironment The integration service environment. ResourceReference
parameters The parameters. WorkflowPropertiesParameters
state The state. 'Completed'
'Deleted'
'Disabled'
'Enabled'
'NotSpecified'
'Suspended'

WorkflowPropertiesParameters

Name Description Value