Push-instellingen naar App Configuration met Azure Pipelines

  • Artikel
  • 5 minuten om te lezen

De Azure App Configuration Push-taak pusht sleutelwaarden van een configuratiebestand naar uw App Configuration archief. Deze taak maakt functionaliteit van volledige cirkels in de pijplijn mogelijk, omdat u nu instellingen kunt pullen uit de App Configuration-opslag en instellingen kunt pushen naar de App Configuration store.

Vereisten

Een serviceverbinding maken

Een serviceverbinding biedt u toegang tot resources in uw Azure-abonnement vanuit uw Azure DevOps-project.

  1. Ga in Azure DevOps naar het project dat uw doelpijplijn bevat. Selecteer Projectinstellingen in de linkerbenedenhoek.

  2. Selecteer onder Pipelines de optie Serviceverbindingen. Selecteer in de rechterbovenhoek Nieuwe serviceverbinding.

  3. Selecteer in Nieuwe serviceverbinding de optie Azure Resource Manager.

    Schermopname van het Azure Resource Manager selecteren in de vervolgkeuzelijst Nieuwe serviceverbinding.

  4. Selecteer in het dialoogvenster Verificatiemethode de optie Service-principal (automatisch) om een nieuwe service-principal te maken of selecteer Service-principal (handmatig) om een bestaande service-principal te gebruiken.

  5. Voer uw abonnement en resource en een naam voor uw serviceverbinding in.

Als u een nieuwe service-principal hebt gemaakt, zoek dan de naam van de service-principal die is toegewezen aan de serviceverbinding. In de volgende stap voegt u een nieuwe roltoewijzing toe aan deze service-principal.

  1. Ga naar Projectinstellingen > Serviceverbindingen.

  2. Selecteer de nieuwe serviceverbinding.

  3. Selecteer Service-principal beheren.

  4. Noteer de waarde in Weergavenaam.

    Schermopname van de weergavenaam van de service-principal.

Roltoewijzing toevoegen

Wijs de juiste App Configuration toe aan de referenties die in de taak worden gebruikt, zodat de taak toegang heeft tot App Configuration opslag.

  1. Ga naar de doelopslag App Configuration winkel.

  2. Selecteer toegangsbeheer (IAM) in het menu aan de linkerkant.

  3. Selecteer roltoewijzingen toevoegen in het rechterdeelvenster.

    Schermopname van de knop Roltoewijzingen toevoegen.

  4. Selecteer voor Rol de optie App Configuration Eigenaar van gegevens. Met deze rol kan de taak lezen van en schrijven naar App Configuration store.

  5. Selecteer de service-principal die is gekoppeld aan de serviceverbinding die u in de vorige sectie hebt gemaakt.

    Schermopname van het dialoogvenster Roltoewijzing toevoegen.

Gebruiken in builds

In deze sectie wordt be lezen hoe u de Azure App Configuration pushtaak in een Azure DevOps-build-pijplijn gebruikt.

  1. Navigeer naar de pagina build-pijplijn door te klikken op Pipelines > Pipelines. Documentatie voor build-pijplijnen vindt u hier.
    • Als u een nieuwe build-pijplijn maakt, selecteert u in de laatste stap van het proces op het tabblad Controleren de optie Assistent aan de rechterkant van de pijplijn tonen. Schermopname van de knop Assistent weergeven voor een nieuwe pijplijn.
    • Als u een bestaande build-pijplijn gebruikt, klikt u rechtsboven op de knop Bewerken. Schermopname van de knop Bewerken voor een bestaande pijplijn.
  2. Zoek naar de Azure App Configuration pushtaak. Schermopname van het dialoogvenster Taak toevoegen met Azure App Configuration Push in het zoekvak.
  3. Configureer de benodigde parameters voor de taak om de sleutelwaarden van het configuratiebestand naar het App Configuration pushen. Uitleg van de parameters zijn beschikbaar in de sectie Parameters hieronder en in knopinfo naast elke parameter. Schermopname van de parameters voor de pushtaak van de app-configuratie.
  4. Een build opslaan en in de wachtrij opslaan. In het buildlogboek worden eventuele fouten weergegeven die zijn opgetreden tijdens de uitvoering van de taak.

Gebruiken in releases

In deze sectie wordt be lezen hoe u de Azure App Configuration Push-taak in een Azure DevOps-release-pijplijnen gebruikt.

  1. Navigeer naar de release-pijplijnpagina door Pijplijnenreleases te > selecteren. Documentatie voor release-pijplijnen vindt u hier.
  2. Kies een bestaande release-pijplijn. Als u nog geen account hebt, selecteert u + Nieuw om een nieuwe te maken.
  3. Selecteer de knop Bewerken in de rechterbovenhoek om de release-pijplijn te bewerken.
  4. Kies in de vervolgkeuzelijst Taken de fase waaraan u de taak wilt toevoegen. Meer informatie over fasen vindt u hier. Schermopname van de geselecteerde fase in de vervolgkeuzekeuze selecteren taken.
  5. Klik + naast de taak waaraan u een nieuwe taak wilt toevoegen. Schermopname van de plusknop naast de taak.
  6. Typ in het dialoogvenster Taken toevoegen Azure App Configuration Push in het zoekvak en selecteer deze.
  7. Configureer de benodigde parameters binnen de taak om uw sleutelwaarden van uw configuratiebestand naar uw App Configuration pushen. Uitleg van de parameters zijn beschikbaar in de sectie Parameters hieronder en in knopinfo naast elke parameter.
  8. Sla een release op en wachtrij. In het releaselogboek worden eventuele fouten weergegeven die zijn aangetroffen tijdens de uitvoering van de taak.

Parameters

De volgende parameters worden gebruikt door de App Configuration Push-taak:

  • Azure-abonnement: een vervolgkeuzekeuze met uw beschikbare Azure-serviceverbindingen. Als u de lijst met beschikbare Azure-serviceverbindingen wilt bijwerken en vernieuwen, drukt u op de knop Azure-abonnement vernieuwen rechts van het tekstvak.
  • App Configuration naam: een vervolgkeuzekaart die uw beschikbare configuratieopslag onder het geselecteerde abonnement laadt. Als u de lijst met beschikbare configuratieopslag wilt bijwerken en vernieuwen, drukt u op de App Configuration Naam vernieuwen rechts van het tekstvak.
  • Pad naar configuratiebestand: het pad naar het configuratiebestand. De parameter Pad naar configuratiebestand begint in de hoofdmap van de bestandsopslagplaats. U kunt door uw build-artefact bladeren om een configuratiebestand te selecteren. ( ... rechts van het tekstvak). De ondersteunde bestandsindelingen zijn: yaml, json, properties. Hier volgt een voorbeeld van een configuratiebestand in json-indeling. 
    {
    "TestApp:Settings:BackgroundColor":"#FFF",
    "TestApp:Settings:FontColor":"#000",
    "TestApp:Settings:FontSize":"24",
    "TestApp:Settings:Message": "Message data"
}
  • Scheidingsteken: het scheidingsteken dat wordt gebruikt om JSON- en YML-bestanden plat te maken.
  • Diepte: de diepte waar de .json- en yml-bestanden op worden afgevlakt.
  • Voorvoegsel: een tekenreeks die wordt toegevoegd aan het begin van elke sleutel die naar het App Configuration wordt gep pusht.
  • Label: een tekenreeks die wordt toegevoegd aan elke sleutelwaarde als het label in App Configuration opslag.
  • Inhoudstype: een tekenreeks die wordt toegevoegd aan elke sleutelwaarde als het inhoudstype in App Configuration store.
  • Tags: een JSON-object in de indeling van , dat tags definieert die worden toegevoegd aan elke sleutelwaarde die naar uw App Configuration {"tag1":"val1", "tag2":"val2"} opgeslagen.
  • Verwijder alle andere Key-Values in store met het opgegeven voorvoegsel en label : Standaardwaarde is Uitgeschakeld.
    • Gecontroleerd: hiermee verwijdert u alle sleutelwaarden in het App Configuration-archief die overeenkomen met zowel het opgegeven voorvoegsel als het opgegeven label voordat u nieuwe sleutelwaarden uit het configuratiebestand pusht.
    • Uitgeschakeld: alle sleutelwaarden uit het configuratiebestand worden naar het App Configuration-archief pushen en alle andere waarden in de App Configuration blijven intact.

Problemen oplossen

Als er een onverwachte fout optreedt, kunnen logboeken voor foutopsporing worden ingeschakeld door de pijplijnvariabele in system.debug te stellen op true .

Veelgestelde vragen

Hoe kan ik meerdere configuratiebestanden uploaden?

Maak meerdere exemplaren van de Azure App Configuration pushtaak binnen dezelfde pijplijn om meerdere configuratiebestanden naar de App Configuration pushen.

Hoe kan ik Key Vault maken met behulp van deze taak?

Als u Key Vault wilt maken, stelt u de parameter Inhoudstype in op application/vnd.microsoft.appconfig.keyvaultref+json;charset=utf-8. Als niet alle sleutelwaarden in een configuratiebestand Key Vault zijn, plaats dan Key Vault-verwijzingen en normale sleutelwaarden in afzonderlijke configuratiebestanden en push ze afzonderlijk.

Waarom krijg ik een 409-foutmelding wanneer ik sleutelwaarden naar mijn configuratieopslag push?

Er treedt een 409-conflictfoutbericht op als de taak probeert een sleutelwaarde te verwijderen of te overschrijven die is vergrendeld in App Configuration store.