Tworzenie parametrów między środowiskami dla danych wejściowych przepływu pracy w usłudze Azure Logic Apps

Dotyczy: Azure Logic Apps (Zużycie + Standardowa)

W usłudze Azure Logic Apps możesz abstrakcyjne wartości, które mogą ulec zmianie w przepływach pracy w środowiskach deweloperskich, testowych i produkcyjnych, definiując parametry. Gdy używasz parametrów, a nie zmiennych specyficznych dla środowiska, możesz początkowo skupić się bardziej na projektowaniu przepływów pracy i wstawić zmienne specyficzne dla środowiska później.

W tym artykule przedstawiono sposób tworzenia, używania i edytowania parametrów dla wielodostępnych przepływów pracy aplikacji logiki zużycie oraz przepływów pracy aplikacji logiki w warstwie Standardowa z jedną dzierżawą. Dowiesz się również, jak zarządzać zmiennymi środowiskowymi.

Aby uzyskać więcej informacji na temat wielodostępnych i jednodostępnych usługi Azure Logic Apps, zapoznaj się z tematem Single-tenant versus multitenant in Azure Logic Apps (Pojedyncze dzierżawy i wielodostępne w usłudze Azure Logic Apps).

Wymagania wstępne

• Konto i subskrypcja platformy Azure. Jeśli nie masz subskrypcji, zarejestruj się w celu założenia bezpłatnego konta platformy Azure.

• Przepływ pracy użycia lub standardowej aplikacji logiki

  Jeśli nie masz jeszcze przepływu pracy aplikacji logiki, zobacz Tworzenie przykładowego przepływu pracy aplikacji logiki zużycie przy użyciu witryny Azure Portal lub Tworzenie przykładowego przepływu pracy aplikacji logiki w warstwie Standardowa przy użyciu witryny Azure Portal.

  Uwaga

  Obecnie można tworzyć parametry dla przepływów pracy aplikacji logiki Zużycie tylko przy użyciu witryny Azure Portal. Parametry dla przepływów pracy aplikacji logiki w warstwie Standardowa można tworzyć tylko przy użyciu witryny Azure Portal lub programu Visual Studio Code.

Parametry dla przepływów pracy aplikacji logiki w warstwie Zużycie i Standardowa

W przypadku przepływów pracy aplikacji logiki Zużycie i Standardowa można zdefiniować parametry przy użyciu projektanta. Po zdefiniowaniu parametru można odwoływać się do tego parametru z dowolnego przepływu pracy lub połączenia, które znajduje się w tym samym zasobie aplikacji logiki.

W wielodostępnych przepływach pracy aplikacji logiki Zużycie po utworzeniu i użyciu parametrów w projektancie zdefiniujesz i ustawisz zmienne środowiskowe w szablonie usługi Azure Resource Manager (szablon ARM) i plikach parametrów szablonu. W tym scenariuszu należy zdefiniować i ustawić parametry podczas wdrażania, co oznacza, że nawet jeśli trzeba zmienić tylko jedną zmienną, musisz ponownie wdrożyć szablon arm aplikacji logiki.

W przepływach pracy aplikacji logiki w warstwie Standardowa z jedną dzierżawą można pracować ze zmiennymi środowiskowymi zarówno w czasie wykonywania, jak i we wdrożeniu przy użyciu parametrów i ustawień aplikacji. Ustawienia aplikacji zawierają globalne opcje konfiguracji dla wszystkich przepływów pracy w tym samym zasobie aplikacji logiki. Aby uzyskać więcej informacji, zobacz Edytowanie ustawień hosta i aplikacji dla aplikacji logiki opartych na jednej dzierżawie.

Ważne

Jeśli masz poufne informacje, takie jak parametry połączenia zawierające nazwy użytkowników i hasła, upewnij się, że jest dostępny najbezpieczniejszy przepływ uwierzytelniania. Na przykład w standardowych przepływach pracy aplikacji logiki bezpieczne typy danych, takie jak securestring i secureobject, nie są obsługiwane. Firma Microsoft zaleca uwierzytelnianie dostępu do zasobów platformy Azure przy użyciu tożsamości zarządzanej, jeśli to możliwe, i przypisanie roli, która ma najmniejsze uprawnienia niezbędne.

Jeśli ta funkcja jest niedostępna, upewnij się, że zabezpieczasz parametry połączenia za pomocą innych miar, takich jak usługa Azure Key Vault, której można używać z ustawieniami aplikacji. Następnie można bezpośrednio odwoływać się do bezpiecznych ciągów, takich jak parametry połączenia i klucze. Podobnie jak w przypadku szablonów usługi ARM, gdzie można zdefiniować zmienne środowiskowe w czasie wdrażania, można zdefiniować ustawienia aplikacji w definicji przepływu pracy aplikacji logiki. Następnie można przechwytywać dynamicznie generowane wartości infrastruktury, takie jak punkty końcowe połączenia, parametry magazynu i inne. Aby uzyskać więcej informacji, zobacz Typy aplikacji dla Platforma tożsamości Microsoft.

Jednak ustawienia aplikacji mają limity rozmiaru i nie można odwoływać się do niektórych obszarów w usłudze Azure Logic Apps. Parametry oferują szerszy zakres przypadków użycia niż ustawienia aplikacji, takie jak obsługa dużych rozmiarów wartości i złożonych obiektów.

Jeśli na przykład używasz programu Visual Studio Code jako lokalnego narzędzia programistycznego do lokalnego uruchamiania przepływów pracy, w projekcie aplikacji logiki możesz zdefiniować parametry przy użyciu pliku parameters.json . Następnie możesz odwołać się do dowolnego parametru w tym pliku parametrów z dowolnego przepływu pracy w pliku workflow.json projektu lub z dowolnego obiektu połączenia w pliku connections.json projektu. Na poniższej liście opisano kilka typowych przypadków użycia:

• Utwórz plik parametrów testu zawierający wszystkie wartości, które są używane podczas testowania. Podczas wdrażania możesz zastąpić plik parametrów testu plikiem parametrów produkcyjnych.

• Parametryzowanie różnych części pliku connections.json . Następnie możesz sprawdzić plik connections.json w kontroli źródła, a następnie zarządzać wszystkimi połączeniami za pośrednictwem pliku parameters.json.

• Parametryzowanie obiektów złożonych, takich jak authentication obiekt JSON. Można na przykład zastąpić authentication wartość obiektu ciągiem zawierającym jedno wyrażenie parametrów, takie jak @parameters('api-auth').

• Przejrzyj i edytuj ustawienia aplikacji w pliku local.settings.json projektu. Następnie możesz odwołać się do tych ustawień aplikacji w parametrach.

Uwaga

Ogólnie rzecz biorąc, rozważ użycie parametrów jako domyślnego sposobu sparametryzowania wartości, a nie ustawień aplikacji. W ten sposób, gdy musisz przechowywać bezpieczne klucze lub ciągi, możesz postępować zgodnie z zaleceniem, aby odwołać się do ustawień aplikacji z parametrów. Jeśli chcesz, możesz użyć obu opcji w rozwiązaniu, używając parametrów do odwołowania się do ustawień aplikacji.

Definiowanie, używanie i edytowanie parametrów

Zużycie

Azure Portal

1. W witrynie Azure Portal otwórz przepływ pracy aplikacji logiki. W obszarze Przepływy pracy wybierz i otwórz przepływ pracy w projektancie.

2. Na pasku narzędzi projektanta wybierz pozycję Parametry.

   

3. W okienku Parametry wybierz pozycję Dodaj parametr.

4. Podaj następujące informacje o parametrze do utworzenia:

   Właściwości	Wymagania	opis
   Nazwa	Tak	Nazwa parametru do utworzenia.
   Type	Tak	Typ danych parametru, taki jak Array, Bool, Float, Int, Object, Secure Object, Secure Object, Secure String i String.
   Wartość domyślna	Tak	Wartość domyślna parametru. Należy określić domyślną wartość parametru, ponieważ logika przepływu pracy, informacje o połączeniu i wartości parametrów nie istnieją w jednej lokalizacji. Projektant musi być w stanie rozpoznać wartości parametrów przed załadowaniem. Ważne: w przypadku typów danych Secure Object i Secure String unikaj ustawiania wartości domyślnej, ponieważ wartość jest przechowywana jako zwykły tekst.
   Wartość rzeczywista	Nie.	Rzeczywista wartość parametru.

   W poniższym przykładzie przedstawiono definicję parametru ciągu:

   

5. Jeśli masz więcej parametrów do dodania, wybierz pozycję Dodaj parametr. W przeciwnym razie zamknij okienko parametrów, ale pamiętaj, aby zapisać przepływ pracy, aby zapisać nową definicję parametrów.

6. Aby odwołać się do parametru z wyzwalacza lub akcji, która znajduje się w tym samym przepływie pracy, wykonaj następujące kroki:

   1. W projektancie otwórz żądany przepływ pracy i rozwiń wyzwalacz lub akcję.

   2. We właściwości, w której chcesz użyć parametru, kliknij wewnątrz pola edycji tej właściwości.

   3. Z listy zawartości dynamicznej, która zostanie otwarta w obszarze Parametry, wybierz wcześniej utworzony parametr, na przykład:

      

7. Aby wyświetlić lub edytować parametry w przepływie pracy aplikacji logiki, wykonaj następujące kroki:

   1. Otwórz przepływ pracy aplikacji logiki w projektancie. Na pasku narzędzi projektanta wybierz pozycję Parametry.

      Zostanie otwarte okienko Parametry i wyświetli wszystkie parametry zdefiniowane dla tego przepływu pracy.

   2. Wprowadź zmiany, zamknij okienko parametrów i zapisz przepływ pracy aplikacji logiki.

Standardowa

Azure Portal

1. W witrynie Azure Portal otwórz zasób aplikacji logiki. W obszarze Przepływy pracy otwórz przepływ pracy w projektancie.

2. Na pasku narzędzi projektanta wybierz pozycję Parametry.

   

3. W okienku Parametry wybierz pozycję Utwórz parametr.

4. Podaj następujące informacje o parametrze do utworzenia:

   Właściwości	Wymagania	opis
   Nazwa	Tak	Nazwa parametru do utworzenia.
   Type	Tak	Typ danych parametru, taki jak Array, Bool, Float, Int, Object i String. Uwaga: w standardowych przepływach pracy aplikacji logiki bezpieczne typy danych, takie jak securestring i secureobject, nie są obsługiwane.
   Wartość	Tak	Wartość parametru. W przepływach pracy aplikacji logiki w warstwie Standardowa należy określić wartość parametru, ponieważ logika przepływu pracy, informacje o połączeniu i wartości parametrów nie istnieją w jednej lokalizacji. Projektant musi być w stanie rozpoznać wartości parametrów przed załadowaniem.

   W poniższym przykładzie przedstawiono definicję parametru ciągu:

   

5. Po zakończeniu zamknij okienko Parametry , ale pamiętaj, aby zapisać przepływ pracy, aby zapisać nową definicję parametrów.

6. Aby odwołać się do parametru z wyzwalacza lub akcji znajdującej się w dowolnym przepływie pracy w tej samej aplikacji logiki, wykonaj następujące kroki:

   1. W projektancie otwórz żądany przepływ pracy i rozwiń wyzwalacz lub akcję.

   2. We właściwości, w której chcesz użyć parametru, kliknij wewnątrz pola edycji tej właściwości.

   3. Z listy zawartości dynamicznej, która zostanie otwarta w obszarze Parametry, wybierz wcześniej utworzony parametr, na przykład:

      

7. Aby wyświetlić lub edytować parametry w tej samej aplikacji logiki, wykonaj dowolny krok:

   • Otwórz dowolny przepływ pracy w tej aplikacji logiki. W menu przepływu pracy wybierz pozycję Projektant. Na pasku narzędzi projektanta wybierz pozycję Parametry.

     Zostanie otwarte okienko Parametry i wyświetli wszystkie parametry zdefiniowane z przepływów pracy w tej aplikacji logiki.

   • Aby wyświetlić lub edytować zbiorczo kod JSON, w menu głównym aplikacji logiki wybierz pozycję Parametry.

     Zostanie otwarty widok Parametry JSON zawierający wszystkie parametry zdefiniowane na podstawie przepływów pracy w tej aplikacji logiki.

Visual Studio Code

1. W pliku JSON na poziomie głównym projektu o nazwie parameters.json zdefiniuj wszystkie parametry i ich wartości. Ten plik zawiera obiekt zawierający pary klucz-wartość . Każdy klucz jest nazwą każdego parametru, a każda wartość jest strukturą dla każdego parametru. Każda struktura musi zawierać zarówno deklarację, jak type i value .

   Ważne

   Plik parameters.json musi definiować i uwzględniać wszystkie parametry oraz ich wartości, do których odwołujesz się lub używasz w innym miejscu projektu, na przykład w definicjach lub połączeniach przepływu pracy.

   W poniższym przykładzie przedstawiono podstawowy plik parametrów:

   {
       "responseString": { 
           "type": "string", 
           "value": "hello" 
       },
       "functionAuth": { 
           "type": "object", 
           "value": { 
               "type": "QueryString", 
               "name": "Code", 
               "value": "@appsetting('<AzureFunctionsOperation-FunctionAppKey>')" 
           }
       }
    }
   

   Uwaga

   W pliku @appsetting parameters.json jest jedynym prawidłowym typem wyrażenia.

2. Aby odwołać się do parametrów w danych wejściowych wyzwalacza lub akcji, użyj wyrażenia @parameters('<parameter-name>').

Sparametryzowanie pliku połączeń

Aby sparametryzować plik connections.json , zastąp wartości literałów, takich jak ConnectionRuntimeUrl, pojedynczym parameters() wyrażeniem, na przykład @parameters('api-runtimeUrl'). W pliku connections.json jedynymi prawidłowymi typami wyrażeń są @parameters i @appsetting.

Ważne

Jeśli podczas programowania sparametryzujesz plik connections.json , środowisko projektanta stanie się ograniczone zarówno lokalnie, jak i w witrynie Azure Portal. Jeśli chcesz użyć projektanta do programowania, zamiast tego użyj pliku connections.json bez parametrów. Następnie w potokach wdrażania zastąp ciąg sparametryzowanym plikiem. Środowisko uruchomieniowe nadal działa z parametryzacji. Ulepszenia projektanta są opracowywane.

W poniższym przykładzie przedstawiono sparametryzowany plik connections.json , który używa zarówno ustawień aplikacji, jak i parametrów. Mimo że chcesz używać parametrów tam, gdzie to możliwe, ten scenariusz jest wyjątkiem lub przypadkiem krawędzi, w którym można użyć ustawień aplikacji za pośrednictwem parametrów, ponieważ ustawienia aplikacji są generowane podczas wdrażania i są łatwiejsze do dynamicznego wypełniania w potoku programowania. Ten przykładowy plik używa parametru dla złożonego blob_auth obiektu uwierzytelniania i ustawień aplikacji dla innych wartości. W takim przypadku można użyć parametru dla obiektu uwierzytelniania, ponieważ jest mało prawdopodobne, aby odwołać się do parametru w przepływie pracy:

{
   "serviceProviderConnections": {
      "serviceBus": {
         "parameterValues": {
            "connectionString": "@appsetting('serviceBus_connectionString')"
        },
        "serviceProvider": {
           "id": "/serviceProviders/serviceBus"
        },
        "displayName": "servicebus"
     }
   },
   "managedApiConnections": {
      "azureblob": {
         "api": {
            "id": "/subscriptions/@{appsetting('WORKFLOWS_SUBSCRIPTION_ID')}/providers/Microsoft.Web/locations/@{appsetting('WORKFLOWS_LOCATION_NAME')}/managedApis/azureblob"
         },
         "connection": {
            "id": "/subscriptions/@{appsetting('WORKFLOWS_SUBSCRIPTION_ID')}/resourceGroups/@{appsetting('WORKFLOWS_RESOURCE_GROUP_NAME')}/providers/Microsoft.Web/connections/azureblob"
         },
         "connectionRuntimeUrl": "@appsetting('BLOB_CONNECTION_RUNTIMEURL')",
         "authentication": "@parameters('blob_auth')"
      }
   }
}

Uwaga

Jeśli masz wyrażenie wbudowane w zwykły tekst, upewnij się, że używasz formatu interpolowanego dla tego wyrażenia, otaczając to wyrażenie nawiasami klamrowymi ({}). Ten format pomaga uniknąć problemów z analizowaniem.

Jeśli na przykład masz "<text>/@<function-name>('<parameter-name>')/<text>"wersję , użyj następującej wersji: "<text>/@{<function-name>('<parameter-name>')}/<text>".

Aby uzyskać więcej informacji, zapoznaj się z tematem Zagadnienia dotyczące używania funkcji.

Zarządzanie plikami parametrów

Zazwyczaj należy zarządzać wieloma wersjami plików parametrów. Mogą istnieć docelowe wartości dla różnych środowisk wdrażania, takich jak programowanie, testowanie i produkcja. Zarządzanie tymi plikami parametrów często działa jak zarządzanie plikami parametrów szablonu usługi ARM. Podczas wdrażania w określonym środowisku należy podwyższyć poziom odpowiedniego pliku parametrów, zazwyczaj za pośrednictwem potoku dla metodyki DevOps.

Aby dynamicznie zastępować pliki parametrów przy użyciu interfejsu wiersza polecenia platformy Azure, uruchom następujące polecenie:

az functionapp deploy --resource-group MyResourceGroup --name MyLogicApp --src-path C:\parameters.json --type static --target-path parameters.json

Jeśli masz projekt aplikacji logiki opartej na nuGet, musisz zaktualizować plik projektu (<logic-app-name.csproj>), aby uwzględnić plik parametrów w danych wyjściowych kompilacji, na przykład:

<ItemGroup>
  <None Update="parameters.json">
    <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
  </None>
</ItemGroup>

Uwaga

Obecnie możliwość dynamicznego zastępowania plików parametrów nie jest jeszcze dostępna w witrynie Azure Portal ani w projektancie przepływu pracy.

Aby uzyskać więcej informacji na temat konfigurowania aplikacji logiki dla wdrożeń metodyki DevOps, zapoznaj się z następującą dokumentacją:

• Omówienie wdrażania metodyki DevOps dla aplikacji logiki opartych na jednej dzierżawie
• Konfigurowanie wdrożenia metodyki DevOps dla aplikacji logiki opartych na jednej dzierżawie

Zarządzanie ustawieniami aplikacji

W usłudze Azure Logic Apps z jedną dzierżawą ustawienia aplikacji zawierają globalne opcje konfiguracji dla wszystkich przepływów pracy w tej samej aplikacji logiki. Po uruchomieniu przepływów pracy lokalnie w programie Visual Studio Code możesz uzyskać dostęp do tych ustawień aplikacji jako zmiennych środowiskowych lokalnych w pliku local.settings.json . Następnie możesz odwołać się do tych ustawień aplikacji w parametrach.

Aby dodać, zaktualizować lub usunąć ustawienia aplikacji, wybierz i przejrzyj następujące sekcje dotyczące szablonu Programu Visual Studio Code, witryny Azure Portal, interfejsu wiersza polecenia platformy Azure lub usługi ARM (Bicep).

Azure Portal

Aby przejrzeć ustawienia aplikacji dla zasobu aplikacji logiki w witrynie Azure Portal, wykonaj następujące kroki:

1. W witrynie Azure Portal otwórz zasób aplikacji logiki.

2. W menu aplikacji logiki w obszarze Ustawienia wybierz pozycję Konfiguracja.

3. Na stronie Konfiguracja na karcie Ustawienia aplikacji przejrzyj ustawienia aplikacji dla aplikacji logiki.

4. Aby wyświetlić wszystkie wartości, wybierz pozycję Pokaż wartości. Lub, aby wyświetlić pojedynczą wartość, wybierz tę wartość.

Aby dodać nowe ustawienie, wykonaj następujące kroki:

1. Na karcie Ustawienia aplikacji w obszarze Ustawienia aplikacji wybierz pozycję Nowe ustawienie aplikacji.

2. W polu Nazwa wprowadź klucz lub nazwę nowego ustawienia.

3. W polu Wartość wprowadź wartość nowego ustawienia.

4. Gdy wszystko będzie gotowe do utworzenia nowej pary klucz-wartość , wybierz przycisk OK.

   

5. Gdy wszystko będzie gotowe, na pasku narzędzi Konfiguracja wybierz pozycję Zapisz.

Interfejs wiersza polecenia platformy Azure

Aby przejrzeć bieżące ustawienia aplikacji przy użyciu interfejsu wiersza polecenia platformy Azure, uruchom polecenie az logicapp config appsettings list. Upewnij się, że polecenie zawiera --name -n parametry i --resource-group -g , na przykład:

az logicapp config appsettings list --name MyLogicApp --resource-group MyResourceGroup

Aby dodać lub zaktualizować ustawienie aplikacji przy użyciu interfejsu wiersza polecenia platformy Azure, uruchom polecenie az logicapp config appsettings set. Upewnij się, że polecenie zawiera --name n parametry i --resource-group -g . Na przykład następujące polecenie tworzy ustawienie z kluczem o nazwie CUSTOM_LOGIC_APP_SETTING z wartością 12345:

az logicapp config appsettings set --name MyLogicApp --resource-group MyResourceGroup --settings CUSTOM_LOGIC_APP_SETTING=12345 

Szablon usługi Resource Manager lub Bicep

Aby przejrzeć i zdefiniować ustawienia aplikacji w szablonie usługi ARM lub szablonie Bicep, znajdź definicję zasobu aplikacji logiki i zaktualizuj appSettings obiekt JSON. Aby uzyskać pełną definicję zasobu, zobacz dokumentację szablonu usługi ARM.

W tym przykładzie przedstawiono ustawienia plików dla szablonów usługi ARM lub szablonów Bicep:

"appSettings": [
    {
        "name": "string",
        "value": "string"
    },
    {
        "name": "string",
        "value": "string"
    },
    <...>
], 

Powiązana zawartość

• Pojedyncza dzierżawa a wielodostępna w usłudze Azure Logic Apps