Publikowanie zdarzeń w niestandardowych tematach usługi Azure Event Grid przy użyciu kluczy dostępu

Ten artykuł zawiera wskazówki dotyczące publikowania zdarzeń w niestandardowych tematach usługi Azure Event Grid przy użyciu kluczy dostępu. Dowiesz się więcej o wymaganym formacie punktu końcowego, nagłówkach uwierzytelniania, schemacie zdarzeń i sposobie wysyłania przykładowych zdarzeń.

Umowa dotycząca poziomu usług (SLA) dotyczy tylko wpisów, które są zgodne z oczekiwanym formatem.

Punkt końcowy

Aby opublikować zdarzenia w temacie niestandardowym, wyślij żądanie HTTP POST przy użyciu następującego formatu identyfikatora 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ć punkt końcowy dla tematu niestandardowego, użyj witryny Azure Portal, interfejsu wiersza polecenia platformy Azure lub programu 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

Nagłówek

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 dla tematu niestandardowego przy użyciu interfejsu wiersza polecenia platformy Azure, użyj:

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

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

Schemat danych zdarzenia dla tematów niestandardowych

W przypadku tematów niestandardowych dane najwyższego poziomu zawierają te same pola co standardowe zdarzenia zdefiniowane przez zasoby. Jedną z tych właściwości jest właściwość zawierająca data właściwości unikatowe dla tematu niestandardowego. Jako wydawca zdarzeń określasz właściwości dla tego obiektu danych. Oto schemat:

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

Opis tych właściwości można znaleźć w temacie Azure Event Grid event schema (Schemat zdarzeń usługi Azure Event Grid). Gdy klient wysyła zdarzenia do tematu usługi Event Grid, tablica może mieć całkowity rozmiar do 1 MB. Maksymalny dozwolony rozmiar zdarzenia wynosi również 1 MB. Zdarzenia powyżej 64 KB są naliczane w przyrostach 64 KB. Gdy klient odbiera zdarzenia w partii, maksymalna dozwolona liczba zdarzeń wynosi 5000 na partię.

Na przykład prawidłowy schemat danych zdarzenia to:

[{
  "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}

Response

Po opublikowaniu w punkcie końcowym tematu otrzymasz odpowiedź. Odpowiedź to standardowy kod odpowiedzi HTTP. Oto niektóre typowe odpowiedzi:

W przypadku błędów treść komunikatu ma następujący format:

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

Powiązana zawartość

• Monitorowanie dostarczania komunikatów usługi Event Grid: dowiedz się, jak śledzić i rozwiązywać problemy z dostawami 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.