Central de API do Azure como uma fonte de Grade de Eventos (Visualização)

  • Artigo

Este artigo fornece as propriedades e o esquema para eventos do Centro de API do Azure. Para obter uma introdução aos esquemas de eventos, consulte Esquema de eventos da Grade de Eventos do Azure.

Nota

Esta funcionalidade está atualmente em pré-visualização.

Tipos de eventos disponíveis

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

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

Exemplo de evento

Quando um evento é acionado, o serviço do Centro de API envia dados sobre esse evento para o ponto de extremidade de assinatura. Esta seção contém um exemplo da aparência desses dados para cada evento do Centro de APIs.

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 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 do Centro de API do Azure.
specversion string Versão da especificação do esquema CloudEvents.

O objeto de dados tem as seguintes propriedades:

Propriedade Type Description
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, consistindo em (nome da especificação) e version (versão da name especificação)

Tutorials and how-tos (Tutoriais e procedimentos)

Title Description
Habilite o linting e a análise para governança de API em seu centro de API Use eventos da Grade de Eventos para acionar o linting para analisar as definições de API em seu centro de APIs.

Conteúdos relacionados

  • 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.