AzureFunction@0: Aufrufen des Azure Function v0-Tasks

Artikel
06/11/2024

Verwenden Sie diese Aufgabe in einem agentlosen Auftrag einer Releasepipeline, um eine von HTTP ausgelöste Funktion in einer Funktions-App aufzurufen und die Antwort zu analysieren. Die Funktions-App muss in Azure Functions erstellt und gehostet werden.

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.

Eingaben

function - Azure-Funktions-URL
string. Erforderlich.

Die URL der azure-Funktion, die aufgerufen werden soll. Beispiel: https://azurefunctionapp.azurewebsites.net/api/HttpTriggerJS1.

key - Funktionstaste
string. Erforderlich.

Die Funktion oder der Hostschlüssel, der für den Zugriff auf die Funktion und das Aufrufen der Funktion verwendet wird. Um den Schlüssel sicher zu halten, verwenden Sie eine geheime Pipelinevariable, um den Funktionsschlüssel zu speichern. Beispiel: $(myFunctionKey). myFunctionKey ist eine Geheimnisvariable auf Umgebungsebene mit einem Wert als geheimem Schlüssel.

method - Methode
string. Erforderlich. Zulässige Werte: OPTIONS, GET, HEAD, PUTPOST, DELETE, , TRACE. PATCH Standardwert. POST.

Die HTTP-Methode, mit der die Funktion aufgerufen wird.

headers - Header
string. Standardwert. {\n"Content-Type":"application/json"\n}.

Der Header im JSON-Format, der an die Anforderung angefügt werden soll, die an die Funktion gesendet wird.

queryParameters - Abfrageparameter
string.

Die Zeichenfolgenabfrage, die an die Funktions-URL angefügt werden soll. Darf nicht mit ? oder &beginnen.

body - Körper
string. Optional. Verwenden Sie , wenn method != GET && method != HEAD. Standardwert. {"JobId": "$(system.jobId)", "PlanId": "$(system.planId)", "TimelineId": "$(system.timelineId)", "ProjectId": "$(system.teamProjectId)", "VstsUrl": "$(system.CollectionUri)","AuthToken": "$(system.AccessToken)"}.

Der Anforderungstext im JSON-Format.

waitForCompletion - Abschließen basierend auf
string. Erforderlich. Zulässige Werte: true (Rückruf), false (ApiResponse). Standardwert. false.

So meldet der Task die Vervollständigung.

false - API-Antwort : Die Funktion gibt den Erfolg zurück, und die Erfolgskriterien werden auf "true" ausgewertet.
true - Rückruf: Die Funktion führt einen Rückruf aus, um den Zeitleiste Datensatz zu aktualisieren.

successCriteria - Erfolgskriterien
string. Optional. Verwenden Sie , wenn waitForCompletion = false.

Die Kriterien für eine erfolgreiche Aufgabe. Standardmäßig gibt die Aufgabe bei erfolgreicher Ausführung status zurück 200 OK .

Beispiel: Für die Antwort {"status" : "successful"}kann der Ausdruck sein eq(root['status'], 'successful'). Erfahren Sie mehr über das Angeben von Bedingungen.

Optionen für die Vorgangskontrolle

Alle Vorgänge verfügen zusätzlich zu ihren Eingaben über Steuerungsoptionen. Weitere Informationen finden Sie unter Steuerungsoptionen und allgemeine Aufgabeneigenschaften.

Ausgabevariablen

Keine.

Hinweise

AzureFunction@2 ist eine neuere Version des Tasks Azure Function aufrufen.

Anforderungen

Anforderung	BESCHREIBUNG
Pipelinetypen	Klassische Version
Wird ausgeführt auf	Server, ServerGate
Forderungen	Keine
Capabilities	Diese Aufgabe erfüllt keine Anforderungen an nachfolgende Aufgaben im Auftrag.
Befehlseinschränkungen	Any
Einstellbare Variablen	Any
Agent-Version	Alle unterstützten Agent-Versionen.
Aufgabenkategorie	Hilfsprogramm

Weitere Informationen

AzureFunction@2 ist eine neuere Version des Tasks Azure Function aufrufen.

Teilen über