Publicar eventos en temas personalizados de Azure Event Grid usando claves de acceso

Un tema personalizado de Grid de Eventos es un punto final al que tus aplicaciones envían sus propios eventos, para que Grid de Eventos pueda enrutarlos a suscriptores interesados. Este artículo te muestra cómo publicar eventos en un tema personalizado usando claves de acceso, que autentican tus solicitudes sin necesidad de configurar Microsoft Entra ID. Obtienes el endpoint del tema y la clave de acceso, formateas una carga útil de evento, envías un evento de muestra y revisas la respuesta.

El Acuerdo de Nivel de Servicio (SLA) solo se aplica a publicaciones que coinciden con el formato esperado.

Prerequisites

• Un tema personalizado de Azure Event Grid. Para crear uno, consulta Enviar eventos personalizados a un punto final web usando el portal de Azure.
• CLI de Azure, Azure PowerShell o acceso al portal de Azure para recuperar el endpoint del tema y la clave de acceso.
• Una herramienta que puede enviar solicitudes HTTP POST, como curl.

Obtención del punto de conexión del tema

Para publicar eventos en un tema personalizado, envía una solicitud HTTP POST usando el siguiente formato URI: https://<topic-endpoint>?api-version=2018-01-01. Por ejemplo, un URI válido es: https://exampletopic.westus2-1.eventgrid.azure.net/api/events?api-version=2018-01-01. Para obtener el endpoint de un tema personalizado, utiliza el portal de Azure, CLI de Azure o 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

Obtención de la clave de acceso

En la solicitud, incluya un valor de encabezado denominado aeg-sas-key que contenga una clave para la autenticación. Por ejemplo, un valor de encabezado válido es aeg-sas-key: xxxxxxxxxxxxxxxxxxxxxxx. Para obtener la clave de un tema personalizado, utiliza el portal de Azure, CLI de Azure o 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

Dar formato a la carga útil del evento

Formatea cada evento como un objeto JSON. Los campos de nivel superior son los mismos que los eventos estándar definidos por recurso, y la data propiedad contiene las propiedades únicas de tu tema personalizado. Como editor, defines el contenido del data objeto. Para una descripción de cada propiedad, véase 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
  }
]

Ten en cuenta estos límites de tamaño cuando construyas la carga útil:

• El array de eventos puede tener un tamaño total de hasta 1 MB.
• El tamaño máximo para un solo evento es de 1 MB. Los eventos de más de 64 KB conllevan cargos por bloques de 64 KB.
• Un lote puede contener un máximo de 5.000 eventos.

El siguiente ejemplo muestra una carga útil de evento válida:

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

Envío de un evento de ejemplo

En esta sección se muestra cómo enviar un evento de ejemplo al tema personalizado.

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}

Revisión de la respuesta

Después de publicar en el endpoint del tema, recibes una respuesta. La respuesta es un código de respuesta HTTP estándar. Algunas respuestas comunes son:

En caso de error, el cuerpo del mensaje utiliza el siguiente formato:

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

Contenido relacionado

• Supervisión de la entrega de mensajes de Event Grid: obtenga información sobre cómo realizar un seguimiento y solucionar problemas de entregas de eventos.
• Seguridad y autenticación de Event Grid: comprenda cómo proteger los eventos con claves de autenticación.
• Esquema de suscripción de Event Grid: guía paso a paso sobre la creación de una suscripción de Event Grid.