Publicar eventos em tópicos personalizados da Grade de Eventos do Azure usando chaves de acesso

Este artigo fornece orientação sobre como publicar eventos em tópicos personalizados da Grade de Eventos do Azure usando chaves de acesso. Você aprende sobre o formato de ponto de extremidade necessário, cabeçalhos de autenticação, esquema de eventos e como enviar eventos de exemplo.

O Contrato de Nível de Serviço (SLA) só se aplica a postagens que correspondam ao formato esperado.

Ponto final

Para publicar eventos em um tópico personalizado, envie uma solicitação HTTP POST usando o seguinte formato de URI: https://<topic-endpoint>?api-version=2018-01-01. Por exemplo, um URI válido é: https://exampletopic.westus2-1.eventgrid.azure.net/api/events?api-version=2018-01-01. Para aceder ao ponto de extremidade de um tópico personalizado, utilize o portal do Azure, o Azure CLI ou 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

Cabeçalho

Na solicitação, inclua um valor de cabeçalho chamado aeg-sas-key que contenha uma chave para autenticação. Por exemplo, um valor de cabeçalho válido é aeg-sas-key: xxxxxxxxxxxxxxxxxxxxxxx. Para obter a chave para um tópico personalizado usando a CLI do Azure, use:

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

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

Esquema de dados de evento para tópicos personalizados

Para tópicos personalizados, os dados de nível superior contêm os mesmos campos que os eventos padrão definidos por recursos. Uma dessas propriedades é uma data propriedade que contém propriedades exclusivas para o tópico personalizado. Como um editor de eventos, você determina as propriedades desse objeto de dados. Aqui está o esquema:

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

Para obter uma descrição dessas propriedades, consulte Esquema de eventos da Grade de Eventos do Azure. Quando um cliente envia eventos para um tópico de Grade de Eventos, a matriz pode ter um tamanho total de até 1 MB. O tamanho máximo permitido para um evento também é de 1 MB. Eventos acima de 64 KB são cobrados em incrementos de 64 KB. Quando um cliente recebe eventos em um lote, o número máximo permitido de eventos é 5.000 por lote.

Por exemplo, um esquema de dados de evento válido é:

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

Enviar um exemplo de evento

Esta seção mostra como enviar um evento de exemplo para o tópico 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}

Response

Depois de postar no ponto de extremidade do tópico, você recebe uma resposta. A resposta é um código de resposta HTTP padrão. Algumas respostas comuns são:

Para erros, o corpo da mensagem tem o seguinte formato:

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

Conteúdos relacionados

• Monitorar a entrega de mensagens da Grade de Eventos: saiba como acompanhar e solucionar problemas de entregas de eventos.
• Segurança e autenticação da Grade de Eventos: entenda como proteger seus eventos com chaves de autenticação.
• Esquema de assinatura da Grade de Eventos: orientação passo a passo sobre como criar uma assinatura da Grade de Eventos.