Azure İşlevleri için Azure Blob depolama giriş bağlaması

Python v2 programlama modeli, doğrudan Python işlev kodunuzda dekoratörleri kullanarak bağlamaları tanımlamanıza olanak tanır. Daha fazla bilgi için bkz . Python geliştirici kılavuzu.

Python v1 programlama modeli, işlev klasöründeki ayrı bir function.json dosyasında bağlamaları tanımlamanızı gerektirir. Daha fazla bilgi için bkz . Python geliştirici kılavuzu.

Aşağıdaki örnek, yalıtılmış bir çalışan işleminde çalışan ve hem blob girişi hem de blob çıkış blob bağlamaları ile blob tetikleyicisi kullanan bir C# işlevidir . İşlev, test-samples-trigger kapsayıcısında bir blob oluşturularak tetikleniyor. Test-samples-input kapsayıcısından bir metin dosyası okur ve tetiklenen dosyanın adına göre çıkış kapsayıcısında yeni bir metin dosyası oluşturur.

    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";
        }
    }
}

Aşağıdaki örnek, kuyruk tetikleyicisi ve giriş blob bağlaması kullanan bir C# işlevidir. Kuyruk iletisi blobun adını içerir ve işlev blobun boyutunu günlüğe kaydeder.

[FunctionName("BlobInput")]
public static void Run(
    [QueueTrigger("myqueue-items")] string myQueueItem,
    [Blob("samples-workitems/{queueTrigger}", FileAccess.Read)] Stream myBlob,
    ILogger log)
{
    log.LogInformation($"BlobInput processed blob\n Name:{myQueueItem} \n Size: {myBlob.Length} bytes");
}

Aşağıdaki örnekte, bir blobun kopyasını oluşturan kuyruk tarafından tetiklenen TypeScript işlevi gösterilmektedir. İşlev, kopyalanacak blobun adını içeren bir kuyruk iletisiyle tetikleniyor. Yeni blob {originalblobname}-Copy olarak adlandırılır.

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

Model v3 için TypeScript örnekleri belgelenmez.

Aşağıdaki örnekte, bir blobun kopyasını oluşturan kuyruk tarafından tetiklenen JavaScript işlevi gösterilmektedir. İşlev, kopyalanacak blobun adını içeren bir kuyruk iletisiyle tetikleniyor. Yeni blob {originalblobname}-Copy olarak adlandırılır.

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

Aşağıdaki örnekte, function.json dosyasındaki blob giriş ve çıkış bağlamaları ve bağlamaları kullanan JavaScript kodu gösterilmektedir. işlevi bir blobun kopyasını oluşturur. İşlev, kopyalanacak blobun adını içeren bir kuyruk iletisiyle tetikleniyor. Yeni blob {originalblobname}-Copy olarak adlandırılır.

function.json dosyasında meta veri özelliği, queueTrigger özelliklerde path blob adını belirtmek için kullanılır:

{
  "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
}

Yapılandırma bölümünde bu özellikler açıklanır.

JavaScript kodu şu şekildedir:

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

Bu örnek, Blob depolama giriş bağlaması tarafından sağlanan temel alınan BlobClient nesneye doğrudan erişmek için SDK türlerini kullanır:

import logging

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

app = func.FunctionApp(http_auth_level=func.AuthLevel.ANONYMOUS)
@app.route(route="file")
@app.blob_input(
    arg_name="client", path="PATH/TO/BLOB", connection="AzureWebJobsStorage"
)
def blob_input(req: func.HttpRequest, client: blob.BlobClient):
    logging.info(
        f"Python blob input function processed blob \n"
        f"Properties: {client.get_blob_properties()}\n"
        f"Blob content head: {client.download_blob().read(size=1)}"
    )
    return "ok"

Diğer SDK türlerini kullanma örnekleri için ve StorageStreamDownloader örneklerine ContainerClient bakın.

Projenizde SDK türü bağlamalarını etkinleştirme de dahil olmak üzere daha fazla bilgi edinmek için bkz . SDK türü bağlamaları.

Kod bir blobun kopyasını oluşturur.

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"

işlevi bir blobun kopyasını oluşturur. İşlev, kopyalanacak blobun adını içeren bir kuyruk iletisiyle tetikleniyor. Yeni blob {originalblobname}-Copy olarak adlandırılır.

function.json dosyasında meta veri özelliği, queueTrigger özelliklerde path blob adını belirtmek için kullanılır:

{
  "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": "$return",
      "type": "blob",
      "path": "samples-workitems/{queueTrigger}-Copy",
      "connection": "MyStorageConnectionAppSetting",
      "direction": "out"
    }
  ],
  "disabled": false,
  "scriptFile": "__init__.py"
}

Yapılandırma bölümünde bu özellikler açıklanır.

dataType özelliği hangi bağlamanın kullanıldığını belirler. Farklı bağlama stratejilerini desteklemek için aşağıdaki değerler kullanılabilir:

dataType özelliği function.json içinde tanımlanmamışsa, varsayılan değer olurstring.

Python kodu şu şekildedir:

import logging
import azure.functions as func


# The input binding field inputblob can either be 'bytes' or 'str' depends
# on dataType in function.json, 'binary' or 'string'.
def main(queuemsg: func.QueueMessage, inputblob: bytes) -> bytes:
    logging.info(f'Python Queue trigger function processed {len(inputblob)} bytes')
    return inputblob

Yalıtılmış çalışan işlemi, aşağıdaki parametreleri alan bir öznitelik kullanarak bir BlobInputAttribute giriş bağlaması tanımlar:

C# sınıf kitaplıklarında, aşağıdaki parametreleri alan BlobAttribute'u kullanın:

Aşağıdaki örnek, özniteliğin oluşturucusunun blob yolunu nasıl izlediğini ve giriş bağlaması için okunduğunu gösteren bir FileAccess parametreyi gösterir:

[FunctionName("BlobInput")]
public static void Run(
    [QueueTrigger("myqueue-items")] string myQueueItem,
    [Blob("samples-workitems/{queueTrigger}", FileAccess.Read)] Stream myBlob,
    ILogger log)
{
    log.LogInformation($"BlobInput processed blob\n Name:{myQueueItem} \n Size: {myBlob.Length} bytes");
}

Özniteliği bir Connection özellik alırken depolama hesabı bağlantısı belirtmek için StorageAccountAttribute'u da kullanabilirsiniz. Kitaplıktaki diğer işlevlerden farklı bir depolama hesabı kullanmanız gerektiğinde bunu yapabilirsiniz. Oluşturucu, depolama bağlantı dizesi içeren bir uygulama ayarının adını alır. Özniteliği parametre, yöntem veya sınıf düzeyinde uygulanabilir. Aşağıdaki örnekte sınıf düzeyi ve yöntem düzeyi gösterilmektedir:

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

Kullanılacak depolama hesabı aşağıdaki sırayla belirlenir:

• Tetikleyici veya bağlama özniteliğinin Connection özelliği.
• Tetikleyici StorageAccount veya bağlama özniteliğiyle aynı parametreye uygulanan öznitelik.
• StorageAccount İşleve uygulanan öznitelik.
• StorageAccount sınıfına uygulanan öznitelik.
• uygulama ayarında AzureWebJobsStorage tanımlanan işlev uygulaması için varsayılan depolama hesabı.

Aşağıdaki tabloda, yöntemine geçirilen input.storageBlob() nesnede options ayarlayabileceğiniz özellikler açıklanmaktadır.

Aşağıdaki tabloda, function.json dosyasında ayarladığınız bağlama yapılandırma özellikleri açıklanmaktadır.

İşlevin tek bir blobu işlemesini istediğinizde, blob giriş bağlaması aşağıdaki türlere bağlanabilir:

İşlevin bir kapsayıcıdan birden çok blobu işlemesini istediğinizde, blob giriş bağlaması aşağıdaki türlere bağlanabilir:

¹ Bu türleri kullanmak için Microsoft.Azure.Functions.Worker.Extensions.Storage.Blobs 6.0.0 veya sonraki sürümlerine ve SDK türü bağlamaları için ortak bağımlılıklara başvurmanız gerekir.

Desteklenen türlerin listesi için bkz. Bağlama türleri.

kullanarak context.extraInputs.get()blob verilerine erişin.

function.json özelliğinde belirtilen değeri kullanarak context.bindings.<name> <name> blob verilerine name erişin.