Azure İşlevleri için Azure Kuyruk depolama çıkış bağlamaları

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.

[Function(nameof(QueueFunction))]
[QueueOutput("output-queue")]
public string[] Run([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.ToString()}"};

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

    // Queue Output messages
    return messages;
}

Aşağıdaki örnekte, alınan her HTTP isteği için bir kuyruk iletisi oluşturan bir C# işlevi gösterilmektedir.

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

Aşağıdaki örnekte, alınan her HTTP isteği için bir kuyruk öğesi oluşturan HTTP ile tetiklenen TypeScript işlevi gösterilmektedir.

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

Birden çok iletinin çıktısını almak için tek bir nesne yerine bir dizi döndürebilirsiniz. Örneğin:

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

Model v3 için TypeScript örnekleri belgelenmez.

Aşağıdaki örnekte, alınan her HTTP isteği için bir kuyruk öğesi oluşturan HTTP ile tetiklenen JavaScript işlevi gösterilmektedir.

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

Birden çok iletinin çıktısını almak için tek bir nesne yerine bir dizi döndürebilirsiniz. Örneğin:

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

Kuyruk depolamaya çıkış bağlamasını yapılandırmaya ilişkin uçtan uca bir örnek için şu makalelerden birine bakın:

• Visual Studio Code kullanarak işlevleri Azure Depolama'ya bağlama
• Komut satırı araçlarını kullanarak işlevleri Azure Depolama'ya bağlama

Aşağıdaki örnekte, bir function.json dosyasında http tetikleyici bağlaması ve bağlamayı kullanan bir JavaScript işlevi gösterilmektedir. İşlev, alınan her HTTP isteği için bir kuyruk öğesi oluşturur.

İşte function.json dosyası:

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

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

JavaScript kodu şu şekildedir:

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

Çıkış bağlaması için myQueueItem bir ileti dizisi tanımlayarak aynı anda birden çok ileti gönderebilirsiniz. Aşağıdaki JavaScript kodu, alınan her HTTP isteği için sabit kodlanmış değerler içeren iki kuyruk iletisi gönderir.

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'

Kuyruk depolamaya çıkış bağlamasını yapılandırmaya ilişkin uçtan uca bir örnek için şu makalelerden birine bakın:

• Visual Studio Code kullanarak işlevleri Azure Depolama'ya bağlama
• Komut satırı araçlarını kullanarak işlevleri Azure Depolama'ya bağlama

Depolama kuyruğu bağlaması, türün olarak ayarlandığı queuefunction.json tanımlanır.

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

Kuyrukta tek bir ileti ayarlamak için yöntemine set tek bir değer geçirirsiniz.

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'

Kuyrukta birden çok ileti oluşturmak için, parametreyi uygun liste türü olarak bildirin ve yönteme set bir değer dizisi (liste türüyle eşleşen) geçirin.

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'

Yalıtılmış bir çalışan işleminde çalışırken, aşağıdaki örnekte gösterildiği gibi kuyruğun adını alan QueueOutputAttribute'u kullanırsınız:

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

Yalıtılmış bir çalışan işleminde çalıştırılırken yalnızca döndürülen değişkenler desteklenir. Çıkış parametreleri kullanılamaz.

C# sınıf kitaplıklarında QueueAttribute kullanın. Bunun yerine C# betiği, C# betik kılavuzunda açıklandığı gibi bir function.json yapılandırma dosyası kullanır.

özniteliği bir out parametreye veya işlevin dönüş değerine uygulanır. Öznitelik oluşturucu, aşağıdaki örnekte gösterildiği gibi kuyruğun adını alır:

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

Özelliğini, aşağıdaki örnekte gösterildiği gibi kullanılacak depolama hesabını belirtecek şekilde ayarlayabilirsiniz Connection :

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

sınıfı, StorageAccount yöntemi veya parametre düzeyinde depolama hesabını belirtmek için özniteliğini kullanabilirsiniz. Daha fazla bilgi için bkz. Tetikleyici - öznitelikler.

Aşağıdaki tabloda, yöntemine geçirilen output.storageQueue() 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.

Yalıtılmış çalışan işlem sınıfı kitaplığı derlenmiş C# işlevi çalışma zamanından yalıtılmış bir işlemde çalışır.

İşlem içi sınıf kitaplığı, İşlevler çalışma zamanıyla aynı işlemde çalıştırılan derlenmiş bir C# işlevidir.

gibi out T paramNamebir yöntem parametresi kullanarak tek bir kuyruk iletisi yazın. Bir parametre yerine out yöntem dönüş türünü kullanabilirsiniz ve T aşağıdaki türlerden herhangi biri olabilir:

• JSON olarak serileştirilebilir nesne
• string
• byte[]
• QueueMessage

Bu türleri kullanan örnekler için uzantının GitHub deposuna bakın.

Aşağıdaki türlerden birini kullanarak kuyruğa birden çok ileti yazabilirsiniz:

• ICollector<T> veya IAsyncCollector<T>
• QueueClient

QueueMessage ve QueueClient kullanan örnekler için uzantının GitHub deposuna bakın.

Ö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ı.

gibi out T paramNamebir yöntem parametresi kullanarak tek bir kuyruk iletisi yazın. Bir parametre yerine out yöntem dönüş türünü kullanabilirsiniz ve T aşağıdaki türlerden herhangi biri olabilir:

• JSON olarak serileştirilebilir nesne
• string
• byte[]
• CloudQueueMessage

CloudQueueMessage'a bağlanmaya çalışır ve bir hata iletisi alırsanız, doğru Depolama SDK'sı sürümüne başvuru aldığınızdan emin olun.

Aşağıdaki türlerden birini kullanarak kuyruğa birden çok ileti yazabilirsiniz:

• ICollector<T> veya IAsyncCollector<T>
• CloudQueue

Ö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ı.

İşlevin tek bir ileti yazmasını istediğinizde, kuyruk çıkış bağlaması aşağıdaki türlere bağlanabilir:

İşlevin birden çok ileti yazmasını istediğinizde, kuyruk çıkış bağlaması aşağıdaki türlere bağlanabilir:

Diğer çıkış senaryoları için, doğrudan Azure.Storage.Queues'tan başka türlerle queueclient oluşturun ve kullanın. Azure SDK'dan bir istemci türü oluşturmak için bağımlılık ekleme kullanma örneği için bkz . Azure istemcilerini kaydetme.

Yalıtılmış çalışan işlemi şu anda yalnızca dize parametrelerine bağlamayı destekler.

Değeri doğrudan döndürerek veya kullanarak context.extraOutputs.set()çıkış kuyruğu öğesine erişin. Kuyruk öğesi yükü için bir dize veya JSON serileştirilebilir nesnesi kullanabilirsiniz.

function.json özelliğinde name belirtilen değeri kullanarak context.bindings.<name> <name> çıkış kuyruğu öğesine erişin. Kuyruk öğesi yükü için bir dize veya JSON serileştirilebilir nesnesi kullanabilirsiniz.