Pull-instellingen voor App Configuration met Azure Pipelines

  • Artikel
  • 5 minuten om te lezen

De Azure App Configuration haalt sleutelwaarden op uit uw App Configuration-opslag en stelt deze in als Azure-pijplijnvariabelen, die kunnen worden gebruikt door volgende taken. Deze taak vormt een aanvulling op Azure App Configuration Push-taak die sleutelwaarden van een configuratiebestand naar uw App Configuration pusht. Zie Push settings to App Configuration with Azure Pipelines (Push-instellingen voor App Configuration met Azure Pipelines) voor meer informatie.

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 in een Azure DevOps-build-pijplijn gebruikt.

  1. Navigeer naar de pagina build-pijplijn door te klikken op Pipelines > Pipelines. Zie Uw eerste pijplijn maken voor documentatie over build-pipelines.
    • Als u een nieuwe build-pijplijn maakt, selecteert u in de laatste stap van het proces op het tabblad Controleren de optie Assistent tonen aan de rechterkant van de pijplijn. 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 de Azure App Configuration taak. Schermopname van het dialoogvenster Taak toevoegen met Azure App Configuration in het zoekvak.
  3. Configureer de vereiste parameters voor de taak om de sleutelwaarden op te halen uit App Configuration opslag. Beschrijvingen van de parameters zijn beschikbaar in de sectie Parameters hieronder en in knopinfo naast elke parameter.
    • Stel de parameter Azure-abonnement in op de naam van de serviceverbinding die u in een vorige stap hebt gemaakt.
    • Stel de App Configuration in op de resourcenaam van uw App Configuration winkel.
    • Laat de standaardwaarden voor de resterende parameters staan. Schermopname van de parameters voor de app-configuratietaak.
  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 taak Azure App Configuration in een Azure DevOps-release-pijplijn.

  1. Navigeer naar de release-pijplijnpagina door Pijplijnenreleases 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 pijplijn 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. Zoek de Azure App Configuration taak. Schermopname van het dialoogvenster Taak toevoegen met Azure App Configuration in het zoekvak.
  7. Configureer de benodigde parameters binnen de taak om uw sleutelwaarden op te halen uit App Configuration opslag. Beschrijvingen van de parameters zijn beschikbaar in de sectie Parameters hieronder en in knopinfo naast elke parameter.
    • Stel de parameter Azure-abonnement in op de naam van de serviceverbinding die u in een vorige stap hebt gemaakt.
    • Stel de App Configuration in op de resourcenaam van uw App Configuration winkel.
    • Laat de standaardwaarden voor de resterende parameters staan.
  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 Azure App Configuration 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.
  • Sleutelfilter: het filter kan worden gebruikt om te selecteren welke sleutelwaarden worden aangevraagd bij Azure App Configuration. Met de waarde * worden alle sleutelwaarden geselecteerd. Zie Querysleutelwaarden voor meer informatie over.
  • Label: hiermee geeft u op welk label moet worden gebruikt bij het selecteren van sleutelwaarden uit App Configuration store. Als er geen label is opgegeven, worden sleutelwaarden met het label geen opgehaald. De volgende tekens zijn niet toegestaan: , *.
  • Voorvoegsel voor trimsleutel: hiermee geeft u een of meer voorvoegsels op die moeten worden afgekort tot App Configuration sleutels voordat u ze als variabelen instelt. Meerdere voorvoegsels kunnen worden gescheiden door een teken van een nieuwe regel.

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 wordt uitgevoerd, kan deze een sleutelwaarde gebruiken met de sleutel 'myBuildSetting' als deze:

echo "$env:myBuildSetting"

En de waarde wordt afgedrukt naar de console.

Notitie

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

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 mijn configuratie samenstellen op basis van meerdere sleutels en labels?

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