Event Grid 원본으로서의 Azure API Management

  • 아티클

이 문서에서는 Azure API Management 이벤트의 속성과 스키마를 제공합니다. 이벤트 스키마에 대한 소개는 Azure Event Grid 이벤트 스키마를 참조하세요. API Management를 이벤트 원본으로 사용할 수 있는 문서의 링크도 제공합니다.

사용할 수 있는 이벤트 유형

API Management는 다음 이벤트 유형을 내보냅니다.

이벤트 유형 설명
Microsoft.ApiManagement.UserCreated 사용자가 만들어질 때 발생합니다.
Microsoft.ApiManagement.UserUpdated 사용자가 업데이트될 때 발생합니다.
Microsoft.ApiManagement.UserDeleted 사용자가 삭제될 때 발생합니다.
Microsoft.ApiManagement.APICreated API가 만들어질 때 발생합니다.
Microsoft.ApiManagement.APIUpdated API가 업데이트될 때 발생합니다.
Microsoft.ApiManagement.APIDeleted API가 삭제될 때 발생합니다.
Microsoft.ApiManagement.ProductCreated 제품이 만들어질 때 발생합니다.
Microsoft.ApiManagement.ProductUpdated 제품이 업데이트될 때 발생합니다.
Microsoft.ApiManagement.ProductDeleted 제품이 삭제될 때 발생합니다.
Microsoft.ApiManagement.ReleaseCreated API 릴리스가 만들어질 때 발생합니다.
Microsoft.ApiManagement.ReleaseUpdated API 릴리스가 업데이트될 때 발생합니다.
Microsoft.ApiManagement.ReleaseDeleted API 릴리스가 삭제될 때 발생합니다.
Microsoft.ApiManagement.SubscriptionCreated 구독이 만들어질 때 발생합니다.
Microsoft.ApiManagement.SubscriptionUpdated 구독이 업데이트될 때 발생합니다.
Microsoft.ApiManagement.SubscriptionDeleted 구독이 삭제될 때 발생합니다.
Microsoft.ApiManagement.GatewayCreated 자체 호스팅 게이트웨이가 만들어질 때 발생합니다.
Microsoft.ApiManagement.GatewayDeleted 자체 호스팅 게이트웨이가 업데이트될 때 발생합니다.
Microsoft.ApiManagement.GatewayUpdated 자체 호스팅 게이트웨이가 삭제될 때 발생합니다.
Microsoft.ApiManagement.GatewayAPIAdded 자체 호스팅 게이트웨이에서 API가 제거되었을 때 발생합니다.
Microsoft.ApiManagement.GatewayAPIRemoved 자체 호스팅 게이트웨이에서 API가 제거되었을 때 발생합니다.
Microsoft.ApiManagement.GatewayCertificateAuthorityCreated 인증 기관이 자체 호스팅에 대해 업데이트되었을 때 발생합니다.
Microsoft.ApiManagement.GatewayCertificateAuthorityDeleted 자체 호스팅에 대한 인증 기관이 삭제되었을 때 발생합니다.
Microsoft.ApiManagement.GatewayCertificateAuthorityUpdated 인증 기관이 자체 호스팅에 대해 업데이트되었을 때 발생합니다.
Microsoft.ApiManagement.GatewayHostnameConfigurationCreated 자체 호스팅에 대한 호스트 이름 구성이 만들어졌을 때 발생합니다.
Microsoft.ApiManagement.GatewayHostnameConfigurationDeleted 자체 호스팅에 대한 호스트 이름 구성이 삭제되었을 때 발생합니다.
Microsoft.ApiManagement.GatewayHostnameConfigurationUpdated 자체 호스팅에 대한 호스트 이름 구성이 업데이트되었을 때 발생합니다.

예제 이벤트

다음 예제에서는 제품 생성 이벤트의 스키마를 보여 줍니다. 다른 API Management 리소스 생성 이벤트의 스키마는 비슷합니다.

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

다음 예제에서는 사용자 삭제 이벤트의 스키마를 보여 줍니다. 다른 API Management 리소스 삭제 이벤트의 스키마는 비슷합니다.

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

다음 예제에서는 API 업데이트 이벤트의 스키마를 보여 줍니다. 다른 API Management 리소스 업데이트 이벤트의 스키마는 비슷합니다.

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

이벤트 속성

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

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

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

속성 Type Description
resourceUri string 리소스 이름과 리소스 형식을 포함하여 준수 상태 변경이 적용되는 리소스의 정규화된 ID입니다. /subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName> 형식 사용

자습서 및 방법

제목 설명
API Management에서 Event Grid로 이벤트 보내기 Event Grid를 사용하여 API Management 이벤트를 구독하는 방법

다음 단계