Compartir a través de

AzureFunction@0: tarea Invocar la función de Azure v0

  • Artículo

Use esta tarea en un trabajo sin agente de una canalización de versión para invocar una función desencadenada por HTTP en una aplicación de funciones y analizar la respuesta. La aplicación de funciones debe crearse y hospedarse en Azure Functions.

Sintaxis

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

Entradas

function - dirección URL de la función de Azure
string. Obligatorio.

Dirección URL de la función de Azure que se va a invocar. Ejemplo: https://azurefunctionapp.azurewebsites.net/api/HttpTriggerJS1.


clave de función de key -
string. Obligatorio.

Función o clave de host usada para acceder a la función e invocarla. Para proteger la clave, use una variable de canalización secreta para almacenar la clave de función. Ejemplo: $(myFunctionKey). myFunctionKey es una variable secreta de nivel de entorno con un valor como clave secreta.


del método method -
string. Obligatorio. Valores permitidos: OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, PATCH. Valor predeterminado: POST.

Método HTTP con el que se invocará la función.


headers - encabezados
string. Valor predeterminado: {\n"Content-Type":"application/json"\n}.

Encabezado en formato JSON que se va a adjuntar a la solicitud enviada a la función.


queryParameters - Parámetros de consulta
string.

Consulta de cadena que se va a anexar a la dirección URL de la función. No debe comenzar con ? ni &.


cuerpo de body -
string. Opcional. Use cuando method != GET && method != HEAD. Valor predeterminado: {"JobId": "$(system.jobId)", "PlanId": "$(system.planId)", "TimelineId": "$(system.timelineId)", "ProjectId": "$(system.teamProjectId)", "VstsUrl": "$(system.CollectionUri)","AuthToken": "$(system.AccessToken)"}.

Cuerpo de la solicitud en formato JSON.


waitForCompletion - Completado en función de
string. Obligatorio. Valores permitidos: true (devolución de llamada), false (ApiResponse). Valor predeterminado: false.

Cómo notifica la finalización de la tarea.

  • false: de respuesta de API: la función devuelve criterios correctos y correctos se evalúa como true.
  • true: devolución de llamada: la función realiza una devolución de llamada para actualizar el registro de escala de tiempo.

successCriteria - criterios de éxito
string. Opcional. Use cuando waitForCompletion = false.

Criterios para una tarea correcta. De forma predeterminada, la tarea devuelve 200 OK estado cuando se ejecuta correctamente.

Ejemplo: para la {"status" : "successful"}de respuesta, la expresión puede ser eq(root['status'], 'successful'). Obtenga más información sobre especificar condiciones.


Opciones de control de tareas

Todas las tareas tienen opciones de control además de sus entradas de tarea. Para obtener más información, consulte Opciones de control y propiedades de tareas comunes.

Variables de salida

Ninguno.

Observaciones

AzureFunction@2 es una versión más reciente de la tarea Invocar función de Azure.

Requisitos

Requisito Descripción
Tipos de canalización Versión clásica
Se ejecuta en Server, ServerGate
demandas Ninguno
funcionalidades de Esta tarea no satisface ninguna demanda de tareas posteriores en el trabajo.
restricciones de comandos Cualquiera
variables settable Cualquiera
Versión del agente Todas las versiones de agente admitidas.
Categoría de tarea Utilidad

Consulte también

  • AzureFunction@2 es una versión más reciente de la tarea Invocar función de Azure.