Instellingen ophalen uit App Configuration met Azure Pipelines

De Azure-app Configuratietaak haalt sleutelwaarden op uit uw App Configuration-archief en stelt deze in als Azure-pijplijnvariabelen, die kunnen worden gebruikt door volgende taken. Deze taak vormt een aanvulling op de Azure-app Configuratiepushtaak die sleutelwaarden van een configuratiebestand naar uw App Configuration-archief pusht. Zie Push-instellingen naar App Configuration met Azure Pipelines voor meer informatie.

Vereisten

• Azure-abonnement: u kunt een gratis abonnement nemen
• App Configuration-archief - maak er gratis een
• Azure DevOps-project : maak er gratis een
• Azure-app configuratietaak - gratis downloaden van de Visual Studio Marketplace.
• Azure Pipelines-agent versie 2.206.1 of hoger en Node versie 16 of hoger voor het uitvoeren van de taak op zelf-hostende agents.

Een serviceverbinding maken

Met een serviceverbinding hebt u vanuit uw Azure DevOps-project toegang tot resources in uw Azure-abonnement.

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 de optie Nieuwe serviceverbinding.

3. Selecteer Azure Resource Manager in de 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, resourcegroep en een naam in voor uw serviceverbinding.

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

1. Ga naar Project Instellingen> Service-verbindingen.

2. Selecteer de nieuwe serviceverbinding.

3. Selecteer Service-principal beheren.

4. Noteer de waarde in weergavenaam.

   

Roltoewijzing toevoegen

Wijs de juiste Roltoewijzingen voor App Configuration toe aan de referenties die in de taak worden gebruikt, zodat de taak toegang heeft tot het App Configuration-archief.

1. Ga naar uw doel-App Configuration-archief.

2. Selecteer toegangsbeheer (IAM) in het linkermenu.

3. Selecteer Roltoewijzingen toevoegen in het rechterdeelvenster.

   

4. Voor Rol selecteert u App Configuration Data Reader. Met deze rol kan de taak lezen uit het App Configuration-archief.

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

   

6. Selecteer Controleren + toewijzen.

7. Als het archief Key Vault-verwijzingen bevat, gaat u naar relevante Key Vault en wijst u de rol Key Vault Secret User toe aan de service-principal die u in de vorige stap hebt gemaakt. Selecteer in het menu Key Vault toegangsbeleid en zorg ervoor dat op rollen gebaseerd toegangsbeheer van Azure is geselecteerd als het machtigingsmodel.

Gebruiken in builds

In deze sectie wordt beschreven hoe u de Azure-app-configuratietaak gebruikt in een Azure DevOps-buildpijplijn.

1. Navigeer naar de pagina build-pijplijn door op Pipelines Pipelines> te klikken. Zie Uw eerste pijplijn maken voor documentatie over build-pijplijnen.
   • Als u een nieuwe build-pijplijn maakt, selecteert u in de laatste stap van het proces op het tabblad Controleren de assistent Weergeven aan de rechterkant van de pijplijn.
   • Als u een bestaande build-pijplijn gebruikt, klikt u op de knop Bewerken in de rechterbovenhoek.
2. Zoek de Azure-app configuratietaak.
3. Configureer de benodigde parameters voor de taak om de sleutelwaarden op te halen uit het App Configuration-archief. Beschrijvingen van de parameters zijn beschikbaar in de sectie Parameters hieronder en in knopinfo naast elke parameter.
   • Stel de parameter voor het Azure-abonnement in op de naam van de serviceverbinding die u in een vorige stap hebt gemaakt.
   • Stel het App Configuration-eindpunt in op het eindpunt van uw App Configuration-archief.
   • Laat de standaardwaarden voor de resterende parameters staan.
4. Een build opslaan en in de wachtrij plaatsen. In het buildlogboek worden eventuele fouten weergegeven die zijn opgetreden tijdens de uitvoering van de taak.

Gebruiken in releases

In deze sectie wordt beschreven hoe u de Azure-app-configuratietaak gebruikt in een Azure DevOps-releasepijplijn.

1. Navigeer naar de release-pijplijnpagina door Pijplijnreleases> te selecteren. Zie Release-pijplijnen voor documentatie over release-pijplijnen.
2. Kies een bestaande release-pijplijn. Als u nog geen pijplijn hebt, klikt u op Nieuwe pijplijn 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.
5. Klik + naast de taak waaraan u een nieuwe taak wilt toevoegen.
6. Zoek de Azure-app configuratietaak.
7. Configureer de benodigde parameters binnen de taak om uw sleutelwaarden op te halen uit uw App Configuration-archief. Beschrijvingen van de parameters zijn beschikbaar in de sectie Parameters hieronder en in knopinfo naast elke parameter.
   • Stel de parameter voor het Azure-abonnement in op de naam van de serviceverbinding die u in een vorige stap hebt gemaakt.
   • Stel het App Configuration-eindpunt in op het eindpunt van uw App Configuration-archief.
   • Laat de standaardwaarden voor de resterende parameters staan.
8. Sla een release op en plaats deze in de wachtrij. In het releaselogboek worden eventuele fouten weergegeven die zijn opgetreden tijdens de uitvoering van de taak.

Parameters

De volgende parameters worden gebruikt door de Azure-app configuratietaak:

• Azure-abonnement: een vervolgkeuzelijst met uw beschikbare Azure-serviceverbindingen. Als u uw lijst met beschikbare Azure-serviceverbindingen wilt bijwerken en vernieuwen, drukt u op de knop Azure-abonnement vernieuwen rechts van het tekstvak.
• App Configuration-eindpunt: een vervolgkeuzelijst waarin de beschikbare configuratie-eindpunten worden opgeslagen onder het geselecteerde abonnement. Als u de lijst met beschikbare configuratieopslageindpunten wilt bijwerken en vernieuwen, drukt u op de knop App Configuration-eindpunt vernieuwen rechts van het tekstvak.
• Selectiemodus: Hiermee geeft u op hoe de sleutelwaarden uit een configuratiearchief worden geselecteerd. Met de standaardselectiemodus kunnen sleutel- en labelfilters worden gebruikt. Met de selectiemodus Momentopname kunnen sleutelwaarden uit een momentopname worden geselecteerd. De standaardwaarde is Standaard.
• Sleutelfilter: het filter kan worden gebruikt om te selecteren welke sleutelwaarden worden aangevraagd in Azure-app Configuratie. Een waarde van * selecteert alle sleutelwaarden. Zie Sleutelwaarden opvragen voor meer informatie.
• Label: Hiermee geeft u op welk label moet worden gebruikt bij het selecteren van sleutelwaarden in het App Configuration-archief. Als er geen label is opgegeven, worden sleutelwaarden zonder label opgehaald. De volgende tekens zijn niet toegestaan: , *.
• Naam van momentopname: hiermee geeft u de momentopname op waaruit sleutelwaarden moeten worden opgehaald in Azure-app Configuratie.
• Sleutelvoorvoegsel knippen: hiermee geeft u een of meer voorvoegsels op die moeten worden bijgesneden uit App Configuration-sleutels voordat u deze instelt als variabelen. Meerdere voorvoegsels kunnen worden gescheiden door een nieuw regelteken.
• Waarschuwing onderdrukken voor overschreven sleutels: standaardwaarde is uitgeschakeld. Hiermee geeft u op of waarschuwingen moeten worden weergegeven wanneer bestaande sleutels worden overschreven. Schakel deze optie in wanneer wordt verwacht dat de sleutelwaarden die zijn gedownload uit App Configuration overlappende sleutels bevatten met wat er in pijplijnvariabelen bestaat.

Sleutelwaarden gebruiken in volgende taken

De sleutelwaarden die worden opgehaald uit App Configuration, worden ingesteld als pijplijnvariabelen, die toegankelijk zijn als omgevingsvariabelen. De sleutel van de omgevingsvariabele is de sleutel van de sleutelwaarde die wordt opgehaald uit App Configuration nadat het voorvoegsel is ingekort, indien opgegeven.

Als een volgende taak bijvoorbeeld een PowerShell-script uitvoert, kan deze een sleutelwaarde gebruiken met de sleutel 'myBuildSetting', zoals deze:

echo "$env:myBuildSetting"

En de waarde wordt afgedrukt naar de console.

Notitie

Azure Key Vault-verwijzingen in App Configuration worden omgezet en ingesteld als geheime variabelen. In Azure-pijplijnen worden geheime variabelen uit logboeken gemaskeerd. Ze worden niet doorgegeven aan taken als omgevingsvariabelen en moeten in plaats daarvan worden doorgegeven als invoer.

Probleemoplossing

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

Veelgestelde vragen

Hoe kan ik mijn configuratie van meerdere sleutels en labels opstellen?

Er zijn momenten waarop de configuratie mogelijk moet worden samengesteld uit meerdere labels, bijvoorbeeld standaard en dev. Er kunnen meerdere App Configuration-taken in één pijplijn worden gebruikt om dit scenario te implementeren. De sleutelwaarden die door een taak in een latere stap worden opgehaald, vervangen alle waarden uit de vorige stappen. In het bovenstaande voorbeeld kan een taak worden gebruikt om sleutelwaarden te selecteren met het standaardlabel, terwijl een tweede taak sleutelwaarden met het dev-label kan selecteren. De sleutels met het dev-label overschrijven dezelfde sleutels met het standaardlabel.