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-ai-foundry-api.md
+20-21Lines changed: 20 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ ms.service: azure-api-management
5
5
author: dlepow
6
6
ms.author: danlep
7
7
ms.topic: how-to
8
-
ms.date: 10/07/2025
8
+
ms.date: 03/24/2026
9
9
ms.update-cycle: 180-days
10
10
ms.collection: ce-skilling-ai-copilot
11
11
ms.custom: template-how-to, build-2024
@@ -21,32 +21,31 @@ Learn more about managing AI APIs in API Management:
21
21
22
22
*[AI gateway capabilities in Azure API Management](genai-gateway-capabilities.md)
23
23
24
-
25
24
## Client compatibility options
26
25
27
26
API Management supports two client compatibility options for AI APIs from Microsoft Foundry. When you import the API using the wizard, choose the option suitable for your model deployment. The option determines how clients call the API and how the API Management instance routes requests to the Foundry tool.
28
27
29
-
***Azure OpenAI** - Manage Azure OpenAI in Microsoft Foundry model deployments.
28
+
***Azure OpenAI**: Manage Azure OpenAI in Microsoft Foundry model deployments.
30
29
31
-
Clients call the deployment at an `/openai` endpoint such as `/openai/deployments/my-deployment/chat/completions`. Deployment name is passed in the request path. Use this option if your Foundry tool only includes Azure OpenAI model deployments.
30
+
Clients call the deployment at an `/openai` endpoint such as `/openai/deployments/my-deployment/chat/completions`. Deployment name is passed in the request path. Use this option if your Foundry tool only includes Azure OpenAI model deployments.
32
31
33
-
***Azure AI** - Manage model endpoints in Microsoft Foundry that are exposed through the [Azure AI Model Inference API](/azure/ai-studio/reference/reference-model-inference-api).
32
+
***Azure AI**: Manage model endpoints in Microsoft Foundry that are exposed through the [Azure AI Model Inference API](/rest/api/aifoundry/modelinference/).
34
33
35
34
Clients call the deployment at a `/models` endpoint such as `/my-model/models/chat/completions`. Deployment name is passed in the request body. Use this option if you want flexibility to switch between models exposed through the Azure AI Model Inference API and those deployed in Azure OpenAI in Foundry Models.
36
35
37
36
## Prerequisites
38
37
39
-
- An existing API Management instance. [Create one if you haven't already](get-started-create-service-instance.md).
38
+
* An existing API Management instance. [Create one if you haven't already](get-started-create-service-instance.md).
40
39
41
-
- A Foundry tool in your subscription with one or more models deployed. Examples include models deployed in Microsoft Foundry or Azure OpenAI.
40
+
* A Foundry tool in your subscription with one or more models deployed. Examples include models deployed in Microsoft Foundry or Azure OpenAI.
42
41
43
42
## Import Microsoft Foundry API using the portal
44
43
45
-
Use the following steps to import an AI API to API Management.
44
+
Use the following steps to import an AI API to API Management.
46
45
47
46
When you import the API, API Management automatically configures:
48
47
49
-
* Operations for each of the API's REST API endpoints
48
+
* Operations for each of the API's REST API endpoints.
50
49
* A system-assigned identity with the necessary permissions to access the Foundry tool deployment.
51
50
* A [backend](backends.md) resource and a [set-backend-service](set-backend-service-policy.md) policy that direct API requests to the Azure AI Services endpoint.
52
51
* Authentication to the backend using the instance's system-assigned managed identity.
@@ -62,37 +61,38 @@ To import a Microsoft Foundry API to API Management:
62
61
1. On the **Select AI Service** tab:
63
62
1. Select the **Subscription** in which to search for Foundry Tools. To get information about the model deployments in a service, select the **deployments** link next to the service name.
64
63
:::image type="content" source="media/azure-ai-foundry-api/deployments.png" alt-text="Screenshot of deployments for an AI service in the portal.":::
65
-
1. Select a Foundry tool.
64
+
1. Select a Foundry tool.
66
65
1. Select **Next**.
67
66
1. On the **Configure API** tab:
68
67
1. Enter a **Display name** and optional **Description** for the API.
69
68
1. In **Base path**, enter a path that your API Management instance uses to access the deployment endpoint.
70
-
1. Optionally select one or more **Products** to associate with the API.
69
+
1. Optionally, select one or more **Products** to associate with the API.
71
70
1. In **Client compatibility**, select either of the following based on the types of client you intend to support. See [Client compatibility options](#client-compatibility-options) for more information.
72
-
***Azure OpenAI** - Select this option if your clients only need to access Azure OpenAI in Microsoft Foundry model deployments.
73
-
***Azure AI** - Select this option if your clients need to access other models in Microsoft Foundry.
71
+
***Azure OpenAI**: Select this option if your clients only need to access Azure OpenAI in Microsoft Foundry model deployments.
72
+
***Azure AI**: Select this option if your clients need to access other models in Microsoft Foundry.
74
73
1. Select **Next**.
75
74
76
75
:::image type="content" source="media/azure-ai-foundry-api/client-compatibility.png" alt-text="Screenshot of Microsoft Foundry API configuration in the portal.":::
77
76
78
-
1. On the **Manage token consumption** tab, optionally enter settings or accept defaults that define the following policies to help monitor and manage the API:
77
+
1. On the **Manage token consumption** tab, optionally enter settings, or accept defaults that define the following policies to help monitor and manage the API:
1. On the **Apply semantic caching** tab, optionally enter settings or accept defaults that define the policies to help optimize performance and reduce latency for the API:
1. On the **Apply semantic caching** tab, optionally enter settings, or accept defaults that define the policies to help optimize performance and reduce latency for the API:
82
81
*[Enable semantic caching of responses](azure-openai-enable-semantic-caching.md)
83
-
1. On the **AI content safety**, optionally enter settings or accept defaults to configure the Azure AI Content Safety service to block prompts with unsafe content:
82
+
1. On the **AI content safety**, optionally enter settings, or accept defaults to configure the Azure AI Content Safety service to block prompts with unsafe content:
84
83
*[Enforce content safety checks on LLM requests](llm-content-safety-policy.md)
85
84
1. Select **Review**.
86
-
1. After settings are validated, select **Create**.
85
+
1. After settings are validated, select **Create**.
87
86
88
87
## Test the AI API
89
88
90
-
To ensure that your AI API is working as expected, test it in the API Management test console.
89
+
To ensure that your AI API is working as expected, test it in the API Management test console.
90
+
91
91
1. Select the API you created in the previous step.
92
92
1. Select the **Test** tab.
93
93
1. Select an operation that's compatible with the model deployment.
94
94
The page displays fields for parameters and headers.
95
-
1. Enter parameters and headers as needed. Depending on the operation, you might need to configure or update a **Request body**. Here's a very basic example request body for a chat completions operation:
95
+
1. Enter parameters and headers as needed. Depending on the operation, you might need to configure or update a **Request body**. Here's a basic example request body for a chat completions operation:
96
96
97
97
```json
98
98
{
@@ -113,5 +113,4 @@ To ensure that your AI API is working as expected, test it in the API Management
113
113
114
114
When the test is successful, the backend responds with a successful HTTP response code and some data. Appended to the response is token usage data to help you monitor and manage your language model token consumption.
Copy file name to clipboardExpand all lines: articles/event-grid/use-cases.md
+27-14Lines changed: 27 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,65 +1,75 @@
1
1
---
2
-
title: Use cases for using Azure Event Grid
3
-
description: This article provides a list of use cases that show you how to use both Message Queuing Telemetry Transport (MQTT) and HTTP messaging capabilities of Event Grid.
2
+
title: Azure Event Grid Use Cases for Event-Driven Apps
3
+
description: This article provides a list of use cases that show you how to use both Message Queuing Telemetry Transport (MQTT) and HTTP messaging capabilities of Event Grid.
4
4
ms.topic: concept-article
5
5
author: robece
6
6
ms.author: robece
7
+
ms.reviewer: spelluru
7
8
ms.custom:
8
9
- references_regions
9
10
- build-2024
10
-
ms.date: 02/04/2025
11
+
ms.date: 03/26/2026
11
12
# Customer intent: As an architect or a developer, I want to know what Azure Event Grid is and how it can help me with creating event-driven applications.
12
13
---
13
14
14
15
# Azure Event Grid use cases
15
16
16
-
This article provides you with a few sample use cases for using Azure Event Grid.
17
+
This article provides several sample use cases for using Azure Event Grid.
17
18
18
19
> [!NOTE]
19
-
> If you are new to Azure Event Grid, read through the [Azure Event Grid overview](overview.md)article before proceeding further.
20
+
> If you're new to Azure Event Grid, read the [Azure Event Grid overview](overview.md) before proceeding.
20
21
21
22
## MQTT messaging use cases
22
-
Azure Event Grid’s MQTT broker feature enables you to accomplish the following scenarios.
23
+
24
+
Azure Event Grid's MQTT broker feature enables you to accomplish the following scenarios.
23
25
24
26
### Ingest IoT telemetry
27
+
25
28
:::image type="content" source="media/overview/ingest-telemetry.png" alt-text="High-level diagram of Event Grid that shows IoT clients using MQTT protocol to send messages to a cloud app." lightbox="media/overview/ingest-telemetry-high-res.png" border="false":::
26
29
27
-
Ingest telemetry using a **many-to-one messaging** pattern. For example, use Event Grid to send telemetry from multiple IoT devices to a cloud application. This pattern enables the application to offload the burden of managing the high number of connections with devices to Event Grid.
30
+
Ingest telemetry by using a **many-to-one messaging** pattern. For example, use Event Grid to send telemetry from multiple IoT devices to a cloud application. This pattern enables the application to offload the burden of managing the high number of connections with devices to Event Grid.
28
31
29
32
### Command and control
33
+
30
34
:::image type="content" source="media/overview/command-control.png" alt-text="High-level diagram of Event Grid that shows a cloud application sending a command message over MQTT to a device using request and response topics." lightbox="media/overview/command-control-high-res.png" border="false":::
31
35
32
-
Control your MQTT clients using the **request-response** (one-to-one) message pattern. For example, use Event Grid to send a command from a cloud application to an IoT device.
36
+
Control your MQTT clients by using the **request-response** (one-to-one) message pattern. For example, use Event Grid to send a command from a cloud application to an IoT device.
33
37
34
38
### Broadcast alerts
39
+
35
40
:::image type="content" source="media/overview/broadcast-alerts.png" alt-text="High-level diagram of Event Grid that shows a cloud application sending an alert message over MQTT to several devices." lightbox="media/overview/broadcast-alerts-high-res.png" border="false":::
36
41
37
-
Broadcast alerts to a fleet of clients using the **one-to-many** messaging pattern. For example, use Event Grid to send an alert from a cloud application to multiple IoT devices. This pattern enables the application to publish only one message that the service replicates for every interested client.
42
+
Broadcast alerts to a fleet of clients by using the **one-to-many** messaging pattern. For example, use Event Grid to send an alert from a cloud application to multiple IoT devices. This pattern enables the application to publish only one message that the service replicates for every interested client.
38
43
39
44
### Integrate MQTT data
45
+
40
46
:::image type="content" source="media/overview/integrate-data.png" alt-text="Diagram that shows several IoT devices sending health data over MQTT to Event Grid." lightbox="media/overview/integrate-data-high-res.png" border="false":::
41
47
42
48
Integrate data from your MQTT clients by routing MQTT messages to Azure services and custom endpoints through [push delivery](overview.md#push-delivery) or [pull delivery](overview.md#pull-delivery). For example, use Event Grid to route telemetry from your IoT devices to Event Hubs and then to Azure Stream Analytics to gain insights from your device telemetry.
43
49
44
50
## Push delivery use cases
45
-
Event Grid’s push delivery allows you to realize the following use cases.
51
+
Event Grid push delivery enables the following use cases.
46
52
47
53
### Build event-driven serverless solutions
54
+
48
55
:::image type="content" source="media/overview/build-event-serverless.png" alt-text="Diagram that shows Azure Functions publishing events to Event Grid using HTTP. Event Grid then sends those events to Azure Logic Apps." lightbox="media/overview/build-event-serverless-high-res.png" border="false":::
49
56
50
-
Use Event Grid to build serverless solutions with Azure Functions Apps, Logic Apps, and API Management. Using serverless services with Event Grid affords you a level of productivity, effort economy, and integration superior to that of classical computing models where you have to procure, manage, secure, and maintain all infrastructure deployed.
57
+
Use Event Grid to build serverless solutions with Azure Functions Apps, Logic Apps, and API Management. By using serverless services with Event Grid, you get a level of productivity, effort economy, and integration that's superior to classical computing models where you have to procure, manage, secure, and maintain all infrastructure deployed.
51
58
52
59
### Receive events from Azure services
60
+
53
61
:::image type="content" source="media/overview/receive-events-azure.png" alt-text="Diagram that shows Blob Storage publishing events to Event Grid over HTTP." lightbox="media/overview/receive-events-azure-high-res.png" border="false":::
54
62
55
-
Event Grid can receive events from 20+ Azure services so that you can automate your operations. For example, you can configure Event Grid to receive an event when a new blob has been created on an Azure Storage Account so that your downstream application can read and process its content. For a list of all supported Azure services and events, see [System topics](system-topics.md).
63
+
Event Grid can receive events from more than 20 Azure services so that you can automate your operations. For example, you can configure Event Grid to receive an event when a new blob is created on an Azure Storage Account so that your downstream application can read and process its content. For a list of all supported Azure services and events, see [System topics](system-topics.md).
56
64
57
65
### Receive events from your applications
66
+
58
67
:::image type="content" source="media/overview/receive-events-apps.png" alt-text="Diagram that shows customer application publishing events to Event Grid using HTTP. Event Grid sends those events to webhooks or Azure services." lightbox="media/overview/receive-events-apps-high-res.png" border="false":::
59
68
60
69
Your own service or application publishes events to Event Grid that subscriber applications process. Event Grid features [Namespace Topics](concepts-event-grid-namespaces.md#namespace-topics) to address integration and routing requirements at scale with a simple resource model. You can also use [Custom Topics](custom-topics.md) to meet basic integration requirements and [Domains](event-domains.md) for a simple management and routing model when you need to distribute events to hundreds or thousands of different groups.
61
70
62
71
### Receive events from partner (SaaS providers)
72
+
63
73
:::image type="content" source="media/overview/receive-saas-providers.png" alt-text="Diagram that shows an external partner application publishing event to Event Grid using HTTP." lightbox="media/overview/receive-saas-providers-high-res.png" border="false":::
64
74
65
75
A multitenant SaaS provider or platform can publish their events to Event Grid through a feature called [Partner Events](partner-events-overview.md). You can [subscribe to those events](subscribe-to-partner-events.md) and automate tasks, for example. Events from the following partners are currently available:
@@ -69,14 +79,17 @@ A multitenant SaaS provider or platform can publish their events to Event Grid t
Azure Event Grid features [pull CloudEvents delivery](pull-delivery-overview.md#push-and-pull-delivery). With this delivery mode, clients connect to Event Grid to read events. The following use cases can be realized using pull delivery.
82
+
83
+
Azure Event Grid features [pull CloudEvents delivery](pull-delivery-overview.md#push-and-pull-delivery). By using this delivery mode, clients connect to Event Grid to read events. The following use cases can be realized by using pull delivery.
73
84
74
85
### Receive events at your own pace
86
+
75
87
:::image type="content" source="media/overview/pull-events-at-your-own-pace.png" alt-text="High-level diagram of a publisher and consumer application." lightbox="media/overview/pull-events-at-your-own-pace-high-res.png" border="false":::
76
88
77
-
One or more clients can connect to Azure Event Grid to read messages at their own pace. Event Grid affords clients full control on events consumption. Your application can receive events at certain times of the day, for example. Your solution can also increase the rate of consumption by adding more clients that read from Event Grid.
89
+
One or more clients can connect to Azure Event Grid to read messages at their own pace. Event Grid gives clients full control over event consumption. Your application can receive events at certain times of the day, for example. Your solution can also increase the rate of consumption by adding more clients that read from Event Grid.
78
90
79
91
### Consume events over a private link
92
+
80
93
:::image type="content" source="media/overview/consume-private-link-pull-api.png" alt-text="High-level diagram of a consumer app inside a virtual network reading events from Event Grid over a private endpoint inside the virtual network." lightbox="media/overview/consume-private-link-pull-api-high-res.png" border="false":::
81
94
82
95
You can configure **private links** to connect to Azure Event Grid to **publish and read** CloudEvents through a [private endpoint](../private-link/private-endpoint-overview.md) in your virtual network. Traffic between your virtual network and Event Grid travels the Microsoft backbone network.
| Managed TLS certificates are rotated automatically | Yes | See below |Yes|
109
+
| Managed TLS certificates are rotated automatically | Yes | See below |No|
110
110
111
111
When you use Azure Front Door-managed TLS certificates with apex domains, the automated certificate rotation might require you to revalidate your domain ownership. For more information, see [Apex domains in Azure Front Door](apex-domain.md#azure-front-door-managed-tls-certificate-rotation).
0 commit comments