Microsoft.Logic workflows 2018-07-01-preview

Article
08/11/2023

Bicep resource definition

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

Resource groups - See resource group deployment commands

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@2018-07-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    definition: any()
    integrationAccount: {
      id: 'string'
    }
    parameters: {}
    sku: {
      name: 'string'
      plan: {
        id: 'string'
      }
    }
    state: 'string'
  }
}

Property values

workflows

Name	Description	Value
name	The resource name	string (required) Character limit: 1-43 Valid characters: Alphanumerics, hyphens, underscores, periods, and parenthesis.
location	The resource location.	string
tags	The resource tags.	Dictionary of tag names and values. See Tags in templates
properties	The workflow properties.	WorkflowProperties

WorkflowProperties

Name	Description	Value
definition	The definition. See Schema reference for Workflow Definition Language in Azure Logic Apps. See Schema reference for Workflow Definition Language in Azure Logic Apps.	For Bicep, you can use the any() function.
integrationAccount	The integration account.	ResourceReference
parameters	The parameters.	object
sku	The sku.	Sku
state	The state.	'Completed' 'Deleted' 'Disabled' 'Enabled' 'NotSpecified' 'Suspended'

ResourceReference

Name	Description	Value
id	The resource id.	string

Sku

Name	Description	Value
name	The name.	'Basic' 'Free' 'NotSpecified' 'Premium' 'Shared' 'Standard' (required)
plan	The reference to plan.	ResourceReference

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Alert to queue with Logic app	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	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	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.
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.
Logic App to email detailed backup reports	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 instances	Create a Logic App to send reports on backup instances protected using Azure Backup via email
Logic App to email reports on backup and restore jobs	Create a Logic App to send reports on your backup and restore jobs via email
Logic App to email reports on backup cost optimizmation	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 policies	Create a Logic App to send reports on your backup policies via email
Logic App to email reports on backup policy adherence	Create a Logic App to send reports on backup policy adherence of your backup instances via email
Logic App to email summary reports on backups	Create a Logic App to send summary reports on your backups via email.
Logic App to email reports on your Azure Backup billing	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.
Deploy a sample logic app, to use as Entitlement Management custom extensions	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.
Integration Patterns - Message Router - Logic App	Solution which shows how we can set up the Message Router pattern using a Logic App
Extend Existing Azure Resources with Custom Providers	This sample will go into detail on how to extend existing Azure resources and Resource Manager templates to add in custom workloads.
Create a Custom Resource for templates with Custom Providers	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	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.
Azure Logic App with Function	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	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	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.
Correlating messages over Logic Apps using Service Bus	which shows how we can correlate messages over Logic Apps using Azure Service Bus
Create a Consumption logic app	This template creates an empty logic app that you can use to define workflows.
Call custom APIs from Azure Logic Apps	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	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.
Send email with Logic app	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.
Run a SQL stored procedure on a schedule via a logic app	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.
Azure Logic Apps - VETER Pipeline	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	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.
Run timer jobs that execute on a schedule using Logic Apps	This template creates a pair of Logic Apps that allows you to create scheduled timer job instances.

ARM template resource definition

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

Resource groups - See resource group deployment commands

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": "2018-07-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "definition": {},
    "integrationAccount": {
      "id": "string"
    },
    "parameters": {},
    "sku": {
      "name": "string",
      "plan": {
        "id": "string"
      }
    },
    "state": "string"
  }
}

Property values

workflows

Name	Description	Value
type	The resource type	'Microsoft.Logic/workflows'
apiVersion	The resource api version	'2018-07-01-preview'
name	The resource name	string (required) Character limit: 1-43 Valid characters: Alphanumerics, hyphens, underscores, periods, and parenthesis.
location	The resource location.	string
tags	The resource tags.	Dictionary of tag names and values. See Tags in templates
properties	The workflow properties.	WorkflowProperties

WorkflowProperties

Name	Description	Value
definition	The definition. See Schema reference for Workflow Definition Language in Azure Logic Apps. See Schema reference for Workflow Definition Language in Azure Logic Apps.
integrationAccount	The integration account.	ResourceReference
parameters	The parameters.	object
sku	The sku.	Sku
state	The state.	'Completed' 'Deleted' 'Disabled' 'Enabled' 'NotSpecified' 'Suspended'

ResourceReference

Name	Description	Value
id	The resource id.	string

Sku

Name	Description	Value
name	The name.	'Basic' 'Free' 'NotSpecified' 'Premium' 'Shared' 'Standard' (required)
plan	The reference to plan.	ResourceReference

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Alert to queue with Logic app	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	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	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.
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.
Logic App to email detailed backup reports	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 instances	Create a Logic App to send reports on backup instances protected using Azure Backup via email
Logic App to email reports on backup and restore jobs	Create a Logic App to send reports on your backup and restore jobs via email
Logic App to email reports on backup cost optimizmation	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 policies	Create a Logic App to send reports on your backup policies via email
Logic App to email reports on backup policy adherence	Create a Logic App to send reports on backup policy adherence of your backup instances via email
Logic App to email summary reports on backups	Create a Logic App to send summary reports on your backups via email.
Logic App to email reports on your Azure Backup billing	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.
Deploy a sample logic app, to use as Entitlement Management custom extensions	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.
Integration Patterns - Message Router - Logic App	Solution which shows how we can set up the Message Router pattern using a Logic App
Extend Existing Azure Resources with Custom Providers	This sample will go into detail on how to extend existing Azure resources and Resource Manager templates to add in custom workloads.
Create a Custom Resource for templates with Custom Providers	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	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.
Azure Logic App with Function	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	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	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.
Correlating messages over Logic Apps using Service Bus	which shows how we can correlate messages over Logic Apps using Azure Service Bus
Create a Consumption logic app	This template creates an empty logic app that you can use to define workflows.
Call custom APIs from Azure Logic Apps	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	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.
Send email with Logic app	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.
Run a SQL stored procedure on a schedule via a logic app	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.
Azure Logic Apps - VETER Pipeline	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	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.
Run timer jobs that execute on a schedule using Logic Apps	This template creates a pair of Logic Apps that allows you to create scheduled timer job instances.

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@2018-07-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      integrationAccount = {
        id = "string"
      }
      parameters = {}
      sku = {
        name = "string"
        plan = {
          id = "string"
        }
      }
      state = "string"
    }
  })
}

Property values

workflows

Name	Description	Value
type	The resource type	"Microsoft.Logic/workflows@2018-07-01-preview"
name	The resource name	string (required) Character limit: 1-43 Valid characters: Alphanumerics, hyphens, underscores, periods, and parenthesis.
location	The resource location.	string
parent_id	To deploy to a resource group, use the ID of that resource group.	string (required)
tags	The resource tags.	Dictionary of tag names and values.
properties	The workflow properties.	WorkflowProperties

WorkflowProperties

Name	Description	Value
definition	The definition. See Schema reference for Workflow Definition Language in Azure Logic Apps. See Schema reference for Workflow Definition Language in Azure Logic Apps.
integrationAccount	The integration account.	ResourceReference
parameters	The parameters.	object
sku	The sku.	Sku
state	The state.	"Completed" "Deleted" "Disabled" "Enabled" "NotSpecified" "Suspended"

ResourceReference

Name	Description	Value
id	The resource id.	string

Sku

Name	Description	Value
name	The name.	"Basic" "Free" "NotSpecified" "Premium" "Shared" "Standard" (required)
plan	The reference to plan.	ResourceReference

Share via

Microsoft.Logic workflows 2018-07-01-preview

Bicep resource definition

Resource format

Property values

workflows

WorkflowProperties

ResourceReference

Sku

Quickstart templates

ARM template resource definition

Resource format

Property values

workflows

WorkflowProperties

ResourceReference

Sku

Quickstart templates

Terraform (AzAPI provider) resource definition

Resource format

Property values

workflows

WorkflowProperties

ResourceReference

Sku

Feedback

Additional resources