Trigger služby Azure Blob Storage pro Azure Functions

Trigger služby Blob Storage spustí funkci při zjištění nového nebo aktualizovaného objektu blob. Obsah objektu blob se poskytuje jako vstup funkce.

Podrobnosti o rozdílech mezi dvěma implementacemi triggeru úložiště objektů blob a dalšími možnostmi triggeru najdete v tématu Práce s objekty blob.

Informace o nastavení a konfiguraci najdete v přehledu.

Příklad

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

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

@FunctionName("blobprocessor")
public void run(
  @BlobTrigger(name = "file",
               dataType = "binary",
               path = "myblob/{name}",
               connection = "MyStorageAccountAppSetting") byte[] content,
  @BindingName("name") String filename,
  final ExecutionContext context
) {
  context.getLogger().info("Name: " + filename + " Size: " + content.length + " bytes");
}

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

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

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

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

{
  "bindings": [
    {
      "name": "InputBlob",
      "type": "blobTrigger",
      "direction": "in",
      "path": "source/{name}",
      "connection": "MyStorageAccountConnectionString"
    }
  ]
}

param([byte[]] $InputBlob, $TriggerMetadata)

Write-Host "PowerShell Blob trigger: Name: $($TriggerMetadata.Name) Size: $($InputBlob.Length) bytes"

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

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")

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

import logging
import azure.functions as func


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

[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)

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

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

Kompletní příklady najdete v části Příklad.

public static void Run(string myBlob, string blobTrigger, ILogger log)
{
    log.LogInformation($"Full blob path: {blobTrigger}");
} 

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

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

Využití

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

Propojení

Vlastnost connection je odkazem na konfiguraci prostředí, která určuje, jak se má aplikace připojit k objektům blob Azure. Může zadat:

• Název nastavení aplikace obsahující připojovací řetězec
• Název sdílené předpony pro více nastavení aplikace, společně definující připojení založené na identitě.

Pokud je nakonfigurovaná hodnota přesná shoda pro jedno nastavení i shodu předpony pro jiná nastavení, použije se přesná shoda.

Connection string

Pokud chcete získat připojovací řetězec, postupujte podle kroků uvedených v tématu Správa přístupových klíčů účtu úložiště. Připojovací řetězec musí být pro účet úložiště pro obecné účely, nikoli účet úložiště Blob.

Tato připojovací řetězec by měla být uložena v nastavení aplikace s názvem, který connection odpovídá hodnotě určené vlastností konfigurace vazby.

Pokud název nastavení aplikace začíná na "AzureWebJobs", můžete zde zadat pouze zbytek názvu. Pokud například nastavíte connection "MyStorage", modul runtime Functions vyhledá nastavení aplikace s názvem AzureWebJobsMyStorage. Pokud necháte connection prázdné, modul runtime Služby Functions použije výchozí připojovací řetězec úložiště v nastavení aplikace, které je pojmenované AzureWebJobsStorage.

Připojení založená na identitách

Pokud používáte rozšíření verze 5.x nebo vyšší (sada 3.x nebo vyšší pro non-.NET zásobníky jazyků), místo použití připojovací řetězec s tajným kódem můžete aplikaci použít identitu Microsoft Entra. Pokud chcete použít identitu, definujete nastavení pod běžnou předponou, která se mapuje na connection vlastnost v konfiguraci triggeru a vazby.

Pokud nastavujete connection azureWebJobsStorage, přečtěte si téma Připojení k hostitelskému úložišti pomocí identity. Pro všechna ostatní připojení rozšíření vyžaduje následující vlastnosti:

¹ <CONNECTION_NAME_PREFIX>__blobServiceUri lze použít jako alias. Pokud se konfigurace připojení použije triggerem objektu blob, blobServiceUri musí být doprovázena queueServiceUritaké . Viz níže.

Formulář serviceUri nelze použít, pokud se má použít celková konfigurace připojení napříč objekty blob, frontami a/nebo tabulkami. Identifikátor URI může určit pouze službu blob. Jako alternativu můžete zadat identifikátor URI speciálně pro každou službu, což umožňuje použití jediného připojení. Pokud jsou k dispozici obě verze, použije se formulář s více službami. Pokud chcete nakonfigurovat připojení pro více služeb, nikoli <CONNECTION_NAME_PREFIX>__serviceUrinastavit:

² Trigger objektu blob zpracovává selhání napříč několika opakováními tím, že zapíše otrávené objekty blob do fronty . Ve formuláři serviceUri AzureWebJobsStorage se použije připojení. Při zadávání blobServiceUrivšak musí být k dispozici také identifikátor URI služby fronty queueServiceUri. Doporučujeme používat službu ze stejného účtu úložiště jako služba blob. Musíte také zajistit, aby trigger mohl číst a zapisovat zprávy ve službě nakonfigurované fronty přiřazením role, jako je Přispěvatel dat fronty služby Storage.

Pro přizpůsobení připojení mohou být nastaveny další vlastnosti. Viz Běžné vlastnosti pro připojení založená na identitě.

Při hostovaní ve službě Azure Functions používají připojení založená na identitách spravovanou identitu. Identita přiřazená systémem se používá ve výchozím nastavení, i když je možné zadat identitu přiřazenou uživatelem s vlastnostmi a clientID vlastnostmicredential. Všimněte si, že konfigurace identity přiřazené uživatelem s ID prostředku se nepodporuje . Při spuštění v jiných kontextech, jako je místní vývoj, se místo toho použije vaše identita vývojáře, i když je možné ji přizpůsobit. Viz Místní vývoj s připojeními založenými na identitách.

Udělení oprávnění identitě

Jakákoli identita, kterou používáte, musí mít oprávnění k provedení zamýšlených akcí. U většiny služeb Azure to znamená, že potřebujete přiřadit roli v Azure RBAC pomocí předdefinovaných nebo vlastních rolí, které tato oprávnění poskytují.

Musíte vytvořit přiřazení role, které poskytuje přístup k kontejneru objektů blob za běhu. Role správy, jako je vlastník , nestačí. Následující tabulka ukazuje předdefinované role, které se doporučují při použití rozšíření Blob Storage v normálním provozu. Vaše aplikace může vyžadovat další oprávnění na základě kódu, který napíšete.

¹ Trigger objektu blob zpracovává selhání napříč několika opakováními tím, že zapíše otrávené objekty blob do fronty v účtu úložiště určeném připojením.

² Připojení AzureWebJobsStorage se používá interně pro objekty blob a fronty, které aktivují trigger. Pokud je nakonfigurované tak, aby používalo připojení založené na identitě, potřebuje další oprávnění nad rámec výchozího požadavku. Požadovaná oprávnění jsou pokryta rolemi Vlastník dat objektů blob služby Storage, Přispěvatel dat fronty úložiště a Přispěvatel účtů úložiště. Další informace najdete v tématu Připojení k hostitelskému úložišti pomocí identity.

Vzory názvů objektů blob

Vzor názvu objektu path blob můžete zadat ve vlastnosti v function.json nebo v konstruktoru BlobTrigger atributů. Vzorem názvů může být výraz filtru nebo vazby. Následující části poskytují příklady.

Získání názvu a přípony souboru

Následující příklad ukazuje, jak vytvořit vazbu na název a příponu objektu blob samostatně:

"path": "input/{blobname}.{blobextension}",

Pokud se objekt blob jmenuje original-Blob1.txt, hodnoty proměnných blobextension blobname v kódu funkce jsou original-Blob1 a txt.

Filtrování názvu objektu blob

Následující příklad se aktivuje pouze u objektů blob v kontejneru input , které začínají řetězcem original-:

"path": "input/original-{name}",

Pokud je název objektu blob original-Blob1.txt, hodnota name proměnné v kódu funkce je Blob1.txt.

Filtrovat podle typu souboru

Následující příklad se aktivuje pouze u .png souborů:

"path": "samples/{name}.png",

Filtrování složených závorek v názvech souborů

Chcete-li hledat složené závorky v názvech souborů, uchytejte složené závorky pomocí dvou složených závorek. Následující příklad filtruje objekty blob, které mají složené závorky v názvu:

"path": "images/{{20140101}}-{name}",

Pokud je objekt blob pojmenován {20140101}-soundfile.mp3, name hodnota proměnné v kódu funkce je soundfile.mp3.

Dotazování a latence

Dotazování funguje jako hybridní mezi kontrolou protokolů a spouštěním pravidelných kontrol kontejnerů. Objekty blob se prohledávají ve skupinách po 10 000 s tokenem pokračování používaným mezi intervaly. Pokud je vaše aplikace funkcí v plánu Consumption, může v případě nečinnosti aplikace funkcí dojít až o 10minutové zpoždění při zpracování nových objektů blob.

Pokud potřebujete rychlejší nebo spolehlivější zpracování objektů blob, měli byste zvážit přepnutí hostování na použití plánu služby App Service s povolenou funkcí AlwaysOn, což může vést ke zvýšení nákladů. Můžete také zvážit použití jiného triggeru než klasického triggeru objektu blob dotazování. Další informace a porovnání různých možností triggerů pro kontejnery úložiště objektů blob najdete v tématu Trigger pro kontejner objektů blob.

Potvrzení o objektech blob

Modul runtime Azure Functions zajišťuje, že se pro stejný nový nebo aktualizovaný objekt blob nevolá více než jednou žádná funkce triggeru objektu blob. Pokud chcete zjistit, jestli je daná verze objektu blob zpracována, udržuje účtenky objektů blob.

Azure Functions ukládá účtenky objektů blob do kontejneru s názvem azure-webjobs-hosts v účtu úložiště Azure pro vaši aplikaci funkcí (definované nastavením AzureWebJobsStorageaplikace). Potvrzení o objektu blob obsahuje následující informace:

• Aktivovaná funkce (<FUNCTION_APP_NAME>.Functions.<FUNCTION_NAME>například: MyFunctionApp.Functions.CopyBlob)
• Název kontejneru
• Typ objektu blob (BlockBlob nebo PageBlob)
• Název objektu blob
• Značka ETag (identifikátor verze objektu blob, například: 0x8D1DC6E70A277EF)

Pokud chcete vynutit opětovné zpracování objektu blob, odstraňte účtenku objektu blob pro tento objekt blob z kontejneru azure-webjobs-hosts ručně. I když k opětovnému zpracování nemusí dojít okamžitě, je zaručeno, že dojde k pozdějšímu bodu v čase. K okamžitému zpracování je možné aktualizovat objekt blob scaninfo v azure-webjobs-hosts/blobscaninfo . Všechny objekty blob s časovým razítkem poslední změny po LatestScan opětovné kontrole vlastnosti.

Otrávené objekty blob

Když funkce triggeru objektu blob pro daný objekt blob selže, Azure Functions ve výchozím nastavení opakuje, že tato funkce funguje celkem pětkrát.

Pokud všech 5 pokusů selže, Azure Functions přidá zprávu do fronty úložiště s názvem webjobs-blobtrigger-poison. Maximální počet opakování je možné konfigurovat. Stejné nastavení MaxDequeueCount se používá pro zpracování otrávených objektů blob a zpracování zpráv fronty jedu. Zpráva fronty pro otrávené objekty blob je objekt JSON, který obsahuje následující vlastnosti:

• FunctionId (ve formátu <FUNCTION_APP_NAME>.Functions.<FUNCTION_NAME>)
• BlobType (BlockBlob nebo PageBlob)
• ContainerName
• Název objektu blob
• Značka ETag (identifikátor verze objektu blob, například: 0x8D1DC6E70A277EF)

Využití paměti a souběžnost

Využití paměti může být dále ovlivněno, pokud více instancí funkcí současně zpracovává data objektů blob. Pokud máte problémy s pamětí při použití triggeru objektu blob, zvažte snížení počtu povolených souběžných spuštění. Samozřejmě, snížení souběžnosti může mít vedlejší účinek zvýšení backlogu objektů blob čekajících na zpracování. Limity paměti vaší aplikace funkcí závisí na plánu. Další informace najdete v tématu Omezení služby.

Způsob, jakým můžete řídit počet souběžných spuštění, závisí na verzi rozšíření úložiště, které používáte.

Omezení platí pro každou funkci, která používá trigger objektu blob.

host.json vlastnosti

Soubor host.json obsahuje nastavení, která řídí chování triggeru objektu blob. Podrobnosti o dostupných nastaveních najdete v části nastavení host.json .

Další kroky

• Čtení dat úložiště objektů blob při spuštění funkce
• Zápis dat úložiště objektů blob z funkce