Skip to content

Commit d4673f7

Browse files
authored
Merge pull request #280985 from flang-msft/fxl---disable-access-keys
Fxl---disable access keys
2 parents bd521b8 + a11224a commit d4673f7

File tree

2 files changed

+30
-1
lines changed

2 files changed

+30
-1
lines changed

articles/azure-cache-for-redis/cache-azure-active-directory-for-authentication.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ author: flang-msft
77
ms.custom: references_regions
88
ms.service: cache
99
ms.topic: conceptual
10-
ms.date: 05/09/2024
10+
ms.date: 07/17/2024
1111
ms.author: franlanglois
1212

1313
---
@@ -57,6 +57,35 @@ To use the ACL integration, your client application must assume the identity of
5757
5858
For information on using Microsoft Entra ID with Azure CLI, see the [references pages for identity](/cli/azure/redis/identity).
5959

60+
## Disable access key authentication on your cache
61+
62+
Using Microsoft Entra ID is the secure way to connect your cache. We recommend using Microsoft Entra ID and disabling access keys.
63+
64+
When you disable access key Authentication for a cache, all existing client connections are terminated, whether they use access keys or Microsoft Entra ID auth-based. You're advised to follow the recommended Redis client best practices to implement proper retry mechanisms for reconnecting MS Entra-based connections, if any.
65+
66+
Before you disable access keys:
67+
68+
- Before you disable access keys, Microsoft Entra ID authorization must be enabled.
69+
- Disabling access keys is only available for Basic, Standard, and Premium tier caches.
70+
- For geo-replicated caches, before you disable accces keys, you must: 1) unlink the caches, 2) disable access keys, and finally, 3) relink the caches.
71+
72+
If you have a cache where access keys are used, and you want to disable access keys, follow this procedure.
73+
74+
1. In the Azure portal, select the Azure Cache for Redis instance where you'd like to disable access keys.
75+
76+
1. Select **Authentication** from the Resource menu.
77+
78+
1. In the working pane, select **Access keys**.
79+
80+
1. Select **Disable Access Keys Authentication**. Then, select **Save**.
81+
82+
:::image type="content" source="media/cache-azure-active-directory-for-authentication/cache-disable-access-keys.png" alt-text="Screenshot showing access keys in the working pane with a red box around Disable Access Key Authentication. ":::
83+
84+
1. You're asked to confirm that you want to update your configuration. Select **Yes**.
85+
86+
> [!IMPORTANT]
87+
> When the **Disable Access Key Authentication**" setting is changed for a cache, all existing client connections, using access keys or Microsoft Entra ID, are terminated. Follow the best practices to implement proper retry mechanisms for reconnecting MS Entra-based connections. For more information, see [Connection resilience](cache-best-practices-connection.md).
88+
6089
## Using data access configuration with your cache
6190

6291
If you would like to use a custom access policy instead of Redis Data Owner, go to the **Data Access Configuration** on the Resource menu. For more information, see [Configure a custom data access policy for your application](cache-configure-role-based-access-control.md#configure-a-custom-data-access-policy-for-your-application).
74.9 KB
Loading

0 commit comments

Comments
 (0)