You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/api-management/azure-openai-api-from-specification.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,7 +32,7 @@ Learn more about managing LLM APIs in API Management:
32
32
*[AI gateway capabilities in Azure API Management](genai-gateway-capabilities.md)
33
33
34
34
> [!NOTE]
35
-
> API Management policies such as [azure-openai-token-limit](azure-openai-token-limit-policy.md) and [azure-openai-emit-token-metric](azure-openai-emit-token-metric-policy.md) support certain API endpoints exposed through specific Azure OpenAI models. For more information, see [Supported Azure OpenAI models](azure-openai-token-limit-policy.md#supported-azure-openai-in-azure-ai-foundry-models).
35
+
> API Management policies such as [azure-openai-token-limit](azure-openai-token-limit-policy.md) and [azure-openai-emit-token-metric](azure-openai-emit-token-metric-policy.md) support certain API endpoints exposed through specific Azure OpenAI models. For more information, see [Supported Azure OpenAI models](azure-openai-token-limit-policy.md#supported-azure-openai-in-microsoft-foundry-models).
Copy file name to clipboardExpand all lines: articles/container-apps/dapr-component-connect-services.md
+22-22Lines changed: 22 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,55 +1,55 @@
1
1
---
2
-
title: Connect to other Azure or third-party services via Dapr components
3
-
description: Learn more about connecting Dapr components with Azure and external services.
2
+
title: Connect to other Azure or partner services via Dapr components
3
+
description: Learn more about connecting Dapr components with Azure and non-Microsoft services.
4
4
ms.author: nigreenf
5
5
ms.reviewer: hannahhunter
6
6
author: greenie-msft
7
7
ms.service: azure-container-apps
8
8
ms.subservice: dapr
9
9
ms.custom: build-2023
10
-
ms.topic: conceptual
11
-
ms.date: 12/10/2024
10
+
ms.topic: concept-article
11
+
ms.date: 02/03/2026
12
12
---
13
13
14
-
# Connect to other Azure or third-party services via Dapr components
14
+
# Connect to other Azure or partner services by using Dapr components
15
15
16
-
Securely establish connections to Azure and third-party services for Dapr components using managed identity or Azure Key Vault secret stores.
16
+
Securely establish connections to Azure and non-Microsoft services for Dapr components by using managed identity or Azure Key Vault secret stores.
17
17
18
-
Before getting started, [learn more about the offered support for Dapr components.][supported-dapr-components]
18
+
Before getting started, learn more about the [offered support for Dapr components][supported-dapr-components].
19
19
20
20
## Recommendations
21
21
22
22
Whenever possible, it's recommended that you use Azure components that provide managed identity support for the most secure connection. Use Azure Key Vault secret stores *only* when managed identity authentication isn't supported.
23
23
24
24
| Service type | Recommendation |
25
25
| ------------ | -------------- |
26
-
| Azure component with managed identity support |[Use the managed identity flow (recommended)](#using-managed-identity-recommended)|
26
+
| Azure component with managed identity support |[Use the managed identity flow (recommended)](#use-managed-identity-recommended)|
27
27
| Azure component without managed identity support |[Use an Azure Key Vault secret store](#azure-key-vault-secret-stores)|
28
28
| Non-Azure components |[Use an Azure Key Vault secret store](#azure-key-vault-secret-stores)|
29
29
30
30
31
-
## Using managed identity (recommended)
31
+
## Use managed identity (recommended)
32
32
33
-
For Azure-hosted services, Dapr can use [the managed identity of the scoped container apps][aca-managed-id] to authenticate to the backend service provider. When using managed identity, you don't need to include secret information in a component manifest. **Using managed identity is recommended** as it eliminates storage of sensitive input in components and doesn't require managing a secret store.
33
+
For Azure-hosted services, Dapr can use the [managed identity of the scoped container apps][aca-managed-id] to authenticate to the backend service provider. When using managed identity, you don't need to include secret information in a component manifest. *Using managed identity is recommended* as it eliminates storage of sensitive input in components and doesn't require managing a secret store.
34
34
35
35
> [!NOTE]
36
-
> The `azureClientId` metadata field (the client ID of the managed identity) is **required** for any component authenticating with user-assigned managed identity.
36
+
> The `azureClientId` metadata field (the client ID of the managed identity) is *required* for any component authenticating with user-assigned managed identity.
37
37
38
-
## Using a Dapr secret store component reference
38
+
## Use a Dapr secret store component reference
39
39
40
40
When you create Dapr components for non-Entra ID enabled services or components that don't support managed identity authentication, certain metadata fields require sensitive input values. For this approach, retrieve these secrets by referencing an existing Dapr secret store component that securely accesses secret information.
41
41
42
42
To set up a reference:
43
43
44
-
1.[Create a Dapr secret store component using the Azure Container Apps schema.](#creating-a-dapr-secret-store-component) The component type for all supported Dapr secret stores begins with `secretstores.`.
45
-
1.[Create extra components (as needed) which reference the Dapr secret store component](#referencing-dapr-secret-store-components) you created to retrieve the sensitive metadata input.
44
+
1. Create a [Dapr secret store component using the Azure Container Apps schema](#create-a-dapr-secret-store-component). The component type for all supported Dapr secret stores begins with `secretstores`.
45
+
1. Create [extra components (as needed) that reference the Dapr secret store component](#reference-dapr-secret-store-components) you created to retrieve the sensitive metadata input.
46
46
47
-
### Creating a Dapr secret store component
47
+
### Create a Dapr secret store component
48
48
49
49
When creating a secret store component in Azure Container Apps, you can provide sensitive information in the metadata section in either of the following ways:
50
50
51
-
-[For an **Azure Key Vault secret store**,](#using-managed-identity-recommended) use managed identity to establish the connection.
52
-
-[For **non-Azure secret stores**,](#platform-managed-kubernetes-secrets) use platform-managed Kubernetes secrets that are defined directly as part of the component manifest.
51
+
- For an [**Azure Key Vault secret store**](#use-managed-identity-recommended), use managed identity to establish the connection.
52
+
- For [**non-Azure secret stores**](#platform-managed-kubernetes-secrets), use platform-managed Kubernetes secrets that are defined directly as part of the component manifest.
53
53
54
54
#### Azure Key Vault secret stores
55
55
@@ -72,7 +72,7 @@ scopes:
72
72
73
73
#### Platform-managed Kubernetes secrets
74
74
75
-
As an alternative to Kubernetes secrets, Local environment variables, and Local file Dapr secret stores, Azure Container Apps provides a platform-managed approach for creating and leveraging Kubernetes secrets. This approach can be used to connect to non-Azure services or in dev/test scenarios for quickly deploying components via the CLI without setting up a secret store or managed identity.
75
+
As an alternative to Kubernetes secrets, local environment variables, and local file Dapr secret stores, Azure Container Apps provides a platform-managed approach for creating and using Kubernetes secrets. This approach can be used to connect to non-Azure services or in dev/test scenarios for quickly deploying components via the CLI without setting up a secret store or managed identity.
76
76
77
77
This component configuration defines the sensitive value as a secret parameter that can be referenced from the metadata section.
78
78
@@ -98,9 +98,9 @@ scopes:
98
98
- subscriber-app
99
99
```
100
100
101
-
### Referencing Dapr secret store components
101
+
### Reference Dapr secret store components
102
102
103
-
Once you [create a Dapr secret store using one of the previous approaches](#creating-a-dapr-secret-store-component), you can reference that secret store from other Dapr components in the same environment. The following example demonstrates using Entra ID authentication.
103
+
Once you [create a Dapr secret store using one of the previous approaches](#create-a-dapr-secret-store-component), you can reference that secret store from other Dapr components in the same environment. The following example demonstrates using Microsoft Entra ID authentication.
104
104
105
105
```yaml
106
106
componentType: pubsub.azure.servicebus.queue
@@ -122,9 +122,9 @@ scopes:
122
122
- subscriber-app
123
123
```
124
124
125
-
## Next steps
125
+
## Related content
126
126
127
-
[Learn how to set Dapr component resiliency.][dapr-resiliency]
# Connect to Azure services via Dapr components in the Azure portal
15
15
16
-
You can easily connect Dapr APIs to [backing Azure services](./dapr-overview.md#dapr-components) using a combination of [Service Connector](../service-connector/overview.md) and [Dapr](https://docs.dapr.io/). This feature creates Dapr components on your behalf with valid metadata and authenticated identity to access the Azure service.
16
+
You can easily connect Dapr APIs to [backing Azure services](./dapr-overview.md#dapr-components)by using a combination of [Service Connector](../service-connector/overview.md) and [Dapr](https://docs.dapr.io). This feature creates Dapr components on your behalf with valid metadata and authenticated identity to access the Azure service.
17
17
18
-
In this guide, you connect Dapr Pub/Sub API to an Azure Service Bus by:
18
+
In this guide, you connect the Dapr publish and subscribe (pub/sub) API to an Azure Service Bus:
19
19
> [!div class="checklist"]
20
-
> - Select pub/sub as the API
21
-
> - Specify Azure Service Bus as the service and required properties like namespace, queue name, and identity
20
+
> - Select pub/sub as the API.
21
+
> - Specify Azure Service Bus as the service and required properties like namespace, queue name, and identity.
22
22
> - Use your Azure Service Bus pub/sub component!
23
23
24
24
## Prerequisites
@@ -30,10 +30,10 @@ In this guide, you connect Dapr Pub/Sub API to an Azure Service Bus by:
30
30
Start by navigating to the Dapr component creation feature.
31
31
32
32
1. In the Azure portal, navigate to your Container Apps environment.
33
-
1. In the left-side menu, under **Settings**, select **Dapr components**.
34
-
1.From the top menu, select **Add** > **Azure component** to open the **Add Dapr Component** configuration pane.
33
+
1. In the sidebar menu, under **Settings**, select **Dapr components**.
34
+
1.Select **+ Add** > **Azure component** to open the **Add Dapr Component** configuration pane.
35
35
36
-
:::image type="content" source="media/dapr-component-connection/select-azure-component.png" alt-text="Screenshot of selecting Azure Component from the dropdown menu.":::
36
+
:::image type="content" source="media/dapr-component-connection/select-azure-component.png" alt-text="Screenshot of selecting Azure Component from the drop-down menu.":::
37
37
38
38
> [!NOTE]
39
39
> Currently, creating Dapr components using Service Connector in the Azure portal is in preview and only works with Azure services (Azure Service Bus, Azure Cosmos DB, etc.). To create non-Azure Dapr components (Redis), use the manual component creation option.
@@ -42,47 +42,46 @@ Start by navigating to the Dapr component creation feature.
42
42
43
43
For the component creation tool to map to the required component metadata, you need to provide the required metadata from predefined dropdowns in the **Basics** tab.
44
44
45
-
For example, for a pub/sub Azure Service Bus component, you'll start with the following fields:
45
+
For example, for a pub/sub Azure Service Bus component, you start with the following fields:
46
46
47
47
| Field | Example | Description |
48
48
| ----- | ------- | ----------- |
49
49
| Component name |`mycomponent`| Enter a name for your Dapr component. The name must match the component referenced in your application code. |
50
50
| Building block | Pub/sub | Select the [building block/API](https://docs.dapr.io/developing-applications/building-blocks/) for your component from the drop-down. |
51
51
| Component type | Service Bus | Select a component type from the drop-down. |
52
52
53
-
The component creation pane populates with different fields depending on the building block and component type you select. For example, the following table and image demonstrate the fields associated with an Azure Service Bus pub/sub component type, but the fields you see may vary.
53
+
The component creation pane populates with different fields depending on the building block and component type you select. For example, the following table and image demonstrate the fields associated with an Azure Service Bus pub/sub component type, but the fields you see might vary.
54
54
55
55
| Field | Example | Description |
56
56
| ----- | ------- | ----------- |
57
-
| Subscription | My subscription | Select your Azure subscription |
58
-
| Namespace |`mynamespace`| Select the Service Bus namespace |
57
+
| Subscription | My subscription | Select your Azure subscription.|
58
+
| Namespace |`mynamespace`| Select the Service Bus namespace.|
59
59
| Authentication | User assigned managed identity | Select the subscription that contains the component you're looking for. Recommended: User assigned managed identity. |
60
-
| User assigned managed identity |`testidentity`| Select an existing identity from the drop-down. If you don’t already have one, you can create a new managed identity client ID. |
60
+
| User assigned managed identity |`testidentity`| Select an existing identity from the dropdown. If you don't already have one, you can create a new managed identity client ID. |
61
61
62
-
:::image type="content" source="media/dapr-component-connection/add-pubsub-component.png" alt-text="Screenshot of the Azure platform showing the Basics tab of adding a Dapr Pub/sub component.":::
62
+
:::image type="content" source="media/dapr-component-connection/add-pubsub-component.png" alt-text="Screenshot of the Azure platform showing the Basics tab of adding a Dapr Pub/sub component." lightbox="media/dapr-component-connection/add-pubsub-component.png":::
63
63
64
64
**What happened?**
65
65
66
-
Now that you've filled out these required fields, they'll automatically map to the required component metadata. In this Service Bus example, the only required metadata is the connection string. The component creation tool takes the information you provided and maps the input to create a connection string in the component YAML file.
66
+
After you fill out these required fields, they automatically map to the required component metadata. In this Service Bus example, the only required metadata is the connection string. The component creation tool takes the information you provided and maps the input to create a connection string in the component YAML file.
67
67
68
68
### Provide optional metadata
69
69
70
70
While the component creation tool automatically populates all required metadata for the component, you can also customize the component by adding optional metadata.
71
71
72
72
1. Select **Next : Metadata + Scopes**.
73
73
74
-
1. Under **Metadata**, select **Add** to select extra, optional metadata for your Dapr component from a drop-down of supported fields.
74
+
1. Under **Metadata**, select **Add** to select extra, optional metadata for your Dapr component from a dropdown of supported fields.
75
75
76
-
1. Under **Scopes**, select **Add** or type in the app IDs for the container apps that you want to load this component.
77
-
- By default, when the scope is unspecified, Dapr applies the component to all app IDs.
76
+
1. Under **Scopes**, select **Add** or type in the app IDs for the container apps that you want to load this component. By default, when the scope is unspecified, Dapr applies the component to all app IDs.
78
77
79
78
1. Select **Review + Create** to review the component values.
80
79
81
80
1. Select **Create**.
82
81
83
82
### Save the component YAML
84
83
85
-
Once the component has been added to the Container Apps environment, the portal displays the YAML (or Bicep) for the component.
84
+
After the component is added to the Container Apps environment, the portal displays the YAML (or Bicep) for the component.
86
85
87
86
1. Copy and save the YAML file for future use.
88
87
@@ -100,12 +99,8 @@ You can then check the YAML/Bicep artifact into a repo and recreate it outside o
100
99
101
100
:::image type="content" source="media/dapr-component-connection/manage-dapr-component.png" alt-text="Screenshot of the Azure platform showing existing Dapr Components.":::
102
101
103
-
## Next steps
102
+
## Next step
104
103
105
-
[Learn how to set Dapr component resiliency.](./dapr-component-resiliency.md)
104
+
> [!div class="nextstepaction"]
105
+
> [Learn how to set Dapr component resiliency](./dapr-component-resiliency.md)
106
106
107
-
## Related links
108
-
109
-
Learn more about:
110
-
-[Using Dapr with Azure Container Apps](./dapr-overview.md)
111
-
-[Connecting to cloud services using Service Connector](./service-connector.md)
![learn-build-service-prod[bot]](https://avatars.githubusercontent.com/in/237442?v=4&size=40){kind=avatar}
0 commit comments