InvokeRESTAPI@1 - Invocar la tarea de la API de REST v1

Use esta tarea para invocar una API de REST como parte de la canalización.

# Invoke REST API v1
# Invoke a REST API as a part of your pipeline.
- task: InvokeRESTAPI@1
  inputs:
    connectionType: 'connectedServiceName' # 'connectedServiceName' | 'connectedServiceNameARM'. Alias: connectedServiceNameSelector. Required. Connection type. Default: connectedServiceName.
    serviceConnection: # string. Alias: connectedServiceName | genericService. Required when connectedServiceNameSelector = connectedServiceName. Generic service connection. 
    #azureServiceConnection: # string. Alias: connectedServiceNameARM | azureSubscription. Required when connectedServiceNameSelector = connectedServiceNameARM. Azure subscription. 
    method: 'POST' # 'OPTIONS' | 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'TRACE' | 'PATCH'. Required. Method. Default: POST.
    #headers: # string. Headers. 
    #body: # string. Optional. Use when method != GET && method != HEAD. Body. 
    #urlSuffix: # string. URL suffix and parameters. 
  # Advanced
    waitForCompletion: 'false' # 'true' | 'false'. Required. Completion event. Default: false.
    #successCriteria: # string. Optional. Use when waitForCompletion = false. Success criteria.

connectionType - tipo de conexión
Alias de entrada: connectedServiceNameSelector. string. Obligatorio. Valores permitidos: connectedServiceName (Genérico), connectedServiceNameARM (Azure Resource Manager). Valor predeterminado: connectedServiceName.

Especifica el tipo de conexión de servicio que se va a utilizar para invocar la API de REST. Seleccione Azure Resource Manager para invocar una API de administración de Azure o Genérico para todas las demás API.

serviceConnection - Conexión de servicio genérica
Alias de entrada: connectedServiceName | genericService. string. Obligatorio cuando connectedServiceNameSelector = connectedServiceName.

Especifica la conexión de servicio genérica que proporciona baseUrl para la llamada y la autorización que se va a usar para la tarea.

azureServiceConnection - de suscripción de Azure
Alias de entrada: connectedServiceNameARM | azureSubscription. string. Obligatorio cuando connectedServiceNameSelector = connectedServiceNameARM.

Especifica la suscripción de Azure Resource Manager que se va a configurar y usar para invocar las API de administración de Azure.

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

Especifica el método HTTP que invoca la API.

headers - encabezados
string. Valor predeterminado: {\n"Content-Type":"application/json", \n"PlanUrl": "$(system.CollectionUri)", \n"ProjectId": "$(system.TeamProjectId)", \n"HubName": "$(system.HostType)", \n"PlanId": "$(system.PlanId)", \n"JobId": "$(system.JobId)", \n"TimelineId": "$(system.TimelineId)", \n"TaskInstanceId": "$(system.TaskInstanceId)", \n"AuthToken": "$(system.AccessToken)"\n}.

Define el encabezado en formato JSON. El encabezado se adjunta con la solicitud enviada a la API.

cuerpo de body -
string. Opcional. Use cuando method != GET && method != HEAD.

Especifica el cuerpo de la solicitud para la llamada a la función en formato JSON.

urlSuffix - Sufijo y parámetros de URL
string.

Especifica la cadena que se va a anexar a baseUrl desde la conexión de servicio genérico al realizar la llamada HTTP.

Ejemplo: Si la URL de conexión de servicio es https:...TestProj/_apis/Release/releases y el sufijo de URL es /2/environments/1, la URL de conexión de servicio se convierte en https:.../TestProj/_apis/Release/releases/2/environments/1. Si el sufijo de la URL es ?definitionId=1&releaseCount=1, la URL de la conexión del servicio se convierte en https//...TestProj/_apis/Release/releases?definitionId=1&releaseCount=1.

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

Especifica cómo la tarea notifica su finalización. Los valores permitidos son:

• false - Respuesta de la API: informa de la finalización cuando la función devuelve el resultado correcto en un plazo de 20 segundos y el criterio de éxito se evalúa como verdadero.
• true - Devolución de llamada: informa de la finalización cuando el servicio externo realiza una devolución de llamada para actualizar el registro de la línea de tiempo.

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

Especifica los criterios de éxito de la tarea. El contenido de la respuesta no influye en el resultado si no se define ningún criterio. De forma predeterminada, la tarea pasa cuando se devuelve 200 OKla llamada .

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

Ninguno.