Gerenciamento de API do Azure como uma origem da Grade de Eventos

  • Artigo

Este artigo mostra as propriedades e o esquema dos eventos do Gerenciamento de API do Azure. Para obter uma introdução a esquemas de evento, consulte esquema de grade de eventos do Azure. Além disso, conta com links para artigos que explicam como usar o Gerenciamento de API como origem do evento.

Tipos de evento disponíveis

O Gerenciamento de API emite os seguintes tipos de evento:

Tipo de evento Descrição
Microsoft.ApiManagement.UserCreated Gerado quando um usuário é criado.
Microsoft.ApiManagement.UserUpdated Gerado quando um usuário é atualizado.
Microsoft.ApiManagement.UserDeleted Gerado quando um usuário é excluído.
Microsoft.ApiManagement.APICreated Gerado quando uma API é criada.
Microsoft.ApiManagement.APIUpdated Gerado quando uma API é atualizada.
Microsoft.ApiManagement.APIDeleted Gerado quando uma API é excluída.
Microsoft.ApiManagement.ProductCreated Gerado quando um produto é criado.
Microsoft.ApiManagement.ProductUpdated Gerado quando um produto é atualizado.
Microsoft.ApiManagement.ProductDeleted Gerado quando um produto é excluído.
Microsoft.ApiManagement.ReleaseCreated Gerado quando uma versão de API é criada.
Microsoft.ApiManagement.ReleaseUpdated Gerado quando uma versão de API é atualizada.
Microsoft.ApiManagement.ReleaseDeleted Gerado quando uma versão de API é excluída.
Microsoft.ApiManagement.SubscriptionCreated Gerado quando uma assinatura é criada.
Microsoft.ApiManagement.SubscriptionUpdated Gerado quando uma assinatura é atualizada.
Microsoft.ApiManagement.SubscriptionDeleted Gerado quando uma assinatura é excluída.
Microsoft.ApiManagement.GatewayCreated Gerado quando um gateway auto-hospedado é criado.
Microsoft.ApiManagement.GatewayDeleted Gerado quando um gateway auto-hospedado é atualizado.
Microsoft.ApiManagement.GatewayUpdated Gerado quando um gateway auto-hospedado é excluído.
Microsoft.ApiManagement.GatewayAPIAdded Gerado quando uma API foi removida de um gateway auto-hospedado.
Microsoft.ApiManagement.GatewayAPIRemoved Gerado quando uma API foi removida de um gateway auto-hospedado.
Microsoft.ApiManagement.GatewayCertificateAuthorityCreated Gerado quando uma autoridade de certificação foi atualizada para um auto-hospedado.
Microsoft.ApiManagement.GatewayCertificateAuthorityDeleted Gerado quando uma autoridade de certificação foi excluída para um auto-hospedado.
Microsoft.ApiManagement.GatewayCertificateAuthorityUpdated Gerado quando uma autoridade de certificação foi atualizada para um auto-hospedado.
Microsoft.ApiManagement.GatewayHostnameConfigurationCreated Gerado quando uma configuração de nome do host foi criada para um auto-hospedado.
Microsoft.ApiManagement.GatewayHostnameConfigurationDeleted Gerado quando uma configuração de nome do host foi excluída para um auto-hospedado.
Microsoft.ApiManagement.GatewayHostnameConfigurationUpdated Gerado quando uma configuração de nome do host foi atualizada para um auto-hospedado.

Exemplo de evento

Veja no exemplo a seguir o esquema de um evento de criação de produto. O esquema de outros eventos criados pelo recurso do Gerenciamento de API é semelhante.

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

O exemplo a seguir mostra o esquema de um evento excluído pelo usuário. O esquema de outros eventos excluídos pelo recurso do Gerenciamento de API é semelhante.

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

O exemplo a seguir mostra o esquema de um evento de atualização de API. O esquema de outros eventos atualizados pelo recurso do Gerenciamento de API é semelhante.

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

Propriedades do evento

Um evento tem os seguintes dados de nível superior:

Propriedade Type Descrição
source string Caminho de recurso completo para a origem do evento. Este campo não é gravável. A Grade de Eventos fornece esse valor.
subject string Caminho definido pelo publicador para o assunto do evento.
type string Um dos tipos de evento registrados para a origem do evento.
time string A hora em que o evento é gerado com base na hora UTC do provedor.
id string Identificador exclusivo do evento.
data objeto Dados de evento do Gerenciamento de API.
specversion string Versão de especificação do esquema CloudEvents.

O objeto de dados tem as seguintes propriedades:

Propriedade Type Descrição
resourceUri string A ID totalmente qualificada do recurso para o qual o estado de conformidade é alterado, incluindo o nome do recurso e o tipo de recurso. Usa o formato /subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>

Tutoriais e guias de instruções

Título Descrição
Enviar eventos do Gerenciamento de API para a Grade de Eventos Como assinar eventos do Gerenciamento de API usando a Grade de Eventos.

Próximas etapas