Merge pull request #292984 from dlepow/apimamr

[APIM] External cache updates for AMR

Author: JamesJBarnett

articles/api-management/api-management-howto-cache-external.md

@@ -6,7 +6,7 @@ author: dlepow
 
 ms.service: azure-api-management
 ms.topic: how-to
-ms.date: 05/19/2022
+ms.date: 01/13/2025
 ms.author: danlep
 
 ---
@@ -15,7 +15,7 @@ ms.author: danlep
 
 [!INCLUDE [api-management-availability-all-tiers](../../includes/api-management-availability-all-tiers.md)]
 
-In addition to utilizing the built-in cache, Azure API Management allows for caching responses in an external Redis-compatible cache, such as Azure Cache for Redis.
+In addition to utilizing the built-in cache, Azure API Management allows for caching responses in an external Redis-compatible cache, such as Azure Cache for Redis or Azure Managed Redis.
 
 Using an external cache allows you to overcome a few limitations of the built-in cache:
 
@@ -29,7 +29,6 @@ For more detailed information about caching, see [API Management caching policie
 
 [!INCLUDE [api-management-workspace-availability](../../includes/api-management-workspace-availability.md)]
 
-![Bring your own cache to APIM](media/api-management-howto-cache-external/overview.png)
 
 What you'll learn:
 
@@ -42,18 +41,16 @@ To complete this tutorial, you need to:
 
 + [Create an Azure API Management instance](get-started-create-service-instance.md)
 + Understand [caching in Azure API Management](api-management-howto-cache.md)
++ Have an [Azure Cache for Redis](../azure-cache-for-redis/quickstart-create-redis.md), [Azure Managed Redis](../azure-cache-for-redis/quickstart-create-managed-redis.md), or another Redis-compatible cache available. 
 
-## <a name="create-cache"> </a> Create Azure Cache for Redis
+    > [!IMPORTANT]
+    > Azure API Management uses a Redis connection string to connect to the cache. If you use Azure Cache for Redis or Azure Managed Redis, enable access key authentication in your cache to use a connection string. Currently, you can't use Microsoft Entra authentication to connect Azure API Management to Azure Cache for Redis or Azure Managed Redis.
 
-This section explains how to create an Azure Cache for Redis in Azure. If you already have an Azure Cache for Redis, or another Redis-compatible cache within or outside of Azure, you can <a href="#add-external-cache">skip</a> to the next section.
+### Redis cache for Kubernetes
 
-[!INCLUDE [redis-cache-create](~/reusable-content/ce-skilling/azure/includes/azure-cache-for-redis/includes/redis-cache-create.md)]
+For an API Management self-hosted gateway, caching requires an external cache. For caching to be effective, a self-hosted gateway and the cache it relies on must be located close to each other to minimize lookup and store latencies. Deploying a Redis cache into the same Kubernetes cluster or in a separate cluster nearby are the best options. Learn how to [deploy Redis cache to a Kubernetes cluster](https://github.com/kubernetes/examples/tree/master/guestbook).
 
-## <a name="create-cache"> </a> Deploy Redis cache to Kubernetes
-
-For a self-hosted gateway, caching requires an external cache. For caching to be effective, a self-hosted gateway and the cache it relies on must be located close to each other to minimize lookup and store latencies. Deploying a Redis cache into the same Kubernetes cluster or in a separate cluster nearby are the best options. Learn how to [deploy Redis cache to a Kubernetes cluster](https://github.com/kubernetes/examples/tree/master/guestbook).
-
-## <a name="add-external-cache"> </a>Add an external cache
+## Add an external cache
 
 Follow the steps below to add an external Redis-compatible cache in Azure API Management. You can limit the cache to a specific gateway in your API Management instance.
 
@@ -69,52 +66,52 @@ The **Use from** setting in the configuration specifies the location of your API
 
 * **Default**, to configure the cache as the default for all gateway locations in the API Management instance
 
-    A cache used for **Default** will be overridden by a cache used for a specific matching region or location.
+    A cache used for **Default** is overridden by a cache used for a specific matching region or location.
 
-    For example, consider an API Management instance that's hosted in the East US, Southeast Asia, and West Europe regions. There are two caches configured, one for **Default** and one for **Southeast Asia**. In this example, API Management in **Southeast Asia** will use its own cache, while the other two regions will use the **Default** cache entry.
+    For example, consider an API Management instance that's hosted in the East US, Southeast Asia, and West Europe regions. There are two caches configured, one for **Default** and one for **Southeast Asia**. In this example, API Management in **Southeast Asia** uses its own cache, while the other two regions use the **Default** cache entry.
 
 > [!NOTE]
 > You can configure the same external cache for more than one API Management instance. The API Management instances can be in the same or different regions. When sharing the cache for more than one instance, you must select **Default** in the **Use from** setting. 
 
-### Add an Azure Cache for Redis from the same subscription
+### Add an Azure Cache for Redis or Azure Managed Redis instance from the same subscription
 
 1. Browse to your API Management instance in the Azure portal.
-2. Select the **External cache** tab from the menu on the left.
-3. Select the **+ Add** button.
-4. Select your cache in the **Cache instance** dropdown field.
-5. Select **Default** or specify the desired region in the [**Use from**](#use-from-setting) dropdown field.
-6. Select **Save**.
+1. In the left menu, under **Deployment + infrastructure** select **External cache**.
+1. Select **+ Add**.
+1. In the **Cache instance** dropdown, select your cache.
+1. In the [**Use from**](#use-from-setting) dropdown, select **Default** or specify the desired region. The **Connection string** is automatically populated.
+1. Select **Save**.
 
 ### Add a Redis-compatible cache hosted outside of the current Azure subscription or Azure in general
 
 1. Browse to your API Management instance in the Azure portal.
-2. Select the **External cache** tab from the menu on the left.
-3. Select the **+ Add** button.
-4. Select **Custom** in the **Cache instance** dropdown field.
-5. Select **Default** or specify the desired region in the [**Use from**](#use-from-setting) dropdown field.
-6. Provide your Azure Cache for Redis (or Redis-compatible cache) connection string in the **Connection string** field.
-7. Select **Save**.
+1. In the left menu, under **Deployment + infrastructure** select **External cache**.
+1. Select **+ Add**.
+1. In the **Cache instance** dropdown, select **Custom**.
+1. In the [**Use from**](#use-from-setting) dropdown, select **Default** or specify the desired region.
+1. Enter your Azure Cache for Redis, Azure Managed Redis, or Redis-compatible cache connection string in the **Connection string** field.
+1. Select **Save**.
 
 ### Add a Redis cache to a self-hosted gateway
 
-1. Browse to your API Management instance in the Azure portal.
-2. Select the **External cache** tab from the menu on the left.
-3. Select the **+ Add** button.
-4. Select **Custom** in the **Cache instance** dropdown field.
-5. Specify the desired self-hosted gateway location or **Default** in the [**Use from**](#use-from-setting) dropdown field.
-6. Provide your Redis cache connection string in the **Connection string** field.
-7. Select **Save**.
+1. In the left menu, under **Deployment + infrastructure** select **External cache**.
+1. Select **+ Add**.
+1. In the **Cache instance** dropdown, select **Custom**.
+1. In the [**Use from**](#use-from-setting) dropdown, select **Default** or specify the desired region.
+1. Enter your Redis cache connection string in the **Connection string** field.
+1. Select **Save**.
 
 ## Use the external cache
 
 After adding a Redis-compatible cache, configure [caching policies](api-management-policies.md#caching) to enable response caching, or caching of values by key, in the external cache.
 
 For a detailed example, see [Add caching to improve performance in Azure API Management](api-management-howto-cache.md).
 
-## <a name="next-steps"> </a>Next steps
+## Related content
 
 * For more information about caching policies, see [Caching policies][Caching policies] in the [API Management policy reference][API Management policy reference].
 * To cache items by key using policy expressions, see [Custom caching in Azure API Management](api-management-sample-cache-by-key.md).
+* Learn how to [enable semantic caching for Azure OpenAI APIs](azure-openai-enable-semantic-caching.md).
 
 [API Management policy reference]: ./api-management-policies.md
 [Caching policies]: ./api-management-policies.md#caching

articles/api-management/api-management-howto-cache.md

@@ -89,7 +89,7 @@ To see the caching in action, call an operation from the portal.
 ## Related content
 * For more information about caching policies, see [Caching policies][Caching policies] in the [API Management policy reference][API Management policy reference].
 * For information on caching items by key using policy expressions, see [Custom caching in Azure API Management](api-management-sample-cache-by-key.md).
-* For more information about using external Azure Cache for Redis, see [Use an external Azure Cache for Redis in Azure API Management](api-management-howto-cache-external.md).
+* For more information about using external Azure Cache for Redis or Azure Managed Redis, see [Use an external Azure Cache for Redis in Azure API Management](api-management-howto-cache-external.md).
 
 [api-management-management-console]: ./media/api-management-howto-cache/api-management-management-console.png
 [api-management-echo-api]: ./media/api-management-howto-cache/api-management-echo-api.png

articles/api-management/api-management-key-concepts.md

@@ -126,6 +126,7 @@ API Management integrates with many complementary Azure services to create enter
 * **[Azure Defender for APIs](protect-with-defender-for-apis.md)** and **[Azure DDoS Protection](protect-with-ddos-protection.md)** for runtime protection against malicious attacks​
 * **Microsoft Entra ID** for [developer authentication](api-management-howto-aad.md) and [request authorization](api-management-howto-protect-backend-with-aad.md)​
 * **[Event Hubs](api-management-howto-log-event-hubs.md)** for streaming events​
+* **[Azure Redis](api-management-howto-cache-external.md)** for caching responses​ with Azure Cache for Redis or Azure Managed Redis​
 * Several Azure compute offerings commonly used to build and host APIs on Azure, including **[Functions](import-function-app-as-api.md)**, **[Logic Apps](import-logic-app-as-api.md)**, **[Web Apps](import-app-service-as-api.md)**, **[Service Fabric](how-to-configure-service-fabric-backend.yml)**, and others including **[Azure OpenAI](azure-openai-api-from-specification.md)** service.​
 
 **More information**:

articles/api-management/azure-openai-enable-semantic-caching.md

@@ -6,7 +6,7 @@ ms.service: azure-api-management
 ms.custom:
   - build-2024
 ms.topic: how-to
-ms.date: 12/13/2024
+ms.date: 01/13/2025
 ms.author: danlep
 ms.collection: ce-skilling-ai-copilot
 ---
@@ -27,10 +27,10 @@ Enable semantic caching of responses to Azure OpenAI API requests to reduce band
     * Chat Completion API (or Completion API) - Deployment used for API consumer calls 
     * Embeddings API - Deployment used for semantic caching
 * The API Management instance must be configured to use managed identity authentication to the Azure OpenAI APIs. For more information, see [Authenticate and authorize access to Azure OpenAI APIs using Azure API Management ](api-management-authenticate-authorize-azure-openai.md#authenticate-with-managed-identity).
-* [Azure Cache for Redis Enterprise](../azure-cache-for-redis/quickstart-create-redis-enterprise.md). The **RediSearch** module must be enabled on the Redis Enterprise cache.
+* An [Azure Cache for Redis Enterprise](../azure-cache-for-redis/quickstart-create-redis-enterprise.md) or [Azure Managed Redis](../azure-cache-for-redis/quickstart-create-managed-redis.md) instance. The **RediSearch** module must be enabled on the Redis cache.
     > [!NOTE]
-    > You can only enable the **RediSearch** module when creating a new Redis Enterprise cache. You can't add a module to an existing cache. [Learn more](../azure-cache-for-redis/cache-redis-modules.md)
-* External cache configured in the Azure API Management instance. For steps, see [Use an external Azure Cache for Redis in Azure API Management](api-management-howto-cache-external.md).
+    > You can only enable the **RediSearch** module when creating a new Azure Redis Enterprise or Azure Managed Redis cache. You can't add a module to an existing cache. [Learn more](../azure-cache-for-redis/cache-redis-modules.md)
+* External cache configured in the Azure API Management instance. For steps, see [Use an external Redis-compatible cache in Azure API Management](api-management-howto-cache-external.md).
 
 
 ## Test Chat API deployment