Ściąganie ustawień z usługi App Configuration za pomocą usługi Azure Pipelines

Zadanie aplikacja systemu Azure Configuration pobiera wartości klucz-wartość ze sklepu App Configuration i ustawia je jako zmienne potoku platformy Azure, które mogą być używane przez kolejne zadania. To zadanie uzupełnia zadanie wypychania konfiguracji aplikacja systemu Azure, które wypycha klucz-wartości z pliku konfiguracji do magazynu usługi App Configuration. Aby uzyskać więcej informacji, zobacz Ustawienia wypychania do usługi App Configuration za pomocą usługi Azure Pipelines.

Wymagania wstępne

• Subskrypcja platformy Azure — utwórz jedną bezpłatnie
• Sklep App Configuration — utwórz go bezpłatnie
• Projekt usługi Azure DevOps — utwórz go bezpłatnie
• aplikacja systemu Azure Zadanie konfiguracji — pobierz bezpłatnie z witryny Visual Studio Marketplace.
• Agent usługi Azure Pipelines w wersji 2.206.1 lub nowszej oraz node w wersji 16 lub nowszej na potrzeby uruchamiania zadania na własnych agentach.

Tworzenie połączenia z usługą

Połączenie z usługą zapewnia dostęp do zasobów w ramach subskrypcji platformy Azure z projektu usługi Azure DevOps.

1. W usłudze Azure DevOps przejdź do projektu zawierającego potok docelowy. W lewym dolnym rogu wybierz pozycję Ustawienia projektu.

2. W obszarze Potoki wybierz pozycję Połączenia z usługą. W prawym górnym rogu wybierz pozycję Nowe połączenie z usługą.

3. W obszarze Nowe połączenie z usługą wybierz pozycję Azure Resource Manager.

   

4. W oknie dialogowym Metoda uwierzytelniania wybierz pozycję Jednostka usługi (automatyczna), aby utworzyć nową jednostkę usługi lub wybrać jednostkę usługi (ręcznie), aby użyć istniejącej jednostki usługi.

5. Wprowadź swoją subskrypcję, grupę zasobów i nazwę połączenia usługi.

Jeśli utworzono nową jednostkę usługi, znajdź nazwę jednostki usługi przypisanej do połączenia usługi. W następnym kroku dodasz nowe przypisanie roli do tej jednostki usługi.

1. Przejdź do pozycji Project Ustawienia> Usługi połączeń.

2. Wybierz nowe połączenie z usługą.

3. Wybierz pozycję Zarządzaj jednostką usługi.

4. Zanotuj wartość w polu Nazwa wyświetlana.

   

Dodaj przypisanie roli

Przypisz odpowiednie przypisania ról usługi App Configuration do poświadczeń używanych w zadaniu, aby zadanie może uzyskać dostęp do magazynu usługi App Configuration.

1. Przejdź do docelowego magazynu usługi App Configuration.

2. W menu po lewej stronie wybierz pozycję Kontrola dostępu (Zarządzanie dostępem i tożsamościami)..

3. W okienku po prawej stronie wybierz pozycję Dodaj przypisania ról.

   

4. W obszarze Rola wybierz pozycję Czytelnik danych konfiguracji aplikacji. Ta rola umożliwia odczytywanie zadania ze sklepu App Configuration.

5. Wybierz jednostkę usługi skojarzona z połączeniem usługi utworzonym w poprzedniej sekcji.

   

6. Wybierz Przejrzyj + przypisz.

7. Jeśli magazyn zawiera odwołania do usługi Key Vault, przejdź do odpowiedniej usługi Key Vault i przypisz rolę użytkownika wpisu tajnego usługi Key Vault do jednostki usługi utworzonej w poprzednim kroku. Z menu usługi Key Vault wybierz pozycję Zasady dostępu i upewnij się, że jako model uprawnień wybrano kontrolę dostępu opartą na rolach platformy Azure.

Używanie w kompilacjach

W tej sekcji opisano sposób używania zadania konfiguracji aplikacja systemu Azure w potoku kompilacji usługi Azure DevOps.

1. Przejdź do strony potoku kompilacji, klikając pozycję Potoki>. Aby uzyskać dokumentację potoku kompilacji, zobacz Tworzenie pierwszego potoku.
   • Jeśli tworzysz nowy potok kompilacji, w ostatnim kroku procesu na karcie Przegląd wybierz pozycję Pokaż asystenta po prawej stronie potoku.
   • Jeśli używasz istniejącego potoku kompilacji, kliknij przycisk Edytuj w prawym górnym rogu.
2. Wyszukaj zadanie konfiguracji aplikacja systemu Azure.
3. Skonfiguruj niezbędne parametry zadania w celu ściągnięcia wartości klucz-z magazynu App Configuration. Opisy parametrów są dostępne w sekcji Parametry poniżej i w etykietkach narzędzi obok każdego parametru.
   • Ustaw parametr subskrypcji platformy Azure na nazwę połączenia usługi utworzonego w poprzednim kroku.
   • Ustaw punkt końcowy konfiguracji aplikacji na punkt końcowy magazynu usługi App Configuration.
   • Pozostaw wartości domyślne pozostałych parametrów.
4. Zapisywanie i kolejkowanie kompilacji. W dzienniku kompilacji zostaną wyświetlone wszystkie błędy, które wystąpiły podczas wykonywania zadania.

Używanie w wydaniach

W tej sekcji opisano sposób używania zadania konfiguracji aplikacja systemu Azure w potoku wydania usługi Azure DevOps.

1. Przejdź do strony potoku wydania, wybierając pozycję Wydania potoków>. Aby uzyskać dokumentację potoku wydania, zobacz Potoki wydania.
2. Wybierz istniejący potok wydania. Jeśli go nie masz, kliknij pozycję Nowy potok , aby utworzyć nowy.
3. Wybierz przycisk Edytuj w prawym górnym rogu, aby edytować potok wydania.
4. Z listy rozwijanej Zadania wybierz etap , do którego chcesz dodać zadanie. Więcej informacji na temat etapów można znaleźć tutaj.
5. Kliknij + obok zadania, do którego chcesz dodać nowe zadanie.
6. Wyszukaj zadanie konfiguracji aplikacja systemu Azure.
7. Skonfiguruj wymagane parametry w zadaniu, aby ściągnąć wartości kluczy ze sklepu App Configuration. Opisy parametrów są dostępne w sekcji Parametry poniżej i w etykietkach narzędzi obok każdego parametru.
   • Ustaw parametr subskrypcji platformy Azure na nazwę połączenia usługi utworzonego w poprzednim kroku.
   • Ustaw punkt końcowy konfiguracji aplikacji na punkt końcowy magazynu usługi App Configuration.
   • Pozostaw wartości domyślne pozostałych parametrów.
8. Zapisywanie i kolejka wydania. Dziennik wydania wyświetli wszelkie błędy napotkane podczas wykonywania zadania.

Parametry

Następujące parametry są używane przez zadanie aplikacja systemu Azure Configuration:

• Subskrypcja platformy Azure: lista rozwijana zawierająca dostępne połączenia usługi platformy Azure. Aby zaktualizować i odświeżyć listę dostępnych połączeń usług platformy Azure, naciśnij przycisk Odśwież subskrypcję platformy Azure po prawej stronie pola tekstowego.
• Punkt końcowy konfiguracji aplikacji: lista rozwijana, która ładuje dostępne punkty końcowe konfiguracji w ramach wybranej subskrypcji. Aby zaktualizować i odświeżyć listę dostępnych punktów końcowych magazynu konfiguracji, naciśnij przycisk Odśwież punkt końcowy konfiguracji aplikacji po prawej stronie pola tekstowego.
• Tryb wyboru: określa sposób wybierania wartości klucza z magazynu konfiguracji. Tryb wyboru "Domyślny" umożliwia korzystanie z filtrów klawiszy i etykiet. Tryb wyboru "Migawka" umożliwia wybranie wartości kluczy z migawki. Wartość domyślna to Wartość domyślna.
• Filtr klucza: filtr może służyć do wybierania żądanych wartości klucza z aplikacja systemu Azure Configuration. Wartość * spowoduje wybranie wszystkich wartości klucz-wartość. Aby uzyskać więcej informacji na ten temat, zobacz Query key-values (Wykonywanie zapytań o wartości klucz-wartość).
• Etykieta: określa, która etykieta ma być używana podczas wybierania kluczy-wartości z magazynu App Configuration. Jeśli etykieta nie zostanie podana, zostanie pobrana żadna etykieta z kluczami bez etykiety. Następujące znaki są niedozwolone: , *.
• Nazwa migawki: określa migawkę, z której należy pobrać wartości klucza w aplikacja systemu Azure Configuration.
• Przycinanie prefiksu klucza: określa co najmniej jeden prefiks, który ma zostać przycięty z kluczy konfiguracji aplikacji przed ustawieniem ich jako zmiennych. Wiele prefiksów można rozdzielić znakiem nowego wiersza.
• Pomiń ostrzeżenie dla przesłoniętych kluczy: wartość domyślna jest niezaznaczone. Określa, czy mają być wyświetlane ostrzeżenia, gdy istniejące klucze są zastępowane. Włącz tę opcję, jeśli oczekuje się, że wartości klucz-pobrane z usługi App Configuration mają nakładające się klucze o tym, co istnieje w zmiennych potoku.

Używanie wartości kluczy w kolejnych zadaniach

Wartości klucza pobierane z usługi App Configuration są ustawiane jako zmienne potoku, które są dostępne jako zmienne środowiskowe. Klucz zmiennej środowiskowej jest kluczem klucz-wartość, który jest pobierany z usługi App Configuration po przycinaniu prefiksu, jeśli zostanie określony.

Jeśli na przykład kolejne zadanie uruchamia skrypt programu PowerShell, może on używać klucza-wartość z kluczem "myBuildSetting", jak pokazano poniżej:

echo "$env:myBuildSetting"

Wartość zostanie wydrukowana w konsoli programu .

Uwaga

Odwołania do usługi Azure Key Vault w usłudze App Configuration zostaną rozpoznane i ustawione jako zmienne tajne. W usłudze Azure Pipelines zmienne tajne są maskowane z dziennika. Nie są przekazywane do zadań podrzędnych jako zmiennych środowiskowych i zamiast tego muszą być przekazywane jako dane wejściowe.

Rozwiązywanie problemów

Jeśli wystąpi nieoczekiwany błąd, dzienniki debugowania można włączyć, ustawiając zmienną system.debug potoku na true.

Często zadawane pytania

Jak mogę utworzyć konfigurację z wielu kluczy i etykiet?

Czasami może być konieczne tworzenie konfiguracji z wielu etykiet, na przykład domyślnych i deweloperskich. Do zaimplementowania tego scenariusza może być używanych wiele zadań konfiguracji aplikacji w jednym potoku. Wartości klucz-pobrane przez zadanie w późniejszym kroku zastąpią wszystkie wartości z poprzednich kroków. W wyżej wymienionym przykładzie zadanie może służyć do wybierania wartości klucz-wartości z etykietą domyślną, podczas gdy drugie zadanie może wybrać klucz-wartości z etykietą dewelopera. Klucze z etykietą dewelopera zastąpią te same klucze etykietą domyślną.