Compartilhar via

Gerenciamento de API do Azure como uma origem do Event Grid

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

Tipos de evento disponíveis

O Gerenciamento de API emite os seguintes tipos de evento:

Tipo de evento Descrição
Microsoft.ApiManagement.UserCreated Acionado quando um usuário é criado.
Microsoft.ApiManagement.UserUpdated Acionado quando um usuário é atualizado.
Microsoft.ApiManagement.UserDeleted Acionado quando um usuário é excluído.
Microsoft.ApiManagement.APICreated Acionado quando uma API é criada.
Microsoft.ApiManagement.APIUpdated Acionado quando uma API é atualizada.
Microsoft.ApiManagement.APIDeleted Gerado quando uma API é excluída.
Microsoft.ApiManagement.ProductCreated Acionado quando um produto é criado.
Microsoft.ApiManagement.ProductUpdated Acionado quando um produto é atualizado.
Microsoft.ApiManagement.ProductDeleted Acionado quando um produto é excluído.
Microsoft.ApiManagement.APIReleaseCreated Acionado quando uma versão da API é criada.
Microsoft.ApiManagement.APIReleaseUpdated Acionado quando uma nova versão da API é atualizada.
Microsoft.ApiManagement.APIReleaseDeleted Acionado quando uma versão da API é excluída.
Microsoft.ApiManagement.SubscriptionCreated Acionado quando uma assinatura é criada.
Microsoft.ApiManagement.SubscriptionUpdated Acionado quando uma assinatura é atualizada.
Microsoft.ApiManagement.SubscriptionDeleted Acionado 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 Acionado quando uma API é adicionada a um gateway auto-hospedado.
Microsoft.ApiManagement.GatewayAPIRemoved Acionado quando uma API é removida de um gateway auto-hospedado.
Microsoft.ApiManagement.GatewayCertificateAuthorityCreated Acionado quando uma autoridade de certificação é atualizada para um gateway auto-hospedado.
Microsoft.ApiManagement.GatewayCertificateAuthorityDeleted Acionado quando uma autoridade de certificação é excluída para um gateway auto-hospedado.
Microsoft.ApiManagement.GatewayCertificateAuthorityUpdated Acionado quando uma autoridade de certificação é atualizada para um gateway auto-hospedado.
Microsoft.ApiManagement.GatewayHostnameConfigurationCreated Acionado quando uma configuração de nome de host é criada para um gateway auto-hospedado.
Microsoft.ApiManagement.GatewayHostnameConfigurationDeleted Acionado quando uma configuração de nome de host é excluída para um gateway auto-hospedado.
Microsoft.ApiManagement.GatewayHostnameConfigurationUpdated Acionado quando uma configuração de nome de host é atualizada para um gateway auto-hospedado.
Microsoft.ApiManagement.GatewayTokenNearExpiry (versão prévia) Acionado quando um token de acesso ao gateway auto-hospedado está prestes a expirar.
Microsoft.ApiManagement.GatewayTokenExpired (versão prévia) Acionado quando um token de acesso ao gateway auto-hospedado expira.
Microsoft.ApiManagement.CircuitBreaker.Opened (versão prévia) Acionado quando um disjuntor de back-end é aberto.
Microsoft.ApiManagement.CircuitBreaker.Closed (versão prévia) 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 pelo usuário. O esquema de outros eventos excluídos do 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": "/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 de API. O esquema de outros eventos atualizados do recurso de 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 de 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 do token do gateway. O esquema de um evento de token do gateway próximo da expiração é semelhante, mas substitui uma 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 cadeia de caracteres Caminho de recurso completo para a origem do evento. Este campo não é gravável. A Grade de Eventos fornece esse valor.
subject cadeia de caracteres Caminho definido pelo publicador para o assunto do evento.
type cadeia de caracteres Um dos tipos de evento registrados como origem do evento.
time cadeia de caracteres A hora em que o evento é gerado com base na hora UTC do provedor.
id cadeia de caracteres Identificador exclusivo para o evento.
data objeto Dados de eventos do Gerenciamento de API.
specversion cadeia de caracteres Versão de especificação do esquema CloudEvents.

Propriedades do objeto de dados

Eventos do painel de controle

O data objeto tem as seguintes propriedades para eventos do plano de controle, como criar, atualizar e excluir recursos de Gerenciamento de API.

Propriedade Tipo Descrição
resourceUri cadeia de caracteres 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>

Eventos do disjuntor

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

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

Eventos de token de autenticação do gateway auto-hospedado

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

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

* gatewayId - O ID totalmente qualificado 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 no horário UTC do provedor:

* expiresAtUtc – para o evento GatewayTokenNearExpiry, 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 assinar eventos de Gerenciamento de API usando o Event Grid.

Próximas etapas

  • Last updated on