InvokeRESTAPI@1 – Invocar tarefa da API REST v1

Use essa tarefa para invocar uma API REST como parte do pipeline.

# 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 conexão
Alias de entrada: connectedServiceNameSelector. string. Obrigatório Valores permitidos: connectedServiceName (genérico), connectedServiceNameARM (Azure Resource Manager). Valor padrão: connectedServiceName.

Especifica o tipo de conexão de serviço a ser usado para invocar a API REST. Selecione do Azure Resource Manager para invocar uma API de gerenciamento do Azure ou genérico para todas as outras APIs.

serviceConnection - de conexão de serviço genérico
Alias de entrada: connectedServiceName | genericService. string. Necessário quando connectedServiceNameSelector = connectedServiceName.

Especifica a conexão de serviço genérica que fornece o baseUrl para a chamada e a autorização a ser usada para a tarefa.

azureServiceConnection - assinatura do Azure
Alias de entrada: connectedServiceNameARM | azureSubscription. string. Necessário quando connectedServiceNameSelector = connectedServiceNameARM.

Especifica a assinatura do Azure Resource Manager a ser configurada e usada para invocar APIs de gerenciamento do Azure.

Método method -
string. Obrigatório Valores permitidos: OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, PATCH. Valor padrão: POST.

Especifica o método HTTP que invoca a API.

Cabeçalhos headers -
string. Valor padrão: {\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 o cabeçalho no formato JSON. O cabeçalho é anexado com a solicitação enviada à API.

body - corpo
string. Opcional. Use quando method != GET && method != HEAD.

Especifica o corpo da solicitação para a chamada de função no formato JSON.

urlSuffix - sufixo de URL e parâmetros
string.

Especifica a cadeia de caracteres a ser acrescentada ao baseUrl da conexão de serviço genérica ao fazer a chamada HTTP.

Exemplo: se a URL de conexão de serviço for https:...TestProj/_apis/Release/releases e o sufixo de URL for /2/environments/1, a URL de conexão de serviço se tornará https:.../TestProj/_apis/Release/releases/2/environments/1. Se o sufixo de URL for ?definitionId=1&releaseCount=1, a URL de conexão de serviço se tornará https//...TestProj/_apis/Release/releases?definitionId=1&releaseCount=1.

de evento de conclusão de waitForCompletion -
string. Obrigatório Valores permitidos: true (retorno de chamada), false (ApiResponse). Valor padrão: false.

Especifica como a tarefa relata a conclusão. Os valores permitidos são:

• false - de resposta à API: relata a conclusão quando a função retorna êxito dentro de 20 segundos e os critérios de êxito são avaliados como verdadeiros.
• true - de retorno de chamada: relata a conclusão quando o serviço externo faz um retorno de chamada para atualizar o registro da linha do tempo.

critérios de sucesso successCriteria -
string. Opcional. Use quando waitForCompletion = false.

Especifica os critérios da tarefa para êxito. O conteúdo da resposta não influenciará o resultado se nenhum critério for definido. Por padrão, a tarefa é passada quando a chamada retorna 200 OK.

Exemplo: para {"status" : "successful"}de resposta, a expressão pode ser eq(root['status'], 'successful'). Saiba mais sobre especificando condições.

Nenhum.