AzureFunction@0 - Appeler la tâche Azure Function v0

Article
07/02/2024

Utilisez cette tâche dans un travail sans agent d’un pipeline de mise en production pour appeler une fonction déclenchée par HTTP dans une application de fonction et analyser la réponse. L’application de fonction doit être créée et hébergée dans 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.

Entrées

function - URL de la fonction Azure
string. Obligatoire.

URL de la fonction Azure à appeler. Exemple : https://azurefunctionapp.azurewebsites.net/api/HttpTriggerJS1.

key - Clé de fonction
string. Obligatoire.

La fonction ou la clé hôte utilisée pour accéder à la fonction et l’appeler. Pour sécuriser la clé, utilisez une variable de pipeline secrète pour stocker la clé de fonction. Exemple : $(myFunctionKey). myFunctionKey est une variable secrète au niveau de l’environnement avec une valeur comme clé secrète.

method - Méthode
string. Obligatoire. Valeurs autorisées : OPTIONS, GET, HEAD, POST, DELETEPUT, , TRACE. PATCH Valeur par défaut : POST.

Méthode HTTP avec laquelle la fonction sera appelée.

headers - En-têtes
string. Valeur par défaut : {\n"Content-Type":"application/json"\n}.

En-tête au format JSON à joindre à la requête envoyée à la fonction.

queryParameters - Paramètres de requête
string.

Requête de chaîne à ajouter à l’URL de la fonction. Ne doit pas commencer ? par ou &.

body - Corps
string. facultatif. Utilisez quand method != GET && method != HEAD. Valeur par défaut : {"JobId": "$(system.jobId)", "PlanId": "$(system.planId)", "TimelineId": "$(system.timelineId)", "ProjectId": "$(system.teamProjectId)", "VstsUrl": "$(system.CollectionUri)","AuthToken": "$(system.AccessToken)"}.

Corps de la requête au format JSON.

waitForCompletion - Terminer en fonction de
string. Obligatoire. Valeurs autorisées : true (Callback), false (ApiResponse). Valeur par défaut : false.

Comment la tâche signale l’achèvement.

false - Réponse de l’API : la fonction retourne les critères de réussite et les critères de réussite sont évalués à true.
true - Rappel : la fonction effectue un rappel pour mettre à jour l’enregistrement chronologie.

successCriteria - Critères de réussite
string. facultatif. Utilisez quand waitForCompletion = false.

Critères de réussite d’une tâche. Par défaut, la tâche retourne 200 OK status en cas de réussite.

Exemple : Pour la réponse {"status" : "successful"}, l’expression peut être eq(root['status'], 'successful'). En savoir plus sur la spécification de conditions.

Options de contrôle de la tâche

Toutes les tâches ont des options de contrôle en plus de leurs entrées de tâches. Pour plus d’informations, consultez Options de contrôle et propriétés de tâche courantes.

Variables de sortie

Aucun.

Notes

AzureFunction@2 est une version plus récente de la tâche Appeler la fonction Azure.

Configuration requise

Condition requise	Description
Types de pipelines	Version classique
S’exécute sur	Serveur, ServerGate
Demandes	None
Capabilities	Cette tâche ne répond à aucune demande pour les tâches suivantes dans le travail.
Restrictions de commandes	Quelconque
Variables settables	Quelconque
Version de l’agent	Toutes les versions d’agent prises en charge.
Catégorie de la tâche	Utilitaire

Voir aussi

AzureFunction@2 est une version plus récente de la tâche Appeler la fonction Azure.

Partager via