Skip to content

Commit f83d0c7

Browse files
Merge pull request #275009 from hahahahahaiyiwen/haiyiwen/AddApiVersionDocumentation
Add Api Version Note to App Configuration Deployment Overview
2 parents 6f4acac + a838833 commit f83d0c7

File tree

3 files changed

+14
-5
lines changed

3 files changed

+14
-5
lines changed

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

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,9 @@ If you don't have an Azure subscription, create a [free account](https://azure.m
2828

2929
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.
3030

31+
> [!IMPORTANT]
32+
> Configuring ARM authentication mode requires App Configuration control plane API version `2023-08-01-preview` or later.
33+
3134
## Review the Bicep file
3235

3336
The Bicep file used in this quickstart is from [Azure Quickstart Templates](https://azure.microsoft.com/resources/templates/app-configuration-store-kv/).
@@ -39,8 +42,8 @@ The Bicep file used in this quickstart is from [Azure Quickstart Templates](http
3942

4043
Two Azure resources are defined in the Bicep file:
4144

42-
- [Microsoft.AppConfiguration/configurationStores](/azure/templates/microsoft.appconfiguration/2020-07-01-preview/configurationstores): create an App Configuration store.
43-
- [Microsoft.AppConfiguration/configurationStores/keyValues](/azure/templates/microsoft.appconfiguration/2020-07-01-preview/configurationstores/keyvalues): create a key-value inside the App Configuration store.
45+
- [Microsoft.AppConfiguration/configurationStores](/azure/templates/microsoft.appconfiguration/configurationstores): create an App Configuration store.
46+
- [Microsoft.AppConfiguration/configurationStores/keyValues](/azure/templates/microsoft.appconfiguration/configurationstores/keyvalues): create a key-value inside the App Configuration store.
4447

4548
With this Bicep file, we create one key with two different values, one of which has a unique label.
4649

articles/azure-app-configuration/quickstart-deployment-overview.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,9 @@ To learn more about Azure RBAC and Microsoft Entra ID, see [Authorize access to
3333

3434
Azure App Configuration data, such as key-values and snapshots, can be managed in deployment. When managing App Configuration data using this method, it's recommended to set your configuration store's Azure Resource Manager authentication mode to **Pass-through**. This authentication mode ensures that data access requires a combination of data plane and Azure Resource Manager management roles and ensuring that data access can be properly attributed to the deployment caller for auditing purpose.
3535

36+
> [!IMPORTANT]
37+
> App Configuration control plane API version `2023-08-01-preview` or later is required to configure **Azure Resource Manager Authentication Mode** using [ARM template](./quickstart-resource-manager.md), [Bicep](./quickstart-bicep.md), or REST API. See the [REST API examples](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2023-08-01-preview/examples/ConfigurationStoresCreateWithDataPlaneProxy.json).
38+
3639
### Azure Resource Manager authentication mode
3740

3841
# [Azure portal](#tab/portal)

articles/azure-app-configuration/quickstart-resource-manager.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,21 +35,24 @@ If you don't have an Azure subscription, create a [free account](https://azure.m
3535

3636
Managing Azure App Configuration resource inside an ARM template requires Azure Resource Manager role, such as contributor or owner. Accessing Azure App Configuration data (key-values, snapshots) requires Azure Resource Manager role and Azure App Configuration [data plane role](concept-enable-rbac.md) under [pass-through](./quickstart-deployment-overview.md#azure-resource-manager-authentication-mode) ARM authentication mode.
3737

38+
> [!IMPORTANT]
39+
> Configuring ARM authentication mode requires App Configuration control plane API version `2023-08-01-preview` or later.
40+
3841
## Review the template
3942

4043
The template used in this quickstart is from [Azure Quickstart Templates](https://azure.microsoft.com/resources/templates/app-configuration-store-kv/). It creates a new App Configuration store with two key-values inside. It then uses the `reference` function to output the values of the two key-value resources. Reading the key's value in this way allows it to be used in other places in the template.
4144

4245
The quickstart uses the `copy` element to create multiple instances of key-value resource. To learn more about the `copy` element, see [Resource iteration in ARM templates](../azure-resource-manager/templates/copy-resources.md).
4346

4447
> [!IMPORTANT]
45-
> This template requires App Configuration resource provider version `2020-07-01-preview` or later. This version uses the `reference` function to read key-values. The `listKeyValue` function that was used to read key-values in the previous version is not available starting in version `2020-07-01-preview`.
48+
> This template requires App Configuration control plane API version `2022-05-01` or later. This version uses the `reference` function to read key-values. The `listKeyValue` function that was used to read key-values in the previous version is not available starting in version `2020-07-01-preview`.
4649
4750
:::code language="json" source="~/quickstart-templates/quickstarts/microsoft.appconfiguration/app-configuration-store-kv/azuredeploy.json":::
4851

4952
Two Azure resources are defined in the template:
5053

51-
- [Microsoft.AppConfiguration/configurationStores](/azure/templates/microsoft.appconfiguration/2020-07-01-preview/configurationstores): create an App Configuration store.
52-
- [Microsoft.AppConfiguration/configurationStores/keyValues](/azure/templates/microsoft.appconfiguration/2020-07-01-preview/configurationstores/keyvalues): create a key-value inside the App Configuration store.
54+
- [Microsoft.AppConfiguration/configurationStores](/azure/templates/microsoft.appconfiguration/configurationstores): create an App Configuration store.
55+
- [Microsoft.AppConfiguration/configurationStores/keyValues](/azure/templates/microsoft.appconfiguration/configurationstores/keyvalues): create a key-value inside the App Configuration store.
5356

5457
> [!TIP]
5558
> The `keyValues` resource's name is a combination of key and label. The key and label are joined by the `$` delimiter. The label is optional. In the above example, the `keyValues` resource with name `myKey` creates a key-value without a label.

0 commit comments

Comments
 (0)