Uitvoerbinding voor Azure Blob Storage voor Azure Functions

Met het Python v2-programmeermodel kunt u bindingen definiëren met behulp van decorators rechtstreeks in uw Python-functiecode. Zie de Ontwikkelaarshandleiding voor Python voor meer informatie.

Voor het Python v1-programmeermodel moet u bindingen definiëren in een afzonderlijk function.json bestand in de functiemap. Zie de Ontwikkelaarshandleiding voor Python voor meer informatie.

Het volgende voorbeeld is een C#-functie die wordt uitgevoerd in een geïsoleerd werkproces en een blobtrigger gebruikt met zowel blob-invoer- als blobuitvoer-blobbindingen. Het aanmaken van een blob in de testsamples-triggercontainer activeert de functie. Het leest een tekstbestand uit de test-samples-invoercontainer en maakt een nieuw tekstbestand in een uitvoercontainer op basis van de naam van het geactiveerde bestand.

using Microsoft.Azure.Functions.Worker;
using Microsoft.Extensions.Logging;

namespace SampleApp
{
    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";
        }
    }
}

Het volgende voorbeeld is een C#-functie die in het proces wordt uitgevoerd en gebruikmaakt van een blobtrigger en twee uitvoerblobbindingen. Het aanmaken van een afbeeldingsblob in de sample-images-container activeert de functie. Er worden kleine en middelgrote kopieën van de afbeeldingsblob gemaakt.

using System.Collections.Generic;
using System.IO;
using Microsoft.Azure.WebJobs;
using SixLabors.ImageSharp;
using SixLabors.ImageSharp.Formats;
using SixLabors.ImageSharp.PixelFormats;
using SixLabors.ImageSharp.Processing;

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

        using (Image<Rgba32> input = Image.Load<Rgba32>(image, out format))
        {
            ResizeImage(input, imageSmall, ImageSize.Small, format);
        }

        image.Position = 0;
        using (Image<Rgba32> input = Image.Load<Rgba32>(image, out format))
        {
            ResizeImage(input, imageMedium, ImageSize.Medium, format);
        }
    }

    public static void ResizeImage(Image<Rgba32> input, Stream output, ImageSize size, IImageFormat format)
    {
        var dimensions = imageDimensionsTable[size];

        input.Mutate(x => x.Resize(dimensions.Item1, dimensions.Item2));
        input.Save(output, format);
    }

    public enum ImageSize { ExtraSmall, Small, Medium }

    private static Dictionary<ImageSize, (int, int)> imageDimensionsTable = new Dictionary<ImageSize, (int, int)>() {
        { ImageSize.ExtraSmall, (320, 200) },
        { ImageSize.Small,      (640, 400) },
        { ImageSize.Medium,     (800, 600) }
    };

}

In het volgende voorbeeld ziet u een door de wachtrij geactiveerde TypeScript-functie waarmee een kopie van een blob wordt gemaakt. Een wachtrijbericht met de naam van de te kopiëren blob activeert de functie. De nieuwe blob heeft de naam {originalblobname}-Copy.

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

const blobInput = input.storageBlob({
    path: 'samples-workitems/{queueTrigger}',
    connection: 'MyStorageConnectionAppSetting',
});

const blobOutput = output.storageBlob({
    path: 'samples-workitems/{queueTrigger}-Copy',
    connection: 'MyStorageConnectionAppSetting',
});

export async function storageQueueTrigger1(queueItem: unknown, context: InvocationContext): Promise<unknown> {
    return context.extraInputs.get(blobInput);
}

app.storageQueue('storageQueueTrigger1', {
    queueName: 'myqueue-items',
    connection: 'MyStorageConnectionAppSetting',
    extraInputs: [blobInput],
    return: blobOutput,
    handler: storageQueueTrigger1,
});

TypeScript-voorbeelden worden niet gedocumenteerd voor model v3.

In het volgende voorbeeld ziet u een door een wachtrij geactiveerde JavaScript-functie waarmee een kopie van een blob wordt gemaakt. Een wachtrijbericht met de naam van de te kopiëren blob activeert de functie. De nieuwe blob heeft de naam {originalblobname}-Copy.

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

const blobInput = input.storageBlob({
    path: 'samples-workitems/{queueTrigger}',
    connection: 'MyStorageConnectionAppSetting',
});

const blobOutput = output.storageBlob({
    path: 'samples-workitems/{queueTrigger}-Copy',
    connection: 'MyStorageConnectionAppSetting',
});

app.storageQueue('storageQueueTrigger1', {
    queueName: 'myqueue-items',
    connection: 'MyStorageConnectionAppSetting',
    extraInputs: [blobInput],
    return: blobOutput,
    handler: (queueItem, context) => {
        return context.extraInputs.get(blobInput);
    },
});

In het volgende voorbeeld ziet u blobinvoer- en uitvoerbindingen in een function.json-bestand en JavaScript-code die gebruikmaakt van de bindingen. De functie maakt een kopie van een blob. Een wachtrijbericht met de naam van de te kopiëren blob activeert de functie. De nieuwe blob heeft de naam {originalblobname}-Copy.

In het function.json-bestand wordt de queueTrigger eigenschap metagegevens gebruikt om de naam van de blob op te geven in de path eigenschappen:

{
  "bindings": [
    {
      "queueName": "myqueue-items",
      "connection": "MyStorageConnectionAppSetting",
      "name": "myQueueItem",
      "type": "queueTrigger",
      "direction": "in"
    },
    {
      "name": "myInputBlob",
      "type": "blob",
      "path": "samples-workitems/{queueTrigger}",
      "connection": "MyStorageConnectionAppSetting",
      "direction": "in"
    },
    {
      "name": "myOutputBlob",
      "type": "blob",
      "path": "samples-workitems/{queueTrigger}-Copy",
      "connection": "MyStorageConnectionAppSetting",
      "direction": "out"
    }
  ],
  "disabled": false
}

In de configuratiesectie worden deze eigenschappen uitgelegd.

Dit is de JavaScript-code:

module.exports = async function(context) {
    context.log('Node.js Queue trigger function processed', context.bindings.myQueueItem);
    context.bindings.myOutputBlob = context.bindings.myInputBlob;
};

Met de code wordt een kopie van een blob gemaakt.

import logging
import azure.functions as func

app = func.FunctionApp()

@app.function_name(name="BlobOutput1")
@app.route(route="file")
@app.blob_input(arg_name="inputblob",
                path="sample-workitems/test.txt",
                connection="<BLOB_CONNECTION_SETTING>")
@app.blob_output(arg_name="outputblob",
                path="newblob/test.txt",
                connection="<BLOB_CONNECTION_SETTING>")
def main(req: func.HttpRequest, inputblob: str, outputblob: func.Out[str]):
    logging.info(f'Python Queue trigger function processed {len(inputblob)} bytes')
    outputblob.set(inputblob)
    return "ok"

De functie maakt een kopie van een blob. Een wachtrijbericht met de naam van de te kopiëren blob activeert de functie. De nieuwe blob heeft de naam {originalblobname}-Copy.

In het function.json-bestand wordt de queueTrigger eigenschap metagegevens gebruikt om de naam van de blob op te geven in de path eigenschappen:

{
  "bindings": [
    {
      "queueName": "myqueue-items",
      "connection": "MyStorageConnectionAppSetting",
      "name": "queuemsg",
      "type": "queueTrigger",
      "direction": "in"
    },
    {
      "name": "inputblob",
      "type": "blob",
      "dataType": "binary",
      "path": "samples-workitems/{queueTrigger}",
      "connection": "MyStorageConnectionAppSetting",
      "direction": "in"
    },
    {
      "name": "outputblob",
      "type": "blob",
      "dataType": "binary",
      "path": "samples-workitems/{queueTrigger}-Copy",
      "connection": "MyStorageConnectionAppSetting",
      "direction": "out"
    }
  ],
  "disabled": false,
  "scriptFile": "__init__.py"
}

In de configuratiesectie worden deze eigenschappen uitgelegd.

Dit is de Python-code:

import logging
import azure.functions as func


def main(queuemsg: func.QueueMessage, inputblob: bytes, outputblob: func.Out[bytes]):
    logging.info(f'Python Queue trigger function processed {len(inputblob)} bytes')
    outputblob.set(inputblob)

De BlobOutputAttribute constructor gebruikt de volgende parameters:

De constructor van het kenmerk BlobAttribute gebruikt de volgende parameters:

In het volgende voorbeeld wordt het pad ingesteld op de blob en een FileAccess parameter die aangeeft dat er schrijfbewerkingen voor een uitvoerbinding worden aangegeven:

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

Hoewel het kenmerk een Connection eigenschap neemt, kunt u ook storageAccountAttribute gebruiken om een opslagaccountverbinding op te geven. U kunt dit doen wanneer u een ander opslagaccount moet gebruiken dan andere functies in de bibliotheek. De constructor gebruikt de naam van een app-instelling die een opslag-verbindingsreeks bevat. Het kenmerk kan worden toegepast op het niveau van de parameter, methode of klasse. In het volgende voorbeeld ziet u klasseniveau en methodeniveau:

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

Het te gebruiken opslagaccount wordt in de volgende volgorde bepaald:

• De eigenschap van Connection het trigger- of bindingskenmerk.
• Het StorageAccount kenmerk dat is toegepast op dezelfde parameter als het trigger- of bindingskenmerk.
• Het StorageAccount kenmerk dat is toegepast op de functie.
• Het StorageAccount kenmerk dat is toegepast op de klasse.
• Het standaardopslagaccount voor de functie-app, dat is gedefinieerd in de AzureWebJobsStorage toepassingsinstelling.

In de volgende tabel worden de eigenschappen uitgelegd die u kunt instellen voor het options object dat aan de output.storageBlob() methode is doorgegeven.

In de volgende tabel worden de bindingsconfiguratie-eigenschappen uitgelegd die u in het function.json-bestand hebt ingesteld.

Wanneer u wilt dat de functie naar één blob schrijft, kan de blob-uitvoerbinding worden gekoppeld aan de volgende typen:

Wanneer u wilt dat de functie naar meerdere blobs schrijft, kan de blob-uitvoerbinding worden gekoppeld aan de volgende typen:

Voor andere uitvoerscenario's maakt en gebruikt u rechtstreeks een BlobClient of BlobContainerClient met andere typen van Azure.Storage.Blobs. Zie Azure-clients registreren voor een voorbeeld van het gebruik van afhankelijkheidsinjectie om een clienttype te maken op basis van de Azure SDK.

Zie Bindingstypen voor een lijst met ondersteunde typen.

Open de blobgegevens door de waarde rechtstreeks of met behulp van context.extraOutputs.set()de waarde te retourneren.

Open de blobgegevens met behulp van context.bindings.<name> waar <name> de waarde is opgegeven in de name eigenschap van function.json.