次の方法で共有

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.

入力

Azure 関数の URLを function - する
string. 必須。

呼び出される Azure 関数の URL。 例: https://azurefunctionapp.azurewebsites.net/api/HttpTriggerJS1。


key - 関数キーの
string. 必須。

関数にアクセスして関数を呼び出すために使用する関数またはホスト キー。 キーをセキュリティで保護するには、シークレット パイプライン変数を使用して関数キーを格納します。 例: $(myFunctionKey)。 myFunctionKey は、シークレット キーとして値を持つ環境レベルのシークレット変数です。


method - メソッドの
string. 必須。 使用できる値: OPTIONS、GET、HEAD、POST、PUT、DELETE、TRACE、PATCH。 既定値: POST.

関数が呼び出される HTTP メソッド。


headers - ヘッダーの
string. 既定値: {\n"Content-Type":"application/json"\n}.

関数に送信される要求にアタッチされる JSON 形式のヘッダー。


クエリ パラメーターの queryParameters -
string.

関数の URL に追加する文字列クエリ。 ? または &で始めてはなりません。


body - 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 関数呼び出しタスクの新しいバージョンです。

必要条件

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

こちらもご覧ください

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