Zelfstudie: Key Vault-verwijzingen gebruiken in een Python-app

In deze zelfstudie leert u hoe u Key Vault-verwijzingen implementeert in een Python-toepassing met behulp van App Configuration. Het bouwt voort op de web-app die is geïntroduceerd in de quickstart. Voordat u doorgaat, voltooit u eerst Een Python-app maken met App Configuration .

In deze handleiding leer je hoe je:

Vereiste voorwaarden

• Azure-abonnement - maak er gratis een
• Python 3.8 of hoger: zie de Documentatie voor Python in Windows voor meer informatie over het instellen van Python in Windows
• Voltooi de quickstartcursus Een Python-app maken met App Configuration.

Maak een Key Vault.

1. Meld u aan bij de Azure-portal en selecteer Resource maken.

2. Typ Key Vault in het zoekvak. Selecteer Key Vault in de resultatenlijst.

3. Selecteer Maken op de pagina Key Vault.

4. Voer op de pagina Een sleutelkluis maken de volgende gegevens in:

   • Voor abonnement: Selecteer een abonnement.
   • Voor de resourcegroep: voer de naam van een bestaande resourcegroep in of selecteer Nieuwe maken en voer een resourcegroepnaam in.
   • Voer een unieke naam in voor de naam van de sleutelkluis.
   • Voor regio: Selecteer een locatie.

5. Gebruik de standaardwaarden voor de andere opties.

6. Kies Beoordelen + creëren.

7. Nadat het systeem uw invoer heeft gevalideerd en weergegeven, selecteert u Maken.

Vanaf nu is uw Azure-account als enige gemachtigd om bewerkingen op deze nieuwe Key Vault uit te voeren.

Een geheim toevoegen aan Key Vault

Voeg een geheim toe aan de kluis om het ophalen van Key Vault te testen. Het geheim heet Bericht en de waarde is 'Hello from Key Vault'.

1. SelecteerObjectengeheimen> in het menu van de Key Vault-resource.

2. Selecteer Genereren/importeren.

3. Voer in het dialoogvenster Een geheim maken de volgende waarden in:

   • Voor uploadopties: Voer handmatig in.
   • Voor Naam: Voer Bericht in.
   • Voor geheime waarde: Voer Hello uit Key Vault in.

4. Gebruik de standaardwaarden voor de andere opties.

5. Klik op Creëren.

Een sleutelkluisverwijzing toevoegen aan App Configuration

1. Meld u aan bij het Azure-portaal. Selecteer Alle resources en selecteer vervolgens uw App Configuration-archief.

2. Selecteer Configuratieverkenner.

3. Selecteer + Maken>Sleutelkluisverwijzing en geef de volgende waarden op:

   • Sleutel: Voer TestApp:Settings:KeyVaultMessage in.
   • Label: laat deze waarde leeg.
   • Abonnement, resourcegroep en sleutelkluis: voer de waarden in die overeenkomen met de sleutelkluis die u in de vorige sectie hebt gemaakt.
   • Geheim: Selecteer het geheim met de naam Bericht dat u in de vorige sectie hebt gemaakt.

Uw app toegang verlenen tot Key Vault

Uw toepassing gebruikt DefaultAzureCredential voor verificatie bij zowel App Configuration als Key Vault. Deze referentie werkt automatisch met beheerde identiteiten in Azure en met uw referenties voor ontwikkelaars lokaal.

1. Uw identiteit toegang verlenen tot Key Vault. Wijs de rol Key Vault Secrets User toe aan uw gebruikersaccount of beheerde identiteit:

   az role assignment create --role "Key Vault Secrets User" --scope /subscriptions/<SubscriptionId>/resourceGroups/<ResourceGroupName>/providers/Microsoft.KeyVault/vaults/<KeyVaultName> --assignee <AzureAdUserOrManagedIdentity>
   

2. Verleen uw identiteit toegang tot App Configuration. Wijs de rol App Configuration Data Reader toe:

   az role assignment create --role "App Configuration Data Reader" --scope /subscriptions/<SubscriptionId>/resourceGroups/<ResourceGroupName>/providers/Microsoft.AppConfiguration/configurationStores/<AppConfigurationStoreName> --assignee <AzureAdUserOrManagedIdentity>
   

Uw code bijwerken om een Key Vault-referentie te gebruiken

1. Installeer de vereiste pakketten door de volgende opdracht uit te voeren:

   pip install azure-appconfiguration-provider azure-identity
   

2. Maak een omgevingsvariabele met de naam AZURE_APPCONFIG_ENDPOINT. Stel de waarde ervan in op het eindpunt van uw App Configuration-opslag. U vindt het eindpunt op het blade Overzicht in de Azure Portal.

   • Windows-opdrachtprompt
   • PowerShell
   • macOS of Linux

   setx AZURE_APPCONFIG_ENDPOINT "endpoint-of-your-app-configuration-store"
   

   Start de opdrachtprompt opnieuw op om de wijziging door te voeren.

3. Werk uw Python-toepassingsbestand bij om Key Vault-verwijzingen te laden. Maak of werk een bestand genaamd app.py bij.

   from azure.appconfiguration.provider import load
   from azure.identity import DefaultAzureCredential
   import os
   
   endpoint = os.environ.get("AZURE_APPCONFIG_ENDPOINT")
   credential = DefaultAzureCredential()
   
   # Connect to Azure App Configuration and resolve Key Vault references.
   config = load(
       endpoint=endpoint,
       credential=credential,
       keyvault_credential=credential,
   )
   
   # Access configuration values, including resolved Key Vault references.
   print(config["TestApp:Settings:KeyVaultMessage"])
   

   De keyvault_credential parameter geeft de provider de opdracht om de opgegeven referentie te gebruiken bij het omzetten van Key Vault-verwijzingen. Hetzelfde DefaultAzureCredential exemplaar wordt gebruikt voor zowel App Configuration- als Key Vault-verificatie.

   Opmerking

   Als uw Key Vault verwijst naar meerdere sleutelkluizen waarvoor verschillende referenties zijn vereist, kunt u in plaats daarvan de keyvault_client_configs parameter gebruiken om referenties per kluis op te geven. Zie de naslaginformatie over de Python-provider voor meer informatie.

4. Voer de toepassing uit:

   python app.py
   

   U ziet het bericht dat u hebt ingevoerd in App Configuration. U ziet ook het bericht dat u in Key Vault hebt ingevoerd, opgelost via de verwijzing naar Key Vault.

De hulpbronnen opschonen

Als u de resources die in dit artikel zijn gemaakt niet wilt blijven gebruiken, verwijdert u de resourcegroep die u hier hebt gemaakt om kosten te voorkomen.

1. Meld u aan bij de Azure-portal en selecteer Resource-groepen.
2. Voer in het vak Filteren op naam de naam van uw resourcegroep in.
3. Selecteer in de resultatenlijst de resourcegroepnaam om een overzicht te bekijken.
4. Selecteer Resourcegroep verwijderen.
5. U wordt gevraagd om het verwijderen van de resourcegroep te bevestigen. Voer de naam van de resourcegroep in die u wilt bevestigen en selecteer Verwijderen.

Na enkele ogenblikken worden de resourcegroep en alle bijbehorende resources verwijderd.

Volgende stappen 

In deze zelfstudie maakt u een App Configuration-sleutel die verwijst naar een waarde die is opgeslagen in Key Vault. Raadpleeg de referentiedocumentatie voor de Python-provider voor Azure App Configuration voor meer informatie over de Python-provider.