Skip to content

Commit afb1692

Browse files
Update README.md
Clarified around AMR and ACR
1 parent 73ffd77 commit afb1692

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
The `redis-entra-id` Python package helps simplifying the authentication with Azure Cache for Redis using Microsoft Entra ID (formerly Azure Active Directory). It enables seamless integration with Redis Cache for Redis by fetching authentication tokens and managing token renewal in the background. This package builds on top of `redis-py` and provides a structured way to authenticate by using a:
1+
The `redis-entra-id` Python package helps simplifying the authentication with [Azure Managed Redis](https://azure.microsoft.com/en-us/products/managed-redis) and Azure Cache for Redis using Microsoft Entra ID (formerly Azure Active Directory). It enables seamless integration with Azure's Redis services by fetching authentication tokens and managing the token renewal in the background. This package builds on top of `redis-py` and provides a structured way to authenticate by using a:
22

33
* System-assigned managed identity
44
* User-assigned managed identity
@@ -10,22 +10,22 @@ You can learn more about managed identities in the [Microsoft Entra ID documenta
1010

1111
### Create a service principal in Azure
1212

13-
You can [register an application and create a service principal](https://learn.microsoft.com/en-us/entra/identity-platform/app-objects-and-service-principals?tabs=browser) in Azure. Then the following credentials are used to authenticate via Entra ID:
13+
In this quick start guide, you will [register an application and create a service principal](https://learn.microsoft.com/en-us/entra/identity-platform/app-objects-and-service-principals?tabs=browser) in Azure. Then the following credentials are used to authenticate via Entra ID:
1414

1515
* Tenant id
1616
* Client id
1717
* Client secret
1818

1919
### Create cache and grant access
2020

21-
Create an Azure Cache for Redis instance and grant your service principal access:
21+
Create a Redis cache in Azure and grant your service principal access:
2222

23-
1. Create the cache and wait until it was created successfully
23+
1. Create a cache resource and wait until it was created successfully
2424
2. Navigate to `Settings/Authentication`
25-
3. Enable Entra ID authentication
26-
4. Assign your service principal with the role `Data Owner` to the cache
25+
3. If needed, enable Entra ID authentication
26+
4. Assign your previously created service principal to the cache
2727

28-
You can find further details in the [Azure Cache for Redis documentation](https://learn.microsoft.com/en-us/azure/azure-cache-for-redis/cache-azure-active-directory-for-authentication).
28+
Further details are available in the [AMR](https://learn.microsoft.com/en-us/azure/azure-cache-for-redis/managed-redis/managed-redis-entra-for-authentication) or [ACR](https://learn.microsoft.com/en-us/azure/azure-cache-for-redis/cache-azure-active-directory-for-authentication) documentation.
2929

3030
### Install the Entra ID package
3131

0 commit comments

Comments
 (0)