AzureFunction@0 - 叫用 Azure 函式 v0 工作

文章
07/02/2024

在發行管線的無代理程式作業中使用這項工作，在函式應用程式中叫用 HTTP 觸發的函式，並剖析回應。函式應用程式必須建立並裝載于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.

輸入

function - Azure 函式 URL
string. 必要。

要叫用之 Azure 函式的 URL。範例： https://azurefunctionapp.azurewebsites.net/api/HttpTriggerJS1.

key - 函式索引鍵
string. 必要。

用來存取和叫用函式的函式或主機金鑰。若要保護金鑰安全，請使用秘密管線變數來儲存函式金鑰。範例： $(myFunctionKey). myFunctionKey 是環境層級的秘密變數，其值為秘密金鑰。

method - 方法
string. 必要。允許的值： OPTIONS 、、 GET 、 HEAD 、 POSTPUT 、 DELETE 、、 TRACEPATCH 。預設值：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
要求	無
Capabilities	此工作不符合作業中後續工作的任何需求。
命令限制	任意
Settable 變數	任意
代理程式版本	所有支援的代理程式版本。
工作類別	公用程式

另請參閱

AzureFunction@2 是較新版本的叫用 Azure 函式工作。

分享方式：