Gerenciamento de API do Azure como uma fonte de Grade de Eventos

Artigo
03/05/2024

Este artigo fornece as propriedades e o esquema para eventos de Gerenciamento de API do Azure. Para obter uma introdução aos esquemas de eventos, consulte Esquema de eventos da Grade de Eventos do Azure. Ele também fornece links para artigos para usar o Gerenciamento de API como uma fonte de eventos.

Tipos de eventos disponíveis

O Gerenciamento de API emite os seguintes tipos de eventos:

Tipo de evento	Description
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 da API é criada.
Microsoft.ApiManagement.ReleaseAtualizado	Gerado quando uma versão da API é atualizada.
Microsoft.ApiManagement.ReleaseDeleted	Gerado quando uma versão da API é excluída.
Microsoft.ApiManagement.SubscriptionCreated	Gerado quando uma assinatura é criada.
Microsoft.ApiManagement.SubscriptionAtualizado	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.GatewayAtualizado	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 de host foi criada para um auto-hospedado.
Microsoft.ApiManagement.GatewayHostnameConfigurationDeleted	Gerado quando uma configuração de nome de host foi excluída para um auto-hospedado.
Microsoft.ApiManagement.GatewayHostnameConfigurationUpdated	Gerado quando uma configuração de nome de host foi atualizada para um auto-hospedado.

O exemplo a seguir mostra o esquema de um evento criado pelo produto. O esquema de outros eventos criados pelo recurso de 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 criado pelo produto. O esquema de outros eventos criados pelo recurso de Gerenciamento de API é semelhante.

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

Esquema de eventos na nuvem
Esquema de eventos da Grade de Eventos

O exemplo a seguir mostra o esquema de um evento excluído do usuário. O esquema de outros eventos excluídos de recursos 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 excluído do usuário. O esquema de outros eventos excluídos de recursos do Gerenciamento de API é semelhante.

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

Esquema de eventos na nuvem
Esquema de eventos da Grade de Eventos

O exemplo a seguir mostra o esquema de um evento atualizado da API. O esquema de outros eventos atualizados de recursos 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
}]

O exemplo a seguir mostra o esquema de um evento atualizado da API. O esquema de outros eventos atualizados de recursos do Gerenciamento de API é semelhante.

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

Propriedades do evento

Esquema de eventos na nuvem
Esquema de eventos da Grade de Eventos

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

Propriedade	Type	Description
`source`	string	Caminho completo do recurso para a origem do evento. Este campo não pode ser gravado. O Event Grid fornece este valor.
`subject`	string	Caminho definido pelo publicador para o assunto do evento.
`type`	string	Um dos tipos de eventos registados para esta origem de 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 eventos de gerenciamento de API.
`specversion`	string	Versão da especificação do esquema CloudEvents.

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

Propriedade	Type	Description
`topic`	string	Caminho completo do recurso para a origem do evento. Este campo não pode ser gravado. O Event Grid fornece este valor.
`subject`	string	Caminho definido pelo publicador para o assunto do evento.
`eventType`	string	Um dos tipos de eventos registados para esta origem de evento.
`eventTime`	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 eventos de gerenciamento de API.
`dataVersion`	string	A versão do esquema do objeto de dados. O publicador define a versão do esquema.
`metadataVersion`	string	A versão do esquema dos metadados do evento. O Event Grid define o esquema das propriedades de nível superior. O Event Grid fornece este valor.

O objeto de dados tem as seguintes propriedades:

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

Tutorials and how-tos (Tutoriais e procedimentos)

Title	Description
Enviar eventos do Gerenciamento de API para a Grade de Eventos	Como se inscrever em eventos de Gerenciamento de API usando a Grade de Eventos.

Próximos passos

Para obter uma introdução à Grade de Eventos do Azure, consulte O que é a Grade de Eventos?
Para obter mais informações sobre como criar uma assinatura da Grade de Eventos do Azure, consulte Esquema de assinatura da Grade de Eventos.

Partilhar via