AzureFunction@0 – Anropa Azure Function v0-uppgift

Artikel
07/02/2024

Använd den här uppgiften i ett agentlöst jobb i en versionspipeline för att anropa en HTTP-utlöst funktion i en funktionsapp och parsa svaret. Funktionsappen måste skapas och finnas i Azure Functions.

Syntax

# Invoke Azure Function v0
# Invoke Azure function as a part of your process.
- task: AzureFunction@0
  inputs:
    function: # string. Required. Azure function url. 
    key: # string. Required. Function key. 
    method: 'POST' # 'OPTIONS' | 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'TRACE' | 'PATCH'. Required. Method. Default: POST.
    #headers: # string. Headers. 
    #queryParameters: # string. Query parameters. 
    #body: '{"JobId": "$(system.jobId)", "PlanId": "$(system.planId)", "TimelineId": "$(system.timelineId)", "ProjectId": "$(system.teamProjectId)", "VstsUrl": "$(system.CollectionUri)","AuthToken": "$(system.AccessToken)"}' # string. Optional. Use when method != GET && method != HEAD. Body. Default: {"JobId": "$(system.jobId)", "PlanId": "$(system.planId)", "TimelineId": "$(system.timelineId)", "ProjectId": "$(system.teamProjectId)", "VstsUrl": "$(system.CollectionUri)","AuthToken": "$(system.AccessToken)"}.
  # Completion Options
    waitForCompletion: 'false' # 'true' | 'false'. Required. Complete based on. Default: false.
    #successCriteria: # string. Optional. Use when waitForCompletion = false. Success criteria.

Indata

function - Url för Azure-funktion
string. Krävs.

URL:en för den Azure-funktion som ska anropas. Exempel: https://azurefunctionapp.azurewebsites.net/api/HttpTriggerJS1.

key - Funktionsnyckel
string. Krävs.

Funktionen eller värdnyckeln som används för att komma åt och anropa funktionen. Om du vill skydda nyckeln använder du en hemlig pipelinevariabel för att lagra funktionsnyckeln. Exempel: $(myFunctionKey). myFunctionKey är en hemlig variabel på miljönivå med ett värde som hemlig nyckel.

method - Metod
string. Krävs. Tillåtna värden: OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE. PATCH Standardvärde: POST.

DEN HTTP-metod som funktionen ska anropas med.

headers - Headers
string. Standardvärde: {\n"Content-Type":"application/json"\n}.

Huvudet i JSON-format som ska kopplas till begäran som skickas till funktionen.

queryParameters - Frågeparametrar
string.

Strängfrågan som ska läggas till i funktions-URL:en. Får inte börja med ? eller &.

body - Kroppen
string. Valfritt. Använd när method != GET && method != HEAD. Standardvärde: {"JobId": "$(system.jobId)", "PlanId": "$(system.planId)", "TimelineId": "$(system.timelineId)", "ProjectId": "$(system.teamProjectId)", "VstsUrl": "$(system.CollectionUri)","AuthToken": "$(system.AccessToken)"}.

Begärandetexten i JSON-format.

waitForCompletion - Slutfört baserat på
string. Krävs. Tillåtna värden: true (Återanrop), false (ApiResponse). Standardvärde: false.

Hur uppgiften rapporterar slutförande.

false – API-svar – funktionen returnerar framgångs- och framgångskriterier utvärderas till sant.
true – Återanrop – funktionen gör ett återanrop för att uppdatera tidslinjeposten.

successCriteria - Framgångskriterier
string. Valfritt. Använd när waitForCompletion = false.

Kriterierna för en lyckad uppgift. Som standard returnerar 200 OK aktiviteten status när den lyckas.

Exempel: För svar {"status" : "successful"}kan uttrycket vara eq(root['status'], 'successful'). Läs mer om att ange villkor.

Kontrollalternativ för aktivitet

Alla aktiviteter har kontrollalternativ utöver sina aktivitetsindata. Mer information finns i Kontrollalternativ och vanliga uppgiftsegenskaper.

Utdatavariabler

Inga.

Kommentarer

AzureFunction@2 är en nyare version av aktiviteten Anropa Azure Function.

Krav

Krav	Beskrivning
Pipelinetyper	Klassisk version
Körs på	Server, ServerGate
Krav	Ingen
Funktioner	Den här aktiviteten uppfyller inte några krav för efterföljande uppgifter i jobbet.
Kommandobegränsningar	Valfri
Inställningsbara variabler	Valfri
Agentversion	Alla agentversioner som stöds.
Uppgiftskategori	Verktyg

Se även

AzureFunction@2 är en nyare version av aktiviteten Anropa Azure Function.

Dela via