Azure Işlevleri için Azure kuyruk depolama çıkışı bağlamaları

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 örnek, bağlamayı kullanan bir function. JSON dosyası ve C# betiği (. CSX) kodunda bir http tetikleyicisi bağlamayı gösterir. İşlevi, alınan her HTTP isteği için bir Customqueuemessage nesne yüküne sahip 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": "$return",
      "queueName": "outqueue",
      "connection": "MyStorageConnectionAppSetting"
    }
  ]
}

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

Tek bir sıra iletisi oluşturan C# betik kodu aşağıda verilmiştir:

public class CustomQueueMessage
{
    public string PersonName { get; set; }
    public string Title { get; set; }
}

public static CustomQueueMessage Run(CustomQueueMessage input, ILogger log)
{
    return input;
}

Bir veya parametresini kullanarak bir kerede birden çok ileti gönderebilirsiniz ICollector IAsyncCollector . Burada, biri HTTP istek verileriyle, diğeri ise sabit kodlanmış değerlerle birden çok ileti gönderen C# betik kodu:

public static void Run(
    CustomQueueMessage input, 
    ICollector<CustomQueueMessage> myQueueItems, 
    ILogger log)
{
    myQueueItems.Add(input);
    myQueueItems.Add(new CustomQueueMessage { PersonName = "You", Title = "None" });
}

Aşağıdaki örnek, bir HTTP isteği tarafından tetiklendiğinde kuyruk iletisi oluşturan bir Java işlevini gösterir.

@FunctionName("httpToQueue")
@QueueOutput(name = "item", queueName = "myqueue-items", connection = "MyStorageConnectionAppSetting")
 public String pushToQueue(
     @HttpTrigger(name = "request", methods = {HttpMethod.POST}, authLevel = AuthorizationLevel.ANONYMOUS)
     final String message,
     @HttpOutput(name = "response") final OutputBinding<String> result) {
       result.setValue(message + " has been added.");
       return message;
 }

Java işlevleri çalışma zamanı kitaplığı'nda, @QueueOutput değeri kuyruk depolamaya yazılacak olan parametrelerde ek açıklamayı kullanın. Parametre türü olmalıdır OutputBinding<T> , burada T BIR Pojo 'Nın yerel Java türüdür.

Aşağıdaki örnek, bir function. JSON DOSYASıNDAKI bir http tetikleyicisi bağlamasını ve bağlamayı kullanan bir JavaScript işlevini gösterir. İşlevi, 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çıklanmaktadır.

JavaScript kodu aşağıda verilmiştir:

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

Çıkış bağlaması için bir ileti dizisi tanımlayarak bir kerede birden çok ileti gönderebilirsiniz myQueueItem . 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 = function(context) {
    context.bindings.myQueueItem = ["message 1","message 2"];
    context.done();
};

Aşağıdaki kod örnekleri, bir HTTP ile tetiklenen işlevden bir sıra iletisinin nasıl çıktısının alınacağını göstermektedir. İçindeki yapılandırma bölümü, type queue Çıkış bağlamayı tanımlar.

{
  "bindings": [
    {
      "authLevel": "anonymous",
      "type": "httpTrigger",
      "direction": "in",
      "name": "Request",
      "methods": [
        "get",
        "post"
      ]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "Response"
    },
    {
      "type": "queue",
      "direction": "out",
      "name": "Msg",
      "queueName": "outqueue",
      "connection": "MyStorageConnectionAppSetting"
    }
  ]
}

Bu bağlama yapılandırmasını kullanarak bir PowerShell işlevi kullanarak bir kuyruk iletisi oluşturabilir Push-OutputBinding . Bu örnekte, bir sorgu dizesinden veya gövde parametresinden bir ileti oluşturulur.

using namespace System.Net

# Input bindings are passed in via param block.
param($Request, $TriggerMetadata)

# Write to the Azure Functions log stream.
Write-Host "PowerShell HTTP trigger function processed a request."

# Interact with query parameters or the body of the request.
$message = $Request.Query.Message
Push-OutputBinding -Name Msg -Value $message
Push-OutputBinding -Name Response -Value ([HttpResponseContext]@{
    StatusCode = 200
    Body = "OK"
})

Aynı anda birden çok ileti göndermek için, bir ileti dizisi tanımlayın ve Push-OutputBinding Iletileri kuyruk çıkış bağlamasına göndermek için kullanın.

using namespace System.Net

# Input bindings are passed in via param block.
param($Request, $TriggerMetadata)

# Write to the Azure Functions log stream.
Write-Host "PowerShell HTTP trigger function processed a request."

# Interact with query parameters or the body of the request.
$message = @("message1", "message2")
Push-OutputBinding -Name Msg -Value $message
Push-OutputBinding -Name Response -Value ([HttpResponseContext]@{
    StatusCode = 200
    Body = "OK"
})

Aşağıdaki örnek, Depolama kuyruklarına tek ve birden çok değerin nasıl alınacağını gösterir. Function. JSON için gereken yapılandırma her iki yoldan de aynıdır.

Depolama kuyruğu bağlama, türü olarak ayarlandığı function. json içinde tanımlanır 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"
    }
  ]
}

Kuyrukta tek bir ileti ayarlamak için yöntemine tek bir değer geçirirsiniz 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'

Kuyrukta birden çok ileti oluşturmak için, uygun liste türü olarak bir parametre bildirin ve yönteme (liste türüyle eşleşen) bir değer dizisi geçirin 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'

C# sınıf kitaplıklarında queueattributekullanın.

Özniteliği bir out parametre veya işlevin dönüş değeri için geçerlidir. Aşağıdaki örnekte gösterildiği gibi özniteliğin Oluşturucusu sıranın adını alır:

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

ConnectionAşağıdaki örnekte gösterildiği gibi, kullanılacak depolama hesabını belirtmek için özelliğini ayarlayabilirsiniz:

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

Tüm örnek için bkz. çıkış örneği.

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

Öznitelikler C# betiği tarafından desteklenmez.

QueueOutputEk açıklama, bir işlevin çıktısı olarak bir ileti yazmanızı sağlar. Aşağıdaki örnekte, bir kuyruk iletisi oluşturan HTTP ile tetiklenen bir işlev gösterilmektedir.

package com.function;
import java.util.*;
import com.microsoft.azure.functions.annotation.*;
import com.microsoft.azure.functions.*;

public class HttpTriggerQueueOutput {
    @FunctionName("HttpTriggerQueueOutput")
    public HttpResponseMessage run(
            @HttpTrigger(name = "req", methods = {HttpMethod.GET, HttpMethod.POST}, authLevel = AuthorizationLevel.FUNCTION) HttpRequestMessage<Optional<String>> request,
            @QueueOutput(name = "message", queueName = "messages", connection = "MyStorageConnectionAppSetting") OutputBinding<String> message,
            final ExecutionContext context) {

        message.setValue(request.getQueryParameters().get("name"));
        return request.createResponseBuilder(HttpStatus.OK).body("Done").build();
    }
}

QueueOutputEk açıklamayla ilişkili parametre bir OutputBinding <T> örneği olarak yazılır.

Öznitelikler JavaScript tarafından desteklenmez.

Öznitelikler PowerShell tarafından desteklenmez.

Öznitelikler Python tarafından desteklenmez.

Varsayılan

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

• JSON olarak seri hale getirilebilir bir nesne
• string
• byte[]
• CloudQueueMessage

' CloudQueueMessage a bağlanıp bir hata iletisi almaya çalışırsanız, doğru Depolama SDK sürümünebaşvurunuz olduğundan emin olun.

C# ve C# komut dosyasında, aşağıdaki türlerden birini kullanarak birden çok kuyruk iletisi yazın:

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

Ek türler

Uzantının 5.0.0 veya daha yüksek Depolama kullanan uygulamalar. .NETiçin Azure SDK'dan türleri de kullanabilir. Bu sürüm, eski ve türleri CloudQueue için CloudQueueMessage desteği aşağıdaki türler için tercih ediyor:

• QueueMessage
• Birden çok kuyruk iletileri yazmak için QueueClient

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

Varsayılan

gibi bir yöntem parametresi kullanarak tek bir kuyruk iletisi out T paramName yazın. paramName, name function.json özelliğinin özelliğinde belirtilen değerdir. Bir parametre yerine yöntem dönüş türünü out kullanabilirsiniz ve T aşağıdaki türlerden herhangi biri olabilir:

• JSON olarak seri hale getirilebilir bir nesne
• string
• byte[]
• CloudQueueMessage

'a bağlamayı dener ve hata iletisi alırsanız, doğru SDK sürümüne başvuru CloudQueueMessage Depolama olun.

C# ve C# betiğinde, aşağıdaki türlerden birini kullanarak birden çok kuyruk mesajı yazın:

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

Ek türler

Uzantının 5.0.0 veya daha yüksek Depolama kullanan uygulamalar. .NETiçin Azure SDK'dan türleri de kullanabilir. Bu sürüm, eski ve türleri CloudQueue için CloudQueueMessage desteği aşağıdaki türler için tercih ediyor:

• QueueMessage
• Birden çok kuyruk iletileri yazmak için QueueClient

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

QueueOutput ek açıklamasını kullanarak bir işlevden Kuyruk iletisi çıkışı için iki seçenek vardır:

• Dönüş değeri: Ek açıklama işlevin kendisine uygulanarak işlevin dönüş değeri Kuyruk iletisi olarak kalıcı olur.

• Kesinlik: İleti değerini açıkça ayarlamak için, ek açıklamasını türünde belirli bir parametreye (burada POJO veya herhangi bir yerel OutputBinding<T> T Java türü) uygulayabilirsiniz. Bu yapılandırmayla, yöntemine bir setValue değer geçirme, değeri Kuyruk iletisi olarak kalıcı olarak devam eder.

Çıkış kuyruğu öğesi, context.bindings.<NAME> <NAME> function.json içinde tanımlanan adla eşlenin üzerinden kullanılabilir. Kuyruk öğesi yükü için bir dize veya JSON seri hale getirilebilir nesnesi kullanabilirsiniz.

Kuyruk iletisi çıkışı, function.json dosyasında bağlamanın parametresi tarafından belirlenen adla eşan bağımsız değişkenleri Push-OutputBinding name iletirsiniz.

Bir işlevden Kuyruk iletisi çıkışı için iki seçenek vardır:

• Dönüş değeri: name function.json'daki özelliğini olarak $return ayarlayın. Bu yapılandırmayla, işlevin dönüş değeri Kuyruk depolama iletisi olarak kalıcı olur.

• Imperative: Bir değeri Out türü olarak bildirilen parametresinin set yöntemine iletir. geçirilen değer, set Kuyruk depolama iletisi olarak kalıcıdır.