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/azure-app-configuration/concept-enable-rbac.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
2
title: Access Azure App Configuration using Microsoft Entra ID
3
-
description: Enable Azure RBAC to authorize access to your Azure App Configuration instance.
3
+
description: Use Microsoft Entra ID and Azure role-based access control (RBAC) to access your Azure App Configuration store.
4
4
author: zhenlan
5
5
ms.author: zhenlwa
6
6
ms.date: 10/05/2024
@@ -14,9 +14,9 @@ Azure App Configuration supports authorization of requests to App Configuration
14
14
## Overview
15
15
Accessing an App Configuration store using Microsoft Entra ID involves two steps:
16
16
17
-
1.**Authentication**: Acquire a token of the security principal from Microsoft Entra ID for App Configuration. For more details, see [Microsoft Entra authentication](./rest-api-authentication-azure-ad.md) in App Configuration.
17
+
1.**Authentication**: Acquire a token of the security principal from Microsoft Entra ID for App Configuration. For more information, see [Microsoft Entra authentication](./rest-api-authentication-azure-ad.md) in App Configuration.
18
18
19
-
1.**Authorization**: Pass the token as part of a request to an App Configuration store. To authorize access to the specified App Configuration store, the serurity principal must be assigned the appropriate roles in advance. For more information, see [Microsoft Entra authorization](./rest-api-authorization-azure-ad.md) in App Configuration.
19
+
1.**Authorization**: Pass the token as part of a request to an App Configuration store. To authorize access to the specified App Configuration store, the security principal must be assigned the appropriate roles in advance. For more information, see [Microsoft Entra authorization](./rest-api-authorization-azure-ad.md) in App Configuration.
20
20
21
21
## Azure built-in roles for Azure App Configuration
22
22
Azure provides the following built-in roles for authorizing access to App Configuration using Microsoft Entra ID:
@@ -55,7 +55,7 @@ Follow these steps to assign App Configuration Data roles to your credential.
55
55
56
56
If you don't have permission to assign roles, the **Add role assignment** option will be disabled. Only users with *Owner* or *User Access Administrator* roles can make role assignments.
57
57
2. On the **Role** tab, select the **App Configuration Data Reader** role (or another App Configuration role as appropriate) and then select **Next**.
58
-
3. On the **Members** tab, follow the wizard to select the credential you are granting access to and then select **Next**.
58
+
3. On the **Members** tab, follow the wizard to select the credential you're granting access to and then select **Next**.
59
59
4. Finally, on the **Review + assign** tab, select **Review + assign** to assign the role.
Copy file name to clipboardExpand all lines: articles/azure-app-configuration/howto-disable-access-key-authentication.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ Every request to an Azure App Configuration resource must be authenticated. By d
15
15
16
16
## Enable access key authentication
17
17
18
-
Access key is enabled by default, you can use access keys in your code to authenticate requests.
18
+
Access key is enabled by default. You can use access keys in your code to authenticate requests.
19
19
20
20
# [Azure portal](#tab/portal)
21
21
@@ -62,8 +62,8 @@ To check if access key authentication is enabled for an Azure App Configuration
62
62
63
63
# [Azure CLI](#tab/azure-cli)
64
64
65
-
To check if access key authentication is enabled for an Azure App Configuration resource, use the following command. The command will list the access keys for an Azure App Configuration resource.
66
-
If access key authentication is enabled, then read-only access keys and read-write access keys will be returned.
65
+
To check if access key authentication is enabled for an Azure App Configuration resource, use the following command. The command lists the access keys for an Azure App Configuration resource.
66
+
If access key authentication is enabled, then read-only access keys and read-write access keys are returned.
67
67
68
68
```azurecli-interactive
69
69
az appconfig credential list \
@@ -75,7 +75,7 @@ az appconfig credential list \
75
75
76
76
## Disable access key authentication
77
77
78
-
Disabling access key authentication will delete all access keys. If any running applications are using access keys for authentication, they will begin to fail once access key authentication is disabled. Only requests that are authenticated using Microsoft Entra ID will succeed. For more information about using Microsoft Entra ID, see [Authorize access to Azure App Configuration using Microsoft Entra ID](./concept-enable-rbac.md). Enabling access key authentication again will generate a new set of access keys and any applications attempting to use the old access keys will still fail.
78
+
Disabling access key authentication deletes all access keys. If any running applications are using access keys for authentication, they'll begin to fail once access key authentication is disabled. Only requests that are authenticated using Microsoft Entra ID will succeed. For more information about using Microsoft Entra ID, see [Authorize access to Azure App Configuration using Microsoft Entra ID](./concept-enable-rbac.md). Enabling access key authentication again generates a new set of access keys and any applications attempting to use the old access keys will still fail.
79
79
80
80
> [!WARNING]
81
81
> If any clients are currently accessing data in your Azure App Configuration resource with access keys, then Microsoft recommends that you migrate those clients to [Microsoft Entra ID](./concept-enable-rbac.md) before disabling access key authentication.
@@ -125,7 +125,7 @@ To verify access key authentication is disabled for an Azure App Configuration r
125
125
126
126
# [Azure CLI](#tab/azure-cli)
127
127
128
-
To verify access key authentication is disabled for an Azure App Configuration resource, use the following command. The command will list the access keys for an Azure App Configuration resource and if access key authentication is disabled the list will be empty.
128
+
To verify access key authentication is disabled for an Azure App Configuration resource, use the following command. The command lists the access keys for an Azure App Configuration resource and if access key authentication is disabled the list will be empty.
129
129
130
130
```azurecli-interactive
131
131
az appconfig credential list \
@@ -142,7 +142,7 @@ To modify the state of access key authentication for an Azure App Configuration
142
142
- The Azure Resource Manager [Owner](../role-based-access-control/built-in-roles.md#owner) role
143
143
- The Azure Resource Manager [Contributor](../role-based-access-control/built-in-roles.md#contributor) role
144
144
145
-
These roles do not provide access to data in an Azure App Configuration resource via Microsoft Entra ID. However, they include the **Microsoft.AppConfiguration/configurationStores/listKeys/action** action permission, which grants access to the resource's access keys. With this permission, a user can use the access keys to access all the data in the resource.
145
+
These roles don't provide access to data in an Azure App Configuration resource via Microsoft Entra ID. However, they include the **Microsoft.AppConfiguration/configurationStores/listKeys/action** action permission, which grants access to the resource's access keys. With this permission, a user can use the access keys to access all the data in the resource.
146
146
147
147
Role assignments must be scoped to the level of the Azure App Configuration resource or higher to permit a user to allow or disallow access key authentication for the resource. For more information about role scope, see [Understand scope for Azure RBAC](../role-based-access-control/scope-overview.md).
148
148
@@ -160,7 +160,7 @@ Microsoft recommends periodic rotation of access keys to mitigate the risk of at
160
160
You can rotate keys using the following procedure:
161
161
162
162
1. If you're using both keys in production, change your code so that only one access key is in use. In this example, let's say you decide to keep using your store's primary key.
163
-
You must have only one key in your code, because when you regenerate your secondary key, the older version of that key will stop working immediately, causing clients using the older key to get 401 access denied errors.
163
+
You must have only one key in your code, because when you regenerate your secondary key, the older version of that key stops working immediately, causing clients using the older key to get 401 access denied errors.
164
164
165
165
1. Once the primary key is the only key in use, you can regenerate the secondary key.
166
166
@@ -184,7 +184,7 @@ You must have only one key in your code, because when you regenerate your second
184
184
---
185
185
186
186
1. Next, update your code to use the newly generated secondary key.
187
-
It is advisable to review your application logs to confirm that all instances of your application have transitioned from using the primary key to the secondary key before proceeding to the next step.
187
+
It's advisable to review your application logs to confirm that all instances of your application have transitioned from using the primary key to the secondary key before proceeding to the next step.
188
188
189
189
1. Finally, you can invalidate the primary keys by regenerating them. Next time, you can alternate access keys between the secondary and primary keys using the same process.
0 commit comments