Skip to content

Commit d81a4a2

Browse files
committed
freshness updates
1 parent f0c9d0d commit d81a4a2

File tree

2 files changed

+20
-20
lines changed

2 files changed

+20
-20
lines changed

articles/azure-monitor/autoscale/autoscale-webhook-email.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Learn how to use autoscale actions to call web URLs or send email n
44
author: EdB-MSFT
55
ms.author: edbaynash
66
ms.topic: conceptual
7-
ms.date: 06/21/2023
7+
ms.date: 08/25/2024
88
ms.subservice: autoscale
99
ms.reviewer: akkumari
1010
---
@@ -15,7 +15,11 @@ This article shows you how to set up notifications so that you can call specific
1515
Webhooks allow you to send HTTP requests to a specific URL endpoint (callback URL) when a certain event or trigger occurs. Using webhooks, you can automate and streamline processes by enabling the automatic exchange of information between different systems or applications. Use webhooks to trigger custom code, notifications, or other actions to run when an autoscale event occurs.
1616

1717
## Email
18-
You can send email to any valid email address when an autoscale event occurs. Administrators and co-administrators of the subscription where the rule is running are also notified.
18+
You can send email to any valid email address when an autoscale event occurs.
19+
20+
> [!NOTE]
21+
> Starting April 3, 2024, you won't be able to add any new Co-Administrators for Azure Autoscale Notifications. Azure Classic administrators will be retired on August 31, 2024, and you would not be able to send Azure Autoscale Notifications using Administrators and Co-Administrators after August 31, 2024. For moe information, see [Prepare for Co-administrators retirement](/azure/role-based-access-control/classic-administrators?WT.mc_id=Portal-Microsoft_Azure_Monitoring&tabs=azure-portal#prepare-for-co-administrators-retirement)
22+
1923

2024
## Configure Notifications
2125

@@ -27,7 +31,7 @@ Use the Azure portal, CLI, PowerShell, or Resource Manager templates to configur
2731

2832
Select the **Notify** tab on the autoscale settings page to configure notifications.
2933

30-
Select the check boxes to send an email to the subscription administrator or co-administrators. You can also enter a list of email addresses to send notifications to.
34+
Enter a list of email addresses to send notifications to.
3135

3236
Enter a webhook URI to send a notification to a web service. You can also add custom headers to the webhook request. For example, you can add an authentication token in the header, query parameters, or add a custom header to identify the source of the request.
3337

@@ -42,19 +46,16 @@ Use the `az monitor autoscale update` or the `az monitor autoscale create` comma
4246

4347
The following parameters are used to configure notifications:
4448

45-
+ `--add-action` - The action to take when the autoscale rule is triggered. The value must be `email` or `webhook`.
46-
+ `--email-administrator {false, true}` - Send email to the subscription administrator.
47-
+ `--email-coadministrators {false, true}` - Send email to the subscription co-administrators.
49+
+ `--add-action` - The action to take when the autoscale rule is triggered. The value must be `email` or `webhook`, and followed by the email address or webhook URI.
4850
+ `--remove-action` - Remove an action previously added by `--add-action`. The value must be `email` or `webhook`. The parameter is only relevant for the `az monitor autoscale update` command.
4951

5052

51-
For example, the following command adds an email notification and a webhook notification to and existing autoscale setting. The command also sends email to the subscription administrator.
53+
For example, the following command adds an email notification and a webhook notification to and existing autoscale setting.
5254

5355
```azurecli
5456
az monitor autoscale update \
5557
--resource-group <resource group name> \
5658
--name <autoscale setting name> \
57-
--email-administrator true \
5859
--add-action email [email protected] \
5960
--add-action webhook http://myservice.com/webhook-listerner-123
6061
```
@@ -87,7 +88,6 @@ The following example shows how to configure a webhook and email notification.
8788
8889
$notification=New-AzAutoscaleNotificationObject `
8990
-EmailCustomEmail "[email protected]" `
90-
-EmailSendToSubscriptionAdministrator $true ` -EmailSendToSubscriptionCoAdministrator $true `
9191
-Webhook $webhook
9292
9393
@@ -134,13 +134,13 @@ When you use the Resource Manager templates or REST API, include the `notificati
134134

135135
| Field | Mandatory | Description |
136136
| --- | --- | --- |
137-
| operation |Yes |Value must be "Scale." |
138-
| sendToSubscriptionAdministrator |Yes |Value must be "true" or "false." |
139-
| sendToSubscriptionCoAdministrators |Yes |Value must be "true" or "false." |
140-
| customEmails |Yes |Value can be null [] or a string array of emails. |
141-
| webhooks |Yes |Value can be null or valid URI. |
142-
| serviceUri |Yes |Valid HTTPS URI. |
143-
| properties |Yes |Value must be empty {} or can contain key-value pairs. |
137+
| `operation` |Yes |Value must be `Scale`. |
138+
| `sendToSubscriptionAdministrator` |Yes |No longer supported. Value must be `false`. |
139+
| `sendToSubscriptionCoAdministrators` |Yes |No longer supported. Value must be `false`.|
140+
| `customEmails` |Yes |Value can be null [] or a string array of emails. |
141+
| `webhooks` |Yes |Value can be null or valid URI. |
142+
| `serviceUri` |Yes |Valid HTTPS URI. |
143+
| `properties` |Yes |Value must be empty {} or can contain key-value pairs. |
144144

145145
---
146146

@@ -157,15 +157,15 @@ When the autoscale notification is generated, the following metadata is included
157157
"operation": "Scale Out",
158158
"context": {
159159
"timestamp": "2023-06-22T07:01:47.8926726Z",
160-
"id": "/subscriptions/123456ab-9876-a1b2-a2b1-123a567b9f8767/resourceGroups/rg-001/providers/microsoft.insights/autoscalesettings/AutoscaleSettings-002",
160+
"id": "/subscriptions/0000aaaa-11BB-cccc-dd22-eeeeee333333/resourceGroups/rg-001/providers/microsoft.insights/autoscalesettings/AutoscaleSettings-002",
161161
"name": "AutoscaleSettings-002",
162162
"details": "Autoscale successfully started scale operation for resource 'ScaleableAppServicePlan' from capacity '1' to capacity '2'",
163-
"subscriptionId": "123456ab-9876-a1b2-a2b1-123a567b9f8767",
163+
"subscriptionId": "0000aaaa-11BB-cccc-dd22-eeeeee333333",
164164
"resourceGroupName": "rg-001",
165165
"resourceName": "ScaleableAppServicePlan",
166166
"resourceType": "microsoft.web/serverfarms",
167-
"resourceId": "/subscriptions/123456ab-9876-a1b2-a2b1-123a567b9f8767/resourceGroups/rg-001/providers/Microsoft.Web/serverfarms/ScaleableAppServicePlan",
168-
"portalLink": "https://portal.azure.com/#resource/subscriptions/123456ab-9876-a1b2-a2b1-123a567b9f8767/resourceGroups/rg-001/providers/Microsoft.Web/serverfarms/ScaleableAppServicePlan",
167+
"resourceId": "/subscriptions/0000aaaa-11BB-cccc-dd22-eeeeee333333/resourceGroups/rg-001/providers/Microsoft.Web/serverfarms/ScaleableAppServicePlan",
168+
"portalLink": "https://portal.azure.com/#resource/subscriptions/0000aaaa-11BB-cccc-dd22-eeeeee333333/resourceGroups/rg-001/providers/Microsoft.Web/serverfarms/ScaleableAppServicePlan",
169169
"resourceRegion": "West Central US",
170170
"oldCapacity": "1",
171171
"newCapacity": "2"
21.6 KB
Loading

0 commit comments

Comments
 (0)