Azure Kubernetes Service (AKS) as an Event Grid source

Article
06/13/2023

This article provides the properties and schema for AKS events. It also gives you a list of quick starts and tutorials to use AKS as an event source. For an introduction to event schemas, see Azure Event Grid event schema and Cloud event schema.

Available event types

AKS emits the following event types

Event Type	Description
Microsoft.ContainerService.NewKubernetesVersionAvailable	Triggered when the list of available Kubernetes versions is updated.
Microsoft.ContainerService.ClusterSupportEnded	Triggered when the cluster goes out of support
Microsoft.ContainerService.ClusterSupportEnding	Triggered when the clusters kubernetes version is soon going out of support
Microsoft.ContainerService.NodePoolRollingFailed	Triggered when NodepoolRolling fails as a result of upgrade or update
Microsoft.ContainerService.NodePoolRollingStarted	Triggered when NodepoolRolling started as a result of upgrade or an update
Microsoft.ContainerService.NodePoolRollingSucceeded	Triggered when NodepoolRolling succeeded as a result of upgrade or an update

When an event is triggered, the Event Grid service sends data about that event to subscribing endpoint. This section contains an example of what that data would look like for each event. Each event has the following top-level data:

Property	Type	Description
`source`	string	Full resource path to the event source. This field isn't writeable. Event Grid provides this value.
`subject`	string	Publisher-defined path to the event subject.
`type`	string	One of the registered event types for this event source.
`time`	string	The time the event is generated based on the provider's UTC time.
`id`	string	Unique identifier for the event.
`data`	object	Blob storage event data.
`specversion`	string	CloudEvents schema specification version.

Property	Type	Description
`topic`	string	Full resource path to the event source. This field isn't writeable. Event Grid provides this value.
`subject`	string	Publisher-defined path to the event subject.
`eventType`	string	One of the registered event types for this event source.
`eventTime`	string	The time the event is generated based on the provider's UTC time.
`id`	string	Unique identifier for the event.
`data`	object	Blob storage event data.
`dataVersion`	string	The schema version of the data object. The publisher defines the schema version.
`metadataVersion`	string	The schema version of the event metadata. Event Grid defines the schema of the top-level properties. Event Grid provides this value.

Example events

NewKubernetesVersionAvailable

Cloud event schema
Event Grid event schema


{
    "source": "/subscriptions/<id>/resourceGroups<rg>/providers/Microsoft.ContainerService/managedClusters/<cluster>",
    "subject": "<cluster>",
    "type": "Microsoft.ContainerService.NewKubernetesVersionAvailable",
    "id": "1234567890abcdef1234567890abcdef12345678",
    "data": {
      "latestSupportedKubernetesVersion": "1.20.7",
      "latestStableKubernetesVersion": "1.19.11",
      "lowestMinorKubernetesVersion": "1.18.19",
      "latestPreviewKubernetesVersion": "1.21.1"
    },
    "specversion": "1.0",
    "time": "2021-07-01T04:52:57.0000000Z"
}

{
    "topic": "/subscriptions/<id>/resourceGroups<rg>/providers/Microsoft.ContainerService/managedClusters/<cluster>",
    "subject": "<cluster>",
    "eventType": "Microsoft.ContainerService.NewKubernetesVersionAvailable",
    "id": "1234567890abcdef1234567890abcdef12345678",
    "data": {
      "latestSupportedKubernetesVersion": "1.20.7",
      "latestStableKubernetesVersion": "1.19.11",
      "lowestMinorKubernetesVersion": "1.18.19",
      "latestPreviewKubernetesVersion": "1.21.1"
    },
    "dataVersion": "1",
    "metadataVersion": "1",
    "eventTime": "2021-07-01T04:52:57.0000000Z"
}

The data object contains the following properties:

Property	Type	Description
`latestSupportedKubernetesVersion`	string	The latest supported version of Kubernetes available.
`latestStableKubernetesVersion`	string	The latest stable supported version of Kubernetes available.
`lowestMinorKubernetesVersion`	string	The lowest supported version of Kubernetes available.
`latestPreviewKubernetesVersion`	string	The latest preview version of Kubernetes available.

Next steps

See the following tutorial: Quickstart: Subscribe to Azure Kubernetes Service (AKS) events with Azure Event Grid.

Share via