Condividi tramite

Gestione API di Azure come origine di Griglia di eventi

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

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 Si verifica 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 un'API viene eliminata.
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.APIReleaseCreated Generato quando viene creata una versione API.
Microsoft.ApiManagement - Aggiornamento del rilascio dell'API Generato quando viene aggiornata una versione API.
Microsoft.ApiManagement.APIReleaseDeleted 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.GestioneAPI.SottoscrizioneCancellata Generato quando viene eliminata una sottoscrizione.
Microsoft.ApiManagement.GatewayCreated Generato quando viene creato un gateway autogestito.
Microsoft.ApiManagement.GatewayDeleted Generato quando viene aggiornato un gateway con hosting autonomo.
Microsoft.ApiManagement.GatewayAggiornato Generato quando viene eliminato un gateway auto-ospitato.
Microsoft.ApiManagement.GatewayAPIAdded Generato quando un'API viene aggiunta a un gateway ospitato localmente.
Microsoft.ApiManagement.GatewayAPIRemoved Generato quando un'API viene rimossa da un gateway self-hosted.
Microsoft.ApiManagement.GatewayCertificateAuthorityCreated Generato quando un'autorità di certificazione viene aggiornata per un gateway autogestito.
Microsoft.ApiManagement.GatewayCertificateAuthorityDeleted Generato quando un'autorità di certificazione viene cancellata per un gateway autonomo.
Microsoft.ApiManagement.GatewayCertificateAuthorityUpdated Generato quando un'autorità di certificazione viene aggiornata per un gateway autogestito.
Microsoft.ApiManagement.GatewayHostnameConfigurationCreated Generato quando viene creata una configurazione del nome host per un gateway ospitato in proprio.
Microsoft.ApiManagement.GatewayHostnameConfigurationDeleted Generato quando viene eliminata una configurazione dell'hostname per un gateway autogestito.
Microsoft.ApiManagement.GatewayHostnameConfigurationUpdated Generato quando viene aggiornata la configurazione del nome host per un gateway auto-ospitato.
Microsoft.ApiManagement.GatewayTokenNearExpiry (anteprima) Generato quando un token di accesso gateway self-hosted è vicino alla scadenza.
Microsoft.ApiManagement.GatewayTokenExpired (anteprima) Generato quando un token di accesso di un gateway ospitato autonomamente è scaduto.
Microsoft.ApiManagement.CircuitBreaker.Opened (versione anteprima) Sollevato quando viene aperto un interruttore di back-end.
Microsoft.ApiManagement.CircuitBreaker.Closed (anteprima) Generato quando un interruttore del sistema back-end viene chiuso.

Evento di esempio

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

[{
  "id": "81dac958-49cf-487e-8805-d0baf0ee485a",
  "source": "/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"
  },
  "Type": "Microsoft.ApiManagement.ProductCreated",
  "Time": "2021-07-02T00:38:44.3978295Z",
  "specversion":"1.0"
}]

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

[{
  "id": "81dac958-49cf-487e-8805-d0baf0ee485a",
  "source": "/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"
  },
  "Type": "Microsoft.ApiManagement.UserDeleted",
  "Time": "2021-07-02T00:38:44.3978295Z",
  "specversion":"1.0"
}]

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

[{
  "id": "95015754-aa51-4eb6-98d9-9ee322b82ad7",
  "source": "/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"
  },
  "Type": "Microsoft.ApiManagement.APIUpdated",
  "Time": "2021-07-12T23:13:44.9048323Z",
  "specversion":1.0
}]

Nell'esempio seguente viene illustrato lo schema di un evento di apertura dell'interruttore.

{
  "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}",
  "subject": "/backends/{backend-name}/circuit-breaker/rules/{rule-name}",
  "type": "Microsoft.ApiManagement.CircuitBreaker.Opened",
  "time": "2025-04-02T00:47:47.8536532Z",
  "id": "92c502f2-a966-42a7-a428-d3b319844544",
  "data": {
    "backendName": "{backend-name}",
    "circuitBreaker": {
      "rules": {
        "{rule-name}": {
          "tripDuration": "00:00:01"
        }
      }
    }
  },
  "specVersion": "1.0"
}

L'esempio seguente illustra lo schema di un evento scaduto del token del gateway. Lo schema di un token del gateway vicino alla scadenza è simile, ma sostituisce una expiresAtUtc proprietà per la expiredAtUtc proprietà.

{
  "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}",
  "subject": "/gateways/{gateway-name}/{instance-name}",
  "type": "Microsoft.ApiManagement.GatewayTokenExpired",
  "time": "2025-04-02T00:47:47.8536532Z",
  "id": "92c502f2-a966-42a7-a428-d3b319844544",
  "data": {
    "gatewayInfo": {
      "gatewayId": "{gateway-name}",
      "instanceId": "{instance-name}"
    },
    "tokenInfo": {
      "expiredAtUtc": "2025-02-25T08:56:00.0000000Z"
    }
  },
  "specVersion": "1.0"
}

Proprietà degli eventi

Un evento ha i seguenti dati di primo livello:

Proprietà TIPO Descrizione
source corda Percorso completo della risorsa alla sorgente dell'evento. Questo campo non è scrivibile. Questo valore viene specificato da Griglia di eventi.
subject corda Percorso definito dal publisher per il soggetto dell'evento.
type corda Uno dei tipi di evento registrati per questa sorgente dell'evento.
time corda Ora in cui viene generato l'evento in base all'ora UTC del provider.
id corda Identificatore univoco per l'evento.
data oggetto Dati degli eventi di Gestione API.
specversion corda Versione della specifica dello schema CloudEvents.

Proprietà dell'oggetto dati

Eventi del piano di controllo

L'oggetto data ha le proprietà seguenti per gli eventi del piano di controllo, ad esempio la creazione, l'aggiornamento e l'eliminazione di risorse di Gestione API.

Proprietà TIPO Descrizione
resourceUri corda ID completo della risorsa per cui cambia lo 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>

Eventi dell'interruttore automatico

L'oggetto data ha le proprietà seguenti per gli eventi di interruttore.

Proprietà TIPO Descrizione
backendNme corda Nome (ID) dell'entità back-end in cui è configurato l'interruttore.
circuitBreaker oggetto L'interruttore di circuito configurato nel back-end, costituito da un oggetto rules che specifica la regola che ha attivato il backend. La regola ha una tripDuration proprietà nel formato hh:mm:ss che specifica la durata per cui l'interruttore scatta.

Eventi dei token di autenticazione per il gateway autosospitato

L'oggetto data presenta le seguenti proprietà per gli eventi del token di autenticazione del gateway self-hosted.

Proprietà TIPO Descrizione
gatewayInfo oggetto Informazioni sul gateway autogestito, costituite dalle seguenti proprietà stringa:

* gatewayId - ID pienamente qualificato della risorsa gateway
* instanceId - ID univoco dell'istanza del gateway distribuito
tokenInfo oggetto Informazioni sul token, costituite da una delle proprietà seguenti nell'ora UTC del provider:

* expiresAtUtc - per l'evento GatewayTokenNearExpiry, oppure
* expiredAtUtc - per GatewayTokenExpired l'evento

Tutorial e istruzioni

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

Passaggi successivi