Publikuj wydarzenia do niestandardowych tematów Azure Event Grid za pomocą kluczy dostępu

Niestandardowy temat Event Grid to punkt końcowy, do którego Twoje aplikacje wysyłają własne zdarzenia, aby Event Grid mógł kierować te zdarzenia do zainteresowanych subskrybentów. Ten artykuł pokazuje, jak publikować zdarzenia do niestandardowego tematu za pomocą kluczy dostępu, które uwierzytelniają Twoje żądania bez konieczności konfigurowania Microsoft Entra ID. Otrzymujesz punkt końcowy tematu i klucz dostępu, formatujesz ładunek danych zdarzenia, wysyłasz przykładowe zdarzenie i sprawdzasz odpowiedź.

Umowa o Poziomie Obsługi (SLA) dotyczy tylko postów spełniających oczekiwany format.

Wymagania wstępne

• Niestandardowy temat usługi Azure Event Grid. Aby go utworzyć, zobacz Wyślij niestandardowe zdarzenia do punktu końcowego webowego za pomocą portalu Azure.
• Azure CLI, Azure PowerShell lub dostęp do portalu Azure w celu pobrania punktu końcowego tematu oraz klucza dostępu.
• Narzędzie, które może wysyłać żądania HTTP POST, takie jak curl.

Pobierz punkt końcowy tematu

Aby opublikować zdarzenia do tematu niestandardowego, wyślij żądanie HTTP POST za pomocą następującego formatu URI: https://<topic-endpoint>?api-version=2018-01-01. Na przykład prawidłowy identyfikator URI to: https://exampletopic.westus2-1.eventgrid.azure.net/api/events?api-version=2018-01-01. Aby uzyskać endpoint dla niestandardowego tematu, użyj portalu Azure, Azure CLI lub 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

Uzyskiwanie klucza dostępu

W żądaniu dołącz wartość nagłówka o nazwie aeg-sas-key , która zawiera klucz do uwierzytelniania. Na przykład prawidłową wartością nagłówka jest aeg-sas-key: xxxxxxxxxxxxxxxxxxxxxxx. Aby uzyskać klucz do tematu niestandardowego, użyj portalu Azure, Azure CLI lub 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

Formatuj ładunek zdarzenia

Formatuj każde zdarzenie jako obiekt JSON. Pola najwyższego poziomu są takie same jak standardowe zdarzenia zdefiniowane zasobami, a data własność zawiera właściwości unikalne dla Twojego tematu niestandardowego. Jako wydawca definiujesz zawartość data obiektu. Opis każdej właściwości można znaleźć w 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
  }
]

Miej na uwadze te limity rozmiaru podczas budowy ładunku:

• Tablica zdarzeń może mieć całkowity rozmiar do 1 MB.
• Maksymalny rozmiar pojedynczego zdarzenia to 1 MB. Za zdarzenia powyżej 64 KB naliczane są opłaty w jednostkach co 64 KB.
• Partia może zawierać maksymalnie 5 000 zdarzeń.

Poniższy przykład pokazuje poprawny ładunek zdarzeń:

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

Wysyłanie przykładowego zdarzenia

W tej sekcji pokazano, jak wysłać przykładowe zdarzenie do tematu niestandardowego.

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}

Przejrzyj odpowiedź

Po wysłaniu żądania do punktu końcowego tematu otrzymasz odpowiedź. Odpowiedź to standardowy kod odpowiedzi HTTP. Oto niektóre typowe odpowiedzi:

W przypadku błędów treść wiadomości używa następującego formatu:

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

Powiązana zawartość

• Monitoruj dostarczanie komunikatów usługi Event Grid: Dowiedz się, jak śledzić i rozwiązywać problemy z dostarczaniem zdarzeń.
• Zabezpieczenia i uwierzytelnianie usługi Event Grid: informacje na temat zabezpieczania zdarzeń za pomocą kluczy uwierzytelniania.
• Schemat subskrypcji usługi Event Grid: szczegółowe wskazówki dotyczące tworzenia subskrypcji usługi Event Grid.