AzureFunction@0 - Invocar a tarefa V0 da Função do Azure

Artigo
07/02/2024

Utilize esta tarefa numa tarefa sem agente de um pipeline de versão para invocar uma função acionada por HTTP numa aplicação de funções e analisar a resposta. A aplicação de funções tem de ser criada e alojada no Funções do Azure.

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ório.

O URL da função do Azure a invocar. Exemplo: https://azurefunctionapp.azurewebsites.net/api/HttpTriggerJS1.

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

A função ou a chave de anfitrião utilizada para aceder e invocar a função. Para manter a chave segura, utilize uma variável de pipeline secreta para armazenar a chave de função. Exemplo: $(myFunctionKey). myFunctionKey é uma variável secreta ao nível do ambiente com um valor como chave secreta.

method - Método
string. Obrigatório. Valores permitidos: OPTIONS, , GET, POSTHEAD, PUT, DELETE, , . PATCHTRACE Valor predefinido: POST.

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

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

O cabeçalho no formato JSON a anexar ao pedido enviado para a função.

queryParameters - Parâmetros de consulta
string.

A consulta de cadeia de carateres a acrescentar ao URL da função. Não pode começar com ? ou &.

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

O corpo do pedido no formato JSON.

waitForCompletion - Concluído com base em
string. Obrigatório. Valores permitidos: true (Chamada de Retorno), false (ApiResponse). Valor predefinido: false.

Como a tarefa comunica a conclusão.

false - Resposta da API – a função devolve critérios de êxito e êxito avaliados como verdadeiros.
true - Chamada de retorno - a função faz uma chamada de retorno para atualizar o registo da linha cronológica.

successCriteria - Critérios de êxito
string. Opcional. Utilize quando waitForCompletion = false.

Os critérios para uma tarefa com êxito. Por predefinição, a tarefa devolve 200 OK o estado quando for 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 controlo de tarefas

Todas as tarefas têm opções de controlo para além das entradas de tarefas. Para obter mais informações, veja Opções de controlo e propriedades de tarefas comuns.

Variáveis de saída

Nenhum.

Observações

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

Requisitos

Requisito	Description
Tipos de pipeline	Versão clássica
É executado em	Server, ServerGate
Exigências	Nenhuma
Capacidades	Esta tarefa não satisfaz quaisquer exigências para tarefas subsequentes na tarefa.
Restrições de comandos	Qualquer
Variáveis de definição	Qualquer
Versão do agente	Todas as versões de agente suportadas.
Categoria da tarefa	Utilitário

Ver também

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

Partilhar via