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 em Azure Functions.

Syntax

# 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 da função do Azure
string. Obrigatórios.

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

key - Chave de função
string. Obrigatórios.

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.

method - Método
string. Obrigatórios. 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.

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

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

queryParameters - Parâmetros de consulta
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órios. Valores permitidos: true (Retorno de chamada) false (ApiResponse). Valor padrão: false.

Como a tarefa relata a conclusão.

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

successCriteria - Critérios de êxito
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 resposta {"status" : "successful"}, a expressão pode ser eq(root['status'], 'successful'). Saiba mais sobre como especificar condições.

Opções de controle de tarefa

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

Variáveis de saída

Nenhum.

Comentários

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
É executado em	Server, ServerGate
Demandas	Nenhum
Funcionalidades	Essa tarefa não atende a nenhuma demanda por tarefas subsequentes no trabalho.
Restrições de comando	Qualquer
Variáveis configuráveis	Qualquer
Versão do agente	Todas as versões do agente com suporte.
Categoria da tarefa	Utilitário

Confira também

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