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. Jeśli 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 przepływów pracy aplikacji logiki z wieloma dzierżawami oraz przepływów pracy aplikacji logiki w warstwie Standardowa dla jednej dzierżawy. 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 multi-tenant and integration service environment for Azure Logic Apps (Jednodostępne i wielodostępne środowisko usług integracji dla usługi 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 aplikacji logiki Zużycie lub Standardowa

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

  Uwaga

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

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

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 przepływach pracy aplikacji logiki z wieloma dzierżawami po utworzeniu i użyciu parametrów w projektancie należy zdefiniować i ustawić zmienne środowiskowe w szablonie usługi Azure Resource Manager (szablon usługi ARM) i plikach parametrów szablonu. W tym scenariuszu musisz zdefiniować i ustawić parametry we wdrożeniu, co oznacza, że nawet jeśli trzeba zmienić tylko jedną zmienną, musisz ponownie wdrożyć szablon usługi 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.

Uwaga

W przepływach pracy aplikacji logiki w warstwie Standardowa bezpieczne typy danych, takie jak securestring i secureobject, nie są obsługiwane. Alternatywną opcją jest jednak użycie ustawień aplikacji w usłudze Azure Key Vault. Następnie można bezpośrednio odwoływać się do bezpiecznych parametrów, takich jak parametry połączenia i klucze. Podobnie jak w przypadku szablonów usługi ARM, w których 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 nie tylko.

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 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:

• Plik parametrów testu, który zawiera 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.

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

• Sparametryzuj złożone obiekty, takie 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 zaleca się 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 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ść	Wymagane	Opis
   Nazwa	Tak	Nazwa parametru do utworzenia.
   Typ	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 mieć możliwość rozpoznania 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. W właściwości, w której chcesz użyć parametru, kliknij wewnątrz pola edycji tej właściwości.

   3. Na liście 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 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ść	Wymagane	Opis
   Nazwa	Tak	Nazwa parametru do utworzenia.
   Typ	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 mieć możliwość rozpoznania 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, która znajduje 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. W właściwości, w której chcesz użyć parametru, kliknij wewnątrz pola edycji tej właściwości.

   3. Na liście 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ć zbiorczy kod JSON, w menu głównym aplikacji logiki wybierz pozycję Parametry.

     Zostanie otwarty widok Parametry JSON i wyświetli wszystkie parametry zdefiniowane z 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, podczas gdy 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 w projekcie, na przykład w definicjach przepływu pracy lub połączeniach.

   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 @appsettingparameters.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>').

Parametryzacja pliku połączeń

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

Ważne

Jeśli sparametryzujesz plik connections.json podczas programowania, środowisko projektanta stanie się ograniczone zarówno lokalnie, jak i w Azure Portal. Jeśli musisz 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 plikiem sparametryzowanym. Ś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 należy użyć ustawień aplikacji za pośrednictwem parametrów, ponieważ ustawienia aplikacji są generowane podczas wdrażania i są łatwiejsze do dynamicznego wypełniania 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ływać 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>"usługę , użyj następującej wersji: "<text>/@{<function-name>('<parameter-name>')}/<text>".

Aby uzyskać więcej informacji, zobacz Zagadnienia dotyczące używania funkcji.

Zarządzanie plikami parametrów

Zazwyczaj należy zarządzać wieloma wersjami plików parametrów. Być może masz 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 podwyższasz poziom odpowiedniego pliku parametrów, zazwyczaj za pośrednictwem potoku metodyki DevOps.

Aby dynamicznie zastąpić 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 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 Visual Studio Code można 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 Visual Studio Code, Azure Portal, interfejsu wiersza polecenia platformy Azure lub usługi ARM (Bicep).

Azure Portal

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

1. W 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. 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 o wartości 12345:

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

szablon 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"
    },
    <...>
], 

Następne kroki

• Jednodostępne i wielodostępne oraz środowisko usługi integracji dla usługi Azure Logic Apps