Azure Functions の Azure Event Grid 出力バインディング

[アーティクル]
10/07/2023

イベントをカスタムトピックに書き込むには、Event Grid 出力バインディングを使用します。有効なカスタムトピックのアクセスキーが必要です。 Event Grid 出力バインディングでは、Shared Access Signature (SAS トークン) はサポートされていません。

セットアップと構成の詳細については、「How to work with Event Grid triggers and bindings in Azure Functions」を参照してください。

重要

この記事では、タブを使用して、Node.js プログラミングモデルの複数のバージョンに対応しています。 v4 モデルは一般提供されており、JavaScript と TypeScript の開発者にとって、より柔軟で直感的なエクスペリエンスが得られるように設計されています。 v4 モデルの動作の詳細については、Azure Functions Node.js 開発者ガイドを参照してください。 v3 と v4 の違いの詳細については、移行ガイドを参照してください。

Azure Functions では、Python の 2 つのプログラミングモデルがサポートされています。バインドを定義する方法は、選択したプログラミングモデルによって異なります。

Python v2 プログラミングモデルでは、Python 関数コードでデコレーターを使用してバインドを直接定義できます。詳細については、「Python 開発者ガイド」を参照してください。

この記事は、両方のプログラミングモデルをサポートしています。

重要

Event Grid 出力バインディングは、Functions 2.x 以降でのみ使用することができます。

例

Event Grid 出力バインディングで使用される出力パラメーターの型は、Functions ランタイムのバージョン、バインディング拡張機能のバージョン、および C# 関数のモダリティによって異なります。 C# 関数は、次の C# モードのいずれかを使用して作成できます。

インプロセスクラスライブラリ: Functions ランタイムと同じプロセスで実行されるコンパイル済みの C# 関数。
分離ワーカープロセスクラスライブラリ: ランタイムから分離されたワーカープロセスで実行されるコンパイル済みの C# 関数。

分離ワーカーモデル
インプロセスモデル

次の例は、トリガーと Event Grid 出力バインディングの両方でカスタム型がどのように使用されるかを示しています。

using System;
using System.Collections.Generic;
using Microsoft.Azure.Functions.Worker;
using Microsoft.Extensions.Logging;

namespace SampleApp
{
    public static class EventGridFunction
    {
        [Function(nameof(EventGridFunction))]
        [EventGridOutput(TopicEndpointUri = "MyEventGridTopicUriSetting", TopicKeySetting = "MyEventGridTopicKeySetting")]
        public static MyEventType Run([EventGridTrigger] MyEventType input, FunctionContext context)
        {
            var logger = context.GetLogger(nameof(EventGridFunction));

            logger.LogInformation(input.Data.ToString());

            var outputEvent = new MyEventType()
            {
                Id = "unique-id",
                Subject = "abc-subject",
                Data = new Dictionary<string, object>
                {
                    { "myKey", "myValue" }
                }
            };

            return outputEvent;
        }
    }

    public class MyEventType
    {
        public string Id { get; set; }

        public string Topic { get; set; }

        public string Subject { get; set; }

        public string EventType { get; set; }

        public DateTime EventTime { get; set; }

        public IDictionary<string, object> Data { get; set; }
    }
}

重要

インプロセスモデルのサポートは 2026 年 11 月 10 日に終了します。完全なサポートのために、アプリを分離ワーカーモデルに移行することを強くお勧めします。

次の例は、バージョン 3.x の拡張機能を使用して CloudEvent を発行する C# 関数を示しています。

using System.Threading.Tasks;
using Azure.Messaging;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Extensions.EventGrid;
using Microsoft.Azure.WebJobs.Extensions.Http;

namespace Azure.Extensions.WebJobs.Sample
{
    public static class CloudEventBindingFunction
    {
        [FunctionName("CloudEventBindingFunction")]
        public static async Task<IActionResult> RunAsync(
            [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post", Route = null)] HttpRequest req,
            [EventGrid(TopicEndpointUri = "EventGridEndpoint", TopicKeySetting = "EventGridKey")] IAsyncCollector<CloudEvent> eventCollector)
        {
            CloudEvent e = new CloudEvent("IncomingRequest", "IncomingRequest", await req.ReadAsStringAsync());
            await eventCollector.AddAsync(e);
            return new OkResult();
        }
    }
}

次の例は、バージョン 3.x の拡張機能を使用して EventGridEvent を発行する C# 関数を示しています。

using System.Threading.Tasks;
using Azure.Messaging.EventGrid;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Http;
using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Extensions.Http;
using Microsoft.Azure.WebJobs.Extensions.EventGrid;

namespace Azure.Extensions.WebJobs.Sample
{
    public static class EventGridEventBindingFunction
    {
        [FunctionName("EventGridEventBindingFunction")]
        public static async Task<IActionResult> RunAsync(
            [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post", Route = null)] HttpRequest req,
            [EventGrid(TopicEndpointUri = "EventGridEndpoint", TopicKeySetting = "EventGridKey")] IAsyncCollector<EventGridEvent> eventCollector)
        {
            EventGridEvent e = new EventGridEvent(await req.ReadAsStringAsync(), "IncomingRequest", "IncomingRequest", "1.0.0");
            await eventCollector.AddAsync(e);
            return new OkResult();
        }
    }
}

次の例は、メソッドの戻り値を出力として使用して EventGridEvent メッセージを Event Grid のカスタムトピックに発行する C# 関数を示しています。

[FunctionName("EventGridOutput")]
[return: EventGrid(TopicEndpointUri = "MyEventGridTopicUriSetting", TopicKeySetting = "MyEventGridTopicKeySetting")]
public static EventGridEvent Run([TimerTrigger("0 */5 * * * *")] TimerInfo myTimer, ILogger log)
{
    return new EventGridEvent("message-id", "subject-name", "event-data", "event-type", DateTime.UtcNow, "1.0");
}

次のように out パラメーターを使用して、同じことを実行することもできます:

[FunctionName("EventGridOutput")]
[return: EventGrid(TopicEndpointUri = "MyEventGridTopicUriSetting", TopicKeySetting = "MyEventGridTopicKeySetting")]
public static void Run(
    [TimerTrigger("0 */5 * * * *")] TimerInfo myTimer,
    EventGrid(TopicEndpointUri = "MyEventGridTopicUriSetting", TopicKeySetting = "MyEventGridTopicKeySetting") out eventGridEvent,
    ILogger log)
{
    eventGridEvent = EventGridEvent("message-id", "subject-name", "event-data", "event-type", DateTime.UtcNow, "1.0");
}

次の例は、IAsyncCollector インターフェイスを使用して EventGridEvent メッセージのバッチを送信する方法を示しています。

[FunctionName("EventGridAsyncOutput")]
public static async Task Run(
    [TimerTrigger("0 */5 * * * *")] TimerInfo myTimer,
    [EventGrid(TopicEndpointUri = "MyEventGridTopicUriSetting", TopicKeySetting = "MyEventGridTopicKeySetting")]IAsyncCollector<EventGridEvent> outputEvents,
    ILogger log)
{
    for (var i = 0; i < 3; i++)
    {
        var myEvent = new EventGridEvent("message-id-" + i, "subject-name", "event-data", "event-type", DateTime.UtcNow, "1.0");
        await outputEvents.AddAsync(myEvent);
    }
}

バージョン 3.3.0 以降では、出力バインドの認証を行うときに Microsoft Entra ID を使用できます:

[FunctionName("EventGridAsyncOutput")]
public static async Task Run(
    [TimerTrigger("0 */5 * * * *")] TimerInfo myTimer,
    [EventGrid(Connection = "MyEventGridConnection"]IAsyncCollector<CloudEvent> outputEvents,
    ILogger log)
{
    for (var i = 0; i < 3; i++)
    {
        var myEvent = new CloudEvent("message-id-" + i, "subject-name", "event-data");
        await outputEvents.AddAsync(myEvent);
    }
}

Connection プロパティを使用する場合は、topicEndpointUri を接続設定の子として指定する必要があり、TopicEndpointUri プロパティと TopicKeySetting プロパティは使用しないでください。ローカル開発の場合は、次のように local.settings.json ファイルを使用して接続情報を保存します。

{
  "Values": {
    "myConnection__topicEndpointUri": "{topicEndpointUri}"
  }
}

デプロイする場合は、関数アプリのアプリケーション設定に同じ情報を追加する必要があります。詳細については、「ID ベースの認証」を参照してください。

次の例は、メッセージを Event Grid カスタムトピックに書き込む Java 関数を示しています。この関数では、バインドの setValue メソッドを使用して文字列を出力します。

public class Function {
    @FunctionName("EventGridTriggerTest")
    public void run(@EventGridTrigger(name = "event") String content,
            @EventGridOutput(name = "outputEvent", topicEndpointUri = "MyEventGridTopicUriSetting", topicKeySetting = "MyEventGridTopicKeySetting") OutputBinding<String> outputEvent,
            final ExecutionContext context) {
        context.getLogger().info("Java EventGrid trigger processed a request." + content);
        final String eventGridOutputDocument = "{\"id\": \"1807\", \"eventType\": \"recordInserted\", \"subject\": \"myapp/cars/java\", \"eventTime\":\"2017-08-10T21:03:07+00:00\", \"data\": {\"make\": \"Ducati\",\"model\": \"Monster\"}, \"dataVersion\": \"1.0\"}";
        outputEvent.setValue(eventGridOutputDocument);
    }
}

POJO クラスを使用して EventGrid メッセージを送信することもできます。

public class Function {
    @FunctionName("EventGridTriggerTest")
    public void run(@EventGridTrigger(name = "event") String content,
            @EventGridOutput(name = "outputEvent", topicEndpointUri = "MyEventGridTopicUriSetting", topicKeySetting = "MyEventGridTopicKeySetting") OutputBinding<EventGridEvent> outputEvent,
            final ExecutionContext context) {
        context.getLogger().info("Java EventGrid trigger processed a request." + content);

        final EventGridEvent eventGridOutputDocument = new EventGridEvent();
        eventGridOutputDocument.setId("1807");
        eventGridOutputDocument.setEventType("recordInserted");
        eventGridOutputDocument.setEventTime("2017-08-10T21:03:07+00:00");
        eventGridOutputDocument.setDataVersion("1.0");
        eventGridOutputDocument.setSubject("myapp/cars/java");
        eventGridOutputDocument.setData("{\"make\": \"Ducati\",\"model\":\"monster\"");

        outputEvent.setValue(eventGridOutputDocument);
    }
}

class EventGridEvent {
    private String id;
    private String eventType;
    private String subject;
    private String eventTime;
    private String dataVersion;
    private String data;

    public String getId() {
        return id;
    }

    public String getData() {
        return data;
    }

    public void setData(String data) {
        this.data = data;
    }

    public String getDataVersion() {
        return dataVersion;
    }

    public void setDataVersion(String dataVersion) {
        this.dataVersion = dataVersion;
    }

    public String getEventTime() {
        return eventTime;
    }

    public void setEventTime(String eventTime) {
        this.eventTime = eventTime;
    }

    public String getSubject() {
        return subject;
    }

    public void setSubject(String subject) {
        this.subject = subject;
    }

    public String getEventType() {
        return eventType;
    }

    public void setEventType(String eventType) {
        this.eventType = eventType;
    }

    public void setId(String id) {
        this.id = id;
    }  
}

モデル v4
モデル v3

次の例は、タイマーによってトリガーされ、1 つのイベントを出力する TypeScript 関数を示しています。

import { app, EventGridPartialEvent, InvocationContext, output, Timer } from '@azure/functions';

export async function timerTrigger1(myTimer: Timer, context: InvocationContext): Promise<EventGridPartialEvent> {
    const timeStamp = new Date().toISOString();
    return {
        id: 'message-id',
        subject: 'subject-name',
        dataVersion: '1.0',
        eventType: 'event-type',
        data: {
            name: 'John Henry',
        },
        eventTime: timeStamp,
    };
}

app.timer('timerTrigger1', {
    schedule: '0 */5 * * * *',
    return: output.eventGrid({
        topicEndpointUri: 'MyEventGridTopicUriSetting',
        topicKeySetting: 'MyEventGridTopicKeySetting',
    }),
    handler: timerTrigger1,
});

複数のイベントを出力するには、1 つのオブジェクトではなく配列を返します。次に例を示します。

const timeStamp = new Date().toISOString();
return [
    {
        id: 'message-id',
        subject: 'subject-name',
        dataVersion: '1.0',
        eventType: 'event-type',
        data: {
            name: 'John Henry',
        },
        eventTime: timeStamp,
    },
    {
        id: 'message-id-2',
        subject: 'subject-name',
        dataVersion: '1.0',
        eventType: 'event-type',
        data: {
            name: 'John Doe',
        },
        eventTime: timeStamp,
    },
];

モデル v4
モデル v3

次の例は、タイマーによってトリガーされ、1 つのイベントを出力する JavaScript 関数を示しています。

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

const eventGridOutput = output.eventGrid({
    topicEndpointUri: 'MyEventGridTopicUriSetting',
    topicKeySetting: 'MyEventGridTopicKeySetting',
});

app.timer('timerTrigger1', {
    schedule: '0 */5 * * * *',
    return: eventGridOutput,
    handler: (myTimer, context) => {
        const timeStamp = new Date().toISOString();
        return {
            id: 'message-id',
            subject: 'subject-name',
            dataVersion: '1.0',
            eventType: 'event-type',
            data: {
                name: 'John Henry',
            },
            eventTime: timeStamp,
        };
    },
});

複数のイベントを出力するには、1 つのオブジェクトではなく配列を返します。次に例を示します。

const timeStamp = new Date().toISOString();
return [
    {
        id: 'message-id',
        subject: 'subject-name',
        dataVersion: '1.0',
        eventType: 'event-type',
        data: {
            name: 'John Henry',
        },
        eventTime: timeStamp,
    },
    {
        id: 'message-id-2',
        subject: 'subject-name',
        dataVersion: '1.0',
        eventType: 'event-type',
        data: {
            name: 'John Doe',
        },
        eventTime: timeStamp,
    },
];

次の例は、function.json ファイル内の Event Grid 出力バインディングデータを示しています。

{
    "type": "eventGrid",
    "name": "outputEvent",
    "topicEndpointUri": "MyEventGridTopicUriSetting",
    "topicKeySetting": "MyEventGridTopicKeySetting",
    "direction": "out"
}

単一のイベントを作成する JavaScript コードを次に示します。

module.exports = async function (context, myTimer) {
    var timeStamp = new Date().toISOString();

    context.bindings.outputEvent = {
        id: 'message-id',
        subject: 'subject-name',
        dataVersion: '1.0',
        eventType: 'event-type',
        data: "event-data",
        eventTime: timeStamp
    };
};

複数のイベントを作成する JavaScript コードを次に示します。

module.exports = async function(context) {
    var timeStamp = new Date().toISOString();

    context.bindings.outputEvent = [];

    context.bindings.outputEvent.push({
        id: 'message-id-1',
        subject: 'subject-name',
        dataVersion: '1.0',
        eventType: 'event-type',
        data: "event-data",
        eventTime: timeStamp
    });
    context.bindings.outputEvent.push({
        id: 'message-id-2',
        subject: 'subject-name',
        dataVersion: '1.0',
        eventType: 'event-type',
        data: "event-data",
        eventTime: timeStamp
    });
};

次の例は、Event Grid イベントメッセージを出力するように関数を構成する方法を示しています。 type が eventGrid に設定されているセクションでは、Event Grid 出力バインディングを確立するのに必要な値が構成されます。

{
  "bindings": [
    {
      "type": "eventGrid",
      "name": "outputEvent",
      "topicEndpointUri": "MyEventGridTopicUriSetting",
      "topicKeySetting": "MyEventGridTopicKeySetting",
      "direction": "out"
    },
    {
      "authLevel": "anonymous",
      "type": "httpTrigger",
      "direction": "in",
      "name": "Request",
      "methods": [
        "get",
        "post"
      ]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "Response"
    }
  ]
}

関数では、Push-OutputBinding を使用して、Event Grid 出力バインディングを介してカスタムトピックにイベントを送信します。

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 outputEvent -Value  @{
    id = "1"
    eventType = "testEvent"
    subject = "testapp/testPublish"
    eventTime = "2020-08-27T21:03:07+00:00"
    data = @{
        Message = $message
    }
    dataVersion = "1.0"
}

Push-OutputBinding -Name Response -Value ([HttpResponseContext]@{
    StatusCode = 200
    Body = "OK"
})

次の例は、トリガーバインドと、そのバインドが使用される Python 関数を示しています。次に、topicEndpointUri によって指定されたとおり、イベントがカスタムトピックに送信されます。この例は、v1 と v2 のどちらの Python プログラミングモデルを使用するかによって異なります。

function_app.py ファイルの関数を次に示します。

import logging
import azure.functions as func
import datetime

app = func.FunctionApp()

@app.function_name(name="eventgrid_output")
@app.event_grid_trigger(arg_name="eventGridEvent")
@app.event_grid_output(
    arg_name="outputEvent",
    topic_endpoint_uri="MyEventGridTopicUriSetting",
    topic_key_setting="MyEventGridTopicKeySetting")
def eventgrid_output(eventGridEvent: func.EventGridEvent, 
         outputEvent: func.Out[func.EventGridOutputEvent]) -> None:

    logging.log("eventGridEvent: ", eventGridEvent)

    outputEvent.set(
        func.EventGridOutputEvent(
            id="test-id",
            data={"tag1": "value1", "tag2": "value2"},
            subject="test-subject",
            event_type="test-event-1",
            event_time=datetime.datetime.utcnow(),
            data_version="1.0"))

function.json ファイルのバインディングデータを次に示します。

{
  "scriptFile": "__init__.py",
  "bindings": [
    {
      "type": "eventGridTrigger",
      "name": "eventGridEvent",
      "direction": "in"
    },
    {
      "type": "eventGrid",
      "name": "outputEvent",
      "topicEndpointUri": "MyEventGridTopicUriSetting",
      "topicKeySetting": "MyEventGridTopicKeySetting",
      "direction": "out"
    }
  ],
  "disabled": false
}

EventGridOutputEvent を設定してカスタムトピックにイベントを送信する Python サンプルを次に示します。

import logging
import azure.functions as func
import datetime

def main(eventGridEvent: func.EventGridEvent, 
         outputEvent: func.Out[func.EventGridOutputEvent]) -> None:

    logging.log("eventGridEvent: ", eventGridEvent)

    outputEvent.set(
        func.EventGridOutputEvent(
            id="test-id",
            data={"tag1": "value1", "tag2": "value2"},
            subject="test-subject",
            event_type="test-event-1",
            event_time=datetime.datetime.utcnow(),
            data_version="1.0"))

属性

インプロセスと分離ワーカープロセスの C# ライブラリはどちらも、属性を使用してバインドを構成します。 C# スクリプトでは、C# スクリプトガイドで説明されているように、代わりに function.json 構成ファイルを使用します。

属性のコンストラクターは、カスタムトピックの名前を含むアプリ設定の名前と、トピックキーを含むアプリ設定の名前を受け取ります。

分離ワーカーモデル
インプロセスモデル

次の表は、EventGridOutputAttribute のパラメーターを説明したものです。

パラメーター	説明
TopicEndpointUri	カスタムトピックの URI を含むアプリ設定の名前 (例: `MyTopicEndpointUri`)。
TopicKeySetting	カスタムトピックのアクセスキーを含むアプリ設定の名前。
connection^*	トピックエンドポイント URI を含む設定の共通プレフィックスの値。このアプリケーション設定の名前付け形式の詳細については、「ID ベースの認証」を参照してください。

次の表は、EventGridAttribute のパラメーターを説明したものです。

パラメーター	説明
TopicEndpointUri	カスタムトピックの URI を含むアプリ設定の名前 (例: `MyTopicEndpointUri`)。
TopicKeySetting	カスタムトピックのアクセスキーを含むアプリ設定の名前。
接続^*	トピックエンドポイント URI を含む設定の共通プレフィックスの値。このアプリケーション設定の名前付け形式の詳細については、「ID ベースの認証」を参照してください。

注釈

Java クラスでは、EventGridAttribute 属性を使用します。

属性のコンストラクターは、カスタムトピックの名前を含むアプリ設定の名前と、トピックキーを含むアプリ設定の名前を受け取ります。これらの設定の詳細については、「出力 - 構成」を参照してください。 EventGridOutput 属性の例を次に示します。

public class Function {
    @FunctionName("EventGridTriggerTest")
    public void run(@EventGridTrigger(name = "event") String content,
            @EventGridOutput(name = "outputEvent", topicEndpointUri = "MyEventGridTopicUriSetting", topicKeySetting = "MyEventGridTopicKeySetting") OutputBinding<String> outputEvent, final ExecutionContext context) {
            ...
    }
}

次の表では、output.eventGrid() メソッドに渡される options オブジェクトに対して設定できるプロパティについて説明します。

プロパティ	説明
topicEndpointUri	カスタムトピックの URI を含むアプリ設定の名前 (例: `MyTopicEndpointUri`)。
topicKeySetting	カスタムトピックのアクセスキーを含むアプリ設定の名前。
connection^*	トピックエンドポイント URI を含む設定の共通プレフィックスの値。 `connection` プロパティを設定するときは、`topicEndpointUri` と `topicKeySetting` のプロパティは設定しないでください。このアプリケーション設定の名前付け形式の詳細については、「ID ベースの認証」を参照してください。

次の表は、function.json ファイルで設定したバインド構成のプロパティを説明しています。

プロパティ	説明
type	`eventGrid` に設定する必要があります。
direction	`out` に設定する必要があります。このパラメーターは、Azure Portal でバインドを作成するときに自動で設定されます。
name	イベントを表す関数コードに使用される変数の名前。
topicEndpointUri	カスタムトピックの URI を含むアプリ設定の名前 (例: `MyTopicEndpointUri`)。
topicKeySetting	カスタムトピックのアクセスキーを含むアプリ設定の名前。
connection^*	トピックエンドポイント URI を含む設定の共通プレフィックスの値。 `connection` プロパティを設定するときは、`topicEndpointUri` と `topicKeySetting` のプロパティは設定しないでください。このアプリケーション設定の名前付け形式の詳細については、「ID ベースの認証」を参照してください。

構成

次の表は、function.json ファイルで設定したバインド構成のプロパティを説明しています。

function.json のプロパティ	説明
type	`eventGrid` に設定する必要があります。
direction	`out` に設定する必要があります。このパラメーターは、Azure Portal でバインドを作成するときに自動で設定されます。
name	イベントを表す関数コードに使用される変数の名前。
topicEndpointUri	カスタムトピックの URI を含むアプリ設定の名前 (例: `MyTopicEndpointUri`)。
topicKeySetting	カスタムトピックのアクセスキーを含むアプリ設定の名前。
connection^*	トピックエンドポイント URI を含む設定の共通プレフィックスの値。このアプリケーション設定の名前付け形式の詳細については、「ID ベースの認証」を参照してください。

^*ID ベースの接続をサポートするには、バージョン 3.3.x 以降の拡張機能が必要です。

ローカルで開発する場合は、Values コレクション内の local.settings.json ファイルにアプリケーション設定を追加します。

重要

TopicEndpointUri の値を、カスタムトピックの URI を含むアプリ設定の名前に設定してください。このプロパティにカスタムトピックの URI を直接指定しないでください。 Connection を使用する場合も同じことが当てはまります。

完全な例については、セクションの例を参照してください。

使用方法

Event Grid 出力バインディングでサポートされるパラメーター型は、Functions ランタイムのバージョン、拡張機能パッケージのバージョン、および使用される C# のモダリティによって異なります。

インプロセス C# クラスライブラリ関数では、次の型がサポートされています。

out EventGridEvent paramName などのメソッドパラメーターを使用してメッセージを送信します。複数のメッセージを書き込むには、代わりに ICollector<EventGridEvent> または IAsyncCollector<EventGridEvent> を使用します。

インプロセス C# クラスライブラリ関数では、次の型がサポートされています。

関数で 1 つのイベントを書き込むとき、Event Grid 出力バインドは次の型にバインドできます。

Type	説明
`string`	文字列としてのイベント。
`byte[]`	イベントメッセージのバイト数。
JSON シリアル化可能な型	JSON イベントを表すオブジェクト。 Functions は、単純な従来の CLR オブジェクト (POCO) 型を JSON データにシリアル化しようとします。

関数で複数のイベントを書き込むとき、Event Grid 出力バインドは次の型にバインドできます。

Type	説明
`T[]` (`T` は単一のイベントの種類の 1 つ)	複数のイベントを含む配列。各エントリは 1 つのイベントを表します。

その他の出力シナリオでは、Azure.Messaging.EventGrid から型を直接作成して使用します。

out EventGridOutput paramName などのメソッドパラメーターを呼び出して個々のメッセージを送信し、ICollector<EventGridOutput> を使用して複数のメッセージを書き込みます。

モデル v4
モデル v3

値を直接返すか、context.extraOutputs.set() を使って、出力メッセージにアクセスします。

Push-OutputBinding コマンドレットを使用して出力イベントにアクセスし、Event Grid 出力バインディングにイベントを送信します。

関数から Event Grid メッセージを出力するには、次の 2 つのオプションがあります。

戻り値:function.json 内の name プロパティを $return に設定します。この構成では、関数の戻り値は EventGrid メッセージとして永続化されます。
命令型:Out 型として宣言されたパラメーターの set メソッドに値を渡します。 set に渡された値は、EventGrid メッセージとして永続化されます。

つながり

Event Grid 出力バインドを使用する場合、Event Grid トピックに対して認証を行う方法は 2 つあります:

認証方法	説明
トピックキーの使用	「トピックキーを使用する」で説明されているように、`TopicEndpointUri` と `TopicKeySetting` プロパティを設定します。
ID の使用	`Connection` プロパティを複数のアプリケーション設定に対する共有プレフィックスの名前に設定すると共に、ID ベースの認証を定義します。この方法は、バージョン 3.3.x 以降の拡張機能を使用する場合にサポートされます。

トピックキーを使用する

次の手順のようにしてトピックキーを構成します。

アクセスキーの取得に関する記事の手順に従って、Event Grid トピック用のトピックキーを取得します。
アプリケーション設定で、トピックキー値を定義する設定を作成します。この設定の名前を、バインドの TopicKeySetting プロパティに使用します。
アプリケーション設定で、トピックエンドポイントを定義する設定を作成します。この設定の名前を、バインドの TopicEndpointUri プロパティに使用します。

ID ベースの認証

バージョン 3.3.x 以降の拡張機能を使っているときは、Microsoft Entra の ID を使って Event Grid トピックに接続でき、トピックキーを取得して使用する必要がなくなります。

トピックエンドポイント URI を返すアプリケーション設定を作成する必要があります。設定の名前は、"一意の共通プレフィックス" (たとえば、myawesometopic) と値 __topicEndpointUri を組み合わせる必要があります。次に、バインディングで Connection プロパティを定義するときに、その共通プレフィックス (この場合は、myawesometopic) を使用する必要があります。

このモードでは、拡張機能に次のプロパティが必要です。

プロパティ	環境変数テンプレート	説明	値の例
トピックエンドポイント URI	`<CONNECTION_NAME_PREFIX>__topicEndpointUri`	トピックエンドポイント。	`https://<topic-name>.centralus-1.eventgrid.azure.net/api/events`

さらに他のプロパティを使用して、接続をカスタマイズできます。「ID ベース接続に共通のプロパティ」を参照してください。

Note

Azure App Configuration または Key Vault を使ってマネージド ID ベースの接続の設定を指定する場合、名前の設定に __ の代わりに : や / などの有効なキー区切り記号を使って、名前が正しく解決されるようにする必要があります。

たとえば、「 <CONNECTION_NAME_PREFIX>:topicEndpointUri 」のように入力します。

Azure Functions サービスでホストされている場合、ID ベースの接続では、マネージド ID が使用されます。ユーザー割り当て ID を credential および clientID プロパティで指定できますが、システム割り当て ID が既定で使用されます。リソース ID を使用したユーザー割り当て ID の構成はサポートされていないことに注意してください。ローカル開発などの他のコンテキストで実行する場合は、代わりに開発者 ID が使用されますが、カスタマイズすることもできます。 ID ベースの接続によるローカル開発に関するページをご覧ください。

ID にアクセス許可を付与する

使用されている ID が何であれ、目的のアクションを実行するためのアクセス許可が必要です。ほとんどの Azure では、これはそれらのアクセス許可を提供する組み込みロールまたはカスタムロールを使って、Azure RBAC でロールを割り当てる必要があることを意味します。

重要

すべてのコンテキストに必要ではない一部のアクセス許可がターゲットサービスによって公開される場合があります。可能であれば、最小限の特権の原則に従い、必要な特権だけを ID に付与します。たとえば、アプリがデータソースからの読み取りのみを行う必要がある場合は、読み取りアクセス許可のみを持つロールを使用します。サービスへの書き込みも可能なロールを割り当てることは、読み取り操作に対するアクセス許可が過剰になるため、不適切です。同様に、ロールの割り当てが、読み取る必要のあるリソースだけに限定されていることを確認する必要があります。

実行時に Event Grid トピックへのアクセスを提供するロールの割り当てを作成する必要があります。所有者のような管理ロールでは十分ではありません。次の表は、通常の操作で Event Hubs の拡張機能を使用するときに推奨される組み込みのロールを示しています。アプリケーションでは、記述したコードに基づいて追加のアクセス許可が必要になる場合があります。

[バインドの種類]	組み込みロールの例
出力バインド	EventGrid 共同作成者、EventGrid データ送信者

次のステップ

Event Grid イベントをディスパッチする