Publiez des événements sur des sujets personnalisés sur Azure Event Grid en utilisant des clés d’accès

Un sujet personnalisé Event Grid est un point de terminaison auquel vos applications envoient leurs propres événements, afin qu’Event Grid puisse les acheminer vers des abonnés intéressés. Cet article vous montre comment publier des événements sur un sujet personnalisé en utilisant des clés d’accès, qui authentifient vos requêtes sans configurer Microsoft Entra ID. Vous obtenez le point de terminaison du sujet et la clé d’accès, formatez une charge utile d’événement, envoyez un événement d’exemple, puis relisez la réponse.

L’Accord de niveau de service (SLA) ne s’applique qu’aux postes correspondant au format attendu.

Prerequisites

• Un sujet personnalisé d’Azure Event Grid. Pour en créer un, voir Envoyer des événements personnalisés vers un point web en utilisant le portail Azure.
• Azure CLI, Azure PowerShell, ou accès au portail Azure pour récupérer le point de terminaison du sujet et la clé d’accès.
• Un outil capable d’envoyer des requêtes HTTP POST, telles que curl.

Obtenir le point de terminaison de la rubrique

Pour publier des événements sur un sujet personnalisé, envoyez une requête HTTP POST en utilisant le format URI suivant : https://<topic-endpoint>?api-version=2018-01-01. Par exemple, un URI valide est https://exampletopic.westus2-1.eventgrid.azure.net/api/events?api-version=2018-01-01. Pour obtenir le point d’accès d’un sujet personnalisé, utilisez le portail Azure, Azure CLI ou 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

Obtenir la clé d’accès

Dans la demande, incluez une valeur d’en-tête nommée aeg-sas-key qui contient une clé pour l’authentification. Par exemple, une valeur d’en-tête valide est aeg-sas-key: xxxxxxxxxxxxxxxxxxxxxxx. Pour obtenir la clé d’un sujet personnalisé, utilisez le portail Azure, Azure CLI ou 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

Formatez la charge utile de l’événement

Formatez chaque événement comme un objet JSON. Les champs de premier niveau sont les mêmes que les événements définis par ressource standard, et la data propriété contient les propriétés propres à votre sujet personnalisé. En tant qu’éditeur, vous définissez le contenu de l’objet data . Pour une description de chaque propriété, voir 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
  }
]

Gardez à l’esprit ces limites de taille lorsque vous construisez la charge utile :

• Le tableau d’événements peut avoir une taille totale allant jusqu’à 1 Mo.
• La taille maximale pour un événement unique est de 1 Mo. Les événements dépassant 64 Ko sont facturés par tranches de 64 Ko.
• Un lot peut contenir un maximum de 5 000 événements.

L’exemple suivant montre une charge utile d’événement valide :

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

Envoyer un événement d’exemple

Cette section montre comment envoyer un exemple d’événement à la rubrique personnalisée.

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}

Passer en revue la réponse

Après avoir posté sur le point de départ du sujet, vous recevez une réponse. La réponse est un code de réponse HTTP standard. Certaines réponses courantes sont :

Pour les erreurs, le corps du message utilise le format suivant :

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

Contenu connexe

• Surveiller la distribution des messages Event Grid : Découvrez comment suivre et résoudre les problèmes liés à la distribution des événements.
• Sécurité et authentification de la grille d’événements : Comprenez comment sécuriser vos événements avec des clés d’authentification.
• Schéma d’abonnement Event Grid : Conseils étape par étape pour créer un abonnement Event Grid.