Compartilhar via


AzureFunction@0 – Invocar tarefa do Azure Function v0

Use essa tarefa em um trabalho sem agente de um pipeline de lançamento para invocar uma função disparada por HTTP em um aplicativo de funções e analisar a resposta. O aplicativo de funções deve ser criado e hospedado no Azure Functions.

Sintaxe

# 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 - url de função do Azure
string. Obrigatório

A URL da função do Azure a ser invocada. Exemplo: https://azurefunctionapp.azurewebsites.net/api/HttpTriggerJS1.


de chave de função key -
string. Obrigatório

A função ou a chave de host usada para acessar e invocar a função. Para manter a chave segura, use uma variável de pipeline secreta para armazenar a chave de função. Exemplo: $(myFunctionKey). myFunctionKey é uma variável secreta no nível do ambiente com um valor como a chave secreta.


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

O método HTTP com o qual a função será invocada.


Cabeçalhos headers -
string. Valor padrão: {\n"Content-Type":"application/json"\n}.

O cabeçalho no formato JSON a ser anexado à solicitação enviada à função.


parâmetros de consulta queryParameters -
string.

A consulta de cadeia de caracteres a ser acrescentada à URL da função. Não deve começar com ? ou &.


body - corpo
string. Opcional. Use quando method != GET && method != HEAD. Valor padrão: {"JobId": "$(system.jobId)", "PlanId": "$(system.planId)", "TimelineId": "$(system.timelineId)", "ProjectId": "$(system.teamProjectId)", "VstsUrl": "$(system.CollectionUri)","AuthToken": "$(system.AccessToken)"}.

O corpo da solicitação no formato JSON.


waitForCompletion - Concluído com base em
string. Obrigatório Valores permitidos: true (retorno de chamada), false (ApiResponse). Valor padrão: false.

Como a tarefa relata a conclusão.

  • false - de resposta à API - a função retorna critérios de êxito e êxito avaliados como verdadeiros.
  • true - de retorno de chamada - a função faz um retorno de chamada para atualizar o registro da linha do tempo.

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

Os critérios para uma tarefa bem-sucedida. Por padrão, a tarefa retorna 200 OK status quando bem-sucedida.

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


Opções de controle de tarefa

Todas as tarefas têm opções de controle além das suas entradas de tarefas. Para obter mais informações, consulte as opções de Controle de e as propriedades comuns da tarefa.

Variáveis de saída

Nenhum.

Observações

AzureFunction@2 é uma versão mais recente da tarefa Invocar Função do Azure.

Requisitos

Requisito Descrição
Tipos de pipeline Versão clássica
Execuções em Servidor, ServerGate
de demandas Nenhum
recursos Essa tarefa não atende a nenhuma demanda para tarefas subsequentes no trabalho.
restrições de comando Qualquer
variáveis settable Qualquer
Versão do agente Todas as versões de agente com suporte.
Categoria de tarefa Utilidade

Consulte também

  • AzureFunction@2 é uma versão mais recente da tarefa Invocar Função do Azure.