Skip to content

Commit e94de7e

Browse files
author
ecfan
committed
Formatting edits and add include file
1 parent 5e2a042 commit e94de7e

5 files changed

+76
-83
lines changed
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
ms.service: azure-logic-apps
3+
ms.author: estfan
4+
author: ecfan
5+
ms.date: 12/09/2024
6+
ms.topic: include
7+
---
8+
9+
> [!IMPORTANT]
10+
>
11+
> The **Azure Logic Apps Tools for Visual Studio** extension is deprecated and no longer receives updates.
12+
> To create and manage logic app workflows using a local development environment, see the following documentation:
13+
>
14+
> - [Quickstart: Create and manage Consumption logic app workflows in multitenant Azure Logic Apps with Visual Studio Code](/azure/logic-apps/quickstart-create-logic-apps-visual-studio-code)
15+
>
16+
> - [Create a Standard logic app workflow in single-tenant Azure Logic Apps with Visual Studio Code](/azure/logic-apps/create-single-tenant-workflows-visual-studio-code)

articles/logic-apps/logic-apps-author-definitions.md

Lines changed: 54 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -5,70 +5,66 @@ services: logic-apps
55
ms.suite: integration
66
ms.reviewer: estfan, azla
77
ms.topic: how-to
8-
ms.date: 01/04/2024
8+
ms.date: 12/09/2024
99
---
1010

1111
# Create, edit, or extend JSON for logic app workflow definitions in Azure Logic Apps
1212

1313
[!INCLUDE [logic-apps-sku-consumption](~/reusable-content/ce-skilling/azure/includes/logic-apps-sku-consumption.md)]
1414

15-
When you create enterprise integration solutions with automated workflows in
16-
[Azure Logic Apps](../logic-apps/logic-apps-overview.md), the underlying workflow definitions use simple and declarative JavaScript Object Notation (JSON) along with the [Workflow Definition Language (WDL) schema](../logic-apps/logic-apps-workflow-definition-language.md) for their description and validation. These formats make workflow definitions easier to read and understand without knowing much about code.
17-
When you want to automate creating and deploying logic app resources, you can include workflow definitions as
18-
[Azure resources](../azure-resource-manager/management/overview.md) inside [Azure Resource Manager templates](../azure-resource-manager/templates/overview.md).
19-
To create, manage, and deploy logic apps, you can then use [Azure PowerShell](/powershell/module/az.logicapp), [Azure CLI](../azure-resource-manager/templates/deploy-cli.md), or the [Azure Logic Apps REST APIs](/rest/api/logic/).
15+
When you create enterprise integration solutions with automated workflows in [Azure Logic Apps](/azure/logic-apps/logic-apps-overview), the underlying workflow definitions use simple and declarative JavaScript Object Notation (JSON) along with the [Workflow Definition Language (WDL) schema](/azure/logic-apps/logic-apps-workflow-definition-language) for their description and validation. These formats make workflow definitions easier to read and understand without knowing much about code. When you want to automate creating and deploying logic app resources, you can include workflow definitions as [Azure resources](/azure/azure-resource-manager/management/overview) inside [Azure Resource Manager templates](/azure/azure-resource-manager/templates/overview). To create, manage, and deploy logic apps, you can then use [Azure PowerShell](/powershell/module/az.logicapp), [Azure CLI](/azure/azure-resource-manager/templates/deploy-cli), or the [Azure Logic Apps REST APIs](/rest/api/logic/).
2016

21-
To work with workflow definitions in JSON, open the Code View editor when working in the Azure portal or Visual Studio Code, or copy the definition into any editor that you want.
17+
To work with workflow definitions in JSON, open the code view editor when you work in the Azure portal, Visual Studio Code, or Visual Studio, or copy the definition into any editor that you want.
2218

2319
> [!NOTE]
24-
> Some Azure Logic Apps capabilities, such as defining
25-
> parameters and multiple triggers in workflow definitions,
26-
> are available only in JSON, not the workflow designer.
27-
> So for these tasks, you must work in Code View or another editor.
20+
>
21+
> Some Azure Logic Apps capabilities, such as defining parameters and multiple triggers
22+
> in workflow definitions, are available only in JSON, not the workflow designer. So,
23+
> for these tasks, you must work in code view or another editor.
2824
2925
## Edit JSON - Azure portal
3026

31-
1. Sign in to the
32-
<a href="https://portal.azure.com" target="_blank">Azure portal</a>.
27+
1. In the <a href="https://portal.azure.com" target="_blank">Azure portal</a> search box, enter and select **logic apps**. From the **Logic apps** page, select the Consumption logic app resource that you want.
3328

34-
2. From the left menu, choose **All services**.
35-
In the search box, find "logic apps", and then from the results, select your logic app.
29+
1. On the logic app menu, under **Development Tools**, select **Logic app code view**.
3630

37-
3. On your logic app's menu, under **Development Tools**, select **Logic App Code View**.
31+
The code view editor opens and shows your logic app's workflow definition in JSON format.
3832

39-
The Code View editor opens and shows your workflow definition in JSON format.
33+
## Edit JSON - Visual Studio Code
34+
35+
See [Edit deployed logic app in Visual Studio Code](/azure/logic-apps/quickstart-create-logic-apps-visual-studio-code#edit-logic-app)
4036

4137
## Edit JSON - Visual Studio
4238

43-
Before you can work on your workflow definition in Visual Studio, make sure that you've [installed the required tools](../logic-apps/quickstart-create-logic-apps-with-visual-studio.md#prerequisites).
44-
To create a logic app with Visual Studio, review [Quickstart: Automate tasks and processes with Azure Logic Apps - Visual Studio](../logic-apps/quickstart-create-logic-apps-with-visual-studio.md).
39+
[!INCLUDE [visual-studio-extension-deprecation](includes/visual-studio-extension-deprecation.md)]
40+
41+
Before you can work on a Consumption workflow definition in Visual Studio, make sure that you've [installed the required tools](/azure/logic-apps/quickstart-create-logic-apps-with-visual-studio#prerequisites). In Visual Studio, you can open logic apps that were created and deployed either directly from the Azure portal or as Azure Resource Manager projects from Visual Studio.
4542

46-
In Visual Studio, you can open logic apps that were created and deployed either directly from the Azure portal or as Azure Resource Manager projects from Visual Studio.
43+
1. Open the Visual Studio solution, or [Azure Resource Group](/azure/azure-resource-manager/management/overview) project, that contains your logic app.
4744

48-
1. Open the Visual Studio solution, or [Azure Resource Group](../azure-resource-manager/management/overview.md) project, that contains your logic app.
45+
1. Find and open your workflow definition, which by default, appears in an [Resource Manager template](/azure/azure-resource-manager/templates/overview), named **LogicApp.json**.
4946

50-
2. Find and open your workflow definition, which by default, appears in an [Resource Manager template](../azure-resource-manager/templates/overview.md), named **LogicApp.json**.
51-
You can use and customize this template for deployment to different environments.
47+
You can use and customize this template for deployment to different environments.
5248

53-
3. Open the shortcut menu for your workflow definition and template.
54-
Select **Open With Logic App Designer**.
49+
1. Open the shortcut menu for your workflow definition and template. Select **Open With Logic App Designer**.
5550

56-
![Open logic app in a Visual Studio solution](./media/logic-apps-author-definitions/open-logic-app-designer.png)
51+
![Open logic app in a Visual Studio solution.](./media/logic-apps-author-definitions/open-logic-app-designer.png)
5752

5853
> [!TIP]
59-
> If you don't have this command in Visual Studio 2019, check that you have the latest updates for Visual Studio.
54+
>
55+
> If you don't have this command in Visual Studio 2019, make sure that you have the latest updates for Visual Studio.
6056
61-
4. At the bottom of the workflow designer, choose **Code View**.
57+
1. At the bottom of the workflow designer, choose **Code View**.
6258

63-
The Code View editor opens and shows your workflow definition in JSON format.
59+
The code view editor opens and shows your workflow definition in JSON format.
6460

65-
5. To return to designer view, at the bottom of the Code View editor, choose **Design**.
61+
1. To return to designer view, at the bottom of the code view editor, choose **Design**.
6662

6763
## Parameters
6864

69-
The deployment lifecycle usually has different environments for development, test, staging, and production. When you have values that you want to reuse throughout your logic app without hardcoding or that vary based on your deployment needs, you can create an [Azure Resource Manager template](../azure-resource-manager/management/overview.md) for your workflow definition so that you can also automate logic app deployment.
65+
The deployment lifecycle usually has different environments for development, test, staging, and production. When you have values that you want to reuse throughout your logic app without hardcoding or that vary based on your deployment needs, you can create an [Azure Resource Manager template](/azure/azure-resource-manager/management/overview) for your workflow definition so that you can also automate logic app deployment.
7066

71-
Follow these general steps to *parameterize*, or define and use parameters for, those values instead. You can then provide the values in a separate parameter file that passes those values to your template. That way, you can change those values more easily without having to update and redeploy your logic app. For full details, see [Overview: Automate deployment for logic apps with Azure Resource Manager templates](../logic-apps/logic-apps-azure-resource-manager-templates-overview.md).
67+
Follow these general steps to *parameterize*, or define and use parameters for, those values instead. You can then provide the values in a separate parameter file that passes those values to your template. That way, you can change those values more easily without having to update and redeploy your logic app. For full details, see [Overview: Automate deployment for logic apps with Azure Resource Manager templates](/azure/logic-apps/logic-apps-azure-resource-manager-templates-overview).
7268

7369
1. In your template, define template parameters and workflow definition parameters for accepting the values to use at deployment and runtime, respectively.
7470

@@ -80,7 +76,7 @@ Follow these general steps to *parameterize*, or define and use parameters for,
8076

8177
When you specify the values for your workflow definition parameters, you can reference template parameters by using the parameters section that's outside your workflow definition but still inside the resource definition for your logic app. That way, you can pass template parameter values into your workflow definition parameters.
8278

83-
1. Store the values for your parameters in a separate [parameter file](../azure-resource-manager/templates/parameter-files.md) and include that file with your deployment.
79+
1. Store the values for your parameters in a separate [parameter file](/azure/azure-resource-manager/templates/parameter-files) and include that file with your deployment.
8480

8581
## Process strings with functions
8682

@@ -121,33 +117,29 @@ Azure Logic Apps has various functions for working with strings. For example, su
121117

122118
These steps describe how this example processes this string, working from the inside to the outside:
123119

124-
```
125-
"uri": "https://www.example.com/?id=@{replace(replace(base64(substring(parameters('order').companyName,5,sub(length(parameters('order').companyName), 5) )),'+','-') ,'/' ,'_' )}"
126-
```
120+
**`"uri": "https://www.example.com/?id=@{replace(replace(base64(substring(parameters('order').companyName,5,sub(length(parameters('order').companyName), 5) )),'+','-') ,'/' ,'_' )}"`**
127121

128-
1. Get the [`length()`](../logic-apps/logic-apps-workflow-definition-language.md) for the company name, so you get the total number of characters.
122+
1. Get the [**`length()`**](/azure/logic-apps/logic-apps-workflow-definition-language) for the company name, so that you get the total number of characters.
129123

130-
2. To get a shorter string, subtract `5`.
124+
1. To get a shorter string, subtract **5**.
131125

132-
3. Now get a [`substring()`](../logic-apps/logic-apps-workflow-definition-language.md).
133-
Start at index `5`, and go to the remainder of the string.
126+
1. Now get a [**`substring()`**](/azure/logic-apps/logic-apps-workflow-definition-language). Start at index **`5`**, and go to the remainder of the string.
134127

135-
4. Convert this substring to a [`base64()`](../logic-apps/logic-apps-workflow-definition-language.md) string.
128+
1. Convert this substring to a [**`base64()`**](/azure/logic-apps/logic-apps-workflow-definition-language) string.
136129

137-
5. Now [`replace()`](../logic-apps/logic-apps-workflow-definition-language.md) all the `+` characters with `-` characters.
130+
1. Now [**`replace()`**](/azure/logic-apps/logic-apps-workflow-definition-language) all the **`+`** characters with **`-`** characters.
138131

139-
6. Finally, [`replace()`](../logic-apps/logic-apps-workflow-definition-language.md) all the `/` characters with `_` characters.
132+
1. Finally, [**`replace()`**](/azure/logic-apps/logic-apps-workflow-definition-language) all the **`/`** characters with **`_`** characters.
140133

141134
## Map list items to property values, then use maps as parameters
142135

143136
To get different results based a property's value, you can create a map that matches each property value to a result, then use that map as a parameter.
144137

145-
For example, this workflow defines some categories as parameters and a map that matches those categories with a specific URL.
146-
First, the workflow gets a list of articles. Then, the workflow uses the map to find the URL matching the category for each article.
138+
For example, this workflow defines some categories as parameters and a map that matches those categories with a specific URL. First, the workflow gets a list of articles. Then, the workflow uses the map to find the URL matching the category for each article.
147139

148-
* The [`intersection()`](../logic-apps/logic-apps-workflow-definition-language.md) function checks whether the category matches a known defined category.
140+
* The [**`intersection()`** function](/azure/logic-apps/logic-apps-workflow-definition-language) checks whether the category matches a known defined category.
149141

150-
* After getting a matching category, the example pulls the item from the map using square brackets: `parameters[...]`
142+
* After the example gets a matching category, the example pulls the item from the map using square brackets: **`parameters[...]`**
151143

152144
``` json
153145
{
@@ -225,20 +217,19 @@ To get data from a data source that doesn't natively support *triggers*, you can
225217
"expression": "@less(actions('order').startTime,addseconds(utcNow(),-1))",
226218
```
227219

228-
1. From the `order` action, extract the `startTime`.
229-
2. Get the current time with `utcNow()`.
230-
3. Subtract one second:
220+
1. From the **`order`** action, extract the **`startTime`**.
221+
222+
1. Get the current time with the **`utcNow()`** function.
231223

232-
[`addseconds(..., -1)`](../logic-apps/logic-apps-workflow-definition-language.md)
224+
1. Subtract one second: [**`addSeconds(..., -1)`**](/azure/logic-apps/logic-apps-workflow-definition-language)
233225

234-
You can use other units of time, like `minutes` or `hours`.
226+
You can use other units of time such as **`minutes`** or **`hours`**.
235227

236-
3. Now, you can compare these two values.
228+
1. Now, you can compare these two values.
237229

238230
If the first value is less than the second value, then more than one second has passed since the order was first placed.
239231

240-
To format dates, you can use string formatters. For example, to get the RFC1123, use [`utcnow('r')`](../logic-apps/logic-apps-workflow-definition-language.md).
241-
Learn more about [date formatting](../logic-apps/logic-apps-workflow-definition-language.md).
232+
To format dates, you can use string formatters. For example, to get the RFC1123, use [**`utcnow('r')`**](/azure/logic-apps/logic-apps-workflow-definition-language). Learn more about [date formatting](/azure/logic-apps/logic-apps-workflow-definition-language).
242233

243234
``` json
244235
{
@@ -290,12 +281,12 @@ Learn more about [date formatting](../logic-apps/logic-apps-workflow-definition-
290281
}
291282
```
292283

293-
## Next steps
284+
## Related content
294285

295-
* [Run steps based on a condition (conditional statements)](../logic-apps/logic-apps-control-flow-conditional-statement.md)
296-
* [Run steps based on different values (switch statements)](../logic-apps/logic-apps-control-flow-switch-statement.md)
297-
* [Run and repeat steps (loops)](../logic-apps/logic-apps-control-flow-loops.md)
298-
* [Run or merge parallel steps (branches)](../logic-apps/logic-apps-control-flow-branches.md)
299-
* [Run steps based on grouped action status (scopes)](../logic-apps/logic-apps-control-flow-run-steps-group-scopes.md)
300-
* Learn more about the [Workflow Definition Language schema for Azure Logic Apps](../logic-apps/logic-apps-workflow-definition-language.md)
301-
* Learn more about [workflow actions and triggers for Azure Logic Apps](../logic-apps/logic-apps-workflow-actions-triggers.md)
286+
* [Run steps based on a condition (conditional statements)](/azure/logic-apps/logic-apps-control-flow-conditional-statement)
287+
* [Run steps based on different values (switch statements)](/azure/logic-apps/logic-apps-control-flow-switch-statement)
288+
* [Run and repeat steps (loops)](/azure/logic-apps/logic-apps-control-flow-loops)
289+
* [Run or merge parallel steps (branches)](/azure/logic-apps/logic-apps-control-flow-branches)
290+
* [Run steps based on grouped action status (scopes)](/azure/logic-apps/logic-apps-control-flow-run-steps-group-scopes)
291+
* [Workflow Definition Language schema for Azure Logic Apps](/azure/logic-apps/logic-apps-workflow-definition-language)
292+
* [Workflow actions and triggers for Azure Logic Apps](/azure/logic-apps/logic-apps-workflow-actions-triggers)

articles/logic-apps/manage-logic-apps-with-visual-studio.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,7 @@ ms.date: 12/10/2024
1414

1515
[!INCLUDE [logic-apps-sku-consumption](~/reusable-content/ce-skilling/azure/includes/logic-apps-sku-consumption.md)]
1616

17-
> [!IMPORTANT]
18-
>
19-
> The **Azure Logic Apps Tools for Visual Studio** extension is deprecated and no longer receives updates.
20-
> To create and manage logic app workflows using a local development environment, see the following documentation:
21-
>
22-
> - [Quickstart: Create and manage Consumption logic app workflows in multitenant Azure Logic Apps with Visual Studio Code](/azure/logic-apps/quickstart-create-logic-apps-visual-studio-code)
23-
>
24-
> - [Create a Standard logic app workflow in single-tenant Azure Logic Apps with Visual Studio Code](/azure/logic-apps/create-single-tenant-workflows-visual-studio-code)
17+
[!INCLUDE [visual-studio-extension-deprecation](includes/visual-studio-extension-deprecation.md)]
2518

2619
You can create, edit, manage, and deploy automated workflows that integrate services, systems, apps, and data across enterprises and organizations by using [Azure Logic Apps](logic-apps-overview.md). Although you can perform these tasks in the Azure portal, you can also use a local development environment to create logic app projects that you can add to source control, publish different versions, and create Azure Resource Manager templates for different deployment environments.
2720

articles/logic-apps/quickstart-create-logic-apps-visual-studio-code.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -233,10 +233,10 @@ To review your logic app in Azure portal, follow these steps:
233233

234234
In Visual Studio Code, you can open and edit the workflow definition for an already deployed logic app in Azure.
235235

236-
> [!IMPORTANT]
237-
> Before you edit an actively running logic app in production,
238-
> avoid the risk in breaking that logic app and minimize disruption by
239-
> [disabling your logic app first](#disable-enable-logic-apps).
236+
> [!IMPORTANT]
237+
>
238+
> Before you edit an actively running logic app in production, avoid the risk in breaking that logic
239+
> app and minimize disruption by [disabling your logic app first](#disable-enable-logic-apps).
240240
241241
1. If you haven't signed in to your Azure account and subscription yet from inside Visual Studio Code, follow the [previous steps to sign in now](#access-azure).
242242

0 commit comments

Comments
 (0)