Eksportowanie ustawień z usługi App Configuration za pomocą usługi Azure Pipelines

Zadanie Azure App Configuration Export eksportuje pary klucz-wartość z magazynu App Configuration i ustawia je jako zmienne potoku Azure, z których mogą korzystać kolejne zadania. To zadanie stanowi uzupełnienie zadania Import usługi Azure App Configuration, które importuje pary klucz-wartość z pliku konfiguracji do magazynu usługi App Configuration. Aby uzyskać więcej informacji, zobacz Importowanie ustawień 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
• Agent Azure Pipelines w wersji 2.144.0 lub nowszej oraz Node w wersji 16 lub nowszej do uruchamiania zadania na własnych agentach.

Tworzenie połączenia z usługą

Połączenie usługi zapewnia dostęp do zasobów w ramach subskrypcji Azure z poziomu projektu 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ę Federacja tożsamości obciążenia (automatyczna), aby utworzyć nową federację tożsamości obciążenia lub wybrać federację tożsamości obciążenia (ręcznie), aby użyć istniejącej federacji tożsamości obciążenia.

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 tej jednostce usługi.

1. Przejdź do Ustawienia projektu>Połączenia usług.

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

3. Wybierz pozycję Zarządzaj nazwą główną usługi.

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

   

Dodawanie przypisania roli

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

1. Przejdź do docelowego zasobu App Configuration.

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

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

   

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

5. Wybierz nazwę główną usługi skojarzoną z połączeniem z usługą utworzonym w poprzedniej sekcji.

   

6. Wybierz Przejrzyj + przypisz.

7. Jeśli sklep zawiera odwołania do usługi Key Vault, przejdź do odpowiedniego magazynu Key Vault i przypisz rolę Key Vault Secret User nazwie głównej 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, jak używać zadania eksportu usługi Azure App Configuration w potoku kompilacji Azure DevOps.

1. Przejdź do strony potoku kompilacji, klikając pozycję Potoki>. Informacje na temat dokumentacji potoku kompilacji można znaleźć tutaj: Utwórz swój pierwszy potok.
   • Jeśli tworzysz nowy potok kompilacji, w ostatnim kroku procesu, na karcie Przegląd, wybierz po prawej stronie potoku opcję Pokaż asystenta.

   

   • Jeśli używasz istniejącego potoku kompilacji, kliknij przycisk Edytuj w prawym górnym rogu.

   

2. Wyszukaj zadanie Eksport konfiguracji aplikacji Azure.

   

3. Aby wyeksportować wartości klucza z magazynu App Configuration, skonfiguruj niezbędne parametry zadania. Opisy parametrów są dostępne w sekcji Parametry i 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 usługi App Configuration na punkt końcowy magazynu App Configuration.
   • Pozostaw wartości domyślne pozostałych parametrów.

     

4. Zapisywanie i kolejkowanie kompilacji. W dzienniku kompilacji są wyświetlane wszelkie błędy, które wystąpiły podczas wykonywania zadania.

Używanie w wydaniach

W tej sekcji opisano, jak używać zadania eksportu Azure App Configuration w potoku wydań Azure DevOps.

1. Przejdź do strony potoku wydań, wybierając Pipelines>Releases. Informacje na temat dokumentacji potoków wydania można znaleźć w artykule Potoki wydania.
2. Wybierz istniejący potok wdrażania. Jeśli nie masz jeszcze potoku, kliknij Nowy potok, aby utworzyć nowy potok.
3. Wybierz przycisk Edytuj w prawym górnym rogu, aby edytować potok wdrożenia.
4. Z listy rozwijanej Zadania wybierz etap , do którego chcesz dodać zadanie. Więcej informacji na temat etapów można znaleźć w artykule Dodawanie etapów, zależności i warunków.

   

5. Kliknij + obok zadania, do którego chcesz dodać nowe zadanie.

   

6. Wyszukaj zadanie Azure App Configuration Export.

   

7. Aby wyeksportować wartości kluczy z magazynu usługi App Configuration, skonfiguruj wymagane parametry w zadaniu. Opisy parametrów są dostępne w sekcji Parametry i 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. Zapisz i dodaj wydanie do kolejki. W dzienniku wydania są wyświetlane wszelkie błędy napotkane podczas wykonywania zadania.

Parametry

Następujące parametry są używane przez zadanie eksportu Azure App 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 magazynów konfiguracji, naciśnij przycisk Odśwież punkt końcowy konfiguracji aplikacji po prawej stronie pola tekstowego.
• Tryb wyboru: Określa, w jaki sposób pary klucz-wartość odczytane z magazynu konfiguracji są wybierane. Tryb wyboru „Domyślny” umożliwia używanie filtrów kluczy i etykiet. Tryb wyboru "Migawka" umożliwia wybranie wartości kluczy z migawki. Wartość domyślna to Wartość domyślna.
• Filtr kluczy: filtr może być używany do wybierania par klucz-wartość żądanych z usługi Azure App Configuration. Wartość * wybiera wszystkie pary klucz-wartość. Aby uzyskać więcej informacji, zobacz Wykonywanie zapytań o pary 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, zostaną pobrane wartości klucza bez etykiety. Następujące znaki nie są dozwolone: , *.
• Nazwa migawki: określa migawkę, z której należy pobrać pary klucz-wartość z usługi Azure App 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. Znak nowej linii może służyć do oddzielania wielu prefiksów.
• Ukryj ostrzeżenie dla nadpisanych kluczy: Domyślnie opcja jest odznaczona. Określa, czy mają być wyświetlane ostrzeżenia, gdy istniejące klucze są zastępowane. Włącz tę opcję, jeśli przewiduje się, że pary klucz-wartość pobrane z usługi App Configuration zawierają klucze pokrywające się z kluczami już istniejącymi 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 pary klucz-wartość pobieranej z usługi App Configuration po usunięciu prefiksu, jeśli został określony.

Jeśli na przykład następne zadanie uruchamia skrypt programu PowerShell, może używać pary klucz-wartość o kluczu „myBuildSetting” w następujący sposób:

echo "$env:myBuildSetting"

A wartość jest wypisywana do konsoli.

Rozwiązywanie problemów

Jeśli wystąpi nieoczekiwany błąd, logi debugowania można włączyć, ustawiając zmienną potoku system.debug 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 klucza pobierane przez zadanie w późniejszym kroku zastępują wszystkie wartości z poprzednich kroków. W powyższym przykładzie zadanie może służyć do wybierania par klucz-wartość z etykietą domyślną, podczas gdy drugie zadanie może wybierać pary klucz-wartość z etykietą dev. Klucze z etykietą dev nadpisują odpowiadające im klucze z etykietą default.

Następny krok

Aby uzyskać pełny opis parametrów lub użyć tego zadania w potokach YAML, zobacz poniższy dokument.

Aby dowiedzieć się, jak zaimportować klucz-wartości z pliku konfiguracji do magazynu usługi App Configuration, przejdź do następującego dokumentu.

Aby dowiedzieć się, jak utworzyć migawkę w magazynie App Configuration, przejdź do poniższego dokumentu.