Delen via

Azure API Center als een Event Grid-bron (preview)

  • Artikel

Dit artikel bevat de eigenschappen en het schema voor Azure API Center-gebeurtenissen. Zie het Gebeurtenisschema van Azure Event Grid voor een inleiding tot gebeurtenisschema's.

Notitie

Deze functie is momenteel beschikbaar in preview.

Beschikbare gebeurtenistypen

Deze gebeurtenissen worden geactiveerd wanneer een client een API-definitie toevoegt of bijwerken.

Gebeurtenisnaam Beschrijving
Microsoft.ApiCenter.ApiDefinitionAdded Geactiveerd wanneer een API-definitie wordt toegevoegd in een API-centrum.
Microsoft.ApiCenter.ApiDefinitionUpdated Geactiveerd wanneer een API-definitie wordt bijgewerkt in een API-centrum.

Voorbeeld van een gebeurtenis

Wanneer een gebeurtenis wordt geactiveerd, verzendt de API Center-service gegevens over die gebeurtenis naar het abonnementseindpunt. Deze sectie bevat een voorbeeld van hoe die gegevens eruit zouden zien voor elke API Center-gebeurtenis.

Microsoft.ApiCenter.ApiDefinitionAdded-gebeurtenis

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

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

Eigenschappen van gebeurtenis

Een gebeurtenis bevat de volgende gegevens op het hoogste niveau:

Eigenschap Type Omschrijving
source tekenreeks Volledig resourcepad naar de gebeurtenisbron. Dit veld kan niet worden geschreven. Event Grid biedt deze waarde.
subject tekenreeks Het door de uitgever gedefinieerde pad naar het gebeurtenisonderwerp.
type tekenreeks Een van de geregistreerde gebeurtenistypen voor deze gebeurtenisbron.
time tekenreeks Het tijdstip waarop de gebeurtenis wordt gegenereerd op basis van de UTC-tijd van de provider.
id tekenreeks Unieke id voor de gebeurtenis.
data object Gebeurtenisgegevens van Azure API Center.
specversion tekenreeks CloudEvents schemaspecificatieversie.

Het gegevensobject heeft de volgende eigenschappen:

Eigenschap Type Omschrijving
title tekenreeks De titel van de API-definitie.
description tekenreeks De beschrijving van de API-definitie.
specification tekenreeks De eigenschappen van name de API-specificatie, bestaande uit (specificatienaam) en version (specificatieversie)

Zelfstudies en handleidingen

Title Beschrijving
Linting en analyse inschakelen voor API-governance in uw API-centrum Gebruik Event Grid-gebeurtenissen om linting te activeren voor het analyseren van API-definities in uw API-centrum.

Gerelateerde inhoud