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. 必須です。 使用できる値: OPTIONS、GET、、、HEAD、POSTPUT、DELETE、TRACE、 PATCH。 既定値: 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 - Callback - 関数は、タイムライン レコードを更新するためのコールバックを行います。

successCriteria - 成功条件
string. 省略可能。 の場合は waitForCompletion = falseを使用します。

成功したタスクの条件。 既定では、タスクは成功すると状態を 200 OK 返します。

例: 応答 {"status" : "successful"}の場合、式には を指定 eq(root['status'], 'successful')できます。 条件の指定の詳細については、こちらを参照してください。

タスク制御オプション

すべてのタスクには、タスク入力に加えて制御オプションがあります。 詳細については、「 コントロール オプションと一般的なタスク プロパティ」を参照してください。

出力変数

[なし] :

解説

AzureFunction@2 は、Azure 関数の呼び出しタスクの新しいバージョンです。

要件

要件	説明
パイプラインの種類	クラシック リリース
上で実行	Server、ServerGate
確認要求	なし
Capabilities	このタスクは、ジョブ内の後続のタスクに対する要求を満たしていません。
コマンドの制限	Any
設定可能な変数	Any
エージェントのバージョン	サポートされているすべてのエージェント バージョン。
タスクのカテゴリ	ユーティリティ

こちらもご覧ください

• AzureFunction@2 は、Azure 関数の呼び出しタスクの新しいバージョンです。