Create pre and post events

Article
09/02/2024

Applies to: ✔️ Windows VMs ✔️ Linux VMs ✔️ On-premises environment ✔️ Azure Arc-enabled servers ✔️ Azure VMs.

Pre and post events allows you to execute user-defined actions before and after the scheduled maintenance configuration. For more information, go through the workings of a pre and post event in Azure Update Manager.

This article describes on how to create pre and post events in Azure Update Manager.

Event Grid in schedule maintenance configurations

Azure Update Manager leverages Event Grid to create and manage pre and post events. For more information, go through the overview of Event Grid. To trigger an event either before or after a schedule maintenance window, you require the following:

Schedule maintenance configuration - You can create Pre and post events for a schedule maintenance configuration in Azure Update Manager.
Action to be performed in the pre or post event - You can use the Event handlers (Endpoints) supported by Event Grid to define actions or tasks. Here are examples on how to create Azure Automation Runbooks via Webhooks and Azure Functions. Within these Event handlers/Endpoints, you must define the actions that should be performed as part of pre and post events.
1. Webhook - Create a PowerShell 7.2 Runbook and link the Runbook to a webhook.
2. Azure Function - Create an Azure Function.
Pre and post event - You can follow the steps shared in the following section to create a pre and post event for schedule maintenance configuration. To learn more about the terms used in the Basics tab of Event Grid, see Event Grid terms.

Create a pre and post event

Create pre and post events while creating a new schedule maintenance configuration

Sign in to the Azure portal and go to Azure Update Manager.
Under Manage, select Machines.
Select Schedule updates from the ribbon at the top.
In the Create a maintenance configuration page, select the Events tab.
Select +Event Subscription to create pre/post event.
On the Add Event Subscription page, enter the following details: In the Event Subscription Details section, provide an appropriate name.
- Keep the schema as Event Grid Schema.
- Enter the System Topic Name for the first event you create in this maintenance configuration. The same System Topic name will be auto populated for the consequent events.
- In the Event Types section, Filter to Event Types, select the event types that you want to get pushed to the endpoint or destination. You can select either Pre Maintenance Event or Post Maintenance Event or both.
- In the Endpoint details section, select the endpoint where you want to receive the response from.
Select Add to create the pre and post events for the schedule upon its creation.

Note

In the above flow, Webhook and Azure Functions are the two Event handlers/endpoints you can choose from. When you select Add, the event subscription is not created but added to the maintenance configuration. Event subscription is created along with the schedule maintenance configuration.

Create a maintenance configuration by following the steps listed here.

 # Obtain the Maintenance Configuration ID from Step 1 and assign it to MaintenanceConfigurationResourceId variable  

 $MaintenanceConfigurationResourceId = "/subscriptions/<subId>/resourceGroups/<Resource group>/providers/Microsoft.Maintenance/maintenanceConfigurations/<Maintenance configuration Name>"

 # Use the same Resource Group that you used to create maintenance configuration in Step 1

 $ResourceGroupForSystemTopic = "<Resource Group for System Topic>"

 $SystemTopicName = "<System topic name>"

 $TopicType = "Microsoft.Maintenance.MaintenanceConfigurations"

 $SystemTopicLocation = "<System topic location>"

 # System topic creation

 New-AzEventGridSystemTopic -ResourceGroupName $ResourceGroupForSystemTopic -Name $SystemTopicName -Source $MaintenanceConfigurationResourceId -TopicType $TopicType -Location $SystemTopicLocation

 # Event subscription creation

 $IncludedEventTypes = @("Microsoft.Maintenance.PreMaintenanceEvent")

 # Webhook

 $EventSubscriptionName = "PreEventWebhook"

 $PreEventWebhookEndpoint = "<Webhook URL>"

 New-AzEventGridSystemTopicEventSubscription -ResourceGroupName $ResourceGroupForSystemTopic -SystemTopicName $SystemTopicName -EventSubscriptionName $EventSubscriptionName -Endpoint $PreEventWebhookEndpoint -IncludedEventType $IncludedEventTypes

 # Azure Function

 $dest = New-AzEventGridAzureFunctionEventSubscriptionDestinationObject -ResourceId "<Azure Function Resource Id>"

 New-AzEventGridSystemTopicEventSubscription -ResourceGroupName $ResourceGroupForSystemTopic -SystemTopicName $SystemTopicName -EventSubscriptionName $EventSubscriptionName -Destination $dest -IncludedEventType $IncludedEventTypes

Create a maintenance configuration by following the steps listed here.


 SystemTopicName="<System topic name> 

 # Use the same Resource Group that you used to create maintenance configuration in Step 1

 ResourceGroupName="<Resource Group mentioned in Step 1>"

 # Obtain the Maintenance Configuration ID from Step 1 and assign it to Source variable

 Source="/subscriptions/<subId>/resourceGroups/<Resource group>/providers/Microsoft.Maintenance/maintenanceConfigurations/<Maintenance configuration Name>"

 TopicType="Microsoft.Maintenance.MaintenanceConfigurations"

 Location="<System topic location> "

 # System topic creation

 az eventgrid system-topic create --name $SystemTopicName --resource-group $ResourceGroupName --source $Source --topic-type $TopicType --location $Location

 # Event subscription creation

 IncludedEventTypes='("Microsoft.Maintenance.PreMaintenanceEvent")'

 # Webhook

 az eventgrid system-topic event-subscription create --name "<Event subscription name>" --resource-group $ResourceGroupName --system-topic-name $SystemTopicName --endpoint-type webhook --endpoint "<webhook URL>" --included-event-types IncludedEventTypes

 # Azure Function

 az eventgrid system-topic event-subscription create –name "<Event subscription name>" --resource-group $ResourceGroupName --system-topic-name $SystemTopicName --endpoint-type azurefunction --endpoint "<Azure Function ResourceId>" --included-event-types IncludedEventTypes

Create a maintenance configuration by following the steps listed here.

# System topic creation Learn more

PUT /subscriptions/<subscription Id>/resourceGroups/<resource group name>/providers/Microsoft.EventGrid/systemTopics/<system topic name>?api-version=2022-06-15

Request Body:

{
  "properties": {
    "source": "/subscriptions/<subscription Id>/resourceGroups/<resource group>/providers/Microsoft.Maintenance/maintenanceConfigurations/<maintenance configuration name> ",
    "topicType": "Microsoft.Maintenance.MaintenanceConfigurations"
  },
  "location": "<location>"
}

# Event subscription creation Learn more

Allowed Event types - Microsoft.Maintenance.PreMaintenanceEvent, Microsoft.Maintenance.PostMaintenanceEvent

Webhook

PUT /subscriptions/<subscription Id>/resourceGroups/<resource group name>/providers/Microsoft.EventGrid/systemTopics/<system topic name>/eventSubscriptions/<Event Subscription name>?api-version=2022-06-15

Request Body:

{
  "properties": {
    "destination": {
      "endpointType": "WebHook",
      "properties": {
        "endpointUrl": "<Webhook URL>"
      }
    },
    "filter": {
      "includedEventTypes": [
        "Microsoft.Maintenance.PreMaintenanceEvent"
      ]
    }
  }
}

Azure Function

PUT /subscriptions/<subscription Id>/resourceGroups/<resource group name>/providers/Microsoft.EventGrid/systemTopics/<system topic name>/eventSubscriptions/<Event Subscription name>?api-version=2022-06-15

Request Body

{
    "properties": {
        "destination": {
            "endpointType": "AzureFunction",
            "properties": {
                "resourceId": "<Azure Function Resource Id>"
            }
        }
    },
    "filter": {
        "includedEventTypes": [
            "Microsoft.Maintenance.PostMaintenanceEvent"
        ]
    }
}

Create pre and post events on an existing schedule maintenance configuration

Sign in to the Azure portal and go to Azure Update Manager.
Under Manage, select Machines, Maintenance Configurations.
In the Maintenance Configuration page, select the maintenance configuration to which you want to add a pre and post event.
In the selected Maintenance configuration page, under Settings, select Events. Alternatively, under the Overview, select the card Create a maintenance event.
Select +Event Subscription to create Pre/Post Maintenance Event.
On the Create Event Subscription page, enter the following details:
- In the Event Subscription Details section, provide an appropriate name.
- Keep the schema as Event Grid Schema.
- In the Topic Details section, provide an appropriate name to the System Topic Name.
- In the Event Types section, Filter to Event Types, select the event types that you want to get pushed to the endpoint or destination. You can select between Pre Maintenance Event and Post Maintenance Event.
- In the Endpoint details section, select the endpoint from where you want to receive the response from.
Select Create to configure the pre and post events on an existing schedule.

    $MaintenanceConfigurationResourceId = "/subscriptions/<subId>/resourceGroups/<Resource group>/providers/Microsoft.Maintenance/maintenanceConfigurations/<Maintenance configuration Name>"

    $ResourceGroupForSystemTopic = "<Resource Group for System Topic>"

    $SystemTopicName = "<System topic name>"

    $TopicType = "Microsoft.Maintenance.MaintenanceConfigurations"

    $SystemTopicLocation = "<System topic location>"

    # System topic creation

    New-AzEventGridSystemTopic -ResourceGroupName $ResourceGroupForSystemTopic -Name $SystemTopicName -Source $MaintenanceConfigurationResourceId -TopicType $TopicType -Location $SystemTopicLocation

    # Event subscription creation

    $IncludedEventTypes = @("Microsoft.Maintenance.PreMaintenanceEvent")

    # Webhook

    $EventSubscriptionName = "PreEventWebhook"

    $PreEventWebhookEndpoint = "<Webhook URL>"

    New-AzEventGridSystemTopicEventSubscription -ResourceGroupName $ResourceGroupForSystemTopic -SystemTopicName $SystemTopicName -EventSubscriptionName $EventSubscriptionName -Endpoint $PreEventWebhookEndpoint -IncludedEventType $IncludedEventTypes

    # Azure Function

    $dest = New-AzEventGridAzureFunctionEventSubscriptionDestinationObject -ResourceId "<Azure Function Resource Id>"

    New-AzEventGridSystemTopicEventSubscription -ResourceGroupName $ResourceGroupForSystemTopic -SystemTopicName $SystemTopicName -EventSubscriptionName $EventSubscriptionName -Destination $dest -IncludedEventType $IncludedEventTypes


   SystemTopicName="<System topic name> 

   ResourceGroupName="<Resource Group for System Topic>"

   Source="/subscriptions/<subId>/resourceGroups/<Resource group>/providers/Microsoft.Maintenance/maintenanceConfigurations/<Maintenance configuration Name>"

    TopicType="Microsoft.Maintenance.MaintenanceConfigurations"

    Location="<System topic location> "

   # System topic creation

    az eventgrid system-topic create --name $SystemTopicName --resource-group $ResourceGroupName --source $Source --topic-type $TopicType --location $Location

   # Event subscription creation

    IncludedEventTypes='("Microsoft.Maintenance.PreMaintenanceEvent")'

   # Webhook

    az eventgrid system-topic event-subscription create --name "<Event subscription name>" --resource-group $ResourceGroupName --system-topic-name $SystemTopicName --endpoint-type webhook --endpoint "<webhook URL>" --included-event-types IncludedEventTypes

   # Azure Function

    az eventgrid system-topic event-subscription create –name "<Event subscription name>" --resource-group $ResourceGroupName --system-topic-name $SystemTopicName --endpoint-type azurefunction --endpoint "<Azure Function ResourceId>" --included-event-types IncludedEventTypes

# System topic creation Learn more

PUT /subscriptions/<subscription Id>/resourceGroups/<resource group name>/providers/Microsoft.EventGrid/systemTopics/<system topic name>?api-version=2022-06-15

Request Body:

{
  "properties": {
    "source": "/subscriptions/<subscription Id>/resourceGroups/<resource group>/providers/Microsoft.Maintenance/maintenanceConfigurations/<maintenance configuration name> ",
    "topicType": "Microsoft.Maintenance.MaintenanceConfigurations"
  },
  "location": "<location>"
}

# Event subscription creation Learn more

Allowed Event types - Microsoft.Maintenance.PreMaintenanceEvent, Microsoft.Maintenance.PostMaintenanceEvent

Webhook

PUT /subscriptions/<subscription Id>/resourceGroups/<resource group name>/providers/Microsoft.EventGrid/systemTopics/<system topic name>/eventSubscriptions/<Event Subscription name>?api-version=2022-06-15

Request Body:

{
  "properties": {
    "destination": {
      "endpointType": "WebHook",
      "properties": {
        "endpointUrl": "<Webhook URL>"
      }
    },
    "filter": {
      "includedEventTypes": [
        "Microsoft.Maintenance.PreMaintenanceEvent"
      ]
    }
  }
}

Azure Function

PUT /subscriptions/<subscription Id>/resourceGroups/<resource group name>/providers/Microsoft.EventGrid/systemTopics/<system topic name>/eventSubscriptions/<Event Subscription name>?api-version=2022-06-15

Request Body

{
    "properties": {
        "destination": {
            "endpointType": "AzureFunction",
            "properties": {
                "resourceId": "<Azure Function Resource Id>"
            }
        }
    },
    "filter": {
        "includedEventTypes": [
            "Microsoft.Maintenance.PostMaintenanceEvent"
        ]
    }
}

Next steps

For an overview of pre and post events in Azure Update Manager, refer here.
To learn on how to manage pre and post events or to cancel a schedule run, see pre and post maintenance configuration events.
To learn how to use pre and post events to turn on and off your VMs using Webhooks, refer here.
To learn how to use pre and post events to turn on and off your VMs using Azure Functions, refer here.

Create pre and post events

Event Grid in schedule maintenance configurations

Create a pre and post event

Create pre and post events while creating a new schedule maintenance configuration

Create pre and post events on an existing schedule maintenance configuration

Next steps

Additional resources