Partilhar via

Gestão de API do Azure como uma fonte de Event Grid

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 Descrição
Microsoft.ApiManagement.UserCreated Gerado quando um utilizador é criado.
Microsoft.ApiManagement.UserUpdated Acionado quando um utilizador é atualizado.
Microsoft.ApiManagement.UtilizadorEliminado Gerado quando um utilizador é eliminado.
Microsoft.ApiManagement.APICreated Levantado quando uma API é criada.
Atualização da API do Microsoft.ApiManagement Gerado quando uma API é atualizada.
Microsoft.ApiManagement.APIDeleted Gerado quando uma API é excluída.
Microsoft.ApiManagement.ProductCreated Acionado quando um produto é criado.
Microsoft.ApiManagement.ProductUpdated Gerado quando um produto é atualizado.
Microsoft.ApiManagement.ProductDeleted Gerado quando um produto é excluído.
Microsoft.ApiManagement.APIReleaseCreated Gerado quando uma versão da API é criada.
Atualização de Lançamento da API do Microsoft.ApiManagement Levantado quando uma versão da API é atualizada.
Microsoft.ApiManagement.APIReleaseDeleted Gerado quando uma versão da API é eliminada.
Microsoft.ApiManagement.SubscriptionCreated Gerado quando uma assinatura é criada.
Microsoft.ApiManagement.SubscriptionAtualizado Gerado quando uma assinatura é atualizada.
Eliminação de Subscrição Microsoft.ApiManagement Gerado quando uma assinatura é excluída.
Microsoft.ApiManagement.PortalCriado Gerado quando um gateway auto-hospedado é criado.
Microsoft.ApiManagement.Gateway Eliminado Gerado quando um gateway auto-hospedado é atualizado.
Microsoft.ApiManagement.Gateway Atualizado Gerado quando um gateway autogerido é eliminado.
Microsoft.ApiManagement.GatewayAPIAdded Gerado quando uma API é adicionada a um gateway auto-hospedado.
Microsoft.ApiManagement.GatewayAPIRemoved Gerado quando uma API é removida de um gateway auto-hospedado.
Microsoft.ApiManagement.AutoridadeCertificadoraDoGatewayCriado Gerado quando uma autoridade de certificação é atualizada para um gateway auto-hospedado.
Microsoft.ApiManagement.AutoridadeDeCertificaçãoDeGatewayExcluída Gerado quando uma autoridade de certificação é excluída para um gateway auto-hospedado.
Microsoft.ApiManagement.AutoridadeCertificadoraDoGatewayAtualizada Gerado quando uma autoridade de certificação é atualizada para um gateway auto-hospedado.
Microsoft.ApiManagement.GatewayHostnameConfigurationCreated Gerado quando uma configuração de nome de host é criada para um gateway auto-hospedado.
Microsoft.ApiManagement.GatewayHostnameConfigurationDeleted Gerado quando uma configuração de nome de host é excluída para um gateway auto-hospedado.
Microsoft.ApiManagement.GatewayHostnameConfigurationUpdated Gerado quando uma configuração de nome de host é atualizada para um gateway auto-hospedado.
Microsoft.ApiManagement.GatewayTokenNearExpiry (visualização) Acionado quando um token de acesso de um gateway auto-hospedado está prestes a expirar.
Microsoft.ApiManagement.GatewayTokenExpired (pré-visualização) Gerado quando um token de acesso de gateway auto-hospedado expirou.
Microsoft.ApiManagement.CircuitBreaker.Opened (visualização) Ativado quando um disjuntor do circuito de fundo é aberto.
Microsoft.ApiManagement.CircuitBreaker.Closed (visualização) Acionado quando um disjuntor de back-end é fechado.

Exemplo de evento

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 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 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 de abertura do disjuntor.

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

O exemplo a seguir mostra o esquema de um evento de expiração de token de gateway. O esquema de um evento de token de gateway próximo da expiração é semelhante, mas substitui a propriedade expiresAtUtc pela propriedade expiredAtUtc.

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

Propriedades do evento

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

Propriedade Tipo Descrição
source corda Caminho completo do recurso para a origem do evento. Este campo não pode ser gravado. O Event Grid fornece este valor.
subject corda Caminho definido pelo publicador para o assunto do evento.
type corda Um dos tipos de eventos registados para esta fonte de eventos.
time corda A hora em que o evento é gerado com base na hora UTC do provedor.
id corda Identificador único para o evento.
data objeto Dados de eventos de gerenciamento de API.
specversion corda Versão da especificação do esquema CloudEvents.

Propriedades do objeto de dados

Eventos do plano de controlo

O data objeto tem as seguintes propriedades para eventos do plano de controle, como criação, atualização e exclusão de recursos de Gerenciamento de API.

Propriedade Tipo Descrição
resourceUri corda 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>

Incidentes de disjuntores

O data objeto tem as seguintes propriedades para eventos de disjuntor.

Propriedade Tipo Descrição
backendNme corda O nome (ID) da entidade de back-end na qual o disjuntor está configurado.
circuitBreaker objeto O disjuntor configurado no backend, consistindo em um objeto rules especificando a regra que disparou o backend. A regra tem uma tripDuration propriedade no formato hh:mm:ss especificando a duração durante a qual o disjuntor é desativado.

Eventos de token de autenticação para gateway autogerido

O objeto data tem as seguintes propriedades para eventos de token de autenticação de gateway auto-hospedado.

Propriedade Tipo Descrição
gatewayInfo objeto As informações do gateway auto-hospedado, consistindo nas seguintes propriedades de cadeia de caracteres:

* gatewayId - A ID totalmente qualificada do recurso de gateway
* instanceId - ID de instância exclusiva do gateway implantado
tokenInfo objeto As informações do token, que consistem em uma das seguintes propriedades na hora UTC do provedor:

* expiresAtUtc - para GatewayTokenNearExpiry evento, ou
* expiredAtUtc - para GatewayTokenExpired evento

Tutoriais e instruções

Título Descrição
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.