Partager via


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

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.

Syntaxe

# 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

url de fonction Azure function -
string. Obligatoire.

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


key - clé de fonction
string. Obligatoire.

Fonction ou clé hôte utilisée pour accéder à la fonction et appeler la fonction. Pour sécuriser la clé, utilisez une variable de pipeline secret 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.


méthode method -
string. Obligatoire. Valeurs autorisées : OPTIONS, GET, HEAD, POST, PUT, DELETE, 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. Optionnel. 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 - Terminé en fonction de
string. Obligatoire. Valeurs autorisées : true (rappel), 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 de réussite est évaluée à true.
  • true - Rappel - la fonction effectue un rappel pour mettre à jour l’enregistrement de chronologie.

critères de réussite successCriteria -
string. Optionnel. Utilisez quand waitForCompletion = false.

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

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


Options de contrôle de tâche

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

Variables de sortie

Aucun.

Remarques

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

Spécifications

Besoin Descriptif
Types de pipelines Version classique
Exécutions sur Serveur, ServerGate
demandes Aucun
fonctionnalités de Cette tâche ne répond à aucune demande de tâches ultérieures dans le travail.
restrictions de commande N'importe quel
variables settables N'importe quel
Version de l’agent Toutes les versions de l’agent prises en charge.
Catégorie de tâche Utilité

Voir aussi

  • AzureFunction@2 est une version plus récente de la tâche Invoke Azure Function.