Veröffentlichen Sie Ereignisse in benutzerdefinierten Azure Event Grid-Themen mit Zugangsschlüsseln

Ein benutzerdefiniertes Event Grid Thema ist ein Endpunkt, an den Ihre Anwendungen eigene Events senden, sodass Event Grid diese Events an interessierte Abonnenten weiterleiten kann. Dieser Artikel zeigt Ihnen, wie Sie Ereignisse in einem benutzerdefinierten Thema veröffentlichen können, indem Sie Zugangsschlüssel verwenden, die Ihre Anfragen authentifizieren, ohne eine Microsoft Entra ID einzurichten. Du erhältst den Topic-Endpunkt und den Zugriffsschlüssel, formatierst die Payload eines Ereignisses, sendest ein Beispielereignis und überprüfst die Antwort.

Die Service Level Agreement (SLA) gilt nur für Beiträge, die dem erwarteten Format entsprechen.

Voraussetzungen

• Ein benutzerdefiniertes Thema für Azure Event Grid. Um eines zu erstellen, siehe Benutzerdefinierte Ereignisse an einen Web-Endpunkt senden über das Azure-Portal.
• Azure CLI, Azure PowerShell oder Zugriff auf das Azure-Portal, um den Topic-Endpunkt und den Zugriffsschlüssel abzurufen.
• Ein Werkzeug, das HTTP-POST-Anfragen senden kann, zum Beispiel curl.

Abrufen des Themenendpunkts

Um Ereignisse an einem benutzerdefinierten Thema zu veröffentlichen, senden Sie eine HTTP-POST-Anfrage mit folgendem URI-Format: https://<topic-endpoint>?api-version=2018-01-01. https://exampletopic.westus2-1.eventgrid.azure.net/api/events?api-version=2018-01-01 ist beispielsweise ein gültiger URI. Um den Endpunkt für ein benutzerdefiniertes Thema zu erhalten, verwenden Sie das Azure Portal, Azure CLI oder 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

Zugriffsschlüssel abrufen

Schließen Sie einen Headerwert namens aeg-sas-key in die Anforderung ein, der einen Schlüssel für die Authentifizierung enthält. Ein gültiger Headerwert ist beispielsweise aeg-sas-key: xxxxxxxxxxxxxxxxxxxxxxx. Um den Schlüssel für ein benutzerdefiniertes Thema zu erhalten, verwenden Sie das Azure Portal, Azure CLI oder 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

Formatieren der Eventnutzlast

Formatiere jedes Ereignis als JSON-Objekt. Die obersten Felder sind identisch mit den Standard-Resource-Defined Events, und die data Eigenschaft enthält die Eigenschaften, die einzigartig für dein individuelles Thema sind. Als Verlag definieren Sie den Inhalt des data Objekts. Für eine Beschreibung jeder Eigenschaft siehe 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
  }
]

Beachten Sie diese Größenbeschränkungen beim Bau der Nutzlast:

• Das Ereignisarray kann eine Gesamtgröße von bis zu 1 MB haben.
• Die maximale Größe für ein einzelnes Ereignis beträgt 1 MB. Für Ereignisse über 64 KB werden Gebühren in Schritten von 64 KB berechnet.
• Ein Batch kann maximal 5.000 Ereignisse enthalten.

Das folgende Beispiel zeigt eine gültige Ereignisnutzlast:

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

Senden eines Beispielereignisses

In diesem Abschnitt wird gezeigt, wie Sie ein Beispielereignis an das benutzerdefinierte Thema senden.

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}

Überprüfen der Antwort

Nachdem du am Topic-Endpunkt gepostet hast, erhältst du eine Antwort. Die Antwort ist ein HTTP-Standardantwortcode. Einige häufige Antworten lauten:

Bei Fehlern hat der Nachrichtentext das folgende Format:

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

Zugehöriger Inhalt

• Überwachen Sie die Zustellung von Event Grid-Nachrichten: Erfahren Sie, wie Sie die Zustellung von Ereignissen nachverfolgen und Probleme beheben.
• Ereignisrastersicherheit und -Authentifizierung: Verstehen, wie Sie Ihre Ereignisse mit Authentifizierungsschlüsseln sichern.
• Event Grid-Abonnementschema: Schrittweise Anleitung zum Erstellen eines Event Grid-Abonnements.