Visual Studio Code を使用してAzure FunctionsをAzure Storageに接続する

• .NET Core CLI ツールをインストールします。

projectは、extension バンドル を使用するように構成されています。これによって、定義済みの一連の拡張機能パッケージが自動的にインストールされます。

拡張機能バンドルは、projectのルートにある host.json ファイルで既に有効になっています。これは次の例のようになります。

{
  "version": "2.0",
  "extensionBundle": {
    "id": "Microsoft.Azure.Functions.ExtensionBundle",
    "version": "[3.*, 4.0.0)"
  }
}

これで、storage出力バインドをprojectに追加できるようになりました。

projectは、extension バンドル を使用するように構成されています。これによって、定義済みの一連の拡張機能パッケージが自動的にインストールされます。

拡張機能バンドルは、projectのルートにある host.json ファイルで既に有効になっています。これは次の例のようになります。

{
  "version": "2.0",
  "logging": {
    "applicationInsights": {
      "samplingSettings": {
        "isEnabled": true,
        "excludedTypes": "Request"
      }
    }
  },
  "extensionBundle": {
    "id": "Microsoft.Azure.Functions.ExtensionBundle",
    "version": "[4.*, 5.0.0)"
  }
}

これで、storage出力バインドをprojectに追加できるようになりました。

Azure Storage キューに書き込むには:

• バインド構成に extraOutputs プロパティを追加する

  {
      methods: ['GET', 'POST'],
      extraOutputs: [sendToQueue], // add output binding to HTTP trigger
      authLevel: 'function',
      handler: () => {}
  }
  

• output.storageQueue 呼び出しの上に app.http 関数を追加する

  const sendToQueue = output.storageQueue({
    queueName: 'outqueue',
    connection: 'AzureWebJobsStorage',
  });
  

Azure Storage キューに書き込むには:

• バインド構成に extraOutputs プロパティを追加する

  {
      methods: ['GET', 'POST'],
      extraOutputs: [sendToQueue], // add output binding to HTTP trigger
      authLevel: 'function',
      handler: () => {}
  }
  

• output.storageQueue 呼び出しの上に app.http 関数を追加する

  const sendToQueue: StorageQueueOutput = output.storageQueue({
    queueName: 'outqueue',
    connection: 'AzureWebJobsStorage',
  });
  

Functions では、各種のバインドで direction、type、固有の name が必要です。 これらの属性を定義する方法は、関数アプリの言語によって異なります。

バインド属性は、特定の関数の function.json ファイルで定義されます。 バインドの種類によっては、追加のプロパティが必要になることもあります。 キュー出力構成では、Azure Storage キュー バインドに必要なフィールドについて説明します。 この拡張機能により、バインドを簡単に function.json ファイルに追加できます。

バインドを作成するには、HttpTrigger フォルダー内の function.json ファイルを右クリック (macOS では Ctrl キーを押しながらクリック) して、 [バインドの追加] を選択します。プロンプトに従って、新しいバインドの次のバインド プロパティを定義します。

バインドは、bindings の 配列に追加されます。これは次のようになります。

      "name": "msg",
      "queueName": "outqueue",
      "connection": "AzureWebJobsStorage"
    }
  ]
}

バインド属性は、function_app.py ファイル内の特定の関数コードを修飾することによって定義されます。 queue_output デコレーターを使用して、Azure Queue storage出力バインドを追加します。

queue_output デコレーターを使用すると、バインディングの方向は暗黙的に 'out' になり、型は Queue Azure Storageされます。 function_app.pyの関数コードに次のデコレーターを追加します。

@app.queue_output(arg_name="msg", queue_name="outqueue", connection="AzureWebJobsStorage")

このコードでは、arg_name はコードで参照されるバインド パラメーターを識別します。queue_name はバインドが書き込むキューの名前、connection は、Storage アカウントのconnection stringを含むアプリケーション設定の名前です。 クイック スタートでは、AzureWebJobsStorage 設定にある関数アプリと同じstorage アカウントを使用します。 queue_name が存在しない場合は、バインドによって最初に使用されるときに作成されます。

C# projectでは、バインドは関数メソッドのバインド属性として定義されます。 具体的な定義は、お使いのアプリがインプロセス (C# クラス ライブラリ) で実行されるのか、分離ワーカー プロセスで実行されるのかによって異なります。

public class MultiResponse
{
    [QueueOutput("outqueue", Connection = "AzureWebJobsStorage")]
    public string[] Messages { get; set; }
    public IActionResult HttpResponse { get; set; }
}

[Queue("outqueue"),StorageAccount("AzureWebJobsStorage")] ICollector<string> msg,

[FunctionName("HttpExample")]
public static async Task<IActionResult> Run(
    [HttpTrigger(AuthorizationLevel.Function, "get", "post", Route = null)] HttpRequest req, 
    [Queue("outqueue"),StorageAccount("AzureWebJobsStorage")] ICollector<string> msg, 
    ILogger log)

Java projectでは、バインドは関数メソッドのバインド注釈として定義されます。 その後、これらの注釈に基づいて function.json ファイルが自動的に生成されます。

src/main/java で関数コードの場所を参照し、Function.java project ファイルを開き、run メソッド定義に次のパラメーターを追加します。

@QueueOutput(name = "msg", queueName = "outqueue", 
connection = "AzureWebJobsStorage") OutputBinding<String> msg,

msg パラメーターは、OutputBinding<T> 型です。これは、関数の完了時に出力バインドにメッセージとして書き込まれる文字列のコレクションを表します。 この場合、出力は outqueue という名前のstorage キューです。 Storage アカウントのconnection stringは、connection メソッドによって設定されます。 connection string自体ではなく、Storage アカウントを含むアプリケーション設定をconnection string渡します。

run メソッドの定義は次の例のようになります。

@FunctionName("HttpExample")
public HttpResponseMessage run(
        @HttpTrigger(name = "req", methods = {HttpMethod.GET, HttpMethod.POST}, authLevel = AuthorizationLevel.ANONYMOUS) 
        HttpRequestMessage<Optional<String>> request, 
        @QueueOutput(name = "msg", queueName = "outqueue", 
        connection = "AzureWebJobsStorage") OutputBinding<String> msg, 
        final ExecutionContext context) {

context.extraOutputs の出力バインド オブジェクトを使用してキュー メッセージを作成するコードを追加します。 このコードを return ステートメントの前に追加します。

context.extraOutputs.set(sendToQueue, [msg]);

この時点で、関数は次のようになります。

const { app, output } = require('@azure/functions');

const sendToQueue = output.storageQueue({
  queueName: 'outqueue',
  connection: 'AzureWebJobsStorage',
});

app.http('HttpExample', {
  methods: ['GET', 'POST'],
  authLevel: 'anonymous',
  extraOutputs: [sendToQueue],
  handler: async (request, context) => {
    try {
      context.log(`Http function processed request for url "${request.url}"`);

      const name = request.query.get('name') || (await request.text());
      context.log(`Name: ${name}`);

      if (name) {
        const msg = `Name passed to the function ${name}`;
        context.extraOutputs.set(sendToQueue, [msg]);
        return { body: msg };
      } else {
        context.log('Missing required data');
        return { status: 404, body: 'Missing required data' };
      }
    } catch (error) {
      context.log(`Error: ${error}`);
      return { status: 500, body: 'Internal Server Error' };
    }
  },
});

context.extraOutputs の出力バインド オブジェクトを使用してキュー メッセージを作成するコードを追加します。 このコードを return ステートメントの前に追加します。

context.extraOutputs.set(sendToQueue, [msg]);

この時点で、関数は次のようになります。

import {
  app,
  output,
  HttpRequest,
  HttpResponseInit,
  InvocationContext,
  StorageQueueOutput,
} from '@azure/functions';

const sendToQueue: StorageQueueOutput = output.storageQueue({
  queueName: 'outqueue',
  connection: 'AzureWebJobsStorage',
});

export async function HttpExample(
  request: HttpRequest,
  context: InvocationContext,
): Promise<HttpResponseInit> {
  try {
    context.log(`Http function processed request for url "${request.url}"`);

    const name = request.query.get('name') || (await request.text());
    context.log(`Name: ${name}`);

    if (name) {
      const msg = `Name passed to the function ${name}`;
      context.extraOutputs.set(sendToQueue, [msg]);
      return { body: msg };
    } else {
      context.log('Missing required data');
      return { status: 404, body: 'Missing required data' };
    }
  } catch (error) {
    context.log(`Error: ${error}`);
    return { status: 500, body: 'Internal Server Error' };
  }
}

app.http('HttpExample', {
  methods: ['GET', 'POST'],
  authLevel: 'anonymous',
  handler: HttpExample,
});

Push-OutputBinding コマンドレットと msg 出力バインディングを使用してキューにテキストを書き込むコードを追加します。 if ステートメントで OK ステータスを設定する前に、このコードを追加してください。

$outputMsg = $name
Push-OutputBinding -name msg -Value $outputMsg

この時点で、関数は次のようになるはずです。

using namespace System.Net

# Input bindings are passed in via param block.
param($Request, $TriggerMetadata)

# Write to the Azure Functions log stream.
Write-Host "PowerShell HTTP trigger function processed a request."

# Interact with query parameters or the body of the request.
$name = $Request.Query.Name
if (-not $name) {
    $name = $Request.Body.Name
}

if ($name) {
    # Write the $name value to the queue, 
    # which is the name passed to the function.
    $outputMsg = $name
    Push-OutputBinding -name msg -Value $outputMsg

    $status = [HttpStatusCode]::OK
    $body = "Hello $name"
}
else {
    $status = [HttpStatusCode]::BadRequest
    $body = "Please pass a name on the query string or in the request body."
}

# Associate values to output bindings by calling 'Push-OutputBinding'.
Push-OutputBinding -Name Response -Value ([HttpResponseContext]@{
    StatusCode = $status
    Body = $body
})

次のコードに合わせて HttpExample\function_app.py を更新し、関数の定義に msg パラメーターを、msg.set(name) ステートメントの下に if name: を追加してください。

import azure.functions as func
import logging

app = func.FunctionApp(http_auth_level=func.AuthLevel.ANONYMOUS)

@app.route(route="HttpExample")
@app.queue_output(arg_name="msg", queue_name="outqueue", connection="AzureWebJobsStorage")
def HttpExample(req: func.HttpRequest, msg: func.Out [func.QueueMessage]) -> func.HttpResponse:
    logging.info('Python HTTP trigger function processed a request.')

    name = req.params.get('name')
    if not name:
        try:
            req_body = req.get_json()
        except ValueError:
            pass
        else:
            name = req_body.get('name')

    if name:
        msg.set(name)
        return func.HttpResponse(f"Hello, {name}. This HTTP triggered function executed successfully.")
    else:
        return func.HttpResponse(
             "This HTTP triggered function executed successfully. Pass a name in the query string or in the request body for a personalized response.",
             status_code=200
        )

msg パラメーターは、azure.functions.Out classのインスタンスです。 set メソッドはキューに文字列メッセージを書き込みます。 この場合は、URL クエリ文字列の中で関数に渡される name です。

これで、新しい msg パラメーターを使用して、関数コードから出力バインドに書き込むことができます。 成功応答の前に次のコード行を追加して、name の値を msg 出力バインドに追加します。

msg.setValue(name);

出力バインドを使用する場合、認証、キュー参照の取得、データの書き込みに Azure Storage SDK コードを使用する必要はありません。 Functions ランタイムおよびキューの出力バインドが、ユーザーに代わってこれらのタスクを処理します。

run メソッドは次の例のようになります。

@FunctionName("HttpExample")
public HttpResponseMessage run(
        @HttpTrigger(name = "req", methods = {HttpMethod.GET, HttpMethod.POST}, authLevel = AuthorizationLevel.ANONYMOUS) 
        HttpRequestMessage<Optional<String>> request, 
        @QueueOutput(name = "msg", queueName = "outqueue", 
        connection = "AzureWebJobsStorage") OutputBinding<String> msg, 
        final ExecutionContext context) {
    context.getLogger().info("Java HTTP trigger processed a request.");

    // Parse query parameter
    String query = request.getQueryParameters().get("name");
    String name = request.getBody().orElse(query);

    if (name == null) {
        return request.createResponseBuilder(HttpStatus.BAD_REQUEST)
        .body("Please pass a name on the query string or in the request body").build();
    } else {
        // Write the name to the message queue. 
        msg.setValue(name);

        return request.createResponseBuilder(HttpStatus.OK).body("Hello, " + name).build();
    }
}

テストを更新する

アーキタイプはテストのセットも作成するため、msg メソッド シグネチャ内の新しい run パラメーターを処理するためにこれらのテストを更新する必要があります。

src/test/java でテスト コードの場所を参照し、Function.java project ファイルを開き、//Invoke のコード行を次のコードに置き換えます。

@SuppressWarnings("unchecked")
final OutputBinding<String> msg = (OutputBinding<String>)mock(OutputBinding.class);
final HttpResponseMessage ret = new Function().run(req, msg, context);

関数をローカルで実行する

Visual Studio Code は Azure Functions Core ツール と統合され、Azureに発行する前にローカル開発コンピューターでこのprojectを実行できます。 Core Tools をローカルにまだインストールしていない場合は、projectを初めて実行するときにインストールするように求められます。

1. 関数を呼び出すには、F5 を押して関数アプリのprojectを開始します。 ターミナル パネルに、Core Tools からの出力が表示されます。 アプリがターミナル パネルで起動します。 HTTP によってトリガーされる関数の URL エンドポイントがローカルで実行されていることを確認できます。

   Code output.Visual Studio Code output.

   Core Tools がまだインストールされていない場合は、Install を選択し、To doプロンプトが表示されたら Core Tools をインストールします。
   Windows で実行できない場合は、Visual Studio Code の既定のターミナルが WSL Bash に設定されていないことを確認してください。

2. Core Tools が実行されたら、Azure: Functions 領域に移動します。 Functions で、Local Project>Functions を展開します。 関数を右クリック (Windows) または HttpExample キーを押しながらクリック (macOS) して、[Execute Function Now]\(今すぐ関数を実行\) を選択します。

   Visual Studio Code.

3. [Enter request body] (要求本文を入力してください) で、Enter キーを押して要求メッセージを関数に送信します。

4. 関数がローカルで実行され、応答を返すと、Visual Studio Code で通知が発生します。 関数の実行に関する情報は、ターミナル パネルに表示されます。

5. Ctrl + C キーを押して Core Tools を停止し、デバッガーの接続を解除します。

関数をローカルで実行する

1. 前の記事と同様に、F5 を押して、関数アプリのprojectと Core Tools を起動します。

2. Core Tools が実行されたら、Azure: Functions 領域に移動します。 Functions で、Local Project>Functions を展開します。 HttpExample 関数を右クリック (Mac では Ctrl キーを押しながらクリック) し、[Execute Function Now...] (今すぐ関数を実行...) を選択します。

   Visual Studio Code.

3. Enter 要求本文には、{ "name": "Azure" } の要求メッセージ本文の値が表示されます。 Enter キーを押して、この要求メッセージを関数に送信します。

4. 応答が返されたら、Ctrl + C キーを押して Core Tools を停止します。

storage connection stringを使用しているため、関数はローカルで実行するときにAzure storage アカウントに接続します。 出力バインドが最初に使用されるときに、storage アカウントに outqueue という名前の新しいキューが作成されます。 Storage Explorerを使用して、キューが新しいメッセージと共に作成されたことを確認します。

• C#。

• Azure Functions C# 開発者向けリファレンス

• JavaScript の完全な関数プロジェクトのサンプル。

• Azure Functions JavaScript 開発者ガイド

• Java の完全な関数プロジェクトのサンプル。

• Azure Functions Java 開発者ガイド

• TypeScript の完全な関数プロジェクトのサンプル。

• Azure Functions TypeScript 開発者ガイド

• Python の完全な関数プロジェクトのサンプル。

• Azure Functions Python 開発者ガイド

• PowerShell の完全な関数プロジェクトのサンプル。

• Azure Functions PowerShell 開発者ガイド