Azure FunctionsのAzure Blob storage トリガー

Python v2 プログラミング モデルでは、Python 関数コードでデコレーターを使用してバインドを直接定義できます。 詳細については、「Python 開発者ガイド」を参照してください。

Python v1 プログラミング モデルでは、関数フォルダー内の個別の function.json ファイルでバインドを定義する必要があります。 詳細については、「Python 開発者ガイド」を参照してください。

次の例は C# 関数であり、分離ワーカー プロセスで実行され、BLOB 入力と BLOB 出力の両方の BLOB バインドを持つ BLOB トリガーを使用します。 この関数は、test-sample-trigger コンテナーの BLOB の作成によってトリガーされます。 test-samples-input コンテナーからテキスト ファイルを読み取り、トリガーされたファイルの名前に基づいて、出力コンテナーに新しいテキスト ファイルを作成します。

public static class BlobFunction
{
    [Function(nameof(BlobFunction))]
    [BlobOutput("test-samples-output/{name}-output.txt")]
    public static string Run(
        [BlobTrigger("test-samples-trigger/{name}")] string myTriggerItem,
        [BlobInput("test-samples-input/sample1.txt")] string myBlob,
        FunctionContext context)
    {
        var logger = context.GetLogger("BlobFunction");
        logger.LogInformation("Triggered Item = {myTriggerItem}", myTriggerItem);
        logger.LogInformation("Input Item = {myBlob}", myBlob);

        // Blob Output
        return "blob-output content";
    }
}

次の例は、 コンテナーで BLOB が追加または更新されたときにログを書き込む samples-workitemsを示しています。

[FunctionName("BlobTriggerCSharp")]        
public static void Run([BlobTrigger("samples-workitems/{name}")] Stream myBlob, string name, ILogger log)
{
    log.LogInformation($"C# Blob trigger function Processed blob\n Name:{name} \n Size: {myBlob.Length} Bytes");
}

BLOB トリガー パス samples-workitems/{name} 内の文字列 {name}は、binding 式を作成します。この式を関数コードで使用して、トリガーする BLOB のファイル名をaccessできます。 詳しくは、後述の「BLOB 名のパターン」をご覧ください。

BlobTrigger 属性の詳細については、「属性」を参照してください。

この例では、Storage BLOB トリガーと HTTP トリガーの入力バインドの両方から BlobClient を取得する方法を示します。

import "@azure/functions-extensions-blob"; // This is the mandatory first import for SDK binding
import { StorageBlobClient } from "@azure/functions-extensions-blob";
import { app, InvocationContext } from "@azure/functions";

export async function storageBlobTrigger(
  blobStorageClient: StorageBlobClient, // SDK binding provides this client
  context: InvocationContext
): Promise<void> {
  context.log(`Blob trigger processing: ${context.triggerMetadata.name}`);

  // Access to full SDK capabilities
  const blobProperties = await blobStorageClient.blobClient.getProperties();
  context.log(`Blob size: ${blobProperties.contentLength}`);

  // Download blob content
  const downloadResponse = await blobStorageClient.blobClient.download();
  context.log(`Content: ${downloadResponse}`);
}

// Register the function
app.storageBlob("storageBlobTrigger", {
  path: "snippets/{name}",
  connection: "AzureWebJobsStorage",
  sdkBinding: true, // Enable SDK binding
  handler: storageBlobTrigger,
});

この例では、HTTP トリガーを使用して、Storage BLOB 入力バインディングの両方から ContainerClient を取得する方法を示します。

import "@azure/functions-extensions-blob"; // This is the mandatory first import for SDK binding
import { StorageBlobClient } from "@azure/functions-extensions-blob";
import {
  app,
  HttpRequest,
  HttpResponseInit,
  input,
  InvocationContext,
} from "@azure/functions";

const blobInput = input.storageBlob({
  path: "snippets",
  connection: "AzureWebJobsStorage",
  sdkBinding: true,
});

export async function listBlobs(
  request: HttpRequest,
  context: InvocationContext
): Promise<HttpResponseInit> {
  // Get input binding for a specific container
  const storageBlobClient = context.extraInputs.get(
    blobInput
  ) as StorageBlobClient;

  // List all blobs in the container
  const blobs = [];
  for await (const blob of storageBlobClient.containerClient.listBlobsFlat()) {
    blobs.push(blob.name);
  }

  return { jsonBody: { blobs } };
}

app.http("listBlobs", {
  methods: ["GET"],
  authLevel: "function",
  extraInputs: [blobInput],
  handler: listBlobs,
});

次の例は、BLOB トリガーの TypeScript コードを示しています。 関数は、samples-workitems コンテナーで BLOB が追加または更新されたときにログを書き込みます。

BLOB トリガー パス samples-workitems/{name} 内の文字列 {name}は、binding 式を作成します。この式を関数コードで使用して、トリガーする BLOB のファイル名をaccessできます。 詳しくは、後述の「BLOB 名のパターン」をご覧ください。

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

export async function storageBlobTrigger1(blob: Buffer, context: InvocationContext): Promise<void> {
    context.log(
        `Storage blob function processed blob "${context.triggerMetadata.name}" with size ${blob.length} bytes`
    );
}

app.storageBlob('storageBlobTrigger1', {
    path: 'samples-workitems/{name}',
    connection: 'MyStorageAccountAppSetting',
    handler: storageBlobTrigger1,
});

TypeScript のサンプルは、モデル v3 には記載されていません。

次の例は、BLOB トリガーの JavaScript コードを示しています。 関数は、samples-workitems コンテナーで BLOB が追加または更新されたときにログを書き込みます。

BLOB トリガー パス samples-workitems/{name} 内の文字列 {name}は、binding 式を作成します。この式を関数コードで使用して、トリガーする BLOB のファイル名をaccessできます。 詳しくは、後述の「BLOB 名のパターン」をご覧ください。

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

app.storageBlob('storageBlobTrigger1', {
    path: 'samples-workitems/{name}',
    connection: 'MyStorageAccountAppSetting',
    handler: (blob, context) => {
        context.log(
            `Storage blob function processed blob "${context.triggerMetadata.name}" with size ${blob.length} bytes`
        );
    },
});

次の例は、function.json ファイルの BLOB トリガー バインドと、バインドを使用する JavaScript コードを示しています。 関数は、samples-workitems コンテナーで BLOB が追加または更新されたときにログを書き込みます。

function.json ファイルを次に示します。

{
    "disabled": false,
    "bindings": [
        {
            "name": "myBlob",
            "type": "blobTrigger",
            "direction": "in",
            "path": "samples-workitems/{name}",
            "connection":"MyStorageAccountAppSetting"
        }
    ]
}

BLOB トリガー パス samples-workitems/{name} 内の文字列 {name}は、binding 式を作成します。この式を関数コードで使用して、トリガーする BLOB のファイル名をaccessできます。 詳しくは、後述の「BLOB 名のパターン」をご覧ください。

function.json ファイル プロパティについて詳しくは、これらのプロパティについて説明している「構成」セクションをご覧ください。

JavaScript コードを次に示します。

module.exports = async function(context) {
    context.log('Node.js Blob trigger function processed', context.bindings.myBlob);
};

この例では、SDK 型を使用して、Blob storage トリガーによって提供される基になる BlobClient オブジェクトを直接accessします。

import azure.functions as func
import azurefunctions.extensions.bindings.blob as blob

app = func.FunctionApp(http_auth_level=func.AuthLevel.FUNCTION)
@app.blob_trigger(
    arg_name="client", path="PATH/TO/BLOB", connection="AzureWebJobsStorage"
)
def blob_trigger(client: blob.BlobClient):
    logging.info(
        f"Python blob trigger function processed blob \n"
        f"Properties: {client.get_blob_properties()}\n"
        f"Blob content head: {client.download_blob().read(size=1)}"
    )

他の SDK の種類の使用例については、ContainerClient および StorageStreamDownloader サンプルを参照してください。 関数アプリに SDK 型のバインドを含める方法の詳細なチュートリアルについては、Python SDK Bindings for BLOB サンプルに従ってください。

他の SDK 型バインドがサポートされているものも含め、詳細については、 SDK の型バインドに関するページを参照してください。

この例では、受信 BLOB トリガーの BLOB 名とサイズをログに記録します。

import logging
import azure.functions as func

app = func.FunctionApp()

@app.function_name(name="BlobTrigger1")
@app.blob_trigger(arg_name="myblob", 
                  path="samples-workitems/{name}",
                  connection="MyStorageAccountAppSetting")
def test_function(myblob: func.InputStream):
   logging.info(f"Python blob trigger function processed blob \n"
                f"Name: {myblob.name}\n"
                f"Blob Size: {myblob.length} bytes")

この関数は、samples-workitemscontainer で BLOB が追加または更新されたときにログを書き込みます。 function.json ファイルを次に示します。

{
    "scriptFile": "__init__.py",
    "disabled": false,
    "bindings": [
        {
            "name": "myblob",
            "type": "blobTrigger",
            "direction": "in",
            "path": "samples-workitems/{name}",
            "connection":"MyStorageAccountAppSetting"
        }
    ]
}

BLOB トリガー パス samples-workitems/{name} 内の文字列 {name}は、binding 式を作成します。この式を関数コードで使用して、トリガーする BLOB のファイル名をaccessできます。 詳しくは、後述の「BLOB 名のパターン」をご覧ください。

function.json ファイル プロパティについて詳しくは、これらのプロパティについて説明している「構成」セクションをご覧ください。

Python コードを次に示します。

import logging
import azure.functions as func


def main(myblob: func.InputStream):
    logging.info('Python Blob trigger function processed %s', myblob.name)

メソッド シグネチャでの BlobTrigger 属性を次に示します。

[Function(nameof(BlobFunction))]
[BlobOutput("test-samples-output/{name}-output.txt")]
public static string Run(
    [BlobTrigger("test-samples-trigger/{name}")] string myTriggerItem,
    [BlobInput("test-samples-input/sample1.txt")] string myBlob,
    FunctionContext context)

C# クラス ライブラリの属性のコンストラクターは、監視するコンテナーを示すパス文字列と、必要に応じて BLOB 名のパターンを受け取ります。 次に例を示します。

[FunctionName("ResizeImage")]
public static void Run(
  [BlobTrigger("sample-images/{name}")] Stream image,
  [Blob("sample-images-md/{name}", FileAccess.Write)] Stream imageSmall)
{
  ....
}

属性は Connection プロパティを受け取りますが、StorageAccountAttribute を使用してstorage アカウント接続を指定することもできます。 これは、ライブラリ内の他の関数とは異なるstorage アカウントを使用する必要がある場合に行うことができます。 コンストラクターは、storage connection stringを含むアプリ設定の名前を受け取ります。 属性は、パラメーター、メソッド、またはクラス レベルで適用できます。 次の例では、クラス レベルとメソッド レベルを示します。

[StorageAccount("ClassLevelStorageAppSetting")]
public static class AzureFunctions
{
    [FunctionName("StorageTrigger")]
    [StorageAccount("FunctionLevelStorageAppSetting")]
    public static void Run( //...
{
    ...
}

使用するstorage アカウントは、次の順序で決定されます。

• トリガーまたはバインド属性の Connection プロパティ。
• トリガーまたはバインド属性と同じパラメーターに適用された StorageAccount 属性。
• 関数に適用される StorageAccount 属性。
• クラスに適用される StorageAccount 属性。
• AzureWebJobsStorage アプリケーション設定で定義されている関数アプリの既定のstorage アカウント。

次の表では、options メソッドに渡される app.storageBlob() オブジェクトに対して設定できるプロパティについて説明します。

次の表は、function.json ファイルで設定したバインド構成のプロパティを説明しています。

次の例に示すように、指定した triggerMetadata オブジェクトの context プロパティからメタデータを取得できます。この場合、コンテナーを含め、トリガーとなる BLOB (blobTrigger) へのパスがログに記録されます。

context.log(`Full blob path: ${context.triggerMetadata.blobTrigger}`);

次の例に示すように、指定した bindingData オブジェクトの context プロパティからメタデータを取得できます。この場合、コンテナーを含め、トリガーとなる BLOB (blobTrigger) へのパスがログに記録されます。

module.exports = async function (context, myBlob) {
    context.log("Full blob path:", context.bindingData.blobTrigger);
};

BLOB トリガーは、次の型にバインドできます。

¹ これらの型を使用するには、Microsoft を参照する必要があります。Azure。Functions.Worker.Extensions。Storage。BLOB 6.0.0 以降および SDK 型バインドのcommon 依存関係。

サポートされている型の一覧については、「Binding 型」を参照してください。

関数の最初の引数として BLOB データをAccessします。

context.bindings.<NAME> を使用して BLOB データをAccessします。<NAME> は、function.json で定義されている値と一致します。