Liaisons SendGrid dans Azure Functions

• Créer votre première fonction

• Références pour les développeurs C# :

  • Bibliothèque de classes In-process
  • Bibliothèque de classes de processus Worker isolé
  • Script C#

• Créer votre première fonction

• Informations de référence pour les développeurs JavaScript

• Créer votre première fonction

• Informations de référence pour les développeurs TypeScript

• Créer votre première fonction

• Informations de référence pour les développeurs Java

• Créer votre première fonction

• Informations de référence pour les développeurs Python

• Créer votre première fonction

• Informations de référence pour les développeurs PowerShell

Installer l’extension

Le package NuGet de l’extension que vous installez dépend du mode C# que vous utilisez dans votre application de fonction :

La fonctionnalité de l’extension varie en fonction de la version de l’extension :

Installer le bundle

À partir de Functions version 2.x, l’extension HTTP fait partie d’une offre groupée d’extension, qui est spécifiée dans votre fichier projet host.json. Pour plus d’informations, consultez le bundle d’extensions.

Une fonction C# peut être créée à l’aide de l’un des modes C# suivants :

• Modèle worker isolé : fonction C# compilée exécutée dans un processus worker isolé du runtime. Le processus Worker isolé est requis pour prendre en charge les fonctions C# exécutées sur les versions LTS et non-LTS de .NET et de .NET Framework.
• Modèle In-process : fonction C# compilée exécutée dans le même processus que le runtime Functions.
• Script C# : principalement utilisé lors de la création de fonctions C# dans le portail Azure.

using SendGrid.Helpers.Mail;
using System.Text.Json;

...

[FunctionName("SendEmail")]
public static void Run(
    [ServiceBusTrigger("myqueue", Connection = "ServiceBusConnection")] Message email,
    [SendGrid(ApiKey = "CustomSendGridKeyAppSettingName")] out SendGridMessage message)
{
    var emailObject = JsonSerializer.Deserialize<OutgoingEmail>(Encoding.UTF8.GetString(email.Body));

    message = new SendGridMessage();
    message.AddTo(emailObject.To);
    message.AddContent("text/html", emailObject.Body);
    message.SetFrom(new EmailAddress(emailObject.From));
    message.SetSubject(emailObject.Subject);
}

public class OutgoingEmail
{
    public string To { get; set; }
    public string From { get; set; }
    public string Subject { get; set; }
    public string Body { get; set; }
}

using SendGrid.Helpers.Mail;
using System.Text.Json;

...

[FunctionName("SendEmail")]
public static async Task Run(
 [ServiceBusTrigger("myqueue", Connection = "ServiceBusConnection")] Message email,
 [SendGrid(ApiKey = "CustomSendGridKeyAppSettingName")] IAsyncCollector<SendGridMessage> messageCollector)
{
    var emailObject = JsonSerializer.Deserialize<OutgoingEmail>(Encoding.UTF8.GetString(email.Body));

    var message = new SendGridMessage();
    message.AddTo(emailObject.To);
    message.AddContent("text/html", emailObject.Body);
    message.SetFrom(new EmailAddress(emailObject.From));
    message.SetSubject(emailObject.Subject);

    await messageCollector.AddAsync(message);
}

public class OutgoingEmail
{
    public string To { get; set; }
    public string From { get; set; }
    public string Subject { get; set; }
    public string Body { get; set; }
}

L’exemple suivant montre une liaison de sortie SendGrid dans un fichier function.json et une fonction JavaScript qui utilise la liaison.

Voici les données de liaison dans le fichier function.json :

{
    "bindings": [
        {
            "name": "$return",
            "type": "sendGrid",
            "direction": "out",
            "apiKey" : "MySendGridKey",
            "to": "{ToEmail}",
            "from": "{FromEmail}",
            "subject": "SendGrid output bindings"
        }
    ]
}

La section configuration décrit ces propriétés.

Voici le code JavaScript :

module.exports = function (context, input) {
    var message = {
        "personalizations": [ { "to": [ { "email": "sample@sample.com" } ] } ],
        from: { email: "sender@contoso.com" },
        subject: "Azure news",
        content: [{
            type: 'text/plain',
            value: input
        }]
    };

    return message;
};

Aucun exemple PowerShell complet n'est actuellement disponible pour les liaisons SendGrid.

L’exemple suivant montre une fonction déclenchée par HTTP qui envoie un e-mail à l’aide de la liaison SendGrid. Vous pouvez fournir des valeurs par défaut dans la configuration de la liaison. Par exemple, l’adresse e-mail de l’expéditeur est configurée dans function.json.

{
  "scriptFile": "__init__.py",
  "bindings": [
    {
      "type": "httpTrigger",
      "authLevel": "function",
      "direction": "in",
      "name": "req",
      "methods": ["get", "post"]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "$return"
    },
    {
      "type": "sendGrid",
      "name": "sendGridMessage",
      "direction": "out",
      "apiKey": "SendGrid_API_Key",
      "from": "sender@contoso.com"
    }
  ]
}

La fonction suivante montre comment vous pouvez fournir des valeurs personnalisées pour des propriétés facultatives.

import logging
import json
import azure.functions as func

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

    value = "Sent from Azure Functions"

    message = {
        "personalizations": [ {
          "to": [{
            "email": "user@contoso.com"
            }]}],
        "subject": "Azure Functions email with SendGrid",
        "content": [{
            "type": "text/plain",
            "value": value }]}

    sendGridMessage.set(json.dumps(message))

    return func.HttpResponse(f"Sent")

L’exemple suivant utilise l’annotation @SendGridOutput de la bibliothèque du runtime des fonctions Java pour envoyer un e-mail à l’aide de la liaison de sortie SendGrid.

package com.function;

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

public class HttpTriggerSendGrid {

    @FunctionName("HttpTriggerSendGrid")
    public HttpResponseMessage run(

        @HttpTrigger(
            name = "req",
            methods = { HttpMethod.GET, HttpMethod.POST },
            authLevel = AuthorizationLevel.FUNCTION)
                HttpRequestMessage<Optional<String>> request,

        @SendGridOutput(
            name = "message",
            dataType = "String",
            apiKey = "SendGrid_API_Key",
            to = "user@contoso.com",
            from = "sender@contoso.com",
            subject = "Azure Functions email with SendGrid",
            text = "Sent from Azure Functions")
                OutputBinding<String> message,

        final ExecutionContext context) {

        final String toAddress = "user@contoso.com";
        final String value = "Sent from Azure Functions";

        StringBuilder builder = new StringBuilder()
            .append("{")
            .append("\"personalizations\": [{ \"to\": [{ \"email\": \"%s\"}]}],")
            .append("\"content\": [{\"type\": \"text/plain\", \"value\": \"%s\"}]")
            .append("}");

        final String body = String.format(builder.toString(), toAddress, value);

        message.setValue(body);

        return request.createResponseBuilder(HttpStatus.OK).body("Sent").build();
    }
}

Attributs

Les bibliothèques C# In-process et de processus Worker isolé utilisent des attributs pour définir la liaison de sortie. Le script C# utilise à la place un fichier config function.json.

Annotations

L’annotation SendGridOutput vous permet de configurer de manière déclarative la liaison SendGrid en fournissant les valeurs de configuration suivantes.

• apiKey
• dataType
• name
• to
• from
• subject
• text

Configuration

Le tableau suivant liste les propriétés de configuration de liaison qui sont disponibles dans le fichier function.json et dans l’attribut/annotation SendGrid :

Les propriétés facultatives peuvent avoir des valeurs par défaut qui sont définies dans la liaison, et qui sont soit ajoutées, soit remplacées programmatiquement.