Enlaces de entrada de Azure Tables para Azure Functions

Artículo
08/02/2023

Use el enlace de entrada de Azure Tables para leer una tabla de Azure Cosmos DB for Table o Azure Table Storage.

Para obtener información sobre los detalles de instalación y configuración, vea la información general.

Importante

En este artículo se usan pestañas para admitir varias versiones del modelo de programación de Node.js. El modelo v4 está disponible de forma general y está diseñado para que los desarrolladores de JavaScript y TypeScript tengan una experiencia más flexible e intuitiva. Para más detalles acerca de cómo funciona el modelo v4, consulte la Guía para desarrolladores de Node.js de Azure Functions. Para obtener más información acerca de las diferencias entre v3 y v4, consulte la Guía de migración.

Ejemplo

La utilización del enlace depende de la versión del paquete de extensión y la modalidad de C# que se usa en la aplicación de funciones, que puede ser una de las siguientes:

Modelo de trabajo aislado
Modelo de proceso

Una función de C# compilada de la biblioteca de clases de procesos de trabajo aislados se ejecuta en un proceso aislado del entorno de ejecución.

Elija una versión para ver ejemplos del modo y la versión.

En el ejemplo siguiente se muestra una función de C# que lee una única fila de la tabla. Para cada mensaje que se envíe a la cola, se desencadenará la función.

El valor de la clave de fila {queueTrigger} enlaza la clave de la fila a los metadatos del mensaje, que constituyen la cadena de mensaje.

public class TableStorage
{
    public class MyPoco : 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; }
    }


    [FunctionName("TableInput")]
    public static void TableInput(
        [QueueTrigger("table-items")] string input, 
        [Table("MyTable", "MyPartition", "{queueTrigger}")] MyPoco poco, 
        ILogger log)
    {
        log.LogInformation($"PK={poco.PartitionKey}, RK={poco.RowKey}, Text={poco.Text}");
    }
}

Use un parámetro del método TableClient para leer la tabla mediante Azure SDK. Este es un ejemplo de una función que consulta una tabla de registros de Azure Functions:

using Microsoft.Azure.WebJobs;
using Microsoft.Extensions.Logging;
using Azure.Data.Tables;
using System;
using System.Threading.Tasks;
using Azure;
namespace FunctionAppCloudTable2
{
    public class LogEntity : ITableEntity
    {
        public string OriginalName { get; set; }

        public string PartitionKey { get; set; }
        public string RowKey { get; set; }
        public DateTimeOffset? Timestamp { get; set; }
        public ETag ETag { get; set; }
    }
    public static class CloudTableDemo
    {
        [FunctionName("CloudTableDemo")]
        public static async Task Run(
            [TimerTrigger("0 */1 * * * *")] TimerInfo myTimer,
            [Table("AzureWebJobsHostLogscommon")] TableClient tableClient,
            ILogger log)
        {
            log.LogInformation($"C# Timer trigger function executed at: {DateTime.Now}");
            AsyncPageable<LogEntity> queryResults = tableClient.QueryAsync<LogEntity>(filter: $"PartitionKey eq 'FD2' and RowKey gt 't'");
            await foreach (LogEntity entity in queryResults)
            {
                log.LogInformation($"{entity.PartitionKey}\t{entity.RowKey}\t{entity.Timestamp}\t{entity.OriginalName}");
            }
        }
    }
}

Para obtener más información sobre cómo usar la clase TableClient, consulte la referencia sobre la API Azure.Data.Tables.

En el ejemplo siguiente se muestra una función de C# que lee una única fila de la tabla. Para cada mensaje que se envíe a la cola, se desencadenará la función.

El valor de la clave de fila {queueTrigger} enlaza la clave de la fila a los metadatos del mensaje, que constituyen la cadena de mensaje.

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

    [FunctionName("TableInput")]
    public static void TableInput(
        [QueueTrigger("table-items")] string input, 
        [Table("MyTable", "MyPartition", "{queueTrigger}")] MyPoco poco, 
        ILogger log)
    {
        log.LogInformation($"PK={poco.PartitionKey}, RK={poco.RowKey}, Text={poco.Text}");
    }
}

Use un parámetro del método CloudTable para leer la tabla mediante Azure Storage SDK. Este es un ejemplo de una función que consulta una tabla de registros de Azure Functions:

using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Host;
using Microsoft.Extensions.Logging;
using Microsoft.Azure.Cosmos.Table;
using System;
using System.Threading.Tasks;

namespace FunctionAppCloudTable2
{
    public class LogEntity : TableEntity
    {
        public string OriginalName { get; set; }
    }
    public static class CloudTableDemo
    {
        [FunctionName("CloudTableDemo")]
        public static async Task Run(
            [TimerTrigger("0 */1 * * * *")] TimerInfo myTimer, 
            [Table("AzureWebJobsHostLogscommon")] CloudTable cloudTable,
            ILogger log)
        {
            log.LogInformation($"C# Timer trigger function executed at: {DateTime.Now}");

            TableQuery<LogEntity> rangeQuery = new TableQuery<LogEntity>().Where(
                TableQuery.CombineFilters(
                    TableQuery.GenerateFilterCondition("PartitionKey", QueryComparisons.Equal, 
                        "FD2"),
                    TableOperators.And,
                    TableQuery.GenerateFilterCondition("RowKey", QueryComparisons.GreaterThan, 
                        "t")));

            // Execute the query and loop through the results
            foreach (LogEntity entity in 
                await cloudTable.ExecuteQuerySegmentedAsync(rangeQuery, null))
            {
                log.LogInformation(
                    $"{entity.PartitionKey}\t{entity.RowKey}\t{entity.Timestamp}\t{entity.OriginalName}");
            }
        }
    }
}

Para más información sobre cómo usar CloudTable, Consulte Introducción a Azure Table Storage.

Si intenta enlazar a CloudTable y obtiene un mensaje de error, asegúrese de que tiene una referencia a la versión correcta del SDK de Storage.

En el ejemplo siguiente se muestra una función de C# que lee una única fila de la tabla. Para cada mensaje que se envíe a la cola, se desencadenará la función.

El valor de la clave de fila {queueTrigger} enlaza la clave de la fila a los metadatos del mensaje, que constituyen la cadena de mensaje.

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

    [FunctionName("TableInput")]
    public static void TableInput(
        [QueueTrigger("table-items")] string input, 
        [Table("MyTable", "MyPartition", "{queueTrigger}")] MyPoco poco, 
        ILogger log)
    {
        log.LogInformation($"PK={poco.PartitionKey}, RK={poco.RowKey}, Text={poco.Text}");
    }
}

En el ejemplo siguiente se muestra una función de C# que lee varias filas de la tabla, donde la clase MyPoco se deriva de TableEntity.

public class TableStorage
{
    public class MyPoco : TableEntity
    {
        public string Text { get; set; }
    }

    [FunctionName("TableInput")]
    public static void TableInput(
        [QueueTrigger("table-items")] string input, 
        [Table("MyTable", "MyPartition")] IQueryable<MyPoco> pocos, 
        ILogger log)
    {
        foreach (MyPoco poco in pocos)
        {
            log.LogInformation($"PK={poco.PartitionKey}, RK={poco.RowKey}, Text={poco.Text}");
        }
    }
}

La clase MyTableData siguiente representa una fila de datos en la tabla:

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 siguiente función, que se inicia mediante un desencadenador de Queue Storage, lee una clave de fila de la cola, que se usa para obtener la fila de la tabla de entrada. La expresión {queueTrigger} enlaza la clave de la fila a los metadatos del mensaje, que constituyen la cadena de mensaje.

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

La siguiente función desencadenada mediante Queue devuelve las cinco primeras entidades como objeto IEnumerable<T>, con el valor de clave de partición establecido como el mensaje en cola.

[Function("TestFunction")]
public static void Run([QueueTrigger("myqueue", Connection = "AzureWebJobsStorage")] string partition,
    [TableInput("inTable", "{queueTrigger}", Take = 5, Filter = "Text eq 'test'", 
    Connection = "AzureWebJobsStorage")] IEnumerable<MyTableData> tableInputs,
    FunctionContext context)
{
    var logger = context.GetLogger("TestFunction");
    logger.LogInformation(partition);
    foreach (MyTableData tableInput in tableInputs)
    {
        logger.LogInformation($"PK={tableInput.PartitionKey}, RK={tableInput.RowKey}, Text={tableInput.Text}");
    }
}

Las propiedades Filter y Take se usan para limitar el número de entidades devueltas.

La clase MyTableData siguiente representa una fila de datos en la tabla:

{
    var tableEntities = table.QueryAsync<TableEntity>(filter: $"RowKey eq '{rowKey}'");

    await foreach (TableEntity entity in tableEntities)
    {
        _logger.LogInformation("PK={pk}, RK={rk}, Text={t}", entity.PartitionKey, entity.RowKey, entity["Text"]);
    }

namespace SampleApp
{
    public class TableFunction
    {
        private readonly ILogger<TableFunction> _logger;

        public TableFunction(ILogger<TableFunction> logger)
        {
            _logger = logger;
        }

        /// <summary>
        /// This function demonstrates binding to a single <see cref="TableClient"/>
        /// and using the client for output.
        /// </summary>
        [Function(nameof(TableFunction))]
        public async Task Run(
            [QueueTrigger("table-items")] string rowKey,

La siguiente función desencadenada mediante Queue devuelve las cinco primeras entidades como objeto IEnumerable<T>, con el valor de clave de partición establecido como el mensaje en cola.

[Function("TestFunction")]
public static void Run([QueueTrigger("myqueue", Connection = "AzureWebJobsStorage")] string partition,
    [TableInput("inTable", "{queueTrigger}", Take = 5, Filter = "Text eq 'test'", 
    Connection = "AzureWebJobsStorage")] IEnumerable<MyTableData> tableInputs,
    FunctionContext context)
{
    var logger = context.GetLogger("TestFunction");
    logger.LogInformation(partition);
    foreach (MyTableData tableInput in tableInputs)
    {
        logger.LogInformation($"PK={tableInput.PartitionKey}, RK={tableInput.RowKey}, Text={tableInput.Text}");
    }
}

Las propiedades Filter y Take se usan para limitar el número de entidades devueltas.

En el ejemplo siguiente se muestra una función desencadenada por HTTP que devuelve una lista de objetos Person que se encuentran en una partición especificada del almacenamiento Table. En el ejemplo, la clave de partición se extrae de la ruta http y los elementos tableName y connection proceden de la configuración de la función.

public class Person {
    private String PartitionKey;
    private String RowKey;
    private String Name;

    public String getPartitionKey() { return this.PartitionKey; }
    public void setPartitionKey(String key) { this.PartitionKey = key; }
    public String getRowKey() { return this.RowKey; }
    public void setRowKey(String key) { this.RowKey = key; }
    public String getName() { return this.Name; }
    public void setName(String name) { this.Name = name; }
}

@FunctionName("getPersonsByPartitionKey")
public Person[] get(
        @HttpTrigger(name = "getPersons", methods = {HttpMethod.GET}, authLevel = AuthorizationLevel.FUNCTION, route="persons/{partitionKey}") HttpRequestMessage<Optional<String>> request,
        @BindingName("partitionKey") String partitionKey,
        @TableInput(name="persons", partitionKey="{partitionKey}", tableName="%MyTableName%", connection="MyConnectionString") Person[] persons,
        final ExecutionContext context) {

    context.getLogger().info("Got query for person related to persons with partition key: " + partitionKey);

    return persons;
}

La anotación TableInput también puede extraer los enlaces del cuerpo JSON de la solicitud, como se muestra en el ejemplo siguiente.

@FunctionName("GetPersonsByKeysFromRequest")
public HttpResponseMessage get(
        @HttpTrigger(name = "getPerson", methods = {HttpMethod.GET}, authLevel = AuthorizationLevel.FUNCTION, route="query") HttpRequestMessage<Optional<String>> request,
        @TableInput(name="persons", partitionKey="{partitionKey}", rowKey = "{rowKey}", tableName="%MyTableName%", connection="MyConnectionString") Person person,
        final ExecutionContext context) {

    if (person == null) {
        return request.createResponseBuilder(HttpStatus.NOT_FOUND)
                    .body("Person not found.")
                    .build();
    }

    return request.createResponseBuilder(HttpStatus.OK)
                    .header("Content-Type", "application/json")
                    .body(person)
                    .build();
}

En el ejemplo siguiente se usa un filtro para buscar personas con un nombre concreto en una tabla de Azure y se limita el número de posibles coincidencias a 10 resultados.

@FunctionName("getPersonsByName")
public Person[] get(
        @HttpTrigger(name = "getPersons", methods = {HttpMethod.GET}, authLevel = AuthorizationLevel.FUNCTION, route="filter/{name}") HttpRequestMessage<Optional<String>> request,
        @BindingName("name") String name,
        @TableInput(name="persons", filter="Name eq '{name}'", take = "10", tableName="%MyTableName%", connection="MyConnectionString") Person[] persons,
        final ExecutionContext context) {

    context.getLogger().info("Got query for person related to persons with name: " + name);

    return persons;
}

El siguiente ejemplo muestra un enlace de entrada de tabla que utiliza un desencadenador de cola para leer una sola fila de tabla. El enlace especifica un partitionKey y un rowKey. El valor rowKey "{queueTrigger}" de clave de fila indica que la clave de fila procede de la cadena del mensaje en la cola.

Model v4
Model v3

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

const tableInput = input.table({
    tableName: 'Person',
    partitionKey: 'Test',
    rowKey: '{queueTrigger}',
    connection: 'MyStorageConnectionAppSetting',
});

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

export async function storageQueueTrigger1(queueItem: unknown, context: InvocationContext): Promise<void> {
    context.log('Node.js queue trigger function processed work item', queueItem);
    const person = <PersonEntity>context.extraInputs.get(tableInput);
    context.log('Person entity name: ' + person.Name);
}

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

Model v4
Model v3

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

const tableInput = input.table({
    tableName: 'Person',
    partitionKey: 'Test',
    rowKey: '{queueTrigger}',
    connection: 'MyStorageConnectionAppSetting',
});

app.storageQueue('storageQueueTrigger1', {
    queueName: 'myqueue-items',
    connection: 'MyStorageConnectionAppSetting',
    extraInputs: [tableInput],
    handler: (queueItem, context) => {
        context.log('Node.js queue trigger function processed work item', queueItem);
        const person = context.extraInputs.get(tableInput);
        context.log('Person entity name: ' + person.Name);
    },
});

{
  "bindings": [
    {
      "queueName": "myqueue-items",
      "connection": "MyStorageConnectionAppSetting",
      "name": "myQueueItem",
      "type": "queueTrigger",
      "direction": "in"
    },
    {
      "name": "personEntity",
      "type": "table",
      "tableName": "Person",
      "partitionKey": "Test",
      "rowKey": "{queueTrigger}",
      "connection": "MyStorageConnectionAppSetting",
      "direction": "in"
    }
  ],
  "disabled": false
}

En la sección de configuración se explican estas propiedades.

Este es el código de JavaScript:

module.exports = async function (context, myQueueItem) {
    context.log('Node.js queue trigger function processed work item', myQueueItem);
    context.log('Person entity name: ' + context.bindings.personEntity.Name);
};

En el ejemplo siguiente se usa un desencadenador de cola para leer una fila de tabla única como entrada para una función.

En este ejemplo, la configuración de enlace especifica un valor explícito para la partitionKey de la tabla y utiliza una expresión para pasar a la rowKey. La expresión de rowKey, {queueTrigger}, indica que la clave de fila procede de la cadena del mensaje en la cola.

Configuración de enlace en function.json:

{
  "bindings": [
    {
      "queueName": "myqueue-items",
      "connection": "MyStorageConnectionAppSetting",
      "name": "MyQueueItem",
      "type": "queueTrigger",
      "direction": "in"
    },
    {
      "name": "PersonEntity",
      "type": "table",
      "tableName": "Person",
      "partitionKey": "Test",
      "rowKey": "{queueTrigger}",
      "connection": "MyStorageConnectionAppSetting",
      "direction": "in"
    }
  ],
  "disabled": false
}

Código de PowerShell en run.ps1:

param($MyQueueItem, $PersonEntity, $TriggerMetadata)
Write-Host "PowerShell queue trigger function processed work item: $MyQueueItem"
Write-Host "Person entity name: $($PersonEntity.Name)"

La siguiente función usa un desencadenador de HTTP para leer una fila de tabla única como entrada para una función.

En este ejemplo, la configuración de enlace especifica un valor explícito para el elemento partitionKey de la tabla y se usa una expresión para pasar al elemento rowKey. En la expresión rowKey, {id} indica que la clave de fila procede de la parte {id} de la ruta en la solicitud.

Configuración de enlace del archivo function.json:

{
  "scriptFile": "__init__.py",
  "bindings": [
    {
      "name": "messageJSON",
      "type": "table",
      "tableName": "messages",
      "partitionKey": "message",
      "rowKey": "{id}",
      "connection": "AzureWebJobsStorage",
      "direction": "in"
    },
    {
      "authLevel": "function",
      "type": "httpTrigger",
      "direction": "in",
      "name": "req",
      "methods": [
        "get",
        "post"
      ],
      "route": "messages/{id}"
    },
    {
      "type": "http",
      "direction": "out",
      "name": "$return"
    }
  ],
  "disabled": false
}

Código de Python en el archivo __init__.py:

import json

import azure.functions as func

def main(req: func.HttpRequest, messageJSON) -> func.HttpResponse:

    message = json.loads(messageJSON)
    return func.HttpResponse(f"Table row: {messageJSON}")

Con este enlace simple, no se puede controlar mediante programación un caso en el que no se encuentra ninguna fila que tenga un identificador de clave de fila. Para una selección de datos más detallada, use el SDK de almacenamiento.

Atributos

Las bibliotecas de C# en proceso y de proceso de trabajo aislado usan atributos para definir la función. En su lugar, el script de C# usa un archivo de configuración function.json como se describe en la Guía de scripting de C#.

Modelo de trabajo aislado
Modelo de proceso

En las bibliotecas de clases de C#, la clase TableInputAttribute admite las siguientes propiedades:

Propiedad de atributo	Descripción
TableName	Nombre de la tabla.
PartitionKey	Opcional. Clave de partición de la entidad de tabla que se va a leer.
RowKey	Opcional. Clave de fila de la entidad de tabla que se va a leer.
Take	Opcional. Número máximo de entidades que se van a leer en un objeto `IEnumerable<T>`. No se puede usar con `RowKey`.
Filter	Opcional. Expresión de filtro de OData para que las entidades lean en un objeto `IEnumerable<T>`. No se puede usar con `RowKey`.
Connection	Nombre de una configuración de aplicación o colección de parámetros que especifica cómo conectarse al servicio de tablas. Consulte Conexiones.

En las bibliotecas de clases de C#, la clase TableAttribute admite las siguientes propiedades:

Propiedad de atributo	Descripción
TableName	Nombre de la tabla.
PartitionKey	Opcional. Clave de partición de la entidad de tabla que se va a leer. Consulte la sección acerca del uso para obtener información acerca de cómo usar esta propiedad.
RowKey	Opcional. Clave de fila de una entidad de tabla única que se va a leer. No se puede usar con las propiedades `Take` ni `Filter`.
Take	Opcional. Número máximo de entidades que se devolverán. No se puede usar con `RowKey`.
Filter	Opcional. Expresión de filtro de OData para las entidades que se devolverá de la tabla. No se puede usar con `RowKey`.
Connection	Nombre de una configuración de aplicación o colección de parámetros que especifica cómo conectarse al servicio de tablas. Consulte Conexiones.

El constructor del atributo toma el nombre de la tabla, la clave de partición y la clave de fila, como se muestra en el ejemplo siguiente:

[FunctionName("TableInput")]
public static void Run(
    [QueueTrigger("table-items")] string input, 
    [Table("MyTable", "Http", "{queueTrigger}")] MyPoco poco, 
    ILogger log)
{
    ...
}

Puede establecer la propiedad Connection para especificar la conexión al servicio de tablas, tal como se muestra en el ejemplo siguiente:

[FunctionName("TableInput")]
public static void Run(
    [QueueTrigger("table-items")] string input, 
    [Table("MyTable", "Http", "{queueTrigger}", Connection = "StorageConnectionAppSetting")] MyPoco poco, 
    ILogger log)
{
    ...
}

Aunque el atributo toma una propiedad Connection, también puede usar el atributo Connection para especificar una conexión de cuenta de almacenamiento. Puede hacerlo cuando necesite usar una cuenta de almacenamiento diferente a otras funciones de la biblioteca. El constructor toma el nombre de una configuración de aplicación que contiene una cadena de conexión de almacenamiento. El atributo se puede aplicar en el nivel de clase, método o parámetro. En el ejemplo siguiente se muestran el nivel de clase y de método:

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

La cuenta de almacenamiento que se debe usar se determina en el orden siguiente:

La propiedad Connection del atributo de enlace o desencadenador.
El atributo StorageAccount aplicado al mismo parámetro que el atributo de enlace o desencadenador.
El atributo StorageAccount aplicado a la función.
El atributo StorageAccount aplicado a la clase.
La cuenta de almacenamiento predeterminada de la aplicación de funciones, que se define en la configuración de la aplicación AzureWebJobsStorage.

anotaciones

En la biblioteca en tiempo de ejecución de funciones de Java, utilice la anotación @TableInput en los parámetros cuyo valor provendría del almacenamiento de la tabla. Esta anotación se puede usar con tipos nativos de Java, POJO o valores que aceptan valores NULL mediante Optional<T>. Esta anotación admite los siguientes elementos:

Elemento	Descripción
name	Nombre de la variable que representa la tabla o la entidad en el código de la función.
tableName	Nombre de la tabla.
partitionKey	Opcional. Clave de partición de la entidad de tabla que se va a leer.
rowKey	Opcional. Clave de fila de la entidad de tabla que se va a leer.
take	Opcional. Número máximo de entidades que se leerán.
filtro	Opcional. Expresión de filtro de OData para la entrada de la tabla.
conexión	Nombre de una configuración de aplicación o colección de parámetros que especifica cómo conectarse al servicio de tablas. Consulte Conexiones.

En la tabla siguiente se explican las propiedades que puede establecer en el objeto options que se pasa al métodoinput.table().

Propiedad	Descripción
tableName	Nombre de la tabla.
partitionKey	Opcional. Clave de partición de la entidad de tabla que se va a leer.
rowKey	Opcional. Clave de fila de la entidad de tabla que se va a leer. No se puede usar con las propiedades `take` ni `filter`.
take	Opcional. Número máximo de entidades que se devolverán. No se puede usar con `rowKey`.
filter	Opcional. Expresión de filtro de OData para las entidades que se devolverá de la tabla. No se puede usar con `rowKey`.
connection	Nombre de una configuración de aplicación o colección de parámetros que especifica cómo conectarse al servicio de tablas. Consulte Conexiones.

En la siguiente tabla se explican las propiedades de configuración de enlace que se establecen en el archivo function.json.

Propiedad	Descripción
type	Se debe establecer en `table`. Esta propiedad se establece automáticamente cuando se crea el enlace en Azure Portal.
direction	Se debe establecer en `in`. Esta propiedad se establece automáticamente cuando se crea el enlace en Azure Portal.
name	Nombre de la variable que representa la tabla o la entidad en el código de la función.
tableName	Nombre de la tabla.
partitionKey	Opcional. Clave de partición de la entidad de tabla que se va a leer.
rowKey	Opcional. Clave de fila de la entidad de tabla que se va a leer. No se puede usar con las propiedades `take` ni `filter`.
take	Opcional. Número máximo de entidades que se devolverán. No se puede usar con `rowKey`.
filter	Opcional. Expresión de filtro de OData para las entidades que se devolverá de la tabla. No se puede usar con `rowKey`.
connection	Nombre de una configuración de aplicación o colección de parámetros que especifica cómo conectarse al servicio de tablas. Consulte Conexiones.

Configuración

En la siguiente tabla se explican las propiedades de configuración de enlace que se establecen en el archivo function.json.

Propiedad de function.json	Descripción
type	Se debe establecer en `table`. Esta propiedad se establece automáticamente cuando se crea el enlace en Azure Portal.
direction	Se debe establecer en `in`. Esta propiedad se establece automáticamente cuando se crea el enlace en Azure Portal.
name	Nombre de la variable que representa la tabla o la entidad en el código de la función.
tableName	Nombre de la tabla.
partitionKey	Opcional. Clave de partición de la entidad de tabla que se va a leer.
rowKey	Opcional. Clave de fila de la entidad de tabla que se va a leer. No se puede usar con las propiedades `take` ni `filter`.
take	Opcional. Número máximo de entidades que se devolverán. No se puede usar con `rowKey`.
filter	Opcional. Expresión de filtro de OData para las entidades que se devolverá de la tabla. No se puede usar con `rowKey`.
connection	Nombre de una configuración de aplicación o colección de parámetros que especifica cómo conectarse al servicio de tablas. Consulte Conexiones.

Cuando esté desarrollando localmente, agregue la configuración de la aplicación en el archivo local.settings.json de la colección Values.

Conexiones

La propiedad connection es una referencia a la configuración del entorno que especifica cómo se debe conectar la aplicación al servicio de tablas. Puede especificar lo siguiente:

El nombre de una configuración de la aplicación que contiene una cadena de conexión.
El nombre de un prefijo compartido para varias configuraciones de la aplicación que juntas definen una conexión basada en identidades.

Si el valor configurado es tanto una coincidencia exacta de una única configuración como una coincidencia de prefijo de otras configuraciones, se usa la coincidencia exacta.

Cadena de conexión

Para obtener una cadena de conexión para tablas en Azure Table Storage, siga los pasos que se muestran en Administración de las claves de acceso de la cuenta de almacenamiento. Para obtener una cadena de conexión para las tablas de Azure Cosmos DB for Table, siga los pasos que se muestran en Preguntas frecuentes sobre Azure Cosmos DB for Table.

La cadena de conexión debe almacenarse en una configuración de la aplicación con un nombre que coincida con el valor especificado por la propiedad connection de la configuración de enlace.

Si el nombre de la configuración de aplicación comienza con "AzureWebJobs", puede especificar solo el resto del nombre aquí. Por ejemplo, si establece connection en "MyStorage", el entorno en tiempo de ejecución de Functions busca una configuración de aplicación denominada "AzureWebJobsMyStorage". Si deja connection vacía, el entorno en tiempo de ejecución de Functions usa la cadena de conexión de almacenamiento predeterminada en la configuración de aplicación que se denomina AzureWebJobsStorage.

Conexiones basadas en identidades

Si usa la extensión Table API, en lugar de usar una cadena de conexión con un secreto, puede hacer que la aplicación use una identidad de Microsoft Entra. Esto solo se aplica al acceder a tablas en Azure Storage. Para usar una identidad, se define la configuración con un prefijo común que se asigna a la propiedad de connection en la configuración de desencadenador y enlace.

Si va a establecer connection en "AzureWebJobsStorage", consulte Conexión al almacenamiento de host con una identidad. Para todas las demás conexiones, la extensión requiere las siguientes propiedades:

Propiedad	Plantilla de variable de entorno	Descripción	Valor de ejemplo
URI del servicio de tablas	`<CONNECTION_NAME_PREFIX>__tableServiceUri`¹	URI del plano de datos del servicio de tablas de Azure Storage al que se conecta, mediante el esquema HTTPS.	https://<nombre_cuenta_almacenamiento>.table.core.windows.net

¹ <CONNECTION_NAME_PREFIX>__serviceUri se puede usar como alias. Si se proporcionan ambos formularios, se usa el formulario tableServiceUri. El formulario serviceUri no se puede usar cuando la configuración de conexión general se va a usar en blobs, colas o tablas.

Se pueden establecer otras propiedades para personalizar la conexión. Consulte Propiedades comunes para conexiones basadas en identidades.

El formulario serviceUri no se puede usar cuando la configuración de conexión general se va a usar en blobs, colas o tablas en Azure Storage. El URI solo puede designar el servicio de tablas. Como alternativa, puede proporcionar un URI específicamente para cada servicio del mismo prefijo, lo cual permite usar una sola conexión.

Cuando se hospeda en el servicio de Azure Functions, las conexiones basadas en identidades usan una identidad administrada. La identidad asignada por el sistema se usa de manera predeterminada, aunque se puede especificar una identidad asignada por el usuario con las propiedades credential y clientID. Tenga en cuenta que no se admite la configuración de una identidad asignada por el usuario con un identificador de recurso. Cuando se ejecuta en otros contextos, como el de desarrollo local, se usa en su lugar la identidad del desarrollador, aunque se puede personalizar. Consulte Desarrollo local con conexiones basadas en identidades.

Concesión de permiso a la identidad

Cualquier identidad que se utilice debe tener permisos para realizar las acciones previstas. Para la mayoría de los servicios de Azure, esto significa que debe asignar un rol en Azure RBAC mediante roles integrados o personalizados que proporcionen esos permisos.

Importante

Es posible que el servicio de destino muestre algunos permisos que no son necesarios para todos los contextos. Siempre que sea posible, respete el principio de privilegios mínimos y conceda solo los privilegios necesarios a la identidad. Por ejemplo, si la aplicación solo necesita poder leer desde un origen de datos, use un rol que solo tenga permiso de lectura. Sería inadecuado asignar un rol que también permita escribir en ese servicio, ya que sería un permiso excesivo para una operación de lectura. De forma similar, le interesa asegurarse de que la asignación de roles esté limitada solo a los recursos que se deben leer.

Debe crear una asignación de roles que proporcione acceso al servicio de tablas de Azure Storage en tiempo de ejecución. Los roles de administración, como Propietario, no son suficientes. En la tabla siguiente se muestran los roles integrados que se recomiendan cuando se usa la extensión para Azure Tables en Azure Storage durante el funcionamiento normal. Puede que la aplicación precise permisos adicionales en función del código que escriba.

Tipo de enlace	Roles integrados de ejemplo (Azure Storage¹)
Enlace de entrada	Lector de datos de tabla de Storage
Enlace de salida	Colaborador de datos de tabla de Storage

¹ Si la aplicación se conecta a tablas de Azure Cosmos DB for Table, no se admite el uso de una identidad y la conexión debe usar una cadena de conexión.

Uso

La utilización del enlace depende de la versión del paquete de extensión y la modalidad de C# que se usa en la aplicación de funciones, que puede ser una de las siguientes:

Modelo de trabajo aislado
Modelo de proceso

Una función de C# compilada de la biblioteca de clases de procesos de trabajo aislados se ejecuta en un proceso aislado del entorno de ejecución.

Elija una versión para ver los detalles de utilización del modo y la versión.

Al trabajar con una sola entidad de tabla, el enlace de entrada de Azure Tables puede enlazarse a los siguientes tipos:

Tipo	Descripción
Un tipo serializable JSON que implementa ITableEntity	Functions intenta deserializar la entidad en un tipo de objeto CRL estándar (POCO). El tipo debe implementar ITableEntity o tener una propiedad de cadena `RowKey` y una propiedad de cadena `PartitionKey`.
TableEntity¹	La entidad como tipo de diccionario.

Al trabajar con varias entidades desde una consulta, el enlace de entrada de Azure Tables puede enlazarse a los siguientes tipos:

Tipo	Descripción
`IEnumerable<T>` donde `T` implementa ITableEntity	Una enumeración de entidades devueltas por la consulta. Cada entrada representa una entidad. El tipo `T` debe implementar ITableEntity o tener una propiedad de cadena `RowKey` y una propiedad de cadena `PartitionKey`.
TableClient¹	Un cliente conectado a la tabla. Ofrece el mayor control para procesar la tabla y puede utilizarse para escribir en ella si la conexión tiene permisos suficientes.

¹ Para usar estos tipos, es necesario hacer referencia a Microsoft.Azure.Functions.Worker.Extensions.Tables 1.2.0 o posterior y a las dependencias comunes para los enlaces de tipo de SDK.

El atributo TableInput da acceso a la fila de tabla que desencadenó la función.

Model v4
Model v3

Obtenga los datos de fila de entrada mediante context.extraInputs.get().

Los datos se pasan al parámetro de entrada según especifica la clave name en el archivo function.json. La especificación de partitionKey y rowKey permite filtrar registros específicos.

Los datos de la tabla se pasan a la función como una cadena JSON. Anule la serialización del mensaje mediante una llamada a json.loads como se muestra en el ejemplo de entrada.

Para obtener detalles de utilización específicos, consulte Ejemplo.

Pasos siguientes

Escritura de datos de tabla desde una función

Compartir a través de

Enlaces de entrada de Azure Tables para Azure Functions

Ejemplo

Atributos

anotaciones

Configuración

Configuración

Conexiones

Cadena de conexión

Conexiones basadas en identidades

Concesión de permiso a la identidad

Uso

Pasos siguientes

Comentarios

Recursos adicionales