다음을 통해 공유

Event Grid 원본으로 Azure API 센터 사용(미리 보기)

  • 아티클

이 문서에서는 Azure API 센터 이벤트의 속성과 스키마를 제공합니다. 이벤트 스키마에 대한 소개는 Azure Event Grid 이벤트 스키마를 참조하세요.

참고 항목

이 기능은 현지 미리 보기로 제공됩니다.

사용할 수 있는 이벤트 유형

이러한 이벤트는 클라이언트가 API 정의를 추가하거나 업데이트할 때 트리거됩니다.

이벤트 이름 설명
Microsoft.ApiCenter.ApiDefinitionAdded API 정의가 API 센터에 추가될 때 트리거됩니다.
Microsoft.ApiCenter.ApiDefinitionUpdated API 센터에서 API 정의가 업데이트될 때 트리거됩니다.

예제 이벤트

이벤트가 트리거되면 API 센터 서비스는 해당 이벤트에 대한 데이터를 구독 엔드포인트로 보냅니다. 이 섹션에는 각 API 센터 이벤트에 대한 데이터가 어떻게 표시되는지 예가 포함되어 있습니다.

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

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

이벤트 속성

이벤트에는 다음과 같은 최상위 데이터가 있습니다.

속성 Type 설명
source string 이벤트 원본에 대한 전체 리소스 경로입니다. 이 필드는 쓸 수 없습니다. Event Grid는 이 값을 제공합니다.
subject string 게시자가 정의한 이벤트 주체의 경로입니다.
type string 이 이벤트 원본에 대해 등록된 이벤트 유형 중 하나입니다.
time string 공급자의 UTC 시간을 기준으로 이벤트가 생성되는 시간입니다.
id string 이벤트에 대한 고유 식별자입니다.
data 개체 Azure API Center 이벤트 데이터.
specversion string CloudEvents 스키마 사양 버전입니다.

데이터 개체의 속성은 다음과 같습니다.

속성 Type 설명
title string API 정의의 제목.
description string API 정의의 설명.
specification string name (사양 이름) 및 version (사양 버전)으로 구성된 API 사양 속성

자습서 및 방법

제목 설명
API 센터에서 API 거버넌스에 대한 린팅 및 분석 사용 Event Grid 이벤트를 사용하여 린팅을 트리거하여 API 센터에서 API 정의를 분석합니다.

관련 콘텐츠