Skip to content

subscribe-to-resource-notifications-containerservice-events.md

Latest commit

 

History

History
245 lines (172 loc) · 14.8 KB

subscribe-to-resource-notifications-containerservice-events.md

File metadata and controls

245 lines (172 loc) · 14.8 KB
title Subscribe to Azure Resource Notifications - ContainerService events
description This article explains how to subscribe to events published by Azure Resource Notifications - ContainerService Events.
ms.topic how-to
ms.custom devx-track-azurecli, devx-track-azurepowershell
ms.date 11/14/2024

Subscribe to events raised by Azure Resource Notifications - ContainerService Event Resources system topic (Preview)

This article explains the steps needed to subscribe to events published by Azure Resource Notifications - ContainerService Event Resources. For detailed information about these events, see Azure Resource Notifications - ContainerService Event Resources.

Create Health Resources system topic

Azure CLI

  1. Set the account to the Azure subscription where you wish to create the system topic.

    az account set –s AZURESUBSCRIPTIONID

  2. Create a system topic of type microsoft.resourcenotifications.containerserviceeventresources using the az eventgrid system-topic create command.

    az eventgrid system-topic create --name SYSTEMTOPICNAME --resource-group RESOURCEGROUPNAME --source /subscriptions/AZURESUBSCRIPTIONID --topic-type microsoft.resourcenotifications.containerserviceeventresources --location Global

Azure PowerShell

  1. Set the account to the Azure subscription where you wish to create the system topic.

    Set-AzContext -Subscription AZURESUBSCRIPTIONID

  2. Create a system topic of type microsoft.resourcenotifications.containerserviceeventresources using the New-AzEventGridSystemTopic command.

    New-AzEventGridSystemTopic -name SYSTEMTOPICNAME -resourcegroup RESOURCEGROUPNAME -source /subscriptions/AZURESUBSCRIPTIONID -topictype microsoft.resourcenotifications.containerserviceeventresources -location global

Azure portal

  1. Sign into the Azure portal.

  2. In the search bar, type Event Grid System Topics, and select it from the drop-down list.

  3. On the Event Grid system topics page, select + Create on the toolbar.

  4. On the Create Event Grid System Topic page, select Azure Resource Notifications - ContainerService events for Topic type.

    :::image type="content" source="./media/subscribe-to-resource-notifications-containerservice-events/create-topic.png" alt-text="Screenshot that shows the Create topic page in the Azure portal." lightbox="./media/subscribe-to-resource-notifications-health-resources-events/create-topic.png" :::

  5. Select the resource group in which you want to create the system topic.

  6. Enter a name for the system topic.

  7. Select Review + create

    :::image type="content" source="./media/subscribe-to-resource-notifications-containerservice-events/create-topic-full.png" alt-text="Screenshot that shows the full Create topic page with details in the Azure portal.":::

  8. On the Review + create page, select Create.

  9. On the successful deployment page, select Go to resource to navigate to the page for your system topic. You see the details about your system topic on this page.

    :::image type="content" source="./media/subscribe-to-resource-notifications-containerservice-events/system-topic-home-page.png" alt-text="Screenshot that shows the System topic page in the Azure portal." lightbox="./media/subscribe-to-resource-notifications-containerservice-events/system-topic-home-page.png" :::

Subscribe to events

Azure CLI

Create an event subscription for the above topic by using the az eventgrid system-topic event-subscription create command.

The following sample command creates an event subscription for the ScheduledEventEmitted event.

az eventgrid system-topic event-subscription create --name EVENTSUBSCRIPTIONNAME --resource-group RESOURCEGROUPNAME --system-topic-name SYSTEMTOPICNAME –included-event-types Microsoft.ResourceNotifications.ContainerServiceEventResources.ScheduledEventEmitted --endpoint /subscriptions/AZURESUBSCRIPTIONID/resourceGroups/RESOURCEGROUPNAME/providers/Microsoft.EventHub/namespaces/MYEVENTHUBSNAMESPACE/eventhubs/MYEVENTHUB --endpoint-type eventhub

If you don't specify included-event-types, all the event types are included by default.

To filter events from a specific resource, use the --subject-begins-with parameter. The example shows how to subscribe to ScheduledEventsEmitted events for resources in a specified resource group.

az eventgrid system-topic event-subscription create --name EVENTSUBSCRIPTIONNAME --resource-group RESOURCEGROUPNAME --system-topic-name SYSTEMTOPICNAME –included-event-types Microsoft.ResourceNotifications.ContainerServiceEventResources.ScheduledEventEmitted --endpoint /subscriptions/AZURESUBSCRIPTIONID/resourceGroups/RESOURCEGROUPNAME/providers/Microsoft.EventHub/namespaces/MYEVENTHUBSNAMESPACE/eventhubs/MYEVENTHUB --endpoint-type eventhub --subject-begins-with /subscriptions/AZURESUBSCRIPTIONID/resourceGroups/SOURCERESOURCEGROUP/

Azure PowerShell

Create an event subscription for the above topic using the New-AzEventGridSystemTopicEventSubscription command.

The following sample command creates an event subscription for the ScheduledEventEmitted event.

New-AzEventGridSystemTopicEventSubscription -EventSubscriptionName EVENTSUBSCRIPTIONNAME -ResourceGroupName RESOURCEGROUPNAME -SystemtopicName SYSTEMTOPICNAME -IncludedEventType Microsoft.ResourceNotifications.ContainerServiceEventResources.ScheduledEventEmitted -Endpoint /subscriptions/AZURESUBSCRIPTIONID/resourceGroups/RESOURCEGROUPNAME/providers/Microsoft.EventHub/namespaces/EVENTHUBSNAMESPACE/eventhubs/EVENTHUB -EndpointType eventhub

If you don't specify IncludedEventType, all the event types are included by default.

To filter events from a specific resource, use the -SubjectBeginsWith parameter. The example shows how to subscribe to ScheduledEventEmitted events from resources in a specified resource group.

New-AzEventGridSystemTopicEventSubscription -EventSubscriptionName EVENTSUBSCRIPTIONNAME -ResourceGroupName RESOURCEGROUPNAME -SystemtopicName SYSTEMTOPICNAME -IncludedEventType Microsoft.ResourceNotifications.ContainerServiceEventResources.ScheduledEventEmitted -Endpoint /subscriptions/AZURESUBSCRIPTIONID/resourceGroups/RESOURCEGROUPNAME/providers/Microsoft.EventHub/namespaces/EVENTHUBSNAMESPACE/eventhubs/EVENTHUB -EndpointType eventhub -SubjectBeginsWith /subscriptions/AZURESUBSCRIPTIONID/resourceGroups/SOURCERESOURCEGROUP/

Azure portal

  1. On the Event Grid System Topic page, select + Event Subscription on the toolbar.

  2. Confirm that the Topic Type, Source Resource, and Topic Name are automatically populated.

  3. Enter a name for the event subscription.

  4. For Filter to event types, select the event, for example, ScheduledEventEmitted.

    :::image type="content" source="./media/subscribe-to-resource-notifications-containerservice-events/create-event-subscription-select-event.png" alt-text="Screenshot that shows the Create Event Subscription page." lightbox="./media/subscribe-to-resource-notifications-health-resources-events/create-event-subscription-select-event.png":::

  5. Select endpoint type.

  6. Configure event handler based on the endpoint type you selected. In the following example, an Azure event hub is selected.

    :::image type="content" source="./media/subscribe-to-resource-notifications-containerservice-events/select-endpoint.png" alt-text="Screenshot that shows the Create Event Subscription page with an event handler." lightbox="./media/subscribe-to-resource-notifications-health-resources-events/select-endpoint.png":::

  7. Select the Filters tab to provide subject filtering and advanced filtering. For example, to filter for events from resources in a specific resource group, follow these steps:

    1. Select Enable subject filtering.

    2. In the Subject Filters section, for Subject begins with, provide the value of the resource group in this format: /subscriptions/{subscription-id}/resourceGroups/{resourceGroup-id}.

      :::image type="content" source="./media/subscribe-to-resource-notifications-containerservice-events/filter.png" alt-text="Screenshot that shows the Filters tab of the Create Event Subscription page." lightbox="./media/subscribe-to-resource-notifications-health-resources-events/filter.png":::

  8. Then, select Create to create the event subscription.

Delete event subscription and system topic

Azure CLI

To delete the event subscription, use the az eventgrid system-topic event-subscription delete command. Here's an example:

az eventgrid system-topic event-subscription delete --name EVENTSUBSCRIPTIONNAME --resourcegroup RESOURCEGROUPNAME --system-topic-name SYSTEMTOPICNAME

To delete the system topic, use the az eventgrid system-topic delete command. Here's an example:

az eventgrid system-topic delete --name SYSTEMTOPICNAME --resource-group RESOURCEGROUPNAME

Azure PowerShell

To delete an event subscription, use the Remove-AzEventGridSystemTopicEventSubscription command. Here's an example:

Remove-AzEventGridSystemTopicEventSubscription -EventSubscriptionName EVENTSUBSCRIPTIONNAME -ResourceGroupName RESOURCEGROUPNAME -SystemTopicName SYSTEMTOPICNAME

To delete the system topic, use the Remove-AzEventGridSystemTopic command. Here's an example:

Remove-AzEventGridSystemTopic -ResourceGroupName RESOURCEGROUPNAME -Name SYSTEMTOPICNAME

Azure portal

  1. Sign in to the Azure portal.
  2. In the search bar, type Event Grid System Topics, and press ENTER.
  3. Select the system topic.
  4. On the Event Grid System Topic page, select Delete on the toolbar.

Filtering examples

Subscribe to Azure Kubernetes Cluster Scheduled Events by a Specific Cluster

You might want to filter the Azure Kubernetes Cluster Scheduled Events by a specific cluster on the subscriber end. This filtering helps ensure that you only receive notifications from clusters that are of interest to you.

Azure CLI

az eventgrid system-topic event-subscription create \
 --name EVENTSUBSCRIPTIONNAME \
 --resource-group RESOURCEGROUPNAME \
 --system-topic-name SYSTEMTOPICNAME \
 --included-event-types Microsoft.ResourceNotifications.ContainerServiceEventResources.ScheduledEventEmitted \
 --endpoint /subscriptions/000000000-0000-0000-0000-0000000000000/resourceGroups/RESOURCEGROUPNAME/providers/Microsoft.EventHub/namespaces/EVENTHUBNAMESPACE/eventhubs/EVENTHUBNAME \
 --endpoint-type evenhub \
 --advanced-filter data.resourceInfo.properties.resources StringContains clusterName

Azure PowerShell

New-AzEventGridSystemTopicEventSubscription -EventSubscriptionName EVENTSUBSCRIPTIONNAME
-ResourceGroupName RESOURCEGROUPNAME 
-SystemtopicName SYSTEMTOPICNAME 
-IncludedEventType Microsoft.ResourceNotifications.ContainerServiceEventResources.ScheduledEventEmitted  
-Endpoint /subscriptions/000000000-0000-0000-0000-000000000000/resourceGroups/RESOURCEGROUPNAME/providers/Microsoft.EventHub/namespaces/EVENTHUBNAMESPACE/eventhubs/EVENTHUBNAME 
-EndpointType eventhub 
-AdvancedFilter @(@{operator = "StringContains"; key = "data.resourceInfo.properties.resources" ; value ="clusterName"})

Azure portal

  1. Choose ScheduledEventEmitted as the event type.

  2. In the Filters tab of the event subscription, choose the following advanced filters.

    Key = data.resourceInfo.properties.resources
Operator = String contains 
Value = clusterName

Subscribe to Azure Kubernetes Cluster Scheduled Events by "Completed" Event Status

You might want to filter the Azure Kubernetes Cluster Scheduled Events by a specific status, for example, "Completed" on the subscriber end. This filtering helps ensure that you only receive notifications from events that are of interest to you.

Azure CLI

az eventgrid system-topic event-subscription create \
 --name EVENTSUBSCRIPTIONNAME \
 --resource-group RESOURCEGROUPNAME \
 --system-topic-name SYSTEMTOPICNAME \
 --included-event-types Microsoft.ResourceNotifications.ContainerServiceEventResources.ScheduledEventEmitted \
 --endpoint /subscriptions/000000000-0000-0000-0000-0000000000000/resourceGroups/RESOURCEGROUPNAME/providers/Microsoft.EventHub/namespaces/EVENTHUBNAMESPACE/eventhubs/EVENTHUBNAME \
 --endpoint-type evenhub \
 --advanced-filter data.resourceInfo.properties.eventStatus StringContains Completed

Azure PowerShell

New-AzEventGridSystemTopicEventSubscription -EventSubscriptionName EVENTSUBSCRIPTIONNAME
-ResourceGroupName RESOURCEGROUPNAME 
-SystemtopicName SYSTEMTOPICNAME 
-IncludedEventType Microsoft.ResourceNotifications.ContainerServiceEventResources.ScheduledEventEmitted  
-Endpoint /subscriptions/000000000-0000-0000-0000-000000000000/resourceGroups/RESOURCEGROUPNAME/providers/Microsoft.EventHub/namespaces/EVENTHUBNAMESPACE/eventhubs/EVENTHUBNAME 
-EndpointType eventhub 
-AdvancedFilter @(@{operator = "StringContains"; key = "data.resourceInfo.properties.eventStatus" ; value ="Completed"})

Azure portal

In the Filters tab of the event subscription, choose the following advanced filters.

Key = data.resourceInfo.properties.eventStatus
Operator = String contains 
Value = Completed

[!INCLUDE contact-resource-notifications]

Next steps

For detailed information about these events, see Azure Resource Notifications - Container Service Events.