Microsoft.Azure.WebJobs.Extensions.Storage.Queues 5.3.1

Azure WebJobs 存储队列客户端库，用于 .NET

此扩展提供了在 Azure Functions 中访问 Azure 存储 Queue 的功能。

入门指南

安装代码包

使用 NuGet 安装存储队列扩展

dotnet add package Azure.WebJobs.Extensions.Storage.Queues

先决条件

要使用此代码包，您需要一个 Azure 订阅 和一个 存储帐户。

要创建新的存储帐户，您可以使用 Azure 门户、Azure PowerShell 或 Azure CLI。以下使用 Azure CLI 的示例：

az storage account create --name <your-resource-name> --resource-group <your-resource-group-name> --location westus --sku Standard_LRS

验证客户端

为了让扩展能访问队列，您需要连接字符串，该字符串可以在Azure管理门户中找到，或者使用以下Azure CLI片段。

az storage account show-connection-string -g <your-resource-group-name> -n <your-resource-name>

可以通过AzureWebJobsStorage应用程序设置提供连接字符串。

关键概念

使用队列触发器

队列存储触发器在消息添加到Azure队列存储时运行函数。

请遵循教程了解如何在Azure Functions中监听队列。

使用队列绑定

Azure Functions可以通过设置输出绑定来创建新的Azure队列存储消息。

请遵循绑定教程了解如何使用此扩展在Azure Functions中将消息发布到队列。

示例

监听队列

以下一系列示例展示了如何接收并响应正在添加到队列中的消息。

将队列消息绑定到字符串

public static class QueueTriggerFunction_String
{
    [FunctionName("QueueTriggerFunction")]
    public static void Run(
        [QueueTrigger("sample-queue")] string message,
        ILogger logger)
    {
        logger.LogInformation("Received message from sample-queue, content={content}", message);
    }
}

将队列消息绑定到BinaryData

public static class QueueTriggerFunction_BinaryData
{
    [FunctionName("QueueTriggerFunction")]
    public static void Run(
        [QueueTrigger("sample-queue")] BinaryData message,
        ILogger logger)
    {
        logger.LogInformation("Received message from sample-queue, content={content}", message.ToString());
    }
}

将队列消息绑定到QueueMessage

public static class QueueTriggerFunction_QueueMessage
{
    [FunctionName("QueueTriggerFunction")]
    public static void Run(
        [QueueTrigger("sample-queue")] QueueMessage message,
        ILogger logger)
    {
        logger.LogInformation("Received message from sample-queue, content={content}", message.Body.ToString());
    }
}

将队列消息绑定到自定义类型

public static class QueueTriggerFunction_CustomObject
{
    public class CustomMessage
    {
        public string Content { get; set; }
    }

    [FunctionName("QueueTriggerFunction")]
    public static void Run(
        [QueueTrigger("sample-queue")] CustomMessage message,
        ILogger logger)
    {
        logger.LogInformation("Received message from sample-queue, content={content}", message.Content);
    }
}

将队列消息绑定到JObject

public static class QueueTriggerFunction_JObject
{
    [FunctionName("QueueTriggerFunction")]
    public static void Run(
        [QueueTrigger("sample-queue")] JObject message,
        ILogger logger)
    {
        logger.LogInformation("Received message from sample-queue, content={content}", message["content"]);
    }
}

将消息发布到队列

以下一系列示例展示了如何使用Queue属性将消息添加到队列。

QueueTrigger仅用于示例完整性，即可以替换为任何其他触发机制。

作为字符串发布消息

public static class QueueSenderFunction_String_Return
{
    [FunctionName("QueueFunction")]
    [return: Queue("sample-queue-2")]
    public static string Run(
        [QueueTrigger("sample-queue-1")] string message,
        ILogger logger)
    {
        logger.LogInformation("Received message from sample-queue-1, content={content}", message);
        logger.LogInformation("Dispatching message to sample-queue-2");
        return message;
    }
}

作为BinaryData发布消息

public static class QueueSenderFunction_BinaryData_Return
{
    [FunctionName("QueueFunction")]
    [return: Queue("sample-queue-2")]
    public static BinaryData Run(
        [QueueTrigger("sample-queue-1")] BinaryData message,
        ILogger logger)
    {
        logger.LogInformation("Received message from sample-queue-1, content={content}", message.ToString());
        logger.LogInformation("Dispatching message to sample-queue-2");
        return message;
    }
}

作为QueueMessage发布消息

public static class QueueSenderFunction_QueueMessage_Return
{
    [FunctionName("QueueFunction")]
    [return: Queue("sample-queue-2")]
    public static QueueMessage Run(
        [QueueTrigger("sample-queue-1")] QueueMessage message,
        ILogger logger)
    {
        logger.LogInformation("Received message from sample-queue-1, content={content}", message.Body.ToString());
        logger.LogInformation("Dispatching message to sample-queue-2");
        return message;
    }
}

通过输出参数作为自定义类型发布消息

public static class QueueSenderFunction_CustomObject_OutParamter
{
    public class CustomMessage
    {
        public string Content { get; set; }
    }

    [FunctionName("QueueFunction")]
    public static void Run(
        [QueueTrigger("sample-queue-1")] CustomMessage incomingMessage,
        [Queue("sample-queue-2")] out CustomMessage outgoingMessage,
        ILogger logger)
    {
        logger.LogInformation("Received message from sample-queue-1, content={content}", incomingMessage.Content);
        logger.LogInformation("Dispatching message to sample-queue-2");
        outgoingMessage = incomingMessage;
    }
}

通过收集器作为自定义类型发布消息

public static class QueueSenderFunction_CustomObject_Collector
{
    public class CustomMessage
    {
        public string Content { get; set; }
    }

    [FunctionName("QueueFunction")]
    public static void Run(
        [QueueTrigger("sample-queue-1")] CustomMessage incomingMessage,
        [Queue("sample-queue-2")] ICollector<CustomMessage> collector,
        ILogger logger)
    {
        logger.LogInformation("Received message from sample-queue-1, content={content}", incomingMessage.Content);
        logger.LogInformation("Dispatching message to sample-queue-2");
        collector.Add(incomingMessage);
    }
}

访问队列属性

public static class Function_BindingToQueueClient
{
    [FunctionName("QueueFunction")]
    public static async Task Run(
        [QueueTrigger("sample-queue")] string message,
        [Queue("sample-queue")] QueueClient queueClient,
        ILogger logger)
    {
        logger.LogInformation("Received message from sample-queue, content={content}", message);
        QueueProperties queueProperties = await queueClient.GetPropertiesAsync();
        logger.LogInformation("There are approximatelly {count} messages", queueProperties.ApproximateMessagesCount);
    }
}

配置扩展

请参考示例函数应用。

故障排除

请参考监控Azure Functions以获取故障排除指导。

下一步操作

阅读Azure Functions简介或创建Azure Function指南。

贡献

有关构建、测试和为该库做出贡献的详细信息，请参阅Storage CONTRIBUTING.md。

此项目欢迎贡献和建议。大多数贡献都需要您同意贡献许可协议（CLA），声明您有权，并且确实向我们授予了使用您贡献的权利。有关详细信息，请访问cla.microsoft.com。

此项目已采用Microsoft开源行为准则。有关更多信息，请查看行为准则FAQ或通过[email protected]联系有关任何额外问题或评论。