AzureFunction@0- Azure Function v0-taak aanroepen

Artikel
07/02/2024

Gebruik deze taak in een taak zonder agent van een release-pijplijn om een door HTTP geactiveerde functie in een functie-app aan te roepen en het antwoord te parseren. De functie-app moet worden gemaakt en gehost in 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.

Invoerwaarden

function - Url van Azure-functie
string. Vereist.

De URL van de Azure-functie die moet worden aangeroepen. Bijvoorbeeld: https://azurefunctionapp.azurewebsites.net/api/HttpTriggerJS1.

key - Functietoets
string. Vereist.

De functie of de hostsleutel die wordt gebruikt om de functie te openen en aan te roepen. Als u de sleutel veilig wilt houden, gebruikt u een geheime pijplijnvariabele om de functiesleutel op te slaan. Bijvoorbeeld: $(myFunctionKey). myFunctionKey is een geheime variabele op omgevingsniveau met een waarde als de geheime sleutel.

method - Methode
string. Vereist. Toegestane waarden: OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, . PATCH Standaardwaarde: POST.

De HTTP-methode waarmee de functie wordt aangeroepen.

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

De header in JSON-indeling die moet worden gekoppeld aan de aanvraag die naar de functie wordt verzonden.

queryParameters - Queryparameters
string.

De tekenreeksquery die moet worden toegevoegd aan de functie-URL. Mag niet beginnen met ? of &.

body - Lichaam
string. Optioneel. Gebruik wanneer method != GET && method != HEAD. Standaardwaarde: {"JobId": "$(system.jobId)", "PlanId": "$(system.planId)", "TimelineId": "$(system.timelineId)", "ProjectId": "$(system.teamProjectId)", "VstsUrl": "$(system.CollectionUri)","AuthToken": "$(system.AccessToken)"}.

De aanvraagbody in JSON-indeling.

waitForCompletion - Voltooien op basis van
string. Vereist. Toegestane waarden: true (Callback), false (ApiResponse). Standaardwaarde: false.

Hoe de taakrapporten worden voltooid.

false - API-antwoord : de functie retourneert succes en succescriteria worden geëvalueerd als waar.
true - Callback : de functie maakt een callback om de tijdlijnrecord bij te werken.

successCriteria - Succescriteria
string. Optioneel. Gebruik wanneer waitForCompletion = false.

De criteria voor een geslaagde taak. De taak retourneert 200 OK standaard de status wanneer dit is gelukt.

Voorbeeld: voor antwoord {"status" : "successful"}kan de expressie zijn eq(root['status'], 'successful'). Meer informatie over het opgeven van voorwaarden.

Opties voor taakbeheer

Alle taken hebben besturingsopties naast hun taakinvoer. Zie Besturingsopties en algemene taakeigenschappen voor meer informatie.

Uitvoervariabelen

Geen.

Opmerkingen

AzureFunction@2 is een nieuwere versie van de taak Azure-functie aanroepen.

Vereisten

Vereiste	Beschrijving
Pijplijntypen	Klassieke release
Wordt uitgevoerd op	Server, ServerGate
Eisen	Geen
Functies	Deze taak voldoet niet aan eventuele vereisten voor volgende taken in de taak.
Opdrachtbeperkingen	Alle
Instelbare variabelen	Alle
Agentversie	Alle ondersteunde agentversies.
Taakcategorie	Hulpprogramma

Zie ook

AzureFunction@2 is een nieuwere versie van de taak Azure-functie aanroepen.

Delen via