コマンド ライン ツールを使用してAzure FunctionsをAzure Storageに接続する

開始する前に、記事「Quickstart: コマンド ラインから Azure Functions プロジェクトを作成する」を完了する必要があります。 その記事の最後にリソースを既にクリーンアップしている場合は、もう一度手順を実行して、Azureで関数アプリと関連リソースを再作成します。

開始する前に、クイックスタート: コマンドラインから Azure Functions プロジェクトを作成する を完了する必要があります。 その記事の最後にリソースを既にクリーンアップしている場合は、もう一度手順を実行して、Azureで関数アプリと関連リソースを再作成します。

開始する前に、クイックスタート: コマンドラインから Azure Functions プロジェクトを作成するを完了してください。 その記事の最後にリソースを既にクリーンアップしている場合は、もう一度手順を実行して、Azureで関数アプリと関連リソースを再作成します。

開始する前に、「クイックスタート: コマンドラインから Azure Functions プロジェクトを作成する」を完了する必要があります。 その記事の最後にリソースを既にクリーンアップしている場合は、もう一度手順を実行して、Azureで関数アプリと関連リソースを再作成します。

開始する前に、「クイックスタート: コマンドラインから Azure Functions プロジェクトを作成する」を完了させる必要があります。 その記事の最後にリソースを既にクリーンアップしている場合は、もう一度手順を実行して、Azureで関数アプリと関連リソースを再作成します。

開始する前に、「クイックスタート: コマンドラインから Azure Functions プロジェクトを作成する」の記事を完了する必要があります。 その記事の最後にリソースを既にクリーンアップしている場合は、もう一度手順を実行して、Azureで関数アプリと関連リソースを再作成します。

バインディング拡張機能を登録する

HTTP トリガーとタイマー トリガーを除き、バインドは拡張機能パッケージとして実装されます。 ターミナル ウィンドウで次の dotnet add package コマンドを実行して、Storage拡張機能パッケージをprojectに追加します。

dotnet add package Microsoft.Azure.Functions.Worker.Extensions.Storage.Queues --prerelease

dotnet add package Microsoft.Azure.WebJobs.Extensions.Storage 

これで、ストレージ出力バインディングをプロジェクトに追加できるようになりました。

出力バインディングの定義を関数に追加する

1 つの関数に含めることができるトリガーは 1 つだけですが、複数の入力バインドと出力バインドを持つことができます。これにより、カスタム統合コードを記述することなく、他のAzure サービスやリソースに接続できます。

Node.js v4 プログラミング モデルを使用する場合、バインド属性は ./src/functions/HttpExample.js ファイルで直接定義されます。 前のクイックスタートのファイルには、app.http メソッドによって定義された HTTP バインドが既に含まれています。

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

app.http('httpTrigger', {
  methods: ['GET', 'POST'],
  authLevel: 'anonymous',
  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) {
        return { status: 404, body: 'Not Found' };
      }

      return { body: `Hello, ${name}!` };
    } catch (error) {
      context.log(`Error: ${error}`);
      return { status: 500, body: 'Internal Server Error' };
    }
  },
});

Node.js v4 プログラミング モデルを使用する場合、バインド属性は ./src/functions/HttpExample.js ファイルで直接定義されます。 前のクイックスタートのファイルには、app.http メソッドによって定義された HTTP バインドが既に含まれています。

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

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

  const name = request.query.get('name') || (await request.text()) || 'world';

  return { body: `Hello, ${name}!` };
}

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

関数フォルダーの function.json ファイルでそれらのバインディングを宣言します。 前のクイックスタートの HttpExample フォルダーにある function.json ファイルでは、bindings コレクション内に 2 つのバインディングが含まれています。

Python v2 プログラミング モデルを使用する場合、バインド属性はデコレーターとして function_app.py ファイル内で直接定義されます。 function_app.py ファイルには、前のクイック スタートからデコレーター ベースのバインドが既に 1 つ含まれています。

import azure.functions as func
import logging

app = func.FunctionApp()

@app.function_name(name="HttpTrigger1")
@app.route(route="hello", auth_level=func.AuthLevel.ANONYMOUS)

route デコレーターによって、HttpTrigger と HttpOutput バインドが関数に追加され、http 要求が指定されたルートに達したときに関数をトリガーできます。

この関数からAzure Storage キューに書き込むには、queue_output デコレーターを関数コードに追加します。

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

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

"bindings": [
  {
    "authLevel": "function",
    "type": "httpTrigger",
    "direction": "in",
    "name": "Request",
    "methods": [
      "get",
      "post"
    ]
  },
  {
    "type": "http",
    "direction": "out",
    "name": "Response"
  }
]

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

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

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

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

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

コレクションの 2 つ目のバインディングの名前は res です。 この http バインディングは、HTTP 応答の書き込みに使用される出力バインディング (out) です。

この関数からAzure Storage キューに書き込むには、次のコードに示すように、out という名前の queue 型の msg バインディングを追加します。

    {
      "authLevel": "function",
      "type": "httpTrigger",
      "direction": "in",
      "name": "Request",
      "methods": [
        "get",
        "post"
      ]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "Response"
    },
    {
      "type": "queue",
      "direction": "out",
      "name": "msg",
      "queueName": "outqueue",
      "connection": "AzureWebJobsStorage"
    }
  ]
}

queue 型の場合は、queueName でキューの名前を指定し、Azure Storage接続のname (local.settings.json ファイルから) connection に指定する必要があります。

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 メソッドによって設定されます。 接続文字列自体を渡すのではなく、ストレージ アカウントの接続文字列を含むアプリケーションの設定を渡します。

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

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

次のコードに合わせて 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 です。

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
})

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

msg.setValue(name);

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

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

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);

LocalFunctionsProj フォルダーで、func azure functionapp publish コマンドを使用してprojectを再デプロイし、<APP_NAME>をアプリの名前に置き換えます。

func azure functionapp publish <APP_NAME>

ローカル project フォルダーで、次の Maven コマンドを使用してprojectを再発行します。

mvn azure-functions:deploy

• C#。

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

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

• Azure Functions JavaScript 開発者ガイド

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

• Azure Functions TypeScript 開発者ガイド

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

• Azure Functions Python 開発者ガイド

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

• Azure Functions PowerShell 開発者ガイド