триггер Azure Blob storage для Azure Functions

Модель программирования Python версии 2 позволяет определять привязки с помощью декораторов непосредственно в коде функции Python. Дополнительные сведения см. в руководстве разработчика Python.

Модель программирования Python версии 1 требует определения привязок в отдельном файле function.json в папке функции. Дополнительные сведения см. в руководстве разработчика Python.

В следующем примере показана функция C#, которая выполняется в изолированном рабочем процессе и использует триггер BLOB-объектов с входными и выходными привязками BLOB-объектов. Эта функция активируется путем создания BLOB-объекта в контейнере test-samples-trigger. Он считывает текстовый файл из контейнера 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";
    }
}

В следующем примере показана функция C#, которая добавляет запись в журнал при добавлении или обновлении большого двоичного объекта в контейнере 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");
}

Строка {name} в пути триггера большого двоичного объекта samples-workitems/{name} создает выражение binding, которое можно использовать в коде функции для access имени файла триггерного большого двоичного объекта. Дополнительные сведения см. в разделе Шаблоны имени большого двоичного объекта.

Дополнительные сведения об атрибуте BlobTrigger см. в разделе Атрибуты.

В этом примере показано, как получить blobClient как из триггера Storage BLOB-объекта, так и из входной привязки для триггера HTTP:

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

В этом примере показано, как получить ContainerClient из Storage входной привязки BLOB-объектов с помощью триггера HTTP:

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.

Строка {name} в пути триггера большого двоичного объекта samples-workitems/{name} создает выражение binding, которое можно использовать в коде функции для access имени файла триггерного большого двоичного объекта. Дополнительные сведения см. в разделе Шаблоны имени большого двоичного объекта.

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 не документируются для модели версии 3.

В следующем примере показан код JavaScript для триггера БОЛЬШОго двоичного объекта. Функция делает запись в журнал при добавлении или обновлении большого двоичного объекта в контейнере samples-workitems.

Строка {name} в пути триггера большого двоичного объекта samples-workitems/{name} создает выражение binding, которое можно использовать в коде функции для access имени файла триггерного большого двоичного объекта. Дополнительные сведения см. в разделе Шаблоны имени большого двоичного объекта.

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 и коде JavaScript, который использует привязку. Функция делает запись в журнал при добавлении или обновлении большого двоичного объекта в контейнере samples-workitems.

Ниже показан файл function.json.

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

Строка {name} в пути триггера большого двоичного объекта samples-workitems/{name} создает выражение binding, которое можно использовать в коде функции для access имени файла триггерного большого двоичного объекта. Дополнительные сведения см. в разделе Шаблоны имени большого двоичного объекта.

Дополнительные сведения о свойствах файла function.json см. в разделе Конфигурация.

Ниже показан код JavaScript.

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

В этом примере типы SDK используются для непосредственного access базового объекта BlobClient, предоставленного триггером Blob storage:

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 Sample.

Дополнительные сведения, включая поддерживаемые другие привязки типов ПАКЕТА SDK, см. в статье о привязках типов пакета SDK.

В этом примере регистрируется имя и размер большого двоичного объекта из входящего триггера БОЛЬШОго двоичного объекта.

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. Ниже показан файл function.json.

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

Строка {name} в пути триггера большого двоичного объекта samples-workitems/{name} создает выражение binding, которое можно использовать в коде функции для access имени файла триггерного большого двоичного объекта. Дополнительные сведения см. в разделе Шаблоны имени большого двоичного объекта.

Дополнительные сведения о свойствах файла 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);
};

Триггер большого двоичного объекта может привязаться к следующим типам:

¹ Чтобы использовать эти типы, необходимо ссылаться на Microsoft. Azure. Functions.Worker.Extensions. Storage. Большие двоичные объекты 6.0.0 или более поздней версии и зависимости common для привязок типов ПАКЕТА SDK.

Список поддерживаемых типов см. в разделе типовBinding.

Access данные больших двоичных объектов в качестве первого аргумента функции.

Access данных BLOB-объектов с помощью context.bindings.<NAME>, где <NAME> соответствует значению, определенному в function.json.