Condividi tramite

Centro API di Azure come origine di Griglia di eventi (anteprima)

  • Articolo

Questo articolo fornisce le proprietà e lo schema per gli eventi del Centro API di Azure. Per un'introduzione agli schemi di eventi, vedere Schema di eventi di Griglia di eventi di Azure.

Nota

Questa funzionalità è attualmente disponibile solo in anteprima.

Tipi di evento disponibili

Questi eventi vengono attivati quando un client aggiunge o aggiorna una definizione api.

Nome evento Descrizione
Microsoft.ApiCenter.ApiDefinitionAdded Attivato quando viene aggiunta una definizione API in un centro API.
Microsoft.ApiCenter.ApiDefinitionUpdated Attivato quando una definizione API viene aggiornata in un centro API.

Evento di esempio

Quando viene attivato un evento, il servizio Centro API invia i dati relativi a tale evento all'endpoint di sottoscrizione. Questa sezione contiene un esempio dell'aspetto dei dati per ogni evento del Centro API.

Evento Microsoft.ApiCenter.ApiDefinitionAdded

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

Evento Microsoft.ApiCenter.ApiDefinitionUpdated

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

Proprietà dell'evento

Un evento presenta i seguenti dati di primo livello:

Proprietà Type Descrzione
source stringa Percorso completo della risorsa all'origine evento. Questo campo non è scrivibile. Questo valore viene specificato da Griglia di eventi.
subject string Percorso definito dall'editore all'oggetto dell'evento.
type string Uno dei tipi di evento registrati per l'origine evento.
time string Ora di generazione dell'evento in base all'ora UTC del provider.
id string Identificatore univoco per l'evento.
data oggetto Dati dell'evento di Centro API di Azure.
specversion string Versione della specifica dello schema CloudEvents.

Di seguito sono elencate le proprietà dell'oggetto dati:

Proprietà Type Descrzione
title stringa Titolo della definizione dell'API.
description string Descrizione della definizione dell'API.
specification string Proprietà della specifica DELL'API, costituite da name (nome specifica) e version (versione specifica)

Esercitazioni e procedure

Posizione Descrizione
Abilitare il linting e l'analisi per la governance delle API nel centro API Usare gli eventi di Griglia di eventi per attivare il linting per analizzare le definizioni api nel centro API.

Contenuto correlato