AzureFunction@0 - Invocar a tarefa Azure Function v0

Use esta tarefa em um de trabalho sem agente de um pipeline de liberação para invocar uma função acionada HTTP em um aplicativo de função e analisar a resposta. O aplicativo de função 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.

Insumos

URL da função function - Azure
string. Obrigatório.

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

key - Tecla de função
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 chave secreta.

method - Método
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.

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

O cabeçalho em formato JSON a ser anexado à solicitação enviada para a 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 - Completo com base em
string. Obrigatório. Valores permitidos: true (Callback), false (ApiResponse). Valor padrão: false.

Como a tarefa relata a conclusão.

• false - API response - a função retorna success e success criteria é avaliado como true.
• true - Callback - a função faz um retorno de chamada para atualizar o registro da linha do tempo.

successCriteria - Critérios de sucesso
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 controlo de tarefas

Todas as tarefas têm opções de controle, além de suas entradas de tarefas. Para obter mais informações, consulte Opções de controle de 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.

Requerimentos

Requisito	Descrição
Tipos de pipeline	Versão clássica
Funciona em	Servidor, ServerGate
Exigências	Nenhum
Capacidades	Esta tarefa não satisfaz quaisquer exigências para tarefas subsequentes no trabalho.
Restrições de comando	Qualquer
Variáveis configuráveis	Qualquer
Versão do agente	Todas as versões de agente suportadas.
Categoria de tarefa	Utilidade

Ver também

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