Liaisons de sortie Tables Azure pour Azure Functions

La classe MyTableData suivante représente une ligne de données dans la table :

public class MyTableData : Azure.Data.Tables.ITableEntity
{
    public string Text { get; set; }

    public string PartitionKey { get; set; }
    public string RowKey { get; set; }
    public DateTimeOffset? Timestamp { get; set; }
    public ETag ETag { get; set; }
}

La fonction suivante, qui est démarrée par un déclencheur Stockage File d’attente, écrit une nouvelle entité MyDataTable dans une table nommée OutputTable.

[Function("TableFunction")]
[TableOutput("OutputTable", Connection = "AzureWebJobsStorage")]
public static MyTableData Run(
    [QueueTrigger("table-items")] string input,
    [TableInput("MyTable", "<PartitionKey>", "{queueTrigger}")] MyTableData tableInput,
    FunctionContext context)
{
    var logger = context.GetLogger("TableFunction");

    logger.LogInformation($"PK={tableInput.PartitionKey}, RK={tableInput.RowKey}, Text={tableInput.Text}");

    return new MyTableData()
    {
        PartitionKey = "queue",
        RowKey = Guid.NewGuid().ToString(),
        Text = $"Output record with rowkey {input} created at {DateTime.Now}"
    };
}

L’exemple suivant illustre une fonction C# qui utilise un déclencheur HTTP pour écrire une ligne de table.

public class TableStorage
{
    public class MyPoco
    {
        public string PartitionKey { get; set; }
        public string RowKey { get; set; }
        public string Text { get; set; }
    }

    [FunctionName("TableOutput")]
    [return: Table("MyTable")]
    public static MyPoco TableOutput([HttpTrigger] dynamic input, ILogger log)
    {
        log.LogInformation($"C# http trigger function processed: {input.Text}");
        return new MyPoco { PartitionKey = "Http", RowKey = Guid.NewGuid().ToString(), Text = input.Text };
    }
}

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

const tableOutput = output.table({
    tableName: 'Person',
    connection: 'MyStorageConnectionAppSetting',
});

interface PersonEntity {
    PartitionKey: string;
    RowKey: string;
    Name: string;
}

export async function httpTrigger1(request: HttpRequest, context: InvocationContext): Promise<HttpResponseInit> {
    const rows: PersonEntity[] = [];
    for (let i = 1; i < 10; i++) {
        rows.push({
            PartitionKey: 'Test',
            RowKey: i.toString(),
            Name: `Name ${i}`,
        });
    }
    context.extraOutputs.set(tableOutput, rows);
    return { status: 201 };
}

app.http('httpTrigger1', {
    methods: ['POST'],
    authLevel: 'anonymous',
    extraOutputs: [tableOutput],
    handler: httpTrigger1,
});

Les exemples TypeScript ne sont pas documentés pour le modèle v3.

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

const tableOutput = output.table({
    tableName: 'Person',
    connection: 'MyStorageConnectionAppSetting',
});

app.http('httpTrigger1', {
    methods: ['POST'],
    authLevel: 'anonymous',
    extraOutputs: [tableOutput],
    handler: async (request, context) => {
        const rows = [];
        for (let i = 1; i < 10; i++) {
            rows.push({
                PartitionKey: 'Test',
                RowKey: i.toString(),
                Name: `Name ${i}`,
            });
        }
        context.extraOutputs.set(tableOutput, rows);
        return { status: 201 };
    },
});

Voici le fichier function.json :

{
  "bindings": [
    {
      "name": "input",
      "type": "manualTrigger",
      "direction": "in"
    },
    {
      "tableName": "Person",
      "connection": "MyStorageConnectionAppSetting",
      "name": "tableBinding",
      "type": "table",
      "direction": "out"
    }
  ],
  "disabled": false
}

La section configuration décrit ces propriétés.

Voici le code JavaScript :

module.exports = async function (context) {

    context.bindings.tableBinding = [];

    for (var i = 1; i < 10; i++) {
        context.bindings.tableBinding.push({
            PartitionKey: "Test",
            RowKey: i.toString(),
            Name: "Name " + i
        });
    }
};

Dans les bibliothèques de classes C#, TableInputAttribute prend en charge les propriétés suivantes :

Dans les bibliothèques de classes C#, TableAttribute prend en charge les propriétés suivantes :

Le constructeur de l’attribut prend le nom de la table. Utilisez l’attribut peut être utilisé sur un paramètre out ou sur la valeur de retour de la fonction, comme dans l’exemple suivant :

[FunctionName("TableOutput")]
[return: Table("MyTable")]
public static MyPoco TableOutput(
    [HttpTrigger] dynamic input, 
    ILogger log)
{
    ...
}

Vous pouvez définir la propriété Connection pour spécifier une connexion au service de table, comme dans l’exemple suivant :

[FunctionName("TableOutput")]
[return: Table("MyTable", Connection = "StorageConnectionAppSetting")]
public static MyPoco TableOutput(
    [HttpTrigger] dynamic input, 
    ILogger log)
{
    ...
}

Tandis que l’attribut prend une propriété Connection, vous pouvez également utiliser Connection pour spécifier une connexion à un compte de stockage. Vous pouvez le faire lorsque vous avez besoin d’utiliser un compte de stockage différent de celui utilisé par les autres fonctions de la bibliothèque. Le constructeur prend le nom d’un paramètre d’application comportant une chaîne de connexion de stockage. L’attribut peut être appliqué au niveau du paramètre, de la méthode ou de la classe. L’exemple suivant montre le niveau de la classe et celui de la méthode :

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

Le compte de stockage à utiliser est déterminé dans l’ordre suivant :

• Propriété Connection du déclencheur ou de l’attribut de liaison.
• Attribut StorageAccount appliqué au même paramètre que le déclencheur ou l’attribut de liaison.
• L’attribut StorageAccount appliqué à la fonction.
• L’attribut StorageAccount appliqué à la classe.
• Compte de stockage par défaut pour l’application de fonction, lequel est défini dans le paramètre d’application AzureWebJobsStorage.

Le tableau suivant explique les propriétés que vous pouvez définir pour l’objet options passé à la méthode output.table().

Le tableau suivant décrit les propriétés de configuration de liaison que vous définissez dans le fichier function.json.

Une bibliothèque de classes de processus Worker isolé est une fonction C# compilée exécutée dans un processus Worker isolé du runtime.

Une bibliothèque de classes in-process est une fonction C# compilée exécutée dans le même processus que le runtime Functions.

Les types suivants sont pris en charge pour les paramètres out et les types de retour :

• Un objet POCO (plain-old CLR object) qui comprend les propriétés PartitionKey et RowKey. Vous pouvez accompagner ces propriétés en implémentant ITableEntity.
• ICollector<T> ou IAsyncCollector<T> où T inclut les propriétés PartitionKey et RowKey. Vous pouvez accompagner ces propriétés en implémentant ITableEntity.

Vous pouvez également effectuer une liaison à TableClient partir du Kit de développement logiciel (SDK) Azure. Vous pouvez ensuite utiliser cet objet pour écrire dans la table.

Les types suivants sont pris en charge pour les paramètres out et les types de retour :

• Un objet POCO (plain-old CLR object) qui comprend les propriétés PartitionKey et RowKey. Vous pouvez accompagner ces propriétés en implémentant ITableEntity ou en héritant TableEntity.
• ICollector<T> ou IAsyncCollector<T> où T inclut les propriétés PartitionKey et RowKey. Vous pouvez accompagner ces propriétés en implémentant ITableEntity ou en héritant TableEntity.

Vous pouvez également effectuer une liaison à CloudTable partir du Kit de développement logiciel (SDK ) de stockage en tant que paramètre de méthode. Vous pouvez ensuite utiliser cet objet pour écrire dans la table.

Les types suivants sont pris en charge pour les paramètres out et les types de retour :

• Un objet POCO (plain-old CLR object) qui comprend les propriétés PartitionKey et RowKey. Vous pouvez accompagner ces propriétés en implémentant ITableEntity ou en héritant TableEntity.
• ICollector<T> ou IAsyncCollector<T> où T inclut les propriétés PartitionKey et RowKey. Vous pouvez accompagner ces propriétés en implémentant ITableEntity ou en héritant TableEntity.

Vous pouvez également effectuer une liaison à CloudTable partir du Kit de développement logiciel (SDK ) de stockage en tant que paramètre de méthode. Vous pouvez ensuite utiliser cet objet pour écrire dans la table.

Lorsque vous souhaitez que la fonction écrive dans une seule entité, la liaison de sortie de Tables Azure peut se lier aux types suivants :

Lorsque vous souhaitez que la fonction écrive dans plusieurs entités, la liaison de sortie de Tables Azure peut se lier aux types suivants :

Pour d’autres scénarios de sortie, créez et utilisez un TableClient avec d’autres types à partir d’Azure.Data.Tables directement. Consultez Inscrire des clients Azure pour obtenir un exemple d’utilisation de l’injection de dépendances pour créer un type de client à partir du Kit de développement logiciel (SDK) Azure.

Retourne un objet POCO (plain-old CLR object) avec des propriétés qui peuvent être mappées à l’entité de table.

La version 1.x de Functions ne prend pas en charge le processus Worker isolé.

Définissez les données de ligne de sortie en retournant la valeur ou en utilisant context.extraOutputs.set().

Définissez les donnée de ligne de sortie en utilisant context.bindings.<name>, où <name> est la valeur spécifiée dans la propriété name de function.json.