Skip to content

Latest commit

 

History

History
128 lines (86 loc) · 9.01 KB

advance-notifications.md

File metadata and controls

128 lines (86 loc) · 9.01 KB
title description author ms.author ms.reviewer ms.date ms.service ms.subservice ms.topic monikerRange
Advance notifications (Preview) for planned maintenance events
Get notification before planned maintenance for Azure SQL Database.
scott-kim-sql
scottkim
wiassaf, mathoma, urosmil
12/01/2022
sql-db-mi
service-overview
how-to
= azuresql || = azuresql-db || = azuresql-mi

Advance notifications for planned maintenance events (Preview)

[!INCLUDEappliesto-sqldb-sqlmi]

Advance notifications (Preview) are available for databases configured to use a non-default maintenance window and managed instances with any configuration (including the default one). Advance notifications enable customers to configure notifications to be sent up to 24 hours in advance of any planned event.

Notifications can be configured so you can get texts, emails, Azure push notifications, and voicemails when planned maintenance is due to begin in the next 24 hours. Additional notifications are sent when maintenance begins and when maintenance ends.

Important

For Azure SQL Database, advance notifications cannot be configured for the System default maintenance window option. Choose a maintenance window other than the System default to configure and enable Advance notifications.

Note

While maintenance windows are generally available, advance notifications for maintenance windows are in public preview for Azure SQL Database and Azure SQL Managed Instance.

Configure an advance notification

Advance notifications are available for Azure SQL databases that have their maintenance window configured and managed instances with any configuration (including the default one).

Complete the following steps to enable a notification.

  1. Go to the Planned maintenance page, select Health alerts, then Add service health alert.

    :::image type="content" source="media/advance-notifications/health-alerts.png" alt-text="create a new health alert menu option":::

  2. In the Scope section, select subscription.

    :::image type="content" source="media/advance-notifications/select-subscription.png" alt-text="A screenshot of the Azure portal page where you select the subscription where you will be configuring the health alert.":::

  3. In the Condition section, configure service(s) to be alerted for, region(s) and criteria. For more generic alert, select all values. To narrow down, select Azure SQL Database or Azure SQL Managed Instance as a service, region(s) where you have those services deployed, and Planned maintenance for the event type.

    :::image type="content" source="media/advance-notifications/define-condition-services.png" alt-text="A screenshot of the Azure portal page where you define conditions for the health alert and define services to be notified for.":::

    :::image type="content" source="media/advance-notifications/define-condition-regions.png" alt-text="A screenshot of the Azure portal page where you define conditions for the health alert and define regions to be notified for.":::

    :::image type="content" source="media/advance-notifications/define-condition-event-types.png" alt-text="A screenshot of the Azure portal page where you define conditions for the health alert and define event types to be notified for.":::

Important

Service health is rolling out new experiencs in phases. Some users will see the updated experience, others will still see the classic Service Health portal experience. In case that you still see the classic Service Health portal, for Region don't select Global as an option, but rather the specific region or all regions.

  1. In the Actions section, select the existing action group or create a new one.

    :::image type="content" source="media/advance-notifications/add-action-group.png" alt-text="A screenshot of the Azure portal page where you add or create action groups.":::

  2. In the Details section, define the name for your alert and specify resource group where it should be deployed.

    :::image type="content" source="media/advance-notifications/define-alert-details.png" alt-text="A screenshot of the Azure portal page where you define alert details.":::

  3. Select Review + create and your alert will be created.

You're all set. Next time there's a planned Azure SQL maintenance event, you'll receive an advance notification.

To learn more about creating health alerts, visit Azure Service Health

Receiving notifications

The following table shows the general-information notifications you may receive:

Status Description
Planned Received 24 hours prior to the maintenance event. Maintenance is planned on DATE between 5pm - 8am1 (local time) in region xyz.
InProgress Maintenance for database(s) in region xyz is starting.
Complete Maintenance of database(s) in region xyz is complete.

1 Start and end time depend on the selected maintenance window.

The following table shows additional notifications that may be sent while maintenance is ongoing:

Status Description
Rescheduled 1) Maintenance is in progress but didn't complete inside maintenance window. 2) there was a problem during maintenance and it could not start. 3) Planned maintenance has started but couldn't progress to the end and will continue in next maintenance window.
Canceled Maintenance for database(s) in region xyz is canceled and will be rescheduled for later.

Permissions

While Advance Notifications can be sent to any email address, Azure subscription RBAC (role-based access control) policy determines who can access the links in the email. Querying resource graph is covered by Azure RBAC access management. To enable read access, each recipient should have resource group level read access. For more information, see Steps to assign an Azure role.

Retrieve the list of impacted resources

Azure Resource Graph is an Azure service designed to extend Azure Resource Management. The Azure Resource Graph Explorer provides efficient and performant resource exploration with the ability to query at scale across a given set of subscriptions so that you can effectively govern your environment.

You can use the Azure Resource Graph Explorer to query for maintenance events. For an introduction on how to run these queries, see Quickstart: Run your first Resource Graph query using Azure Resource Graph Explorer.

When the advanced notification for planned maintenance is received, you will get a link that opens Azure Resource Graph and executes the query for the exact event, similar to the following. Note that the notificationId value is unique per maintenance event.

resources
| project resource = tolower(id)
| join kind=inner (
    maintenanceresources
    | where type == "microsoft.maintenance/updates"
    | extend p = parse_json(properties)
    | mvexpand d = p.value
    | where d has 'notificationId' and d.notificationId == 'LNPN-R9Z'
    | project resource = tolower(name), status = d.status, resourceGroup, location, startTimeUtc = d.startTimeUtc, endTimeUtc = d.endTimeUtc, impactType = d.impactType
) on resource
| project resource, status, resourceGroup, location, startTimeUtc, endTimeUtc, impactType

In Azure Resource Graph (ARG) explorer you might find values for the status of deployment that are bit different than the ones displayed in the notification content.

Status Description
Pending 1) Maintenance is planned on upcoming date. 2) Previously planned maintenance was rescheduled and is waiting to start in the next window. 3) Maintenance started but didn't complete in previous window and will continue in the next one.
InProgress Maintenance for resource xyz is starting or is in progress.
Completed Maintenance for resource xyz is complete.
NoUpdatesPending Previously planned maintenance for resource xyz is canceled and will be rescheduled for later.
RetryLater Planned maintenance for resource xyz has started but couldn't progress to the end and will continue in next maintenance window.

For the full reference of the sample queries and how to use them across tools like PowerShell or Azure CLI, visit Azure Resource Graph sample queries for Azure Service Health.

Next steps