適用於 Azure Functions 的 Azure 事件方格輸出繫結

發行項
04/07/2024

使用事件方格輸出系結，將事件寫入自定義主題。您必須具有自定義主題的有效存取金鑰。事件方格輸出系結不支援共用存取簽章（SAS）令牌。

如需安裝和組態詳細數據的詳細資訊，請參閱如何在 Azure Functions 中使用事件方格觸發程式和系結。

重要

本文使用索引標籤來支援多個版本的 Node.js 程式設計模型。 v4 模型已正式推出，旨在為 JavaScript 和 TypeScript 開發人員提供更靈活且更直覺的體驗。如需 v4 模型運作方式的更多詳細資料，請參閱 Azure Functions Node.js 開發人員指南。若要深入了解 v3 與 v4 之間的差異，請參閱移轉指南。

Azure Functions 支援兩種適用於 Python 的程式設計模型。您定義系結的方式取決於您所選擇的程式設計模型。

Python v2 程式設計模型可讓您直接在 Python 函式程式代碼中使用裝飾項目來定義系結。如需詳細資訊，請參閱 Python 開發人員指南。

本文支援這兩種程序設計模型。

重要

Event Grid 輸出系結僅適用於 Functions 2.x 和更新版本。

範例

搭配 Event Grid 輸出系結使用的輸出參數類型取決於 Functions 運行時間版本、系結延伸模組版本，以及 C# 函式的形式。 C# 函式可以使用下列其中一種 C# 模式來建立：

同進程類別庫：在與 Functions 運行時間相同的進程中執行的已編譯 C# 函式。
隔離的背景工作進程類別庫：在與運行時間隔離的背景工作進程中執行的已編譯 C# 函式。

隔離式背景工作角色模型
內含式模型

下列範例示範如何在觸發程式和事件方格輸出系結中使用自訂類型：

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 識別碼：

[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": {
    "MyEventGridConnection__topicEndpointUri": "{topicEndpointUri}"
  }
}

部署時，您必須將此相同的資訊新增至函式應用程式的應用程式設定。如需詳細資訊，請參閱身分識別型驗證。

下列範例示範將訊息寫入事件方格自定義主題的 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 類別來傳送事件方格訊息。

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

下列範例顯示輸出單一事件的定時器觸發 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,
});

若要輸出多個事件，請傳回數位，而不是單一物件。例如：

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

下列範例顯示輸出單一事件的定時器觸發 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,
        };
    },
});

若要輸出多個事件，請傳回數位，而不是單一物件。例如：

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 檔案中的事件方格輸出繫結資料。

{
    "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
    });
};

下列範例示範如何設定函式以輸出事件方格事件訊息。設定為的區段 type 會 eventGrid 設定建立事件方格輸出系結所需的值。

{
  "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 透過事件方格輸出系結將事件傳送至自定義主題。

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# 文稿會改用function.json組態檔，如 C# 腳本指南中所述。

屬性的建構函式會採用包含自定義主題名稱的應用程式設定名稱，以及包含主題索引鍵的應用程式設定名稱。

隔離式背景工作角色模型
內含式模型

下表說明的參數 EventGridOutputAttribute。

參數	描述
TopicEndpointUri	應用程式設定的名稱，其中包含自訂主題的 URI，例如 `MyTopicEndpointUri`。
TopicKeySetting	應用程式設定的名稱，其中包含自訂主題的存取金鑰。
connection^*	包含主題端點 URI 之設定的通用前置詞值。如需此應用程式設定命名格式的詳細資訊，請參閱以身分識別為基礎的驗證。

下表說明的參數 EventGridAttribute。

參數	描述
TopicEndpointUri	應用程式設定的名稱，其中包含自訂主題的 URI，例如 `MyTopicEndpointUri`。
TopicKeySetting	應用程式設定的名稱，其中包含自訂主題的存取金鑰。
[連接]^*	包含主題端點 URI 之設定的通用前置詞值。如需此應用程式設定命名格式的詳細資訊，請參閱以身分識別為基礎的驗證。

註釋

針對 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` 屬性。如需此應用程式設定命名格式的詳細資訊，請參閱以身分識別為基礎的驗證。

下表說明您在 function.json 檔案中設定的繫結設定屬性。

屬性	描述
type	必須設定為 `eventGrid`。
direction	必須設定為 `out`。當您在 Azure 入口網站中建立繫結時，會自動設定此參數。
name	函式程式碼中所使用的變數名稱，代表事件。
topicEndpointUri	應用程式設定的名稱，其中包含自訂主題的 URI，例如 `MyTopicEndpointUri`。
topicKeySetting	應用程式設定的名稱，其中包含自訂主題的存取金鑰。
connection^*	包含主題端點 URI 之設定的通用前置詞值。設定 `connection` 屬性時， `topicEndpointUri` 不應該設定和 `topicKeySetting` 屬性。如需此應用程式設定命名格式的詳細資訊，請參閱以身分識別為基礎的驗證。

組態

下表說明您在 function.json 檔案中設定的繫結設定屬性。

function.json 屬性	描述
type	必須設定為 `eventGrid`。
direction	必須設定為 `out`。當您在 Azure 入口網站中建立繫結時，會自動設定此參數。
name	函式程式碼中所使用的變數名稱，代表事件。
topicEndpointUri	應用程式設定的名稱，其中包含自訂主題的 URI，例如 `MyTopicEndpointUri`。
topicKeySetting	應用程式設定的名稱，其中包含自訂主題的存取金鑰。
connection^*	包含主題端點 URI 之設定的通用前置詞值。如需此應用程式設定命名格式的詳細資訊，請參閱以身分識別為基礎的驗證。

^*支援身分識別型連線需要 3.3.x 版或更新版本的擴充功能。

當您在本機開發時，請在集合中的 local.settings.json 檔案Values中新增應用程式設定。

重要

請確定您已將的值 TopicEndpointUri 設定為包含自訂主題 URI 的應用程式設定名稱。請勿直接在此屬性中指定自定義主題的 URI。使用 Connection時，同樣適用。

如需完整範例，請參閱範例一節。

使用方式

事件方格輸出系結所支援的參數類型取決於 Functions 運行時間版本、擴充套件版本，以及所使用的 C# 形式。

當您想要讓函式撰寫單一事件時，Event Grid 輸出系結可以繫結至下列類型：

類型	描述
`string`	事件做為字串。
`byte[]`	事件訊息的位元組。
JSON 可序列化型別	物件，表示 JSON 事件。函式會嘗試將一般舊的CLR物件（POCO）類型串行化為 JSON 數據。

當您想要函式寫入多個事件時，Event Grid 輸出系結可以繫結至下列類型：

類型	描述
`T[]` 其中 `T` 是其中一個單一事件類型	包含多個事件的陣列。每個專案都代表一個事件。

針對其他輸出案例，請直接從 Azure.Messaging.EventGrid 建立並使用 EventGridPublisherClient 與其他類型。如需使用相依性插入從 Azure SDK 建立用戶端類型的範例，請參閱註冊 Azure 用戶端。

藉由呼叫方法參數來傳送個別訊息，例如 out EventGridOutput paramName，並使用撰寫多個訊息 ICollector<EventGridOutput>。

模型 v4
模型 v3

直接或使用 context.extraOutputs.set()傳回值，以存取輸出訊息。

使用 Push-OutputBinding Cmdlet 將事件傳送至事件方格輸出系結，以存取輸出事件。

有兩個選項可從函式輸出事件方格訊息：

傳回值：將 name 中的屬性設定為 $returnfunction.json。使用此組態時，函式的傳回值會保存為事件方格訊息。
命令式：將值傳遞至宣告為 Out 類型的參數的 set 方法。傳遞至 set 的值會保存為事件方格訊息。

連線

使用事件方格輸出系結時，有兩種方式可以向事件方格主題進行驗證：

驗證方法	描述
使用主題索引鍵	`TopicEndpointUri`設定和 `TopicKeySetting` 屬性，如使用主題索引鍵中所述。
使用身分識別	將 `Connection` 屬性設定為多個應用程式設定的共用前置詞名稱，並定義以身分識別為基礎的驗證。使用 3.3.x 版或更新版本的擴充功能時，支援此方法。

使用主題金鑰

使用下列步驟來設定主題金鑰：

請遵循取得存取金鑰中的步驟，取得事件方格主題的主題密鑰。
在您的應用程式設定中，建立定義主題索引鍵值的設定。針對系結的屬性，請使用此設定 TopicKeySetting 的名稱。
在您的應用程式設定中，建立定義主題端點的設定。針對系結的屬性，請使用此設定 TopicEndpointUri 的名稱。

以身分識別為基礎的驗證

使用 3.3.x 版或更新版本的擴充功能時，您可以使用 Microsoft Entra 身分識別連線到事件方格主題，以避免必須取得和使用主題密鑰。

您必須建立會傳回主題端點 URI 的應用程式設定。設定的名稱應該結合唯一 的通用前置詞 （例如 myawesometopic，）與值 __topicEndpointUri。然後，當您在系結中定義 Connection 屬性時，myawesometopic必須使用該通用前置詞（在此案例中為）。

在此模式中，延伸模組需要下列屬性：

屬性	環境變數範本	描述	範例值
主題端點 URI	`<CONNECTION_NAME_PREFIX>__topicEndpointUri`	主題端點。	`https://<topic-name>.centralus-1.eventgrid.azure.net/api/events`

您可以使用更多屬性來自定義連線。請參閱身分識別型連線的通用屬性。

注意

使用 Azure 應用程式組態或金鑰保存庫來提供受控識別型連線的設定時，設定名稱應該使用有效的索引鍵分隔符，例如 : 或 / 取代 __ ，以確保正確解析名稱。

例如： <CONNECTION_NAME_PREFIX>:topicEndpointUri 。

主控於 Azure Functions 服務時，以身分識別為基礎的連接會使用受控識別。雖然可以使用 credential 和 clientID 屬性指定使用者指派的身分識別，但預設會使用系統指派的身分識別。請注意，不支援以資源識別碼來設定使用者指派的身分識別。在本機開發等其他內容中執行時，雖然這可以自訂，但仍會改用您的開發人員身分識別。請參閱使用身分識別型連線進行本機開發。

授與權限給身分識別

正在使用的任何身分識別，都必須具有執行預期動作的權限。有關大多數 Azure 服務，意即您需要指派 Azure RBAC 的角色，利用提供這些權限的內建或自訂角色。

重要

部分權限可能會由所有內容都不需要的目標服務公開。可以的話，請遵循最低權限原則，只授與身分識別所需的權限。例如，如果應用程式只需要能夠讀取資料來源，請使用只有讀取權限的角色。不宜指派也允許寫入該服務的角色，因為讀取作業不需要這麼多權限。同樣地，最好確保角色指派的範圍僅限於需要讀取的資源。

您必須建立可在執行階段存取事件方格主題的角色指派。擁有者等的管理角色不足。下方資料表顯示一般作業中使用事件中樞延伸模組時建議的內建角色。您的應用程式可能會根據您寫入的程式碼要求額外的權限。

繫結類型	內建角色範例
輸出繫結	EventGrid 參與者、EventGrid 資料傳送者

下一步

分派事件方格事件

共用方式為

適用於 Azure Functions 的 Azure 事件方格輸出繫結

範例

屬性

註釋

組態

組態

使用方式

連線

使用主題金鑰

以身分識別為基礎的驗證

授與權限給身分識別

下一步

意見反應

其他資源