Dela via

Azure API Center som en Event Grid-källa (förhandsversion)

  • Artikel

Den här artikeln innehåller egenskaper och schema för Azure API Center-händelser. En introduktion till händelsescheman finns i Händelseschema för Azure Event Grid.

Kommentar

Den här funktionen finns i förhandsgranskning.

Tillgängliga händelsetyper

Dessa händelser utlöses när en klient lägger till eller uppdaterar en API-definition.

Händelsenamn beskrivning
Microsoft.ApiCenter.ApiDefinitionLägg till Utlöses när en API-definition läggs till i ett API-center.
Microsoft.ApiCenter.ApiDefinitionUpdated Utlöses när en API-definition uppdateras i ett API-center.

Exempelhändelse

När en händelse utlöses skickar API Center-tjänsten data om händelsen till den prenumererande slutpunkten. Det här avsnittet innehåller ett exempel på hur dessa data skulle se ut för varje API Center-händelse.

Microsoft.ApiCenter.ApiDefinitionLägg till händelse

[{
  "source": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.ApiCenter/services",
  "subject": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.ApiCenter/services/{api_center_name}/workspaces/default/apis/{api_name}/versions/{version_name}/definitions/{definition_name}",
  "type": "Microsoft.ApiCenter.ApiDefinitionAdded",
  "time": "2024-03-01T00:00:00.0000000Z",
  "id": "00000000-0000-0000-0000-000000000000",
  "data": {
    "title": "OpenAPI",
    "description": "Default spec",
    "specification": {
      "name": "openapi",
      "version": "3.0.1"
    }
  },
  "specversion": "1.0"
}]

Microsoft.ApiCenter.ApiDefinitionUpdated-händelse

[{
  "source": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.ApiCenter/services",
  "subject": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.ApiCenter/services/{api_center_name}/workspaces/default/apis/{api_name}/versions/{version_name}/definitions/{definition_name}",
  "type": "Microsoft.ApiCenter.ApiDefinitionUpdated",
  "time": "2024-03-01T00:00:00.0000000Z",
  "id": "00000000-0000-0000-0000-000000000000",
  "data": {
    "title": "OpenAPI",
    "description": "Default spec",
    "specification": {
      "name": "openapi",
      "version": "3.0.1"
    }
  },
  "specversion": "1.0"
}]

Händelseegenskaper

En händelse har följande data på den översta nivån:

Property Type Description
source sträng Fullständig resurssökväg till händelsekällan. Det här fältet kan inte skrivas. Event Grid ger det här värdet.
subject sträng Utgivardefinierad sökväg till händelseobjektet.
type sträng En av de registrerade händelsetyperna för den här händelsekällan.
time sträng Den tid då händelsen genereras baserat på leverantörens UTC-tid.
id sträng Unik identifierare för händelsen.
data objekt Azure API Center-händelsedata.
specversion sträng CloudEvents schemaspecifikationsversion.

Dataobjektet har följande egenskaper:

Property Type Description
title sträng Rubriken för API-definitionen.
description sträng Beskrivningen av API-definitionen.
specification sträng API-specifikationsegenskaperna, som består av name (specifikationsnamn) och version (specifikationsversion)

Självstudier och instruktioner

Title Description
Aktivera lintning och analys för API-styrning i DITT API Center Använd Event Grid-händelser för att utlösa lintning för att analysera API-definitioner i ditt API Center.

Relaterat innehåll