AzureFunction@0 – Azure Function v0-Aufgabe aufrufen
Verwenden Sie diese Aufgabe in einem agentlosen Auftrag einer Releasepipeline, um eine 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.
Eingänge
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 die Hosttaste, mit der auf die Funktion zugegriffen und aufgerufen wird. Um den Schlüssel sicher zu halten, verwenden Sie eine geheime Pipelinevariable, um den Funktionsschlüssel zu speichern. Beispiel: $(myFunctionKey)
.
myFunctionKey
ist eine geheime Variable auf Umgebungsebene mit einem Wert als geheimer Schlüssel.
method
-
-Methode
string
. Erforderlich. Zulässige Werte: OPTIONS
, GET
, HEAD
, POST
, PUT
, DELETE
, TRACE
, PATCH
. Standardwert: POST
.
Die HTTP-Methode, mit der die Funktion aufgerufen wird.
headers
-
Kopfzeilen
string
. Standardwert: {\n"Content-Type":"application/json"\n}
.
Der Header im JSON-Format, der an die an die Funktion gesendete Anforderung angefügt werden soll.
queryParameters
-
Abfrageparameter
string
.
Die Zeichenfolgenabfrage, die an die Funktions-URL angefügt werden soll. Darf nicht mit ?
oder &
beginnen.
body
-
Body-
string
. Wahlfrei. Wird verwendet, 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
-
abgeschlossen basierend auf
string
. Erforderlich. Zulässige Werte: true
(Rückruf), false
(ApiResponse). Standardwert: false
.
Wie der Abschluss des Vorgangs meldet.
-
false
- API-Antwort - die Funktion gibt Erfolgs- und Erfolgskriterien als wahr zurück. -
true
– Rückruf – führt die Funktion einen Rückruf aus, um den Zeitachsendatensatz zu aktualisieren.
successCriteria
-
Erfolgskriterien
string
. Wahlfrei. Wird verwendet, wenn waitForCompletion = false
.
Die Kriterien für einen erfolgreichen Vorgang. Standardmäßig gibt die Aufgabe 200 OK
Status zurück, wenn dies erfolgreich war.
Beispiel: Für antwort {"status" : "successful"}
kann der Ausdruck eq(root['status'], 'successful')
werden. Erfahren Sie mehr über Angeben von Bedingungen.
Aufgabensteuerungsoptionen
Alle Aufgaben verfügen zusätzlich zu ihren Aufgabeneingaben über Steuerungsoptionen. Weitere Informationen finden Sie unter Steuerelementoptionen und allgemeinen Aufgabeneigenschaften.
Ausgabevariablen
Keiner.
Bemerkungen
AzureFunction@2 ist eine neuere Version der Aufgabe "Azure-Funktion aufrufen".
Anforderungen
Anforderung | BESCHREIBUNG |
---|---|
Pipelinetypen | Klassische Version |
Läuft auf | Server, ServerGate |
Anforderungen | Nichts |
Funktionen | Dieser Vorgang erfüllt keine Anforderungen für nachfolgende Vorgänge im Auftrag. |
Befehlseinschränkungen | Jegliche |
Settable-Variablen | Jegliche |
Agentversion | Alle unterstützten Agentversionen. |
Vorgangskategorie | Nützlichkeit |
Siehe auch
- AzureFunction@2 ist eine neuere Version der Aufgabe "Azure-Funktion aufrufen".