作為事件方格來源的 Azure API 管理
本文提供 Azure APIM 事件的屬性和結構描述。 如需事件結構描述的簡介,請參閱 Azure Event Grid 事件結構描述。 其也提供您文章的連結,以使用APIM 作為事件來源。
APIM 會發出下列事件類型:
事件類型 | 描述 |
---|---|
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 管理資源所建立事件的結構描述很類似。
[{
"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"
}]
下列範例顯示使用者刪除事件的結構描述。 其他 API 管理資源刪除事件的結構描述很類似。
[{
"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"
}]
下列範例顯示 API 更新事件的結構描述。 其他 API 管理資源所更新事件的結構描述很類似。
[{
"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"
}]
事件具有下列的最高層級資料:
屬性 | 類型 | 描述 |
---|---|---|
topic |
string | 事件來源的完整資源路徑。 此欄位無法寫入。 事件方格提供此值。 |
subject |
string | 發行者定義事件主旨的路徑。 |
eventType |
string | 此事件來源已註冊的事件類型之一。 |
eventTime |
string | 事件產生的時間,以提供者的 UTC 時間為準。 |
id |
string | 事件的唯一識別碼。 |
data |
object | APIM 事件資料。 |
dataVersion |
string | 資料物件的結構描述版本。 發行者會定義結構描述版本。 |
metadataVersion |
string | 事件中繼資料的結構描述版本。 「事件方格」會定義最上層屬性的結構描述。 事件方格提供此值。 |
資料物件具有下列屬性:
屬性 | 類型 | 描述 |
---|---|---|
resourceUri |
string | 合規性狀態變更的資源完整識別碼,包括資源名稱和資源類型。 使用格式、/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName> |
標題 | 描述 |
---|---|
將事件從 APIM 傳送到事件方格 | 如何使用事件方格訂閱 APIM 事件。 |
- 如需 Azure Event Grid 的簡介,請參閱什麼是 Event Grid?
- 若要了解 Event Grid 訂用帳戶的建立,請參閱 Event Grid 訂用帳戶結構描述。