Condividi tramite

Azure Gestione API come origine di Griglia di eventi

  • Articolo

Questo articolo fornisce le proprietà e lo schema per gli eventi di Azure Gestione API. Per un'introduzione agli schemi di eventi, vedere Schema di eventi di Griglia di eventi di Azure. Fornisce anche collegamenti ad articoli per usare Gestione API come origine evento.

Tipi di evento disponibili

Gestione API genera i tipi di evento seguenti:

Tipo di evento Descrizione
Microsoft.ApiManagement.UserCreated Generato quando viene creato un utente.
Microsoft.ApiManagement.UserUpdated Generato quando un utente viene aggiornato.
Microsoft.ApiManagement.UserDeleted Generato quando un utente viene eliminato.
Microsoft.ApiManagement.APICreated Generato quando viene creata un'API.
Microsoft.ApiManagement.APIUpdated Generato quando un'API viene aggiornata.
Microsoft.ApiManagement.APIDeleted Generato quando viene eliminata un'API.
Microsoft.ApiManagement.ProductCreated Generato quando viene creato un prodotto.
Microsoft.ApiManagement.ProductUpdated Generato quando un prodotto viene aggiornato.
Microsoft.ApiManagement.ProductDeleted Generato quando un prodotto viene eliminato.
Microsoft.ApiManagement.ReleaseCreated Generato quando viene creata una versione API.
Microsoft.ApiManagement.ReleaseUpdated Generato quando viene aggiornata una versione dell'API.
Microsoft.ApiManagement.ReleaseDeleted Generato quando viene eliminata una versione api.
Microsoft.ApiManagement.SubscriptionCreated Generato quando viene creata una sottoscrizione.
Microsoft.ApiManagement.SubscriptionUpdated Generato quando viene aggiornata una sottoscrizione.
Microsoft.ApiManagement.SubscriptionDeleted Generato quando viene eliminata una sottoscrizione.
Microsoft.ApiManagement.GatewayCreated Generato quando viene creato un gateway self-hosted.
Microsoft.ApiManagement.GatewayDeleted Generato quando viene aggiornato un gateway self-hosted.
Microsoft.ApiManagement.GatewayUpdated Generato quando viene eliminato un gateway self-hosted.
Microsoft.ApiManagement.GatewayAPIAdded Generato quando un'API è stata rimossa da un gateway self-hosted.
Microsoft.ApiManagement.GatewayAPIRemoved Generato quando un'API è stata rimossa da un gateway self-hosted.
Microsoft.ApiManagement.GatewayCertificateAuthorityCreated Generato quando un'autorità di certificazione è stata aggiornata per un self-hosted.
Microsoft.ApiManagement.GatewayCertificateAuthorityDeleted Generato quando un'autorità di certificazione è stata eliminata per un self-hosted.
Microsoft.ApiManagement.GatewayCertificateAuthorityUpdated Generato quando un'autorità di certificazione è stata aggiornata per un self-hosted.
Microsoft.ApiManagement.GatewayHostnameConfigurationCreated Generato quando è stata creata una configurazione del nome host per un self-hosted.
Microsoft.ApiManagement.GatewayHostnameConfigurationDeleted Generato quando una configurazione del nome host è stata eliminata per un self-hosted.
Microsoft.ApiManagement.GatewayHostnameConfigurationUpdated Generato quando è stata aggiornata una configurazione del nome host per un self-hosted.

Evento di esempio

Nell'esempio seguente viene illustrato lo schema di un evento creato dal prodotto. Lo schema di altri eventi creati Gestione API risorsa è simile.

[{
  "id": "92c502f2-a966-42a7-a428-d3b319844544",
  "topic": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}",
  "subject": "/products/myproduct",
  "data": {
    "resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}/products/myproduct"
  },
  "eventType": "Microsoft.ApiManagement.ProductCreated",
  "dataVersion": "1",
  "metadataVersion": "1",
  "eventTime": "2021-07-02T00:47:47.8536532Z"
}]

Nell'esempio seguente viene illustrato lo schema di un evento eliminato dall'utente. Lo schema di altri eventi eliminati della risorsa Gestione API è simile.

[{
  "id": "92c502f2-a966-42a7-a428-d3b319844544",
  "topic": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}",
  "subject": "/users/apimuser-contoso-com",
  "data": {
    "resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}/users/apimuser-contoso-com"
  },
  "eventType": "Microsoft.ApiManagement.UserDeleted",
  "dataVersion": "1",
  "metadataVersion": "1",
  "eventTime": "2021-07-02T00:47:47.8536532Z"
}]

L'esempio seguente illustra lo schema di un evento aggiornato dell'API. Lo schema di altri eventi aggiornati delle risorse Gestione API è simile.

[{
  "id": "95015754-aa51-4eb6-98d9-9ee322b82ad7",
  "topic": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}",
  "subject": "/apis/myapi;Rev=1",
  "data": {
    "resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}/apis/myapi;Rev=1"
  },
  "eventType": "Microsoft.ApiManagement.APIUpdated",
  "dataVersion": "1",
  "metadataVersion": "1",
  "eventTime": "2021-07-12T23:13:44.9048323Z"
}]

Proprietà degli eventi

Un evento presenta i seguenti dati di primo livello:

Proprietà Type Descrizione
topic string Percorso risorsa completo dell'origine evento. Questo campo non è scrivibile. Questo valore viene fornito da Griglia di eventi.
subject string Percorso dell'oggetto dell'evento definito dall'origine di pubblicazione.
eventType string Uno dei tipi di evento registrati per l'origine evento.
eventTime string Ora di generazione dell'evento in base all'ora UTC del provider.
id string Identificatore univoco dell'evento.
data object Gestione API dati dell'evento.
dataVersion string Versione dello schema dell'oggetto dati. La versione dello schema è definita dall'origine di pubblicazione.
metadataVersion string Versione dello schema dei metadati dell'evento. Lo schema delle proprietà di primo livello è definito da Griglia di eventi. Questo valore viene specificato da Griglia di eventi.

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

Proprietà Type Descrizione
resourceUri string ID completo della risorsa per cui viene modificata la modifica dello stato di conformità, inclusi il nome della risorsa e il tipo di risorsa. Usa il formato , /subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>

Esercitazioni e procedure

Titolo Descrizione
Inviare eventi da Gestione API a Griglia di eventi Come sottoscrivere Gestione API eventi usando Griglia di eventi.

Passaggi successivi