Publiceer gebeurtenissen naar aangepaste Azure Event Grid-topics met toegangssleutels

Een Event Grid custom topic is een eindpunt waarnaar je applicaties hun eigen events sturen, zodat Event Grid die events kan doorsturen naar geïnteresseerde abonnees. Dit artikel laat zien hoe je gebeurtenissen kunt publiceren naar een aangepast onderwerp door toegangssleutels te gebruiken, die je verzoeken authenticeren zonder Microsoft Entra ID in te stellen. Je krijgt het topic-endpoint en toegangssleutel, formatteert een event payload, stuurt een voorbeeldevent en bekijkt het antwoord.

De Service Level Agreement (SLA) is alleen van toepassing op berichten die voldoen aan het verwachte formaat.

Prerequisites

• Een aangepast onderwerp voor Azure Event Grid. Om er een te maken, zie Verzend aangepaste gebeurtenissen naar een web-endpoint via het Azure-portaal.
• Azure CLI,Azure PowerShell, of toegang tot het Azure-portaal om het topic-endpoint en de toegangssleutel op te halen.
• Een tool die HTTP POST-verzoeken kan versturen, zoals curl.

Het onderwerpeindpunt ophalen

Om gebeurtenissen te publiceren naar een aangepast onderwerp, stuur je een HTTP POST-verzoek met het volgende URI-formaat: https://<topic-endpoint>?api-version=2018-01-01. Een geldige URI is bijvoorbeeld: https://exampletopic.westus2-1.eventgrid.azure.net/api/events?api-version=2018-01-01. Om het eindpunt voor een aangepast onderwerp te krijgen, gebruik je het Azure portal, Azure CLI of Azure PowerShell.

az eventgrid topic show --name <topic-name> -g <topic-resource-group> --query "endpoint"

(Get-AzEventGridTopic -ResourceGroupName <topic-resource-group> -Name <topic-name>).Endpoint

De toegangssleutel ophalen

Neem in de aanvraag een headerwaarde aeg-sas-key op die een sleutel voor verificatie bevat. Een geldige headerwaarde is aeg-sas-key: xxxxxxxxxxxxxxxxxxxxxxxbijvoorbeeld . Om de sleutel voor een aangepast onderwerp te krijgen, gebruik je het Azure-portaal, Azure CLI of Azure PowerShell.

az eventgrid topic key list --name <topic-name> -g <topic-resource-group> --query "key1"

(Get-AzEventGridTopicKey -ResourceGroupName <topic-resource-group> -Name <topic-name>).Key1

Formatteren van de gebeurtenispayload

Formatteer elk event als een JSON-object. De top-level velden zijn hetzelfde als standaard resource-defined events, en de data eigenschap bevat de eigenschappen die uniek zijn voor jouw aangepaste onderwerp. Als uitgever definieer je de inhoud van het data object. Voor een beschrijving van elke eigenschap, zie Azure Event Grid event schema.

[
  {
    "id": string,
    "eventType": string,
    "subject": string,
    "eventTime": string-in-date-time-format,
    "data":{
      object-unique-to-each-publisher
    },
    "dataVersion": string
  }
]

Houd deze groottelimieten in gedachten bij het bouwen van de payload:

• De event array kan een totale grootte hebben van maximaal 1 MB.
• De maximale grootte voor een enkel event is 1 MB. Voor gebeurtenissen groter dan 64 KB worden kosten in rekening gebracht per 64 KB.
• Een batch kan maximaal 5.000 gebeurtenissen bevatten.

Het volgende voorbeeld laat een geldige eventpayload zien:

[{
  "id": "1807",
  "eventType": "recordInserted",
  "subject": "myapp/vehicles/motorcycles",
  "eventTime": "2017-08-10T21:03:07+00:00",
  "data": {
    "make": "Ducati",
    "model": "Monster"
  },
  "dataVersion": "1.0"
}]

Een voorbeeldgebeurtenis verzenden

In deze sectie ziet u hoe u een voorbeeldgebeurtenis naar het aangepaste onderwerp verzendt.

endpoint=$(az eventgrid topic show --name <topic name> -g <resource group name> --query "endpoint" --output tsv)

key=$(az eventgrid topic key list --name <topic name> -g <resource group name> --query "key1" --output tsv)

event='[ {"id": "'"$RANDOM"'", "eventType": "recordInserted", "subject": "myapp/vehicles/motorcycles", "eventTime": "'`date +%Y-%m-%dT%H:%M:%S%z`'", "data":{ "make": "Ducati", "model": "Monster"},"dataVersion": "1.0"} ]'

curl -X POST -H "aeg-sas-key: $key" -d "$event" $endpoint

$resourceGroupName = "<resource group name>"
$topicName = "<topic name>"

$endpoint = (Get-AzEventGridTopic -ResourceGroupName $resourceGroupName -Name $topicName).Endpoint

$keys = Get-AzEventGridTopicKey -ResourceGroupName $resourceGroupName -Name $topicName

$eventID = Get-Random 99999
#Date format should be SortableDateTimePattern (ISO 8601)
$eventDate = Get-Date -Format s

#Construct body using Hashtable
$htbody = @{
    id= $eventID
    eventType="recordInserted"
    subject="myapp/vehicles/motorcycles"
    eventTime= $eventDate
    data= @{
        make="Ducati"
        model="Monster"
    }
    dataVersion="1.0"
}

#Use ConvertTo-Json to convert event body from Hashtable to JSON Object
#Append square brackets to the converted JSON payload since they are expected in the event's JSON payload syntax
$body = "["+(ConvertTo-Json $htbody)+"]"

Invoke-WebRequest -Uri $endpoint -Method POST -Body $body -Headers @{"aeg-sas-key" = $keys.Key1}

Het antwoord controleren

Nadat je op het topic-eindpunt hebt gepost, ontvang je een reactie. Het antwoord is een standaard HTTP-antwoordcode. Enkele veelvoorkomende antwoorden zijn:

Voor fouten gebruikt het berichtgedeelte het volgende formaat:

{
    "error": {
        "code": "<HTTP status code>",
        "message": "<description>",
        "details": [{
            "code": "<HTTP status code>",
            "message": "<description>"
    }]
  }
}

Gerelateerde inhoud

• Levering van Event Grid-berichten bewaken: informatie over het bijhouden en oplossen van problemen met leveringen van gebeurtenissen.
• Event Grid-beveiliging en -verificatie: informatie over het beveiligen van uw gebeurtenissen met verificatiesleutels.
• Event Grid-abonnementsschema: stapsgewijze instructies voor het maken van een Event Grid-abonnement.