Azure API Management als event grid-bron

Artikel
03/05/2024

Dit artikel bevat de eigenschappen en het schema voor Azure API Management-gebeurtenissen . Zie het Gebeurtenisschema van Azure Event Grid voor een inleiding tot gebeurtenisschema's. U krijgt ook koppelingen naar artikelen om API Management als gebeurtenisbron te gebruiken.

Beschikbare gebeurtenistypen

API Management verzendt de volgende gebeurtenistypen:

Gebeurtenistype	Beschrijving
Microsoft.ApiManagement.UserCreated	Gegenereerd wanneer een gebruiker wordt gemaakt.
Microsoft.ApiManagement.UserUpdated	Gegenereerd wanneer een gebruiker wordt bijgewerkt.
Microsoft.ApiManagement.UserDeleted	Gegenereerd wanneer een gebruiker wordt verwijderd.
Microsoft.ApiManagement.APICreated	Wordt gegenereerd wanneer er een API wordt gemaakt.
Microsoft.ApiManagement.APIUpdated	Gegenereerd wanneer een API wordt bijgewerkt.
Microsoft.ApiManagement.APIDeleted	Gegenereerd wanneer een API wordt verwijderd.
Microsoft.ApiManagement.ProductCreated	Wordt gegenereerd wanneer een product wordt gemaakt.
Microsoft.ApiManagement.ProductUpdated	Verhoogd wanneer een product wordt bijgewerkt.
Microsoft.ApiManagement.ProductDeleted	Verhoogd wanneer een product wordt verwijderd.
Microsoft.ApiManagement.ReleaseCreated	Wordt gegenereerd wanneer er een API-release wordt gemaakt.
Microsoft.ApiManagement.ReleaseUpdated	Wordt gegenereerd wanneer een API-release wordt bijgewerkt.
Microsoft.ApiManagement.ReleaseDeleted	Wordt gegenereerd wanneer een API-release wordt verwijderd.
Microsoft.ApiManagement.SubscriptionCreated	Wordt gegenereerd wanneer een abonnement wordt gemaakt.
Microsoft.ApiManagement.SubscriptionUpdated	Wordt gegenereerd wanneer een abonnement wordt bijgewerkt.
Microsoft.ApiManagement.SubscriptionDeleted	Wordt gegenereerd wanneer een abonnement wordt verwijderd.
Microsoft.ApiManagement.GatewayCreated	Wordt gegenereerd wanneer een zelf-hostende gateway wordt gemaakt.
Microsoft.ApiManagement.GatewayDeleted	Wordt gegenereerd wanneer een zelf-hostende gateway wordt bijgewerkt.
Microsoft.ApiManagement.GatewayUpdated	Wordt gegenereerd wanneer een zelf-hostende gateway wordt verwijderd.
Microsoft.ApiManagement.GatewayAPIAdded	Gegenereerd wanneer een API is verwijderd uit een zelf-hostende gateway.
Microsoft.ApiManagement.GatewayAPIRemoved	Gegenereerd wanneer een API is verwijderd uit een zelf-hostende gateway.
Microsoft.ApiManagement.GatewayCertificateAuthorityCreated	Gegenereerd wanneer een certificeringsinstantie is bijgewerkt voor een zelf-hostende instantie.
Microsoft.ApiManagement.GatewayCertificateAuthorityDeleted	Wordt gegenereerd wanneer een certificeringsinstantie is verwijderd voor een zelf-hostende instantie.
Microsoft.ApiManagement.GatewayCertificateAuthorityUpdated	Gegenereerd wanneer een certificeringsinstantie is bijgewerkt voor een zelf-hostende instantie.
Microsoft.ApiManagement.GatewayHostnameConfigurationCreated	Wordt gegenereerd wanneer een hostnaamconfiguratie is gemaakt voor een zelf-hostend.
Microsoft.ApiManagement.GatewayHostnameConfigurationDeleted	Gegenereerd wanneer een hostnaamconfiguratie is verwijderd voor een zelf-hostende.
Microsoft.ApiManagement.GatewayHostnameConfigurationUpdated	Wordt gegenereerd wanneer een hostnaamconfiguratie is bijgewerkt voor een zelf-hostend.

In het volgende voorbeeld ziet u het schema van een door een product gemaakte gebeurtenis. Het schema van andere gebeurtenissen die door API Management-resources zijn gemaakt, is vergelijkbaar.

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

In het volgende voorbeeld ziet u het schema van een door een product gemaakte gebeurtenis. Het schema van andere gebeurtenissen die door API Management-resources zijn gemaakt, is vergelijkbaar.

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

Cloud-gebeurtenisschema
Event Grid-gebeurtenisschema

In het volgende voorbeeld ziet u het schema van een verwijderde gebruiker. Het schema van andere verwijderde gebeurtenissen van API Management-resources is vergelijkbaar.

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

In het volgende voorbeeld ziet u het schema van een verwijderde gebruiker. Het schema van andere verwijderde gebeurtenissen van API Management-resources is vergelijkbaar.

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

Cloud-gebeurtenisschema
Event Grid-gebeurtenisschema

In het volgende voorbeeld ziet u het schema van een bijgewerkte API-gebeurtenis. Het schema van andere bijgewerkte gebeurtenissen voor API Management-resources is vergelijkbaar.

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

In het volgende voorbeeld ziet u het schema van een bijgewerkte API-gebeurtenis. Het schema van andere bijgewerkte gebeurtenissen voor API Management-resources is vergelijkbaar.

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

Eigenschappen van gebeurtenis

Cloud-gebeurtenisschema
Event Grid-gebeurtenisschema

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	API Management-gebeurtenisgegevens.
`specversion`	tekenreeks	CloudEvents schemaspecificatieversie.

Een gebeurtenis bevat de volgende gegevens op het hoogste niveau:

Eigenschap	Type	Omschrijving
`topic`	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.
`eventType`	tekenreeks	Een van de geregistreerde gebeurtenistypen voor deze gebeurtenisbron.
`eventTime`	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	API Management-gebeurtenisgegevens.
`dataVersion`	tekenreeks	De schemaversie van het gegevensobject. De uitgever definieert de schemaversie.
`metadataVersion`	tekenreeks	De schemaversie van de metagegevens van de gebeurtenis. Event Grid definieert het schema voor de eigenschappen op het hoogste niveau. Event Grid biedt deze waarde.

Het gegevensobject heeft de volgende eigenschappen:

Eigenschap	Type	Omschrijving
`resourceUri`	tekenreeks	De volledig gekwalificeerde id van de resource waarvoor de nalevingsstatus wordt gewijzigd, inclusief de resourcenaam en het resourcetype. Maakt gebruik van de notatie, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>`

Zelfstudies en handleidingen

Title	Beschrijving
Gebeurtenissen verzenden van API Management naar Event Grid	Abonneren op API Management-gebeurtenissen met behulp van Event Grid.

Volgende stappen

Zie Wat is Event Grid? voor een inleiding tot Azure Event Grid.
Zie het Event Grid-abonnementsschema voor meer informatie over het maken van een Azure Event Grid-abonnement.

Delen via