Dela via

Azure API Management som en Event Grid-källa

  • Artikel

Den här artikeln innehåller egenskaper och schema för Azure API Management-händelser . En introduktion till händelsescheman finns i Händelseschema för Azure Event Grid. Det ger dig också länkar till artiklar för att använda API Management som händelsekälla.

Tillgängliga händelsetyper

API Management genererar följande händelsetyper:

Händelsetyp beskrivning
Microsoft.ApiManagement.UserCreated Upphöjt när en användare skapas.
Microsoft.ApiManagement.UserUpdated Utlöses när en användare uppdateras.
Microsoft.ApiManagement.UserDeleted Utlöses när en användare tas bort.
Microsoft.ApiManagement.APISkapat Utlöses när ett API skapas.
Microsoft.ApiManagement.APIUpdated Utlöses när ett API uppdateras.
Microsoft.ApiManagement.APIDeleted Utlöses när ett API tas bort.
Microsoft.ApiManagement.ProductCreated Upphöjt när en produkt skapas.
Microsoft.ApiManagement.ProductUpdated Upphöjt när en produkt uppdateras.
Microsoft.ApiManagement.ProductDeleted Utlöses när en produkt tas bort.
Microsoft.ApiManagement.ReleaseCreated Utlöses när en API-version skapas.
Microsoft.ApiManagement.ReleaseUpdated Utlöses när en API-version uppdateras.
Microsoft.ApiManagement.ReleaseDeleted Utlöses när en API-version tas bort.
Microsoft.ApiManagement.SubscriptionCreated Utlöses när en prenumeration skapas.
Microsoft.ApiManagement.SubscriptionUpdated Utlöses när en prenumeration uppdateras.
Microsoft.ApiManagement.SubscriptionDeleted Utlöses när en prenumeration tas bort.
Microsoft.ApiManagement.GatewaySkapad Utlöses när en gateway med egen värd skapas.
Microsoft.ApiManagement.GatewayDeleted Utlöses när en lokalt installerad gateway uppdateras.
Microsoft.ApiManagement.GatewayUpdated Utlöses när en gateway med egen värd tas bort.
Microsoft.ApiManagement.GatewayAPILägg till Upphöjt när ett API togs bort från en gateway med egen värd.
Microsoft.ApiManagement.GatewayAPIRemoved Upphöjt när ett API togs bort från en gateway med egen värd.
Microsoft.ApiManagement.GatewayCertificateAuthorityCreated Utlöses när en certifikatutfärdare uppdaterades för en lokalt installerad certifikatutfärdare.
Microsoft.ApiManagement.GatewayCertificateAuthorityDeleted Utlöses när en certifikatutfärdare togs bort för en lokalt installerad certifikatutfärdare.
Microsoft.ApiManagement.GatewayCertificateAuthorityUpdated Utlöses när en certifikatutfärdare uppdaterades för en lokalt installerad certifikatutfärdare.
Microsoft.ApiManagement.GatewayHostnameConfigurationCreated Upphöjt när en värdnamnskonfiguration skapades för en lokalt installerad värd.
Microsoft.ApiManagement.GatewayHostnameConfigurationDeleted Utlöses när en värdnamnskonfiguration togs bort för en lokalt installerad värd.
Microsoft.ApiManagement.GatewayHostnameConfigurationUpdated Utlöses när en värdnamnskonfiguration uppdaterades för en lokalt installerad värd.

Exempelhändelse

I följande exempel visas schemat för en produkt skapad händelse. Schemat för andra API Management-resursskapade händelser är liknande.

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

I följande exempel visas schemat för en användarborttagningshändelse. Schemat för andra borttagna API Management-resurshändelser liknar varandra.

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

I följande exempel visas schemat för en UPPDATERAD API-händelse. Schemat för andra uppdaterade HÄNDELSER för API Management-resursen är liknande.

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

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 API Management-händelsedata.
specversion sträng CloudEvents schemaspecifikationsversion.

Dataobjektet har följande egenskaper:

Property Type Description
resourceUri sträng Det fullständigt kvalificerade ID:t för resursen som ändringen av efterlevnadstillståndet gäller, inklusive resursnamnet och resurstypen. Använder formatet, /subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>

Självstudier och instruktioner

Title Description
Skicka händelser från API Management till Event Grid Prenumerera på API Management-händelser med Event Grid.

Nästa steg