Description

# Azure App Configuration client library for Python Azure App Configuration is a managed service that helps developers centralize their application configurations simply and securely. Modern programs, especially programs running in a cloud, generally have many components that are distributed in nature. Spreading configuration settings across these components can lead to hard-to-troubleshoot errors during an application deployment. Use App Configuration to securely store all the settings for your application in one place. Use the client library for App Configuration to create and manage application configuration settings. [Source code](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/appconfiguration/azure-appconfiguration) | [Package (Pypi)][package] | [Package (Conda)](https://anaconda.org/microsoft/azure-appconfiguration/) | [API reference documentation](https://learn.microsoft.com/python/api/azure-appconfiguration/azure.appconfiguration?view=azure-python) | [Product documentation][appconfig_docs] ## Getting started ### Install the package Install the Azure App Configuration client library for Python with pip: ``` pip install azure-appconfiguration ``` ### Prerequisites * Python 3.8 or later is required to use this package. * You need an [Azure subscription][azure_sub], and a [Configuration Store][configuration_store] to use this package. To create a Configuration Store, you can use the Azure Portal or [Azure CLI][azure_cli]. After that, create the Configuration Store: ```Powershell az appconfig create --name <config-store-name> --resource-group <resource-group-name> --location eastus ``` ### Authenticate the client In order to interact with the App Configuration service, you'll need to create an instance of the [AzureAppConfigurationClient][configuration_client_class] class. To make this possible, you can either use the connection string of the Configuration Store or use an AAD token. #### Use connection string ##### Get credentials Use the [Azure CLI][azure_cli] snippet below to get the connection string from the Configuration Store. ```Powershell az appconfig credential list --name <config-store-name> ``` Alternatively, get the connection string from the Azure Portal. ##### Create client Once you have the value of the connection string, you can create the AzureAppConfigurationClient: <!-- SNIPPET:hello_world_sample.create_app_config_client --> ```python import os from azure.appconfiguration import AzureAppConfigurationClient CONNECTION_STRING = os.environ["APPCONFIGURATION_CONNECTION_STRING"] # Create app config client client = AzureAppConfigurationClient.from_connection_string(CONNECTION_STRING) ``` <!-- END SNIPPET --> #### Use Entra ID token Here we demonstrate using [DefaultAzureCredential][default_cred_ref] to authenticate as a service principal. However, [AzureAppConfigurationClient][configuration_client_class] accepts any [azure-identity][azure_identity] credential. See the [azure-identity][azure_identity] documentation for more information about other credentials. <!-- SNIPPET:hello_world_entra_id_sample.create_app_config_client --> ```python ENDPOINT = os.environ["APPCONFIGURATION_ENDPOINT"] credential = DefaultAzureCredential() # Create app config client client = AzureAppConfigurationClient(base_url=ENDPOINT, credential=credential) ``` <!-- END SNIPPET --> ##### Create a service principal (optional) This [Azure CLI][azure_cli] snippet shows how to create a new service principal. Before using it, replace "your-application-name" with the appropriate name for your service principal. Create a service principal: ```Bash az ad sp create-for-rbac --name http://my-application --skip-assignment ``` > Output: > ```json > { > "appId": "generated app id", > "displayName": "my-application", > "name": "http://my-application", > "password": "random password", > "tenant": "tenant id" > } > ``` Use the output to set **AZURE_CLIENT_ID** ("appId" above), **AZURE_CLIENT_SECRET** ("password" above) and **AZURE_TENANT_ID** ("tenant" above) environment variables. The following example shows a way to do this in Bash: ```Bash export AZURE_CLIENT_ID="generated app id" export AZURE_CLIENT_SECRET="random password" export AZURE_TENANT_ID="tenant id" ``` Assign one of the applicable [App Configuration roles](https://learn.microsoft.com/azure/azure-app-configuration/rest-api-authorization-azure-ad) to the service principal. ##### Create a client Once the **AZURE_CLIENT_ID**, **AZURE_CLIENT_SECRET** and **AZURE_TENANT_ID** environment variables are set, [DefaultAzureCredential][default_cred_ref] will be able to authenticate the [AzureAppConfigurationClient][configuration_client_class]. Constructing the client also requires your configuration store's URL, which you can get from the Azure CLI or the Azure Portal. In the Azure Portal, the URL can be found listed as the service "Endpoint" ```python from azure.identity import DefaultAzureCred