Azure Functions的Azure Blob storage触发器

使用 Python v2 编程模型，可以直接在 Python 函数代码中使用修饰器定义绑定。 有关详细信息，请参阅 Python 开发人员指南。

Python v1 编程模型要求在函数文件夹中的单独 function.json 文件中定义绑定。 有关详细信息，请参阅 Python 开发人员指南。

以下示例是一个 C# 函数，该函数在独立工作进程中运行，并将 blob 触发器与 blob 输入和 blob 输出 blob 绑定配合使用。 在 test-samples-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}创建一个绑定表达式，可用于access触发 blob 的文件名。 有关详细信息，请参阅本文下文中的 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}创建一个绑定表达式，可用于access触发 blob 的文件名。 有关详细信息，请参阅本文下文中的 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,
});

模型 v3 没有记录 TypeScript 示例。

以下示例显示 blob 触发器 JavaScript 代码。 在 samples-workitems 容器中添加或更新 Blob 时，该函数会写入日志。

blob 触发器路径samples-workitems/{name}中的字符串{name}创建一个绑定表达式，可用于access触发 blob 的文件名。 有关详细信息，请参阅本文下文中的 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}创建一个绑定表达式，可用于access触发 blob 的文件名。 有关详细信息，请参阅本文下文中的 Blob 名称模式。

有关 function.json 文件属性的详细信息，请参阅解释了这些属性的配置部分。

JavaScript 代码如下所示：

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

此示例使用 SDK 类型直接access由Blob storage触发器提供的基础 BlobClient 对象：

import logging

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

app = func.FunctionApp(http_auth_level=func.AuthLevel.ANONYMOUS)
@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 类型绑定的分步教程，请遵循适用于 Blob 示例的 Python SDK 绑定。

若要了解详细信息，包括支持其他 SDK 类型绑定的内容，请参阅 SDK 类型绑定。

此示例记录传入 Blob 元数据中的信息。

import logging
import azure.functions as func

app = func.FunctionApp()

@app.function_name(name="BlobTrigger1")
@app.blob_trigger(arg_name="myblob", 
                  path="PATH/TO/BLOB",
                  connection="CONNECTION_SETTING")
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}创建一个绑定表达式，可用于access触发 blob 的文件名。 有关详细信息，请参阅本文下文中的 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 特性。
• 函数应用的默认storage帐户，该帐户在 AzureWebJobsStorage 应用程序设置中定义。

下表说明了可以在传递给 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 类型。

Access blob 数据作为函数的第一个参数。

使用 Access blob 数据，其中与 function.json2 中定义的值匹配。