Schemareferensguide för arbetsflödesdefinitionsspråket i Azure Logic Apps

När du skapar ett logikapparbetsflöde i Azure Logic Apps har arbetsflödet en underliggande JSON-definition (JavaScript Object Notation) som beskriver den faktiska logiken som kör arbetsflödet. Arbetsflödesdefinitionen följer en struktur som verifieras mot schemat arbetsflödesdefinitionsspråk. Den här referensen ger en översikt över den här strukturen och hur schemat definierar attribut i arbetsflödesdefinitionen.

Arbetsflödesdefinitionsstruktur

En arbetsflödesdefinition innehåller alltid en utlösare som instansierar arbetsflödet, plus en eller flera åtgärder som körs när utlösaren utlöses.

Här är den övergripande strukturen för en arbetsflödesdefinition:

"definition": {
  "$schema": "<workflow-definition-language-schema-version>",
  "actions": { "<workflow-action-definitions>" },
  "contentVersion": "<workflow-definition-version-number>",
  "outputs": { "<workflow-output-definitions>" },
  "parameters": { "<workflow-parameter-definitions>" },
  "staticResults": { "<static-results-definitions>" },
  "triggers": { "<workflow-trigger-definitions>" }
}

Utlösare och åtgärder

I en arbetsflödesdefinition definierar avsnitten triggers och actions de anrop som inträffar under arbetsflödets körning. Syntax och mer information om dessa avsnitt finns i Arbetsflödesutlösare och åtgärder.

Parameters

Distributionens livscykel har vanligtvis olika miljöer för utveckling, testning, mellanlagring och produktion. När du distribuerar logikappar till olika miljöer vill du förmodligen använda olika värden, till exempel anslutningssträng, baserat på dina distributionsbehov. Eller så kan du ha värden som du vill återanvända i hela arbetsflödet utan hårdkodning eller som ändras ofta. I avsnittet för arbetsflödesdefinitionen parameters kan du definiera eller redigera parametrar för de värden som arbetsflödet använder vid körning. Du måste definiera dessa parametrar först innan du kan referera till dessa parametrar någon annanstans i arbetsflödesdefinitionen.

Här är den allmänna strukturen för en parameterdefinition:

"parameters": {
   "<parameter-name>": {
      "type": "<parameter-type>",
      "defaultValue": <default-parameter-value>,
      "allowedValues": [ <array-with-permitted-parameter-values> ],
      "metadata": {
         "description": "<parameter-description>"
      }
   }
},

Skapa sedan en Azure Resource Manager-mall för arbetsflödesdefinitionen, definiera mallparametrar som accepterar de värden du vill använda vid distributionen, ersätt hårdkodade värden med referenser till mall- eller arbetsflödesdefinitionsparametrar efter behov och lagra de värden som ska användas vid distributionen i en separat parameterfil. På så sätt kan du enkelt ändra dessa värden via parameterfilen utan att behöva uppdatera och distribuera om logikappen. För information som är känslig eller måste skyddas, till exempel användarnamn, lösenord och hemligheter, kan du lagra dessa värden i Azure Key Vault och låta parameterfilen hämta dessa värden från nyckelvalvet. Mer information och exempel om hur du definierar parametrar på mall- och arbetsflödesdefinitionsnivåer finns i Översikt: Automatisera distribution för logikappar med Azure Resource Manager-mallar.

Statiska resultat

staticResults I attributet definierar du en åtgärds mock outputs och status att åtgärden returnerar när åtgärdens statiska resultatinställning är aktiverad. I åtgärdens definition runtimeConfiguration.staticResult.name refererar attributet till namnet på den statiska resultatdefinitionen i staticResults. Lär dig hur du kan testa logikapparbetsflöden med falska data genom att konfigurera statiska resultat.

"definition": {
   "$schema": "<...>",
   "actions": { "<...>" },
   "contentVersion": "<...>",
   "outputs": { "<...>" },
   "parameters": { "<...>" },
   "staticResults": {
      "<static-result-definition-name>": {
         "outputs": {
            <output-attributes-and-values-returned>,
            "headers": { <header-values> },
            "statusCode": "<status-code-returned>"
         },
         "status": "<action-status>"
      }
   },
   "triggers": { "<...>" }
}

I den här HTTP-åtgärdsdefinitionen refererar attributet runtimeConfiguration.staticResult.name till HTTP0 inuti attributet staticResults, där mock-utdata för åtgärden definieras. Attributet runtimeConfiguration.staticResult.staticResultOptions anger att inställningen för statiskt resultat finns Enabled på HTTP-åtgärden.

"actions": {
   "HTTP": {
      "inputs": {
         "method": "GET",
         "uri": "https://www.microsoft.com"
      },
      "runAfter": {},
      "runtimeConfiguration": {
         "staticResult": {
            "name": "HTTP0",
            "staticResultOptions": "Enabled"
         }
      },
      "type": "Http"
   }
},

HTTP-åtgärden returnerar utdata i HTTP0 definitionen i staticResults. I det här exemplet för statuskoden är OK exempelutdata. För rubrikvärden är mock-utdata "Content-Type": "application/JSON". För statusen för åtgärden är mockoutputen Succeeded.

"definition": {
   "$schema": "<...>",
   "actions": { "<...>" },
   "contentVersion": "<...>",
   "outputs": { "<...>" },
   "parameters": { "<...>" },
   "staticResults": {
      "HTTP0": {
         "outputs": {
            "headers": {
               "Content-Type": "application/JSON"
            },
            "statusCode": "OK"
         },
         "status": "Succeeded"
      }
   },
   "triggers": { "<...>" }
},

Expressions

Med JSON kan du ha literalvärden som finns vid designtillfället, till exempel:

"customerName": "Sophia Owen",
"rainbowColors": ["red", "orange", "yellow", "green", "blue", "indigo", "violet"],
"rainbowColorsCount": 7

Det kan också finnas värden som inte existerar förrän körningstid. För att representera dessa värden kan du använda uttryck som utvärderas vid körning. Ett uttryck är en sekvens som kan innehålla en eller flera funktioner, operatorer, variabler, explicita värden eller konstanter. I arbetsflödesdefinitionen kan du använda ett uttryck var som helst i ett JSON-strängvärde genom att prefixa uttrycket med at-sign (@). När du utvärderar ett uttryck som representerar ett JSON-värde extraheras uttryckstexten genom att @-tecknet tas bort och resulterar alltid i ett annat JSON-värde.

För den tidigare definierade customerName egenskapen kan du till exempel hämta egenskapsvärdet med hjälp av funktionen parameters() i ett uttryck och tilldela värdet till accountName egenskapen:

"customerName": "Sophia Owen",
"accountName": "@parameters('customerName')"

Med stränginterpolation kan du också använda flera uttryck inuti strängar som omsluts av @-tecknet och klammerparenteser ({}). Här är syntaxen:

@{ "<expression1>", "<expression2>" }

Resultatet är alltid en sträng, vilket gör den här funktionen liknande concat(), till exempel:

"customerName": "First name: @{parameters('firstName')} Last name: @{parameters('lastName')}"

Om du har en literalsträng som börjar med @-tecknet prefixar du @-tecknet med ett annat @-tecken som ett escape-tecken: @@

De här exemplen visar hur uttryck utvärderas:

I de här exemplen antar vi att du definierar "myBirthMonth" lika med "Januari" och "myAge" som är lika med talet 42:

"myBirthMonth": "January",
"myAge": 42

De här exemplen visar hur följande uttryck utvärderas:

När du arbetar visuellt i arbetsflödesdesignern kan du skapa uttryck med hjälp av uttrycksredigeraren, till exempel:

När du är klar visas uttrycket för motsvarande egenskap i arbetsflödesdefinitionen searchQuery , till exempel egenskapen här:

"Search_tweets": {
  "inputs": {
    "host": {
      "connection": {
        "name": "@parameters('$connections')['x']['connectionId']"
      }
    }
  },
  "method": "get",
  "path": "/searchtweets",
  "queries": {
    "maxResults": 20,
    "searchQuery": "Azure @{concat('firstName','', 'LastName')}"
  }
},

Outputs

I avsnittet outputs definierar du de data som ditt arbetsflöde kan returnera när det har slutförts. Om du till exempel vill spåra en specifik status eller ett visst värde från varje körning anger du att arbetsflödets utdata returnerar dessa data.

Här är den allmänna strukturen för en utdatadefinition:

"outputs": {
  "<key-name>": {
    "type": "<key-type>",
    "value": "<key-value>"
  }
}

Om du vill hämta utdata från en arbetsflödeskörning granskar du logikappens körningshistorik och information i Azure Portal eller använder REST-API:et för arbetsflöde. Du kan också skicka utdata till externa system, till exempel Power BI så att du kan skapa instrumentpaneler.

Operators

I uttryck och funktioner utför operatorerna specifika uppgifter, till exempel referens till en egenskap eller ett värde i en matris.

Functions

Vissa uttryck får sina värden från körningsåtgärder som kanske inte finns ännu när arbetsflödesdefinitionen börjar köras. Om du vill referera till eller arbeta med dessa värden i uttryck kan du använda funktioner som arbetsflödesdefinitionsspråket tillhandahåller.

Relaterat innehåll

• Åtgärder och utlösare för arbetsflödesdefinitionsspråk
• REST API för arbetsflöde