Share via

Hämta inställningar från App Configuration med Azure Pipelines

  • Artikel

Azure App Configuration-uppgiften hämtar nyckelvärden från appkonfigurationsarkivet och anger dem som Azure-pipelinevariabler, som kan användas av efterföljande uppgifter. Den här uppgiften kompletterar azure appkonfigurationens push-uppgift som push-överför nyckelvärden från en konfigurationsfil till appkonfigurationsarkivet. Mer information finns i Push-inställningar för appkonfiguration med Azure Pipelines.

Förutsättningar

Skapa en tjänstanslutning

En tjänstanslutning ger dig åtkomst till resurser i din Azure-prenumeration från ditt Azure DevOps-projekt.

  1. I Azure DevOps går du till projektet som innehåller målpipelinen. I det nedre vänstra hörnet väljer du Projektinställningar.

  2. Under Pipelines väljer du Tjänstanslutningar. I det övre högra hörnet väljer du Ny tjänstanslutning.

  3. I Ny tjänstanslutning väljer du Azure Resource Manager.

    Screenshot shows selecting Azure Resource Manager from the New service connection dropdown list.

  4. I dialogrutan Autentiseringsmetod väljer du Tjänstens huvudnamn (automatiskt) för att skapa ett nytt huvudnamn för tjänsten eller väljer Tjänstens huvudnamn (manuellt) för att använda ett befintligt huvudnamn för tjänsten.

  5. Ange din prenumeration, resursgrupp och ett namn för tjänstanslutningen.

Om du har skapat ett nytt huvudnamn för tjänsten letar du reda på namnet på tjänstens huvudnamn som tilldelats tjänstanslutningen. Du lägger till en ny rolltilldelning till tjänstens huvudnamn i nästa steg.

  1. Gå till Project Inställningar> Service-anslutningar.

  2. Välj den nya tjänstanslutningen.

  3. Välj Hantera tjänstens huvudnamn.

  4. Observera värdet i Visningsnamn.

    Screenshot shows the service principal display name.

Lägg till rolltilldelning

Tilldela rätt rolltilldelningar för appkonfiguration till de autentiseringsuppgifter som används i aktiviteten så att uppgiften kan komma åt App Configuration Store.

  1. Gå till ditt appkonfigurationsarkiv för mål.

  2. Välj Åtkomstkontroll (IAM) i den vänstra menyn.

  3. I den högra rutan väljer du Lägg till rolltilldelningar.

    Screenshot shows the Add role assignments button.

  4. För Roll väljer du Dataläsare för appkonfiguration. Med den här rollen kan uppgiften läsas från App Configuration Store.

  5. Välj tjänstens huvudnamn som är associerat med tjänstanslutningen som du skapade i föregående avsnitt.

    Screenshot shows the Add role assignment dialog.

  6. Välj Granska + tilldela.

  7. Om arkivet innehåller Key Vault-referenser går du till relevant Key Vault och tilldelar rollen Hemlig nyckelvalv till tjänstens huvudnamn som skapades i föregående steg. På Key Vault-menyn väljer du Åtkomstprinciper och ser till att rollbaserad åtkomstkontroll i Azure har valts som behörighetsmodell.

Använda i versioner

Det här avsnittet beskriver hur du använder Azure App Configuration-uppgiften i en Azure DevOps-byggpipeline.

  1. Gå till sidan byggpipeline genom att klicka på Pipelines>Pipelines. Dokumentation om bygg-pipeline finns i Skapa din första pipeline.
    • Om du skapar en ny bygg-pipeline går du till det sista steget i processen och väljer Visa assistent till höger i pipelinen på fliken Granska. Screenshot shows the Show assistant button for a new pipeline.
    • Om du använder en befintlig byggpipeline klickar du på knappen Redigera längst upp till höger. Screenshot shows the Edit button for an existing pipeline.
  2. Sök efter azure appkonfigurationsuppgiften. Screenshot shows the Add Task dialog with Azure App Configuration in the search box.
  3. Konfigurera nödvändiga parametrar för uppgiften för att hämta nyckelvärdena från App Configuration Store. Beskrivningar av parametrarna finns i avsnittet Parametrar nedan och i knappbeskrivningar bredvid varje parameter.
    • Ange azure-prenumerationsparametern till namnet på tjänstanslutningen som du skapade i ett tidigare steg.
    • Ange appkonfigurationsslutpunkten till slutpunkten för appkonfigurationsarkivet.
    • Lämna standardvärdena för de återstående parametrarna. Screenshot shows the app configuration task parameters.
  4. Spara och köa ett bygge. Byggloggen visar eventuella fel som inträffade under körningen av uppgiften.

Använda i versioner

Det här avsnittet beskriver hur du använder Azure App Configuration-uppgiften i en Azure DevOps-versionspipeline.

  1. Gå till sidan versionspipeline genom att välja Pipelines-versioner>. Dokumentation om versionspipelines finns i Versionspipelines.
  2. Välj en befintlig versionspipeline. Om du inte har någon klickar du på Ny pipeline för att skapa en ny.
  3. Välj knappen Redigera i det övre högra hörnet för att redigera versionspipelinen.
  4. I listrutan Uppgifter väljer du den fas som du vill lägga till uppgiften i. Mer information om faser finns här. Screenshot shows the selected stage in the Tasks dropdown.
  5. Klicka + bredvid det jobb som du vill lägga till en ny uppgift i. Screenshot shows the plus button next to the job.
  6. Sök efter azure appkonfigurationsuppgiften. Screenshot shows the Add Task dialog with Azure App Configuration in the search box.
  7. Konfigurera nödvändiga parametrar i aktiviteten för att hämta dina nyckelvärden från appkonfigurationsarkivet. Beskrivningar av parametrarna finns i avsnittet Parametrar nedan och i knappbeskrivningar bredvid varje parameter.
    • Ange azure-prenumerationsparametern till namnet på tjänstanslutningen som du skapade i ett tidigare steg.
    • Ange appkonfigurationsslutpunkten till slutpunkten för appkonfigurationsarkivet.
    • Lämna standardvärdena för de återstående parametrarna.
  8. Spara och köa en version. Versionsloggen visar eventuella fel som påträffas under körningen av uppgiften.

Parametrar

Följande parametrar används av Azure App Configuration-uppgiften:

  • Azure-prenumeration: En listruta som innehåller dina tillgängliga Azure-tjänstanslutningar. Om du vill uppdatera din lista över tillgängliga Azure-tjänstanslutningar trycker du på knappen Uppdatera Azure-prenumeration till höger om textrutan.
  • Slutpunkt för appkonfiguration: En listruta som läser in dina tillgängliga konfigurationslagerslutpunkter under den valda prenumerationen. Om du vill uppdatera listan över tillgängliga slutpunkter för konfigurationslager trycker du på knappen Uppdatera appkonfigurationsslutpunkt till höger om textrutan.
  • Markeringsläge: Anger hur nyckelvärdena som läss från ett konfigurationsarkiv väljs. Med markeringsläget Standard kan du använda nyckel- och etikettfilter. Med markeringsläget "Ögonblicksbild" kan nyckelvärden väljas från en ögonblicksbild. Standardvärdet är Standard.
  • Nyckelfilter: Filtret kan användas för att välja vilka nyckelvärden som begärs från Azure App Configuration. Värdet * väljer alla nyckelvärden. Mer information finns i Fråga nyckelvärden.
  • Etikett: Anger vilken etikett som ska användas när du väljer nyckelvärden från App Configuration Store. Om ingen etikett anges hämtas nyckelvärden utan etikett. Följande tecken är inte tillåtna: , *.
  • Namn på ögonblicksbild: Anger ögonblicksbild från vilken nyckelvärden ska hämtas i Azure App Configuration.
  • Trimma nyckelprefix: Anger ett eller flera prefix som ska trimmas från appkonfigurationsnycklar innan de anges som variabler. Flera prefix kan avgränsas med ett nytt radtecken.
  • Ignorera varning för åsidosatta nycklar: Standardvärdet är avmarkerat. Anger om du vill visa varningar när befintliga nycklar åsidosättas. Aktivera det här alternativet när det förväntas att nyckelvärdena som laddas ned från App Configuration har överlappande nycklar med vad som finns i pipelinevariabler.

Använda nyckelvärden i efterföljande uppgifter

Nyckelvärdena som hämtas från App Configuration anges som pipelinevariabler, som är tillgängliga som miljövariabler. Nyckeln för miljövariabeln är nyckeln till nyckelvärdet som hämtas från App Configuration efter att prefixet har trimmats om det har angetts.

Om en efterföljande aktivitet till exempel kör ett PowerShell-skript kan den använda ett nyckelvärde med nyckeln "myBuildSetting" så här:

echo "$env:myBuildSetting"

Och värdet skrivs ut till konsolen.

Kommentar

Azure Key Vault-referenser i App Configuration matchas och anges som hemliga variabler. I Azure-pipelines maskeras hemliga variabler från loggen. De skickas inte till uppgifter som miljövariabler och måste i stället skickas som indata.

Felsökning

Om ett oväntat fel inträffar kan felsökningsloggar aktiveras genom att ange pipelinevariabeln system.debug till true.

Vanliga frågor

Hur gör jag för att skriva min konfiguration från flera nycklar och etiketter?

Det finns tillfällen då konfigurationen kan behöva bestå av flera etiketter, till exempel standard och utveckling. Flera appkonfigurationsuppgifter kan användas i en pipeline för att implementera det här scenariot. De nyckelvärden som hämtas av en aktivitet i ett senare steg ersätter alla värden från föregående steg. I det ovan nämnda exemplet kan en uppgift användas för att välja nyckelvärden med standardetiketten medan en andra uppgift kan välja nyckelvärden med utvecklingsetiketten. Nycklarna med dev-etiketten åsidosätter samma nycklar med standardetiketten.