Привязки выходных данных хранилища очередей Azure для Функций Azure

Модель программирования Python версии 2 позволяет определять привязки с помощью декораторов непосредственно в коде функции Python. Дополнительные сведения см. в руководстве разработчика Python.

Модель программирования Python версии 1 требует определения привязок в отдельном файле function.json в папке функции. Дополнительные сведения см. в руководстве разработчика Python.

[Function(nameof(QueueInputOutputFunction))]
[QueueOutput("output-queue")]
public string[] QueueInputOutputFunction([QueueTrigger("input-queue")] Album myQueueItem, FunctionContext context)
{
    // Use a string array to return more than one message.
    string[] messages = {
        $"Album name = {myQueueItem.Name}",
        $"Album songs = {myQueueItem.Songs}"};

    _logger.LogInformation("{msg1},{msg2}", messages[0], messages[1]);

    // Queue Output messages
    return messages;
}

В следующем примере показана функция C#, которая создает сообщения очереди для каждого полученного HTTP-запроса.

[StorageAccount("MyStorageConnectionAppSetting")]
public static class QueueFunctions
{
    [FunctionName("QueueOutput")]
    [return: Queue("myqueue-items")]
    public static string QueueOutput([HttpTrigger] dynamic input,  ILogger log)
    {
        log.LogInformation($"C# function processed: {input.Text}");
        return input.Text;
    }
}

В следующем примере показана функция TypeScript с триггером HTTP, которая создает элемент очереди для каждого полученного HTTP-запроса.

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

const queueOutput = output.storageQueue({
    queueName: 'outqueue',
    connection: 'MyStorageConnectionAppSetting',
});

export async function httpTrigger1(request: HttpRequest, context: InvocationContext): Promise<HttpResponseInit> {
    const body = await request.text();
    context.extraOutputs.set(queueOutput, body);
    return { body: 'Created queue item.' };
}

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

Чтобы вывести несколько сообщений, верните массив вместо одного объекта. Например:

context.extraOutputs.set(queueOutput, ['message 1', 'message 2']);

Примеры TypeScript не документируются для модели версии 3.

В следующем примере показана функция JavaScript с триггером HTTP, которая создает элемент очереди для каждого полученного HTTP-запроса.

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

const queueOutput = output.storageQueue({
    queueName: 'outqueue',
    connection: 'MyStorageConnectionAppSetting',
});

app.http('httpTrigger1', {
    methods: ['GET', 'POST'],
    authLevel: 'anonymous',
    extraOutputs: [queueOutput],
    handler: async (request, context) => {
        const body = await request.text();
        context.extraOutputs.set(queueOutput, body);
        return { body: 'Created queue item.' };
    },
});

Чтобы вывести несколько сообщений, верните массив вместо одного объекта. Например:

context.extraOutputs.set(queueOutput, ['message 1', 'message 2']);

Полный пример настройки выходной привязки к хранилищу очередей см. в одной из следующих статей:

• Подключение функций к служба хранилища Azure с помощью Visual Studio Code
• Подключение функций к служба хранилища Azure с помощью средств командной строки

В следующем примере показана привязка триггера HTTP в файле function.json и функция JavaScript, которая использует привязку. Эта функция создает элемент очереди для каждого полученного HTTP-запроса.

Ниже показан файл function.json.

{
  "bindings": [
    {
      "type": "httpTrigger",
      "direction": "in",
      "authLevel": "function",
      "name": "input"
    },
    {
      "type": "http",
      "direction": "out",
      "name": "$return"
    },
    {
      "type": "queue",
      "direction": "out",
      "name": "myQueueItem",
      "queueName": "outqueue",
      "connection": "MyStorageConnectionAppSetting"
    }
  ]
}

В разделе Конфигурация описываются эти свойства.

Ниже показан код JavaScript.

module.exports = async function (context, input) {
    context.bindings.myQueueItem = input.body;
};

Вы можете отправить несколько сообщений одновременно, определив массив сообщений для выходной привязки myQueueItem. Следующий код JavaScript отправляет два сообщения очереди с четко фиксированными значениями для каждого полученного HTTP-запроса.

module.exports = async function(context) {
    context.bindings.myQueueItem = ["message 1","message 2"];
};

import logging
import azure.functions as func

app = func.FunctionApp()

@app.function_name(name="QueueOutput1")
@app.route(route="message")
@app.queue_output(arg_name="msg", 
                  queue_name="<QUEUE_NAME>", 
                  connection="<CONNECTION_SETTING>")
def main(req: func.HttpRequest, msg: func.Out[str]) -> func.HttpResponse:
    input_msg = req.params.get('name')
    logging.info(input_msg)

    msg.set(input_msg)

    logging.info(f'name: {name}')
    return 'OK'

Полный пример настройки выходной привязки к хранилищу очередей см. в одной из следующих статей:

• Подключение функций к служба хранилища Azure с помощью Visual Studio Code
• Подключение функций к служба хранилища Azure с помощью средств командной строки

Привязка очереди хранилища определяется в файле function.json, в котором type задан как queue.

{
  "scriptFile": "__init__.py",
  "bindings": [
    {
      "authLevel": "function",
      "type": "httpTrigger",
      "direction": "in",
      "name": "req",
      "methods": [
        "get",
        "post"
      ]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "$return"
    },
    {
      "type": "queue",
      "direction": "out",
      "name": "msg",
      "queueName": "outqueue",
      "connection": "AzureStorageQueuesConnectionString"
    }
  ]
}

Чтобы задать отдельное сообщение в очереди, необходимо передать в метод set одно значение.

import azure.functions as func

def main(req: func.HttpRequest, msg: func.Out[str]) -> func.HttpResponse:

    input_msg = req.params.get('message')

    msg.set(input_msg)

    return 'OK'

Чтобы создать несколько сообщений в очереди, объявите параметр с соответствующим типом списка и передайте массив значений (которые соответствуют типу списка) в метод set.

import azure.functions as func
import typing

def main(req: func.HttpRequest, msg: func.Out[typing.List[str]]) -> func.HttpResponse:

    msg.set(['one', 'two'])

    return 'OK'

При выполнении в изолированном рабочем процессе используется QueueOutputAttribute, который принимает имя очереди, как показано в следующем примере:

[Function(nameof(QueueInputOutputFunction))]
[QueueOutput("output-queue")]
public string[] QueueInputOutputFunction([QueueTrigger("input-queue")] Album myQueueItem, FunctionContext context)

При выполнении изолированного рабочего процесса поддерживаются только возвращаемые переменные. Выходные параметры нельзя использовать.

В библиотеках классов C# используйте QueueAttribute. Вместо этого скрипт C# использует файл конфигурации function.json, как описано в руководстве по скриптам C#.

Этот атрибут применяется к параметру out или возвращаемому значению функции. Конструктор атрибута принимает имя очереди, как показано в следующем примере:

[FunctionName("QueueOutput")]
[return: Queue("myqueue-items")]
public static string Run([HttpTrigger] dynamic input,  ILogger log)
{
    ...
}

Чтобы указать учетную запись хранения, которую нужно использовать, можно задать свойство Connection, как показано в следующем примере.

[FunctionName("QueueOutput")]
[return: Queue("myqueue-items", Connection = "StorageConnectionAppSetting")]
public static string Run([HttpTrigger] dynamic input,  ILogger log)
{
    ...
}

Чтобы указать учетную запись хранения на уровне класса, метода или параметра, можно использовать атрибут StorageAccount. Дополнительные сведения см. в разделе "Атрибуты триггера".

В следующей таблице описываются свойства, которые можно задать для options объекта, переданного методу output.storageQueue() .

В следующей таблице описываются свойства конфигурации привязки, которые задаются в файле function.json.

Изолированная библиотека классов рабочих процессов, скомпилированная функция C# выполняется в процессе, изолированном от среды выполнения.

Библиотека внутрипроцессных классов — это скомпилированная функция C#, которая выполняется в том же процессе, что и среда выполнения Функций.

Запишите одно сообщение очереди с помощью параметра метода, например out T paramName. Вы можете использовать этот метод типа возвращаемого значения вместо параметра out. T может быть любого из следующих типов:

• Объект, сериализуемый как JSON
• string
• byte[]
• QueueMessage

Примеры использования этих типов см. в разделе репозитория GitHub для расширения.

Вы можете записать несколько сообщений в очередь с использованием одного из следующих типов:

• ICollector<T> или IAsyncCollector<T>
• QueueClient

Примеры использования QueueMessage и QueueClient см. в разделе репозитория GitHub для расширения.

Хотя атрибут принимает Connection свойство, можно также использовать StorageAccountAttribute для указания подключения к учетной записи хранения. Это можно сделать, если необходимо использовать учетную запись хранения, отличную от той, что используется другими функциями в библиотеке. Конструктор принимает имя параметра приложения, содержащего строку подключения к службе хранилища. Атрибут может применяться на уровне класса, метода или параметра. Ниже показан пример уровня класса и метода.

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

Используемая учетная запись хранения определяется в следующем порядке:

• Свойство триггера или привязки атрибута Connection.
• Атрибут StorageAccount, примененный к тому же параметру, что и триггер или атрибут привязки.
• Атрибут StorageAccount, примененный к функции.
• Атрибут StorageAccount, примененный к классу.
• Учетная запись хранения по умолчанию для приложения-функции, определенная в параметре приложения AzureWebJobsStorage.

Запишите одно сообщение очереди с помощью параметра метода, например out T paramName. Вы можете использовать этот метод типа возвращаемого значения вместо параметра out. T может быть любого из следующих типов:

• Объект, сериализуемый как JSON
• string
• byte[]
• CloudQueueMessage

Если при попытке привязки к CloudQueueMessage отображается сообщение об ошибке, убедитесь, что указана ссылка на правильную версию пакета SDK для службы хранилища.

Вы можете записать несколько сообщений в очередь с использованием одного из следующих типов:

• ICollector<T> или IAsyncCollector<T>
• CloudQueue.

Хотя атрибут принимает Connection свойство, можно также использовать StorageAccountAttribute для указания подключения к учетной записи хранения. Это можно сделать, если необходимо использовать учетную запись хранения, отличную от той, что используется другими функциями в библиотеке. Конструктор принимает имя параметра приложения, содержащего строку подключения к службе хранилища. Атрибут может применяться на уровне класса, метода или параметра. Ниже показан пример уровня класса и метода.

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

Используемая учетная запись хранения определяется в следующем порядке:

• Свойство триггера или привязки атрибута Connection.
• Атрибут StorageAccount, примененный к тому же параметру, что и триггер или атрибут привязки.
• Атрибут StorageAccount, примененный к функции.
• Атрибут StorageAccount, примененный к классу.
• Учетная запись хранения по умолчанию для приложения-функции, определенная в параметре приложения AzureWebJobsStorage.

Если требуется, чтобы функция записывала одно сообщение, выходная привязка очереди может привязаться к следующим типам:

Если требуется, чтобы функция записывала несколько сообщений, выходная привязка очереди может привязаться к следующим типам:

Для других сценариев вывода создайте и используйте QueueClient с другими типами из Azure.Storage.Queues напрямую. Пример использования внедрения зависимостей для создания типа клиента из пакета SDK Azure см. в статье "Регистрация клиентов Azure".

Изолированный рабочий процесс в настоящее время поддерживает привязку только к строковым параметрам.

Доступ к выходному элементу очереди путем возврата значения напрямую или с помощью context.extraOutputs.set(). Строку или сериализуемый объект JSON можно использовать для полезных данных элемента очереди.

Доступ к выходному элементу очереди с помощью context.bindings.<name><name> значения, указанного в свойстве name function.json. Строку или сериализуемый объект JSON можно использовать для полезных данных элемента очереди.