AzureFunction@0 – Vyvolání úlohy Azure Functions v0

Článek
06/11/2024

Tuto úlohu použijte v úloze bez agenta kanálu verze k vyvolání funkce aktivované protokolem HTTP v aplikaci funkcí a parsování odpovědi. Aplikace funkcí musí být vytvořená a hostovaná v 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.

Vstupy

function - Adresa URL funkce Azure
string. Povinná hodnota.

Adresa URL funkce Azure, která se má vyvolat. Příklad: https://azurefunctionapp.azurewebsites.net/api/HttpTriggerJS1.

key - Funkční klávesa
string. Povinná hodnota.

Funkce nebo klíč hostitele použitý pro přístup k funkci a vyvolání funkce Pokud chcete klíč zabezpečit, použijte k uložení klíče funkce proměnnou tajného kanálu. Příklad: $(myFunctionKey). myFunctionKey je proměnná tajného klíče na úrovni prostředí s hodnotou jako tajný klíč.

method - Metoda
string. Povinná hodnota. Povolené hodnoty: OPTIONS, GET, HEAD, POSTPUT, , DELETE, , TRACE. PATCH Výchozí hodnota: POST.

Metoda HTTP, pomocí které bude funkce vyvolána.

headers - Záhlaví
string. Výchozí hodnota: {\n"Content-Type":"application/json"\n}.

Hlavička ve formátu JSON, která se má připojit k požadavku odeslanému do funkce.

queryParameters - Parametry dotazu
string.

Řetězcový dotaz, který se má připojit k adrese URL funkce. Nesmí začínat na ? nebo &.

body - Tělo
string. Nepovinný parametr. Použijte, když method != GET && method != HEAD. Výchozí hodnota: {"JobId": "$(system.jobId)", "PlanId": "$(system.planId)", "TimelineId": "$(system.timelineId)", "ProjectId": "$(system.teamProjectId)", "VstsUrl": "$(system.CollectionUri)","AuthToken": "$(system.AccessToken)"}.

Text požadavku ve formátu JSON

waitForCompletion - Dokončení na základě
string. Povinná hodnota. Povolené hodnoty: true (zpětné volání), false (ApiResponse). Výchozí hodnota: false.

Jak úkol hlásí dokončení.

false - Odpověď rozhraní API – funkce vrátí kritéria úspěchu a vyhodnotí se jako pravdivá.
true - Zpětné volání – funkce provede zpětné volání pro aktualizaci záznamu časové osy.

successCriteria - Kritéria úspěchu
string. Nepovinný parametr. Použijte, když waitForCompletion = false.

Kritéria úspěšného úkolu Ve výchozím nastavení úkol vrátí 200 OK v případě úspěchu stav.

Příklad: Pro odpověď {"status" : "successful"}může být eq(root['status'], 'successful')výrazem . Přečtěte si další informace o zadávání podmínek.

Možnosti ovládání úloh

Všechny úlohy mají kromě vstupů také možnosti ovládání. Další informace najdete v tématu Možnosti ovládacího prvku a běžné vlastnosti úlohy.

Výstupní proměnné

Žádné

Poznámky

AzureFunction@2 je novější verze úlohy Vyvolat funkci Azure.

Požadavky

Požadavek	Popis
Typy kanálů	Klasická verze
Spustí se	Server, ServerGate
Požadavky	Žádné
Možnosti	Tento úkol nesplňuje žádné požadavky na následné úkoly v úloze.
Omezení příkazů	Všechny
Nastavitelné proměnné	Všechny
Verze agenta	Všechny podporované verze agenta.
Kategorie úloh	Nástroj

Viz také

AzureFunction@2 je novější verze úlohy Vyvolat funkci Azure.

Sdílet prostřednictvím