AzureFunction@0 - Richiamare l'attività Funzione di Azure v0

Articolo
07/02/2024

Usare questa attività in un processo senza agente di una pipeline di versione per richiamare una funzione attivata tramite HTTP in un'app per le funzioni e analizzare la risposta. L'app per le funzioni deve essere creata e ospitata in Funzioni di Azure.

Sintassi

# 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.

Input

function - URL della funzione di Azure
string. Obbligatorio.

URL della funzione di Azure da richiamare. Esempio: https://azurefunctionapp.azurewebsites.net/api/HttpTriggerJS1.

key - Tasto funzione
string. Obbligatorio.

Funzione o chiave host usata per accedere e richiamare la funzione. Per proteggere la chiave, usare una variabile della pipeline segreta per archiviare la chiave della funzione. Esempio: $(myFunctionKey). myFunctionKey è una variabile privata a livello di ambiente con un valore come chiave privata.

method - Metodo
string. Obbligatorio. Valori consentiti: OPTIONS, GET, POSTHEAD, PUT, DELETE, , TRACE, PATCH. Valore predefinito: POST.

Metodo HTTP con cui verrà richiamata la funzione.

headers - Intestazioni
string. Valore predefinito: {\n"Content-Type":"application/json"\n}.

Intestazione in formato JSON da collegare alla richiesta inviata alla funzione.

queryParameters - Parametri di query
string.

Query stringa da aggiungere all'URL della funzione. Non deve iniziare con ? o &.

body - Corpo
string. Facoltativa. Usare quando method != GET && method != HEAD. Valore predefinito: {"JobId": "$(system.jobId)", "PlanId": "$(system.planId)", "TimelineId": "$(system.timelineId)", "ProjectId": "$(system.teamProjectId)", "VstsUrl": "$(system.CollectionUri)","AuthToken": "$(system.AccessToken)"}.

Corpo della richiesta in formato JSON.

waitForCompletion - Completato in base a
string. Obbligatorio. Valori consentiti: true (Callback), false (ApiResponse). Valore predefinito: false.

Come l'attività segnala il completamento.

false - Risposta API: la funzione restituisce i criteri di esito positivo e di esito positivo restituisce true.
true - Callback: la funzione esegue un callback per aggiornare il record della sequenza temporale.

successCriteria - Criteri di esito positivo
string. Facoltativa. Usare quando waitForCompletion = false.

Criteri per un'attività riuscita. Per impostazione predefinita, l'attività restituisce 200 OK lo stato in caso di esito positivo.

Esempio: per la risposta {"status" : "successful"}, l'espressione può essere eq(root['status'], 'successful'). Altre informazioni sulla specifica delle condizioni.

Opzioni di controllo delle attività

Tutte le attività dispongono di opzioni di controllo oltre ai relativi input attività. Per altre informazioni, vedere Opzioni di controllo e proprietà comuni delle attività.

Variabili di output

Nessuno.

Osservazioni

AzureFunction@2 è una versione più recente dell'attività Richiama funzione di Azure.

Requisiti

Requisito	Descrizione
Tipi di pipeline	Versione classica
Viene eseguito in	Server, ServerGate
Richieste	Nessuno
Capabilities	Questa attività non soddisfa le richieste per le attività successive nel processo.
Restrizioni dei comandi	Qualsiasi
Variabili impostabili	Qualsiasi
Versione agente	Tutte le versioni dell'agente supportate.
Categoria attività	Utilità

Vedi anche

AzureFunction@2 è una versione più recente dell'attività Richiama funzione di Azure.

Condividi tramite