Event Grid 원본으로서의 Azure API Management

2025-05-08

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

사용할 수 있는 이벤트 유형

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

이벤트 유형	설명
Microsoft.ApiManagement.사용자생성됨	사용자가 생성될 때 발생합니다.
Microsoft.ApiManagement.UserUpdated	사용자가 업데이트될 때 발생합니다.
마이크로소프트. API 관리. 사용자 삭제됨	사용자가 삭제될 때 발생합니다.
Microsoft.ApiManagement.APICreated	API를 만들 때 발생합니다.
Microsoft.ApiManagement.APIUpdated	API가 업데이트될 때 발생합니다.
Microsoft.ApiManagement.API삭제됨	API가 삭제될 때 발생합니다.
Microsoft.ApiManagement.ProductCreated	제품이 만들어질 때 발생됩니다.
Microsoft.ApiManagement.제품업데이트됨	제품이 업데이트될 때 발생합니다.
Microsoft.ApiManagement.제품삭제	제품이 삭제될 때 발생합니다.
Microsoft.ApiManagement.APIReleaseCreated	API 릴리스를 만들 때 발생합니다.
Microsoft.ApiManagement.APIReleaseUpdated	API 릴리스가 업데이트될 때 발생합니다.
Microsoft.ApiManagement.APIReleaseDeleted	API 릴리스가 삭제될 때 발생합니다.
Microsoft.ApiManagement.SubscriptionCreated	구독이 생성될 때 트리거됩니다.
Microsoft.ApiManagement.SubscriptionUpdated	구독이 업데이트될 때 발생합니다.
Microsoft.ApiManagement.SubscriptionDeleted (구독 삭제됨)	구독이 삭제될 때 발생합니다.
Microsoft.ApiManagement.GatewayCreated	자체 호스팅 게이트웨이를 만들 때 발생합니다.
Microsoft.ApiManagement.Gateway 삭제됨	자체 호스팅 게이트웨이가 업데이트될 때 발생합니다.
Microsoft.ApiManagement.게이트웨이가 업데이트되었습니다	자체 호스팅 게이트웨이가 삭제될 때 발생합니다.
Microsoft.ApiManagement.GatewayAPIAdded	API가 자체 호스팅 게이트웨이에 추가될 때 발생합니다.
Microsoft.ApiManagement.게이트웨이API삭제됨	자체 호스팅 게이트웨이에서 API가 제거될 때 발생합니다.
Microsoft.ApiManagement.게이트웨이인증서AuthorityCreated	자체 호스팅 게이트웨이에 대해 인증 기관을 업데이트할 때 발생합니다.
마이크로소프트.ApiManagement.GatewayCertificateAuthority삭제됨	자체 호스팅 게이트웨이에 대해 인증 기관을 삭제할 때 발생합니다.
Microsoft.ApiManagement.GatewayCertificateAuthorityUpdated (게이트웨이 인증 기관 업데이트)	자체 호스팅 게이트웨이에 대해 인증 기관을 업데이트할 때 발생합니다.
Microsoft.ApiManagement.게이트웨이호스트이름구성생성	자체 호스팅 게이트웨이에 대한 호스트 이름 구성을 만들 때 발생합니다.
Microsoft.ApiManagement.GatewayHostnameConfigurationDeleted	자체 호스팅 게이트웨이에 대한 호스트 이름 구성이 삭제될 때 발생합니다.
마이크로소프트.ApiManagement.게이트웨이호스트이름구성업데이트	자체 호스팅 게이트웨이에 대한 호스트 이름 구성 변경 사항이 있을 때 발생합니다.
Microsoft.ApiManagement.GatewayTokenNearExpiry(미리 보기)	자체 호스팅 게이트웨이 액세스 토큰이 거의 만료될 때 발생합니다.
Microsoft.ApiManagement.GatewayTokenExpired(미리 보기)	자체 호스팅 게이트웨이 액세스 토큰이 만료될 때 발생합니다.
Microsoft.ApiManagement.CircuitBreaker.Opened(미리 보기)	백 엔드 회로 차단기를 열 때 발생합니다.
Microsoft.ApiManagement.CircuitBreaker.Closed(미리 보기)	백 엔드 회로 차단기를 닫을 때 발생합니다.

다음 예제에서는 제품 생성 이벤트의 스키마를 보여줍니다. 생성된 다른 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": "92c502f2-a966-42a7-a428-d3b319844544",
  "topic": "/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"
  },
  "eventType": "Microsoft.ApiManagement.ProductCreated",
  "dataVersion": "1",
  "metadataVersion": "1",
  "eventTime": "2021-07-02T00:47:47.8536532Z"
}]

클라우드 이벤트 스키마
Event Grid 이벤트 스키마

다음 예제에서는 사용자 삭제된 이벤트의 스키마를 보여 있습니다. 다른 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 Management 리소스 삭제 이벤트의 스키마는 비슷합니다.

[{
  "id": "92c502f2-a966-42a7-a428-d3b319844544",
  "topic": "/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"
  },
  "eventType": "Microsoft.ApiManagement.UserDeleted",
  "dataVersion": "1",
  "metadataVersion": "1",
  "eventTime": "2021-07-02T00:47:47.8536532Z"
}]

클라우드 이벤트 스키마
Event Grid 이벤트 스키마

다음 예제에서는 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
}]

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

[{
  "id": "95015754-aa51-4eb6-98d9-9ee322b82ad7",
  "topic": "/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"
  },
  "eventType": "Microsoft.ApiManagement.APIUpdated",
  "dataVersion": "1",
  "metadataVersion": "1",
  "eventTime": "2021-07-12T23:13:44.9048323Z"
}]

클라우드 이벤트 스키마
Event Grid 이벤트 스키마

다음 예제에서는 회로 차단기의 열림 이벤트 스키마를 보여줍니다.

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

다음 예제에서는 회로 차단기의 열림 이벤트 스키마를 보여줍니다. 회로 차단기 닫힌 이벤트의 스키마는 비슷합니다.

{
  "id": "92c502f2-a966-42a7-a428-d3b319844544",
  "topic": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}",
  "subject": "/backends/{backend-name}/circuit-breaker/rules/{rule-name}",
  "data": {
    "backendName": "{backend-name}",
    "circuitBreaker": {
      "rules": {
        "{rule-name}": {
          "tripDuration": "00:00:01"
        }
      }
    }
  },
  "eventType": "Microsoft.ApiManagement.CircuitBreaker.Opened",
  "dataVersion": "1",
  "metadataVersion": "1",
  "eventTime": "2025-04-02T00:47:48.8269769Z"
}

클라우드 이벤트 스키마
Event Grid 이벤트 스키마

다음 예제에서는 게이트웨이 토큰 만료 이벤트의 스키마를 보여 줍니다. 만료 임박 이벤트의 게이트웨이 토큰 스키마는 비슷하지만, expiresAtUtc 속성을 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"
}

다음 예제에서는 게이트웨이 토큰 만료 이벤트의 스키마를 보여 줍니다.

{
  "id": "92c502f2-a966-42a7-a428-d3b319844544",
  "topic": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}",
  "subject": "/gateways/{gateway-name}/{instance-name}",
  "data": {
    "gatewayInfo": {
      "gatewayId": "{gateway-name}",
      "instanceId": "{instance-name}"
    },
    "tokenInfo": {
      "expiredAtUtc": "2025-02-25T08:56:00.0000000Z"
    }
  },
  "eventType": "Microsoft.ApiManagement.GatewayTokenExpired",
  "dataVersion": "1",
  "metadataVersion": "1",
  "eventTime": "2025-04-02T00:47:48.8269769Z"
}

이벤트 속성

클라우드 이벤트 스키마
Event Grid 이벤트 스키마

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

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

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

재산	유형	설명
`topic`	문자열	이벤트 원본에 대한 전체 리소스 경로입니다. 이 필드는 쓸 수 없습니다. Event Grid는 이 값을 제공합니다.
`subject`	문자열	이벤트 대상에 대한 게시자가 정의한 경로입니다.
`eventType`	문자열	이 이벤트 원본에 대해 등록된 이벤트 유형 중 하나입니다.
`eventTime`	문자열	공급자의 UTC 시간을 기준으로 이벤트가 생성되는 시간입니다.
`id`	문자열	이벤트의 고유 식별자입니다.
`data`	객체	API Management 이벤트 데이터입니다.
`dataVersion`	문자열	데이터 개체의 스키마 버전입니다. 게시자는 스키마 버전을 정의합니다.
`metadataVersion`	문자열	이벤트 메타데이터의 스키마 버전입니다. Event Grid는 최상위 속성의 스키마를 정의합니다. Event Grid는 이 값을 제공합니다.

데이터 개체 속성

컨트롤 플레인 이벤트

data 개체에는 API Management 리소스 만들기, 업데이트 및 삭제와 같은 컨트롤 플레인 이벤트에 대한 다음과 같은 속성이 있습니다.

재산	유형	설명
`resourceUri`	문자열	리소스 이름 및 리소스 종류를 포함하여 규정 준수 상태가 변경하는 리소스의 정규화된 ID입니다. `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>` 형식을 사용합니다.

회로 차단기 이벤트

개체에는 data 회로 차단기 이벤트에 대한 다음과 같은 속성이 있습니다.

재산	유형	설명
`backendNme`	문자열	회로 차단기가 구성된 백 엔드 엔터티의 이름(ID)입니다.
`circuitBreaker`	객체	백 엔드에 구성된 회로 차단기는 회로를 트립시킨 규칙을 지정하는 `rules` 개체로 구성됩니다. 규칙에는 `tripDuration` 회로 차단기가 트립되는 기간을 지정하는 hh:mm:ss 형식의 속성이 있습니다.

자체 호스팅 게이트웨이 인증 토큰 이벤트

data 개체에는 자체 호스팅 게이트웨이 인증 토큰 이벤트에 대해 다음과 같은 속성이 있습니다.

재산	유형	설명
`gatewayInfo`	객체	다음 문자열 속성으로 구성된 자체 호스팅 게이트웨이 정보입니다. * `gatewayId` - 게이트웨이 리소스의 정규화된 ID * `instanceId` - 배포된 게이트웨이의 고유 인스턴스 ID
`tokenInfo`	객체	공급자의 UTC 시간에서 다음 속성 중 하나로 구성된 토큰 정보입니다. * `expiresAtUtc` - `GatewayTokenNearExpiry` 이벤트 또는 * `expiredAtUtc` - `GatewayTokenExpired` 이벤트용

자습서 및 방법

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

다음 단계

Azure Event Grid에 대한 소개는 Event Grid란?을 참조하세요.
Azure Event Grid 구독을 만드는 방법에 대한 자세한 내용은 Event Grid 구독 스키마를 참조하세요.