AzureFunction@0 - 调用 Azure Function v0 任务

在发布管道 无代理作业中使用此任务,在函数应用中调用 HTTP 触发的函数并分析响应。 必须在 Azure Functions 中创建和托管函数应用。

语法

# 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.

输入

function - Azure 函数 URL
string。 必填。

要调用的 Azure 函数的 URL。 示例:https://azurefunctionapp.azurewebsites.net/api/HttpTriggerJS1


key - 函数密钥
string。 必填。

用于访问和调用函数的函数或主机密钥。 若要保护密钥安全,请使用机密管道变量来存储函数密钥。 示例:$(myFunctionKey)myFunctionKey 是一个环境级机密变量,其值作为密钥。


method - 方法
string。 必填。 允许的值:OPTIONSGETHEADPOSTPUTDELETETRACEPATCH。 默认值:POST

将调用函数的 HTTP 方法。


headers - 标头
string。 默认值:{\n"Content-Type":"application/json"\n}

要附加到发送到函数的请求的 JSON 格式的标头。


queryParameters - 查询参数
string

要追加到函数 URL 的字符串查询。 不得以 ?&开头。


body - 正文
string。 可选。 当 method != GET && method != HEAD时使用。 默认值:{"JobId": "$(system.jobId)", "PlanId": "$(system.planId)", "TimelineId": "$(system.timelineId)", "ProjectId": "$(system.teamProjectId)", "VstsUrl": "$(system.CollectionUri)","AuthToken": "$(system.AccessToken)"}

JSON 格式的请求正文。


基于完成 waitForCompletion -
string。 必填。 允许的值:true(回调)、false(ApiResponse)。 默认值:false

任务如何报告完成。

  • false - API 响应 - 函数返回成功条件,成功条件的计算结果为 true。
  • true - 回调 - 函数发出回调以更新时间线记录。

successCriteria - 成功条件
string。 可选。 当 waitForCompletion = false时使用。

成功任务的条件。 默认情况下,任务在成功时返回 200 OK 状态。

示例:对于响应 {"status" : "successful"},表达式可以 eq(root['status'], 'successful')。 详细了解如何 指定条件


任务控制选项

除任务输入之外,所有任务都具有控制选项。 有关详细信息,请参阅 控件选项和常见任务属性

输出变量

没有。

注解

AzureFunction@2 是调用 Azure 函数任务的较新版本。

要求

要求 说明
管道类型 经典版本
运行时间 Server、ServerGate
需求 没有
功能 此任务不满足作业中后续任务的任何要求。
命令限制 任何
Settable 变量 任何
代理版本 所有支持的代理版本。
任务类别 效用

另请参阅