Erstellen Sie umgebungsübergreifende Parameter für Workfloweingaben in Azure Logic Apps

Gilt für: Azure Logic Apps (Verbrauch + Standard)

In Azure Logic Apps können Sie Werte abstrahieren, die sich in Workflows in Entwicklungs-, Test- und Produktionsumgebungen ändern können, indem Sie Parameter definieren. Wenn Sie Parameter anstelle von umgebungsspezifischen Variablen verwenden, können Sie sich zunächst mehr auf das Entwerfen Ihrer Workflows konzentrieren und Ihre umgebungsspezifischen Variablen später einfügen.

In diesem Artikel erfahren Sie, wie Sie Parameter für Workflows für mehrinstanzenfähige Logik-Apps für den Verbrauch und für Workflows mit einer Standard-Logik-App mit nur einem Mandanten erstellen, verwenden und bearbeiten. Außerdem erfahren Sie, wie Sie Umgebungsvariablen verwalten.

Weitere Informationen zu Azure Logic Apps-Modellen mit einem und mehreren Mandanten finden Sie unter Vergleich zwischen Umgebungen mit einem Mandanten und mehreren Mandanten bzw. Integrationsdienstumgebung für Azure Logic Apps.

Voraussetzungen

• Ein Azure-Konto und ein Azure-Abonnement. Falls Sie kein Abonnement besitzen, können Sie sich für ein kostenloses Azure-Konto registrieren.

• Ein Workflow für eine Verbrauchs- oder Standard-Logik-App

  Wenn Sie noch keinen Logik-App-Workflow haben, lesen Sie Erstellen eines verbrauchsbasierten Logik-App-Beispielworkflows mit dem Azure-Portal oder Erstellen eines Standard-Logik-App-Beispielworkflows mit dem Azure-Portal.

  Hinweis

  Derzeit können Sie Parameter für Logik-App-Workflows (Typ „Verbrauch“) nur über das Azure-Portal erstellen. Sie können Parameter für Logik-App-Workflows (Typ „Standard“) nur über das Azure-Portal oder in Visual Studio Code erstellen.

Parameter für Logik-Apps-Workflows vom Typ Verbrauch im Vergleich zu Standard

Sowohl für Logik-App-Workflows des Typs „Verbrauch“ als auch „Standard“ können Sie Parameter mithilfe des Designers definieren. Nachdem Sie den Parameter definiert haben, können Sie aus jedem Workflow oder jeder Verbindung, der/die sich in derselben Logik-App-Ressource befindet, auf diesen Parameter verweisen.

In mehrinstanzenfähigen Logik-App-Workflows vom Typ „Verbrauch“ definieren Sie jedoch nach dem Erstellen und Verwenden von Parametern im Designer die Umgebungsvariablen in Ihrer Azure Resource Manager-Vorlage (ARM-Vorlage) und in den Vorlagenparameterdateien und legen sie dort fest. In diesem Szenario müssen Sie die Parameter bei der Bereitstellung definieren und festlegen, was bedeutet, dass Sie die ARM-Vorlage Ihrer Logik-App erneut bereitstellen müssen, auch wenn Sie nur eine Variable ändern müssen.

In Logik-Apps-Workflows vom Typ „Standard“ mit nur einem Mandanten können Sie mit Parametern und App-Einstellungen sowohl zur Runtime als auch bei der Bereitstellung mit Umgebungsvariablen arbeiten. App-Einstellungen enthalten globale Konfigurationsoptionen für alle Workflows in derselben Logik-App-Ressource. Weitere Informationen finden Sie unter Bearbeiten von Host- und App-Einstellungen für Logik-Apps, die auf einem einzelnen Mandanten basieren.

Hinweis

In Standard-Logik-App-Workflows werden sichere Datentypen wie securestring und secureobject nicht unterstützt. Alternativ können Sie jedoch App-Einstellungen mit Azure Key Vault verwenden. Sie können dann direkt auf sichere Zeichenfolgen verweisen (z. B. Verbindungszeichenfolgen und Schlüssel). Ähnlich wie bei ARM-Vorlagen, bei denen Sie Umgebungsvariablen zum Bereitstellungszeitpunkt definieren können, können Sie App-Einstellungen in der Workflowdefinition für Ihre Logik-App definieren. Anschließend können Sie dynamisch generierte Infrastrukturwerte erfassen (z. B. Verbindungsendpunkte oder Speicherzeichenfolgen).

App-Einstellungen haben jedoch Größenlimits, und aus bestimmten Azure Logic Apps-Bereichen kann nicht auf sie verwiesen werden. Parameter bieten eine größere Bandbreite von Anwendungsfällen als App-Einstellungen, z. B. Unterstützung für große Werte und komplexe Objekte.

Wenn Sie beispielsweise Visual Studio Code als lokales Entwicklungstool zum lokalen Ausführen von Workflows verwenden, können Sie in Ihrem Logik-App-Projekt Parameter mithilfe der Datei parameters.json definieren. Sie können dann aus jedem Workflow in der Datei workflow.json Ihres Projekts oder aus jedem Verbindungsobjekt in der Datei connections.json Ihres Projekts auf einen beliebigen Parameter in dieser Parameterdatei verweisen. In der folgenden Liste werden einige häufige Anwendungsfälle beschrieben:

• Sie verfügen über eine Testparameterdatei, die alle Werte enthält, die Sie während Tests verwenden. Bei der Bereitstellung können Sie Ihre Testparameterdatei durch Ihre Produktionsparameterdatei ersetzen.

• Sie parametrisieren verschiedene Teile Ihrer connections.json-Datei. Anschließend können Sie Ihre connections.json-Datei in der Quellcodeverwaltung überprüfen und dann alle Verbindungen über Ihre parameters.json-Datei verwalten.

• Sie parametrisieren komplexe Objekte wie das authentication-JSON-Objekt. Sie können beispielsweise den authentication-Objektwert durch eine Zeichenfolge ersetzen, die einen einzelnen Parameterausdruck enthält, z. B. @parameters('api-auth').

• Sie überprüfen und bearbeiten die App-Einstellungen in der Datei local.settings.json Ihres Projekts. Anschließend können Sie in Ihren Parametern auf diese App-Einstellungen verweisen.

Hinweis

Als allgemeine Empfehlung sollten Sie die Verwendung von Parametern als Standardvorgehensweise zum Parametrisieren von Werten erwägen, nicht die Verwendung von App-Einstellungen. Wenn Sie sichere Schlüssel oder Zeichenfolgen speichern müssen, können Sie auf diese Weise die Empfehlung befolgen, von Ihren Parametern aus auf App-Einstellungen zu verweisen. Wenn Sie möchten, können Sie beide Optionen in Ihrer Lösung verwenden, indem Sie mithilfe von Parametern auf App-Einstellungen verweisen.

Definieren, Verwenden und Bearbeiten von Parametern

Verbrauch

Azure-Portal

1. Öffnen Sie Ihren Logik-App-Workflow im Azure-Portal. Wählen Sie unter Workflows Ihren Workflow aus, und öffnen Sie ihn im Designer.

2. Wählen Sie auf der Designer-Symbolleiste Parameter aus.

   

3. Wählen Sie im Bereich Parameter die Option Parameter hinzufügen aus.

4. Geben Sie die folgenden Informationen zum zu erstellenden Parameter an:

   Eigenschaft	Erforderlich	Beschreibung
   Name	Ja	Der Name des zu erstellenden Parameters.
   Typ	Ja	Der Datentyp für den Parameter wie Array, Bool, Float, Int, Object, Secure Object, Secure String und String.
   Standardwert	Ja	Der Standardwert für den Parameter. Sie müssen den Standardparameterwert angeben, da die Workflowlogik, die Verbindungsinformationen und die Parameterwerte nicht an einem einzigen Ort vorhanden sind. Der Designer muss in der Lage sein, die Parameterwerte vor dem Laden aufzulösen. Wichtig: Vermeiden Sie für die Datentypen Secure Object und Secure String das Festlegen eines Standardwerts, da der Wert als Nur-Text gespeichert wird.
   Ist-Wert	Nein	Dies ist der tatsächliche Wert für den Parameter.

   Das folgende Beispiel zeigt eine Definition für einen Zeichenfolgenparameter:

   

5. Wenn Sie weitere Parameter hinzufügen müssen, wählen Sie Parameter hinzufügen aus. Schließen Sie andernfalls den Bereich „Parameter“, aber stellen Sie sicher, dass Sie Ihren Workflow speichern, um Ihre neue Parameterdefinition zu speichern.

6. Um aus einem Trigger oder einer Aktion, der/die sich im selben Workflow befindet, auf den Parameter zu verweisen, führen Sie die folgenden Schritte aus:

   1. Öffnen Sie den gewünschten Workflow im Designer, und erweitern Sie den Trigger oder die Aktion.

   2. Klicken Sie in der Eigenschaft, in der Sie den Parameter verwenden möchten, in das Bearbeitungsfeld dieser Eigenschaft.

   3. Wählen Sie in der Liste mit den dynamischen Inhalten, die geöffnet wird, unter Parameter den von Ihnen zuvor erstellten Parameter aus, z. B.:

      

7. Führen Sie die folgenden Schritte aus, um die Parameter in einem Logik-App-Workflow anzuzeigen oder zu bearbeiten:

   1. Öffnen Sie den Logik-App-Workflow im Designer. Wählen Sie auf der Designersymbolleiste Parameter aus.

      Der Bereich Parameter wird geöffnet und zeigt alle Parameter an, die Sie für diesen Workflows definiert haben.

   2. Nehmen Sie Ihre Änderungen vor, schließen Sie den Parameterbereich, und speichern Sie Ihren Logik-App-Workflow.

Standard

Azure-Portal

1. Öffnen Sie Ihre Logik-App-Ressource im Azure-Portal. Öffnen Sie unter Workflows Ihren Workflow im Designer.

2. Wählen Sie auf der Designer-Symbolleiste Parameter aus.

   

3. Wählen Sie im Bereich Parameter die Option Parameter erstellen aus.

4. Geben Sie die folgenden Informationen zum zu erstellenden Parameter an:

   Eigenschaft	Erforderlich	Beschreibung
   Name	Ja	Der Name des zu erstellenden Parameters.
   Typ	Ja	Der Datentyp für den Parameter wie Array, Bool, Float, Int, Object und String. Hinweis: In Standard-Logik-App-Workflows werden sichere Datentypen wie securestring und secureobject nicht unterstützt.
   Wert	Ja	Der Wert für den Parameter. In Logik-Apps-Workflows vom Typ „Standard“ müssen Sie den Parameterwert angeben, da die Workflowlogik, die Verbindungsinformationen und die Parameterwerte nicht an einem einzigen Ort vorhanden sind. Der Designer muss in der Lage sein, die Parameterwerte vor dem Laden aufzulösen.

   Das folgende Beispiel zeigt eine Definition für einen Zeichenfolgenparameter:

   

5. Wenn Sie fertig sind, schließen Sie den Bereich Parameter, aber stellen Sie sicher, dass Sie Ihren Workflow speichern, um Ihre neue Parameterdefinition zu speichern.

6. Um aus einem Trigger oder einer Aktion, der/die sich in einem Workflow in derselben Logik-App befindet, auf den Parameter zu verweisen, führen Sie die folgenden Schritte aus:

   1. Öffnen Sie den gewünschten Workflow im Designer, und erweitern Sie den Trigger oder die Aktion.

   2. Klicken Sie in der Eigenschaft, in der Sie den Parameter verwenden möchten, in das Bearbeitungsfeld dieser Eigenschaft.

   3. Wählen Sie in der Liste mit den dynamischen Inhalten, die geöffnet wird, unter Parameter den von Ihnen zuvor erstellten Parameter aus, z. B.:

      

7. Um Parameter in derselben Logik-App anzuzeigen oder zu bearbeiten, führen Sie einen der beiden Schritte aus:

   • Öffnen Sie einen beliebigen Workflow in dieser Logik-App. Wählen Sie im Menü „Workflow“ den Designer aus. Wählen Sie auf der Designersymbolleiste Parameter aus.

     Der Bereich Parameter wird geöffnet und zeigt alle Parameter an, die Sie aus Workflows in dieser Logik-App definiert haben.

   • Um JSON massenhaft anzuzeigen oder zu bearbeiten, wählen Sie im Hauptmenü Ihrer Logik-App Parameter aus.

     Der JSON-Ansicht Parameter wird geöffnet und zeigt alle Parameter an, die Sie aus Workflows in dieser Logik-App definiert haben.

Visual Studio Code

1. Definieren Sie in einer JSON-Projektdatei namens parameters.json auf Stammebene alle Parameter mit ihren Werten. Diese Datei enthält ein Objekt, das Schlüssel-Wert-Paare enthält. Jeder Schlüssel ist der Name für jeden Parameter, während jeder Wert die Struktur für jeden Parameter ist. Jede Struktur muss sowohl eine type- als auch eine value-Deklaration enthalten.

   Wichtig

   Ihre Datei parameters.json muss alle Parameter und deren Werte definieren und enthalten, auf die Sie verweisen oder an anderer Stelle in Ihrem Projekt verwenden, z. B. in Workflowdefinitionen oder Verbindungen.

   Das folgende Beispiel zeigt eine Datei mit grundlegenden Parametern:

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

   Hinweis

   In der Datei parameters.json ist @appsetting der einzige gültige Ausdruckstyp.

2. Um auf Parameter in Ihren Trigger- oder Aktionseingaben zu verweisen, verwenden Sie den Ausdruck @parameters('<parameter-name>').

Parametrisieren der Verbindungsdatei

Ersetzen Sie zum Parametrisieren Ihrer connections.json-Datei die Werte für Literale wie ConnectionRuntimeUrl durch einen einzelnen parameters()-Ausdruck, z. B. @parameters('api-runtimeUrl'). In der Datei connections.json sind @parameters und @appsetting die einzigen gültigen Ausdruckstypen.

Wichtig

Wenn Sie während der Entwicklung die Datei connections.json parametrisieren, wird die Designererfahrung sowohl lokal als auch im Azure-Portal eingeschränkt. Wenn Sie den Designer für die Entwicklung verwenden müssen, verwenden Sie stattdessen eine nicht parametrisierte connections.json-Datei. Ersetzen Sie sie dann in Ihren Bereitstellungspipelines durch die parametrisierte Datei. Die Runtime funktioniert weiterhin mit Parametrisierung. Designerverbesserungen befinden sich in der Entwicklung.

Das folgende Beispiel zeigt eine parametrisierte connections.json-Datei, die sowohl App-Einstellungen als auch Parameter verwendet. Obwohl Sie nach Möglichkeit Parameter verwenden sollten, handelt es sich bei diesem Szenario um eine Ausnahme oder einen Grenzfall, bei dem Sie App-Einstellungen gegenüber Parametern vorziehen würden, da App-Einstellungen während der Bereitstellung generiert werden und sich in einer Entwicklungspipeline leichter dynamisch auffüllen lassen. Diese Beispieldatei verwendet einen Parameter für das komplexe Authentifizierungsobjekt blob_auth und App-Einstellungen für die anderen Werte. In diesem Fall können Sie einen Parameter für das Authentifizierungsobjekt verwenden, da es unwahrscheinlich ist, dass Sie in Ihrem Workflow auf den Parameter verweisen:

{
   "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')"
      }
   }
}

Hinweis

Wenn Sie einen Ausdruck haben, der inline mit einfachem Text ist, stellen Sie sicher, dass Sie das interpolierte Format für diesen Ausdruck verwenden, indem Sie den Ausdruck mit geschweiften Klammern ({}) umschließen. Dieses Format hilft, Probleme beim Parsen zu vermeiden.

Wenn Sie zum Beispiel "<text>/@<function-name>('<parameter-name>')/<text>" haben, verwenden Sie stattdessen die folgende Version: "<text>/@{<function-name>('<parameter-name>')}/<text>".

Weitere Informationen finden Sie unter Überlegungen zur Verwendung von Funktionen.

Verwalten von Parameterdateien

In der Regel müssen Sie mehrere Versionen von Parameterdateien verwalten. Möglicherweise benötigen Sie Werte für verschiedene Bereitstellungsumgebungen, z. B. Entwicklung, Tests und Produktion. Das Verwalten dieser Parameterdateien funktioniert häufig wie das Verwalten von ARM-Vorlagenparameterdateien. Wenn Sie in einer bestimmten Umgebung bereitstellen, bringen Sie die entsprechende Parameterdatei in der Regel über eine Pipeline für DevOps ein.

Führen Sie den folgenden Befehl aus, um Parameterdateien dynamisch mittels Azure CLI zu ersetzen:

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

Bei einem NuGet-basierten Logik-App-Projekt müssen Sie Ihre Projektdatei ( <logic-app-name>.csproj) so aktualisieren, dass die Parameterdatei in der Buildausgabe enthalten sind, zum Beispiel:

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

Hinweis

Derzeit ist die Funktion zum dynamischen Ersetzen von Parameterdateien im Azure-Portal oder Workflow-Designer noch nicht verfügbar.

Weitere Informationen zur Einrichtung Ihrer Logik-Apps für die DevOps-Bereitstellung finden Sie in der folgenden Dokumentation:

• Übersicht über die DevOps-Bereitstellung für auf einem einzelnen Mandanten basierende Logik-Apps
• Einrichten der DevOps-Bereitstellung für auf einem einzelnen Mandanten basierende Logik-Apps

Verwalten von App-Einstellungen

In Azure Logic Apps-Instanzen mit nur einem Mandanten enthalten App-Einstellungen globale Konfigurationsoptionen für alle Workflows in derselben Logik-App. Wenn Sie Workflows lokal in Visual Studio Code ausführen, können Sie auf diese App-Einstellungen in der local.settings.json-Datei als lokale Umgebungsvariablen zugreifen. Anschließend können Sie in Ihren Parametern auf diese App-Einstellungen verweisen.

Informationen zum Hinzufügen, Aktualisieren oder Löschen von App-Einstellungen finden Sie in den folgenden Abschnitten zu Visual Studio Code, dem Azure-Portal, der Azure CLI oder ARM-Vorlagen (Bicep).

Azure-Portal

Führen Sie die folgenden Schritte aus, um die App-Einstellungen für Ihre Logik-App-Ressource im Azure-Portal zu überprüfen:

1. Öffnen Sie Ihre Logik-App-Ressource im Azure-Portal.

2. Klicken Sie im Logik-App-Menü unter Einstellungen auf Konfiguration.

3. Überprüfen Sie auf der Seite Konfiguration auf der Registerkarte Anwendungseinstellungen die App-Einstellungen für Ihre Logik-App.

4. Wählen Sie Werte anzeigen aus, um alle Werte anzuzeigen. Alternativ können Sie einen einzelnen Wert auswählen, um ihn anzuzeigen.

Führen Sie die folgenden Schritte aus, um eine neue Einstellung hinzuzufügen:

1. Wählen Sie auf der Registerkarte Anwendungseinstellungen unter Anwendungseinstellungen die Option Neue Anwendungseinstellung aus.

2. Geben Sie für Name den Schlüssel oder Namen für Ihre neue Einstellung ein.

3. Geben Sie für Wert den Wert für Ihre neue Einstellung ein.

4. Wenn Sie Ihr neues Schlüssel-Wert-Paar erstellen möchten, wählen Sie OK aus.

   

5. Wenn Sie fertig sind, wählen Sie auf der Konfiguration-Symbolleiste Speichern aus.

Azure CLI

Führen Sie den Befehl az logicapp config appsettings list aus, um Ihre aktuellen App-Einstellungen mithilfe der Azure CLI zu überprüfen. Stellen Sie sicher, dass Ihr Befehl die Parameter --name -n und --resource-group -g enthält. Beispiel:

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

Führen Sie den Befehl az logicapp config appsettings set aus, um eine App-Einstellung mithilfe der Azure CLI hinzuzufügen oder zu aktualisieren. Stellen Sie sicher, dass Ihr Befehl die Parameter --name n und --resource-group -g enthält. Der folgende Befehl erstellt beispielsweise eine Einstellung mit einem Schlüssel namens CUSTOM_LOGIC_APP_SETTING mit einem Wert von 12345:

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

Resource Manager- oder Bicep-Vorlage

Um Ihre App-Einstellungen in einer ARM- oder Bicep-Vorlage zu überprüfen und zu definieren, suchen Sie die Ressourcendefinition Ihrer Logik-App, und aktualisieren Sie das appSettings-JSON-Objekt. Die vollständige Ressourcendefinition finden Sie in der ARM-Vorlagenreferenz.

Dieses Beispiel zeigt Dateieinstellungen für ARM-Vorlagen oder Bicep-Vorlagen:

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

Nächste Schritte

• Vergleich zwischen Umgebungen mit einem Mandanten und mehreren Mandanten bzw. Integrationsdienstumgebung für Azure Logic Apps