Skip to content

Commit 4f076d2

Browse files
authored
Merge pull request #269294 from hahahahahaiyiwen/haiyiwen/UpdateDocsForDataPlaneProxy
Update App Configuration documentation for data plane proxy
2 parents 800ccd4 + f9b9952 commit 4f076d2

11 files changed

+129
-32
lines changed

articles/azure-app-configuration/TOC.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,9 @@
5353
href: quickstart-container-apps.md
5454
- name: Deployment
5555
items:
56+
- name: Overview
57+
href: quickstart-deployment-overview.md
58+
displayName: ARM, Resource Manager, Template
5659
- name: Bicep
5760
href: quickstart-bicep.md
5861
displayName: ARM, Resource Manager, Template

articles/azure-app-configuration/concept-enable-rbac.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Authorize access to Azure App Configuration using Microsoft Entra ID
3-
description: Enable Azure RBAC to authorize access to your Azure App Configuration instance
3+
description: Enable Azure RBAC to authorize access to your Azure App Configuration instance.
44
author: maud-lv
55
ms.author: malev
66
ms.date: 05/26/2020
@@ -9,14 +9,14 @@ ms.service: azure-app-configuration
99

1010
---
1111
# Authorize access to Azure App Configuration using Microsoft Entra ID
12-
Besides using Hash-based Message Authentication Code (HMAC), Azure App Configuration supports using Microsoft Entra ID to authorize requests to App Configuration instances. Microsoft Entra ID allows you to use Azure role-based access control (Azure RBAC) to grant permissions to a security principal. A security principal may be a user, a [managed identity](../active-directory/managed-identities-azure-resources/overview.md) or an [application service principal](../active-directory/develop/app-objects-and-service-principals.md). To learn more about roles and role assignments, see [Understanding different roles](../role-based-access-control/overview.md).
12+
Besides using Hash-based Message Authentication Code (HMAC), Azure App Configuration supports using Microsoft Entra ID to authorize requests to App Configuration instances. Microsoft Entra ID allows you to use Azure role-based access control (Azure RBAC) to grant permissions to a security principal. A security principal may be a user, a [managed identity](../active-directory/managed-identities-azure-resources/overview.md), or an [application service principal](../active-directory/develop/app-objects-and-service-principals.md). To learn more about roles and role assignments, see [Understanding different roles](../role-based-access-control/overview.md).
1313

1414
## Overview
1515
Requests made by a security principal to access an App Configuration resource must be authorized. With Microsoft Entra ID, access to a resource is a two-step process:
16-
1. The security principal's identity is authenticated and an OAuth 2.0 token is returned. The resource name to request a token is `https://login.microsoftonline.com/{tenantID}` where `{tenantID}` matches the Microsoft Entra tenant ID to which the service principal belongs.
16+
1. The security principal's identity is authenticated and an OAuth 2.0 token is returned. The resource name to request a token is `https://login.microsoftonline.com/{tenantID}` where `{tenantID}` matches the Microsoft Entra tenant ID to which the service principal belongs.
1717
2. The token is passed as part of a request to the App Configuration service to authorize access to the specified resource.
1818

19-
The authentication step requires that an application request contains an OAuth 2.0 access token at runtime. If an application is running within an Azure entity, such as an Azure Functions app, an Azure Web App, or an Azure VM, it can use a managed identity to access the resources. To learn how to authenticate requests made by a managed identity to Azure App Configuration, see [Authenticate access to Azure App Configuration resources with Microsoft Entra ID and managed identities for Azure Resources](howto-integrate-azure-managed-service-identity.md).
19+
The authentication step requires that an application request contains an OAuth 2.0 access token at runtime. If an application is running within an Azure entity, such as an Azure Functions app, an Azure Web App, or an Azure VM, it can use a managed identity to access the resources. To learn how to authenticate requests made by a managed identity to Azure App Configuration, see [Authenticate access to Azure App Configuration resources with Microsoft Entra ID and managed identities for Azure Resources](howto-integrate-azure-managed-service-identity.md).
2020

2121
The authorization step requires that one or more Azure roles be assigned to the security principal. Azure App Configuration provides Azure roles that encompass sets of permissions for App Configuration resources. The roles that are assigned to a security principal determine the permissions provided to the principal. For more information about Azure roles, see [Azure built-in roles for Azure App Configuration](#azure-built-in-roles-for-azure-app-configuration).
2222

@@ -28,10 +28,10 @@ When an Azure role is assigned to a Microsoft Entra security principal, Azure gr
2828
## Azure built-in roles for Azure App Configuration
2929
Azure provides the following Azure built-in roles for authorizing access to App Configuration data using Microsoft Entra ID:
3030

31-
- **App Configuration Data Owner**: Use this role to give read/write/delete access to App Configuration data. This does not grant access to the App Configuration resource.
32-
- **App Configuration Data Reader**: Use this role to give read access to App Configuration data. This does not grant access to the App Configuration resource.
33-
- **Contributor** or **Owner**: Use this role to manage the App Configuration resource. It grants access to the resource's access keys. While the App Configuration data can be accessed using access keys, this role does not grant direct access to the data using Microsoft Entra ID. This role is required if you access the App Configuration data via ARM template, Bicep, or Terraform during deployment. For more information, see [authorization](quickstart-resource-manager.md#authorization).
34-
- **Reader**: Use this role to give read access to the App Configuration resource. This does not grant access to the resource's access keys, nor to the data stored in App Configuration.
31+
- **App Configuration Data Owner**: Use this role to give read/write/delete access to App Configuration data. This role doesn't grant access to the App Configuration resource.
32+
- **App Configuration Data Reader**: Use this role to give read access to App Configuration data. This role doesn't grant access to the App Configuration resource.
33+
- **Contributor** or **Owner**: Use this role to manage the App Configuration resource. It grants access to the resource's access keys. While the App Configuration data can be accessed using access keys, this role doesn't grant direct access to the data using Microsoft Entra ID. This role is required if you access the App Configuration data via ARM template, Bicep, or Terraform during deployment. For more information, see [deployment](quickstart-deployment-overview.md).
34+
- **Reader**: Use this role to give read access to the App Configuration resource. This role doesn't grant access to the resource's access keys, nor to the data stored in App Configuration.
3535

3636
> [!NOTE]
3737
> After a role assignment is made for an identity, allow up to 15 minutes for the permission to propagate before accessing data stored in App Configuration using this identity.

articles/azure-app-configuration/howto-disable-access-key-authentication.md

Lines changed: 11 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Disable access key authentication for an Azure App Configuration instance
33
titleSuffix: Azure App Configuration
4-
description: Learn how to disable access key authentication for an Azure App Configuration instance
4+
description: Learn how to disable access key authentication for an Azure App Configuration instance.
55
ms.service: azure-app-configuration
66
author: jimmyca15
77
ms.author: jimmyca
@@ -17,20 +17,19 @@ When you disable access key authentication for an Azure App Configuration resour
1717

1818
## Disable access key authentication
1919

20-
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. 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.
20+
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. 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.
2121

2222
> [!WARNING]
2323
> 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.
24-
> Additionally, it is recommended to read the [limitations](#limitations) section below to verify the limitations won't affect the intended usage of the resource.
2524
2625
# [Azure portal](#tab/portal)
2726

2827
To disallow access key authentication for an Azure App Configuration resource in the Azure portal, follow these steps:
2928

3029
1. Navigate to your Azure App Configuration resource in the Azure portal.
31-
2. Locate the **Access keys** setting under **Settings**.
30+
2. Locate the **Access settings** setting under **Settings**.
3231

33-
:::image type="content" border="true" source="./media/access-keys-blade.png" alt-text="Screenshot showing how to access an Azure App Configuration resources access key blade":::
32+
:::image type="content" border="true" source="./media/access-settings-blade.png" alt-text="Screenshot showing how to access an Azure App Configuration resources access key blade.":::
3433

3534
3. Set the **Enable access keys** toggle to **Disabled**.
3635

@@ -44,16 +43,16 @@ The capability to disable access key authentication using the Azure CLI is in de
4443

4544
### Verify that access key authentication is disabled
4645

47-
To verify that access key authentication is no longer permitted, a request can be made to list the access keys for the Azure App Configuration resource. If access key authentication is disabled there will be no access keys and the list operation will return an empty list.
46+
To verify that access key authentication is no longer permitted, a request can be made to list the access keys for the Azure App Configuration resource. If access key authentication is disabled, there will be no access keys, and the list operation will return an empty list.
4847

4948
# [Azure portal](#tab/portal)
5049

5150
To verify access key authentication is disabled for an Azure App Configuration resource in the Azure portal, follow these steps:
5251

5352
1. Navigate to your Azure App Configuration resource in the Azure portal.
54-
2. Locate the **Access keys** setting under **Settings**.
53+
2. Locate the **Access settings** setting under **Settings**.
5554

56-
:::image type="content" border="true" source="./media/access-keys-blade.png" alt-text="Screenshot showing how to access an Azure App Configuration resources access key blade":::
55+
:::image type="content" border="true" source="./media/access-settings-blade.png" alt-text="Screenshot showing how to access an Azure App Configuration resources access key blade.":::
5756

5857
3. Verify there are no access keys displayed and **Enable access keys** is toggled to **Disabled**.
5958

@@ -69,7 +68,7 @@ az appconfig credential list \
6968
--resource-group <resource-group>
7069
```
7170

72-
If access key authentication is disabled then an empty list will be returned.
71+
If access key authentication is disabled, then an empty list will be returned.
7372

7473
```
7574
C:\Users\User>az appconfig credential list -g <resource-group> -n <app-configuration-name>
@@ -89,18 +88,13 @@ These roles do not provide access to data in an Azure App Configuration resource
8988

9089
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).
9190

92-
Be careful to restrict assignment of these roles only to those who require the ability to create an App Configuration resource or update its properties. Use the principle of least privilege to ensure that users have the fewest permissions that they need to accomplish their tasks. For more information about managing access with Azure RBAC, see [Best practices for Azure RBAC](../role-based-access-control/best-practices.md).
91+
Be careful to restrict assignment of these roles only to those users who require the ability to create an App Configuration resource or update its properties. Use the principle of least privilege to ensure that users have the fewest permissions that they need to accomplish their tasks. For more information about managing access with Azure RBAC, see [Best practices for Azure RBAC](../role-based-access-control/best-practices.md).
9392

9493
> [!NOTE]
9594
> The classic subscription administrator roles Service Administrator and Co-Administrator include the equivalent of the Azure Resource Manager [Owner](../role-based-access-control/built-in-roles.md#owner) role. The **Owner** role includes all actions, so a user with one of these administrative roles can also create and manage App Configuration resources. For more information, see [Azure roles, Microsoft Entra roles, and classic subscription administrator roles](../role-based-access-control/rbac-and-directory-admin-roles.md#classic-subscription-administrator-roles).
9695
97-
## Limitations
98-
99-
The capability to disable access key authentication has the following limitation:
100-
101-
### ARM template access
102-
103-
When access key authentication is disabled, the capability to read/write key-values in an [ARM template](./quickstart-resource-manager.md) will be disabled as well. This is because access to the Microsoft.AppConfiguration/configurationStores/keyValues resource used in ARM templates requires an Azure Resource Manager role, such as contributor or owner. When access key authentication is disabled, access to the resource requires one of the Azure App Configuration [data plane roles](concept-enable-rbac.md), therefore ARM template access is rejected.
96+
> [!NOTE]
97+
> When access key authentication is disabled and [ARM authentication mode](./quickstart-deployment-overview.md#azure-resource-manager-authentication-mode) of App Configuration store is local, the capability to read/write key-values in an [ARM template](./quickstart-resource-manager.md) will be disabled as well. This is because access to the Microsoft.AppConfiguration/configurationStores/keyValues resource used in ARM templates requires access key authentication with local ARM authentication mode. It's recommended to use pass-through ARM authentication mode. For more information, see [Deployment overview](./quickstart-deployment-overview.md).
10498
10599
## Next steps
106100

articles/azure-app-configuration/index.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,8 @@ landingContent:
8080
url: quickstart-java-spring-app.md
8181
- text: Code a Python app
8282
url: quickstart-python.md
83-
- text: Azure Resource Manager template
84-
url: quickstart-resource-manager.md
83+
- text: Azure Resource Manager deployment
84+
url: quickstart-deployment-overview.md
8585
- text: Azure Container Apps
8686
url: quickstart-container-apps.md
8787
- linkListType: tutorial
5.63 KB
Loading
9.81 KB
Loading
86 KB
Loading
33.9 KB
Loading

articles/azure-app-configuration/quickstart-bicep.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@ This quickstart describes how you can use Bicep to:
2424

2525
If you don't have an Azure subscription, create a [free account](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin.
2626

27+
## Authorization
28+
29+
Managing an Azure App Configuration resource with Bicep file requires an Azure Resource Manager role, such as contributor or owner. Accessing Azure App Configuration data (key-values, snapshots) requires an Azure Resource Manager role and an additional Azure App Configuration [data plane role](concept-enable-rbac.md) when the configuration store's ARM authentication mode is set to [pass-through](./quickstart-deployment-overview.md#azure-resource-manager-authentication-mode) ARM authentication mode.
30+
2731
## Review the Bicep file
2832

2933
The Bicep file used in this quickstart is from [Azure Quickstart Templates](https://azure.microsoft.com/resources/templates/app-configuration-store-kv/).

0 commit comments

Comments
 (0)