Compartilhar via

Centro de API do Azure como uma origem da Grade de Eventos (versão prévia)

  • Artigo

Este artigo fornece as propriedades e o esquema dos eventos do Centro de API do Azure. Para obter uma introdução a esquemas de evento, consulte esquema de grade de eventos do Azure.

Observação

Esse recurso está atualmente na visualização.

Tipos de evento disponíveis

Esses eventos são disparados quando um cliente adiciona ou atualiza uma definição de API.

Nome do evento Descrição
Microsoft.ApiCenter.ApiDefinitionAdded Disparado quando uma definição de API é adicionada em um centro de API.
Microsoft.ApiCenter.ApiDefinitionUpdated Disparado quando uma definição de API é atualizada em um centro de API.

Exemplo de evento

Quando um evento é disparado, o serviço do Centro de API envia dados sobre esse evento para o ponto de extremidade de assinatura. Esta seção mostra um exemplo de como os dados seriam para cada evento do Centro de API.

Evento Microsoft.ApiCenter.ApiDefinitionAdded

[{
  "source": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.ApiCenter/services",
  "subject": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.ApiCenter/services/{api_center_name}/workspaces/default/apis/{api_name}/versions/{version_name}/definitions/{definition_name}",
  "type": "Microsoft.ApiCenter.ApiDefinitionAdded",
  "time": "2024-03-01T00:00:00.0000000Z",
  "id": "00000000-0000-0000-0000-000000000000",
  "data": {
    "title": "OpenAPI",
    "description": "Default spec",
    "specification": {
      "name": "openapi",
      "version": "3.0.1"
    }
  },
  "specversion": "1.0"
}]

Evento Microsoft.ApiCenter.ApiDefinitionUpdated

[{
  "source": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.ApiCenter/services",
  "subject": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.ApiCenter/services/{api_center_name}/workspaces/default/apis/{api_name}/versions/{version_name}/definitions/{definition_name}",
  "type": "Microsoft.ApiCenter.ApiDefinitionUpdated",
  "time": "2024-03-01T00:00:00.0000000Z",
  "id": "00000000-0000-0000-0000-000000000000",
  "data": {
    "title": "OpenAPI",
    "description": "Default spec",
    "specification": {
      "name": "openapi",
      "version": "3.0.1"
    }
  },
  "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 Centro de API do Azure.
specversion string Versão de especificação do esquema CloudEvents.

O objeto de dados tem as seguintes propriedades:

Propriedade Type Descrição
title string O título da definição da API.
description string A descrição da definição da API.
specification string As propriedades de especificação da API, que consistem em name (nome da especificação) e version (versão de especificação)

Tutoriais e guias de instruções

Título Descrição
Habilitar lint e análise para governança de API em seu centro de API Use eventos da Grade de Eventos para disparar o lint para analisar definições de API no centro de API.

Conteúdo relacionado