Skip to content

Commit 3920e56

Browse files
author
ecfan
committed
Security guidance updates
1 parent 03c10e4 commit 3920e56

File tree

6 files changed

+73
-21
lines changed

6 files changed

+73
-21
lines changed

articles/connectors/connectors-create-api-mq.md

Lines changed: 49 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@ services: logic-apps
55
ms.suite: integration
66
ms.reviewer: estfan, azla
77
ms.topic: how-to
8-
ms.date: 01/10/2024
8+
ms.date: 01/08/2025
99
ms.custom: engagement-fy23
1010
---
1111

1212
# Connect to an IBM MQ server from a workflow in Azure Logic Apps
1313

1414
[!INCLUDE [logic-apps-sku-consumption-standard](../../includes/logic-apps-sku-consumption-standard.md)]
1515

16-
This article shows how to access an Azure-hosted or on-premises MQ server from a workflow in Azure Logic Apps using the MQ connector. You can then create automated workflows that receive and send messages stored in your MQ server. For example, your workflow can browse for a single message in a queue and then run other actions.
16+
This guide shows how to access an Azure-hosted or on-premises MQ server from a workflow in Azure Logic Apps using the MQ connector. You can then create automated workflows that receive and send messages stored in your MQ server. For example, your workflow can browse for a single message in a queue and then run other actions.
1717

1818
The MQ connector provides a wrapper around a Microsoft MQ client, which includes all the messaging capabilities to communicate with a remote MQ server across a TCP/IP network. This connector defines the connections, operations, and parameters to call the MQ client.
1919

@@ -30,7 +30,7 @@ The MQ connector has different versions, based on [logic app type and host envir
3030
| Logic app | Environment | Connection version |
3131
|-----------|-------------|--------------------|
3232
| **Consumption** | Multitenant Azure Logic Apps | Managed connector, which appears in the connector gallery under the **Runtime** > **Shared**. This connector provides only actions, not triggers. In on-premises MQ server scenarios, the managed connector supports server only authentication with TLS (SSL) encryption. <br><br>For more information, review the following documentation: <br><br>- [MQ managed connector reference](/connectors/mq) <br>- [Managed connectors in Azure Logic Apps](managed.md) |
33-
| **Standard** | Single-tenant Azure Logic Apps and App Service Environment v3 (ASE v3 with Windows plans only) | Managed connector, which appears in the connector gallery under **Runtime** > **Shared**, and built-in connector, which appears in the connector gallery under **Runtime** > **In-App** and is [service provider-based](../logic-apps/custom-connector-overview.md#service-provider-interface-implementation). The built-in version differs in the following ways: <br><br>- The built-in version includes actions *and* triggers. <br><br>- The built-in connector can directly connect to an MQ server and access Azure virtual networks by using a connection string without an on-premises data gateway. <br><br>- The built-in version supports both server authentication and server-client authentication with TLS (SSL) encryption for data in transit, message encoding for both the send and receive operations, and Azure virtual network integration. <br><br>For more information, review the following documentation: <br><br>- [MQ managed connector reference](/connectors/mq) <br>- [MQ built-in connector reference](/azure/logic-apps/connectors/built-in/reference/mq/) <br>- [Built-in connectors in Azure Logic Apps](built-in.md) |
33+
| **Standard** | Single-tenant Azure Logic Apps and App Service Environment v3 (ASE v3 with Windows plans only) | Managed connector, which appears in the connector gallery under **Runtime** > **Shared**, and built-in connector, which appears in the connector gallery under **Runtime** > **In-app** and is [service provider-based](../logic-apps/custom-connector-overview.md#service-provider-interface-implementation). The built-in version differs in the following ways: <br><br>- The built-in version includes actions *and* triggers. <br><br>- The built-in connector can directly connect to an MQ server and access Azure virtual networks by using a connection string without an on-premises data gateway. <br><br>- The built-in version supports both server authentication and server-client authentication with TLS (SSL) encryption for data in transit, message encoding for both the send and receive operations, and Azure virtual network integration. <br><br>For more information, review the following documentation: <br><br>- [MQ managed connector reference](/connectors/mq) <br>- [MQ built-in connector reference](/azure/logic-apps/connectors/built-in/reference/mq/) <br>- [Built-in connectors in Azure Logic Apps](built-in.md) |
3434

3535
## Authentication with TLS (SSL) encryption
3636

@@ -224,9 +224,9 @@ To check that your workflow returns the results that you expect, run your workfl
224224

225225
1. Run your workflow.
226226

227-
* Consumption logic app: On the workflow designer toolbar, select **Run Trigger** > **Run**.
227+
* Consumption workflow: On the workflow designer toolbar, select **Run** > **Run**.
228228

229-
* Standard logic app: On workflow resource menu, select **Overview**. On the **Overview** pane toolbar, select **Run Trigger** > **Run**.
229+
* Standard workflow: On the workflow menu, under **Settings**, select **Run history**. On the toolbar, select **Run** > **Run**.
230230

231231
After the run finishes, the designer shows the workflow's run history along with the status for each step.
232232

@@ -258,23 +258,25 @@ To check that the thumbprints for the required public key certificates exist on
258258

259259
The PowerShell window lists the existing thumbprints and descriptions, for example:
260260

261-
![Screenshot showing existing example thumbprints and descriptions.](media/connectors-create-api-mq/existing-trusted-certificate-thumbprints.png)
261+
![Screenshot shows example thumbprints and descriptions.](media/connectors-create-api-mq/existing-trusted-certificate-thumbprints.png)
262262

263263
<a name="add-public-key-certificate"></a>
264264

265265
## Add a public key certificate
266266

267-
To add a public key certificate to the Trusted Root CA Store on that virtual machine host where your Standard logic app runs, follow these steps:
267+
Follow these steps to add a public key certificate to the Trusted Root CA Store on the virtual machine host where your Standard logic app runs.
268268

269-
1. In the [Azure portal](https://portal.azure.com), open your Standard logic app resource. On the logic app resource menu, under **Settings**, select **TLS/SSL settings (classic)**.
269+
[!INCLUDE [secrets-guidance](../logic-apps/includes/secrets-guidance.md)]
270270

271-
1. On the **TLS/SSL settings (classic)** page, select the **Public Key Certificates (.cer)** tab, and then select **Upload Public Key Certificate**.
271+
1. In the [Azure portal](https://portal.azure.com), open your Standard logic app resource. On the logic app resource menu, under **Settings**, select **Certificates**.
272272

273-
1. On the **Add Public Key Certificate (.cer)** pane that opens, enter a name to describe the certificate. Find and select the public key certificate file (.cer). When you're done, select **Upload**.
273+
1. Select the **Public key certificates (.cer)** tab, and then select **Add certificate**.
274+
275+
1. On the **Add public key certificate** pane that opens, find and select the public key certificate file (.cer) to add. Eenter a friendly name to describe the certificate. When you're done, select **Add**.
274276

275277
1. After you add the certificate, from the **Thumbprint** column, copy the certificate's thumbprint value.
276278

277-
![Screenshot showing the Azure portal and Standard logic resource with the following items selected: 'TLS/SSL settings (classic)', 'Public Key Certificates (.cer)', and 'Upload Public Key Certificate'.](media/connectors-create-api-mq/add-public-key-certificate.png)
279+
![Screenshot shows Azure portal and Standard logic resource with following items selected: TLS/SSL settings (classic), Public Key Certificates (.cer), and Upload Public Key Certificate.](media/connectors-create-api-mq/add-public-key-certificate.png)
278280

279281
1. On the logic app resource menu, select **Configuration**.
280282

@@ -294,19 +296,45 @@ To add a public key certificate to the Trusted Root CA Store on that virtual mac
294296

295297
## Add a private key certificate
296298

297-
To add a private key certificate to the Trusted Root CA Store on virtual machine host where your Standard logic app runs, follow these steps:
299+
Follow these steps to add a private key certificate to the Trusted Root CA Store on virtual machine host where your Standard logic app runs.
298300

299-
1. In the [Azure portal](https://portal.azure.com), open your logic app resource. On the logic app resource menu, under **Settings**, select **TLS/SSL settings (classic)**.
301+
[!INCLUDE [secrets-guidance](../logic-apps/includes/secrets-guidance.md)]
300302

301-
1. On the **TLS/SSL settings (classic)** page, select the **Private Key Certificates (.pfx)** tab, and then select **Upload Certificate**.
303+
1. In the [Azure portal](https://portal.azure.com), open your logic app resource. On the logic app resource menu, under **Settings**, select **Certificates**.
302304

303-
1. On the **Add Private Key Certificate (.pfx)** pane that opens, find and select the private key certificate file (.pfx), and then enter the certificate password. When you're done, select **Upload**.
305+
1. Select the **Bring your own certificates (.pfx)** tab, and then select **Add certificate**.
304306

305-
1. After you add the certificate, from the **Thumbprint** column, copy the certificate's thumbprint value.
307+
![Screenshot shows Azure portal and Standard logic app resource with following options selected: Certificates, Bring your own certificates (.pfx), and Add certificate.](media/connectors-create-api-mq/add-private-key-certificate.png)
306308

307-
![Screenshot showing the Azure portal and Standard logic resource with the following items selected: 'TLS/SSL settings (classic)', 'Private Key Certificates (.pfx)', and 'Upload Certificate'.](media/connectors-create-api-mq/add-private-key-certificate.png)
309+
1. On the **Add private key certificate** pane that opens, under **Source**, select one of the following options:
308310

309-
1. On the logic app resource menu, select **Configuration**.
311+
- **Upload certificate (.pfx)**
312+
313+
1. Provide the following values:
314+
315+
| Parameter | Description |
316+
|-----------|-------------|
317+
| **PFX certificate file** | Find and select your private key certificate (.pfx) file. |
318+
| **Certificate password** | Enter the password that you created when you exported the PFX file. |
319+
| **Certificate friendly name** | Enter the certificate name to show in your logic app resource. |
320+
321+
1. When you're done, select **Validate** > **Add**.
322+
323+
- **Import from Key Vault**.
324+
325+
1. Select **Select key vault certificate**, and provide the following values:
326+
327+
| Parameter | Description |
328+
|-----------|-------------|
329+
| **Subscription** | Select the Azure subscription associated with your key vault. |
330+
| **Key vault** | Select the key vault that has your private key certificate (.pfx) file. |
331+
| **Certificate** | Select a PKSCS12 certificate in the key vault. All PKCS12 certificates in the vault are listed with their thumbprints, but not all might be supported in Azure Logic Apps. |
332+
333+
1. When you're done, select **Select** > **Validate** > **Add**.
334+
335+
1. After you add the certificate, from the **Thumbprint** column, copy the certificate's thumbprint value.
336+
337+
1. On the logic app resource menu, under **Settings**, select **Configuration**.
310338

311339
1. On the **Application settings** tab, select **New application setting**. Add a new application setting named **WEBSITE_LOAD_CERTIFICATES**, and enter the certificate's thumbprint value that you previously copied.
312340

@@ -318,15 +346,15 @@ To add a private key certificate to the Trusted Root CA Store on virtual machine
318346

319347
1. In the **Client Cert Thumbprint** property, enter the previously copied thumbprint value for the private key certificate, which enables server-client (two-way) authentication. If you don't enter a thumbprint value, the connector uses server-only (one-way) authentication.
320348

321-
![Screenshot showing Standard logic app workflow designer, MQ built-in connection box with 'Use TLS' option selected and the 'Client Cert Thumbprint' property with private key certificate thumbprint entered.](media/connectors-create-api-mq/client-private-key-certificate-thumbprint.png)
349+
![Screenshot shows Standard workflow designer, MQ built-in connection box with selected option named Use TLS and property named Client Cert Thumbprint with private key certificate thumbprint.](media/connectors-create-api-mq/client-private-key-certificate-thumbprint.png)
322350

323351
## Troubleshoot problems
324352

325353
### Failures with browse or receive actions
326354

327355
If you run a browse or receive action on an empty queue, the action fails with the following header outputs:
328356

329-
![Screenshot showing the MQ "no message" error.](media/connectors-create-api-mq/mq-no-message-error.png)
357+
![Screenshot shows MQ error named No message.](media/connectors-create-api-mq/mq-no-message-error.png)
330358

331359
<a name="connection-problems"></a>
332360

@@ -344,7 +372,7 @@ When your workflow uses the MQ managed connector to connect to your on-premises
344372

345373
When you try to connect, the MQ server logs an event message that the connection attempt failed because the MQ server chose the incorrect cipher specification. The event message contains the cipher specification that the MQ server chose from the list. In the server-connection channel configuration, update the cipher specification to match the cipher specification in the event message.
346374

347-
## Next steps
375+
## Related content
348376

349377
* [Managed connectors in Azure Logic Apps](/connectors/connector-reference/connector-reference-logicapps-connectors)
350378
* [Built-in connectors in Azure Logic Apps](built-in.md)
-16 KB
Loading
-2.74 KB
Loading
1.88 KB
Loading
25 KB
Loading
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
ms.service: azure-logic-apps
3+
author: ecfan
4+
ms.author: estfan
5+
ms.topic: include
6+
ms.date: 01/07/2025
7+
---
8+
9+
> [!IMPORTANT]
10+
>
11+
> In production environments, always protect sensitive information and secrets, such as credentials,
12+
> certificates, thumbprints, access keys, and connection strings. Make sure that you securely store such information
13+
> by using Microsoft Entra ID and [Azure Key Vault](https://go.microsoft.com/fwlink/?linkid=2300117).
14+
> Avoid hardcoding this information, sharing with other users, or saving in plain text anywhere others
15+
> can access. Rotate your secrets as soon as possible if you think this information might be compromised.
16+
> For more information, see [About Azure Key Vault](/azure/key-vault/general/overview).
17+
>
18+
> For authentication, use [Microsoft Entra ID](/entra/identity/authentication/overview-authentication) with
19+
> [managed identities](/entra/identity/managed-identities-azure-resources/overview) whenever possible.
20+
> This method provides optimal and superior security without having to provide credentials. Azure manages
21+
> this identity for you and helps keep authentication information secure so that you don't have to manage
22+
> this sensitive information. To set up a managed identity for Azure Logic Apps, see
23+
> [Authenticate access and connections to Azure resources with managed identities in Azure Logic Apps](/azure/logic-apps/authenticate-with-managed-identity).
24+
>

0 commit comments

Comments
 (0)