Публикуйте события в пользовательские темы Сетка событий Azure с помощью ключей доступа

Пользовательская тема Event Grid — это конечная точка, куда ваши приложения отправляют свои события, чтобы Event Grid мог направлять эти события заинтересованным подписчикам. В этой статье показано, как публиковать события в пользовательскую тему с помощью ключей доступа, которые аутентифицируют ваши запросы без настройки Microsoft Entra ID. Вы получаете конечную точку темы и ключ доступа, форматируете полезную нагрузку события, отправляете примерное событие и просматриваете ответ.

Соглашение об уровне обслуживания (SLA) применяется только к постам, соответствующим ожидаемому формату.

Необходимые условия

• Пользовательский раздел Сетка событий Azure. Чтобы создать его, см. раздел «Отправить пользовательские события на веб-конечную точку с помощью портала Azure».
• Azure CLI, Azure PowerShell или доступ к порталу Azure для получения конечной точки раздела и ключа доступа.
• Инструмент, способный отправлять запросы HTTP POST, такие как curl.

Получение конечной точки темы

Чтобы опубликовать события в пользовательскую тему, отправьте запрос HTTP POST с помощью следующего формата URI: https://<topic-endpoint>?api-version=2018-01-01. Например, допустимый URI — https://exampletopic.westus2-1.eventgrid.azure.net/api/events?api-version=2018-01-01. Чтобы получить конечную точку для пользовательской темы, используйте портал Azure, Azure CLI или 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

Получение ключа доступа

Добавьте в запрос значение заголовка aeg-sas-key, содержащее ключ для аутентификации. Например, допустимое значение заголовка — aeg-sas-key: xxxxxxxxxxxxxxxxxxxxxxx. Чтобы получить ключ для пользовательской темы, используйте Azure portal, Azure CLI или 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

Форматирование полезной нагрузки события

Форматируйте каждое событие как JSON-объект. Поля верхнего уровня совпадают со стандартными событиями, определяемыми ресурсами, а свойство data содержит свойства, уникальные для вашей пользовательской темы. Как издатель, вы определяете содержимое data объекта. Для описания каждого свойства см. Сетка событий Azure event schema.

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

Имейте в виду эти ограничения по размеру при сборке полезной нагрузки:

• Массив событий может иметь общий размер до 1 МБ.
• Максимальный размер для одного события — 1 МБ. За события размером более 64 КБ взимается плата блоками по 64 КБ.
• Одна партия может содержать максимум 5 000 событий.

Следующий пример показывает допустимую полезную нагрузку для событий:

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

Отправка примера события

В этом разделе показано, как отправить пример события в пользовательский раздел.

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}

Просмотр ответа

После того как вы отправите сообщение в конечную точку темы, вы получите ответ. Ответ — это стандартный код ответа HTTP. Ниже приведены некоторые распространенные ответы:

В случае ошибок тело сообщения имеет следующий формат:

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

Связанный контент

• Отслеживание доставки сообщений в Event Grid: Узнайте, как отслеживать и устранять неполадки доставки сообщений.
• Безопасность и проверка подлинности сетки событий. Узнайте, как защитить события с помощью ключей проверки подлинности.
• Схема подписки сетки событий: пошаговые инструкции по созданию подписки сетки событий.