Skip to content

Commit 347ad63

Browse files
Merge pull request #186165 from ishasahni1/patch-22
Added Non-common schema file
2 parents 3a2bbd2 + 035b92f commit 347ad63

File tree

3 files changed

+417
-23
lines changed

3 files changed

+417
-23
lines changed

articles/azure-monitor/alerts/action-groups.md

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Each action is made up of the following properties:
2020

2121
For information on how to use Azure Resource Manager templates to configure action groups, see [Action group Resource Manager templates](./action-groups-create-resource-manager-template.md).
2222

23-
Action Group is **Global** service, therefore there is no dependency on a specific Azure region. Requests from client can be processed by action group service in any region, which means, if one region of service is down, the traffic will be routed and process by other regions automatically. Being a *global service* it helps client not to worry about **disaster recovery**.
23+
Action Group is **Global** service, therefore there's no dependency on a specific Azure region. Requests from client can be processed by action group service in any region, which means, if one region of service is down, the traffic will be routed and process by other regions automatically. Being a *global service* it helps client not to worry about **disaster recovery**.
2424

2525
## Create an action group by using the Azure portal
2626

@@ -77,7 +77,7 @@ Under **Instance details**:
7777

7878
b. **Name**: Enter a unique name for the action.
7979

80-
c. **Details**: Based on the action type, enter a webhook URI, Azure app, ITSM connection, or Automation runbook. For ITSM Action, additionally specify **Work Item** and other fields your ITSM tool requires.
80+
c. **Details**: Based on the action type, enter a webhook URI, Azure app, ITSM connection, or Automation Runbook. For ITSM Action, additionally specify **Work Item** and other fields your ITSM tool requires.
8181

8282
d. **Common alert schema**: You can choose to enable the [common alert schema](./alerts-common-schema.md), which provides the advantage of having a single extensible and unified alert payload across all the alert services in Azure Monitor.
8383

@@ -106,22 +106,23 @@ When creating or updating an action group in the Azure portal, you can **test**
106106

107107
![Select Sample Type + notification + action type](./media/action-groups/test-sample-action-group.png)
108108

109-
1. If you close the window or select **Back to test setup** while the test is running, the test is stopped, and you will not get test results.
109+
1. If you close the window or select **Back to test setup** while the test is running, the test is stopped, and you won't get test results.
110110

111111
![Stop running test](./media/action-groups/stop-running-test.png)
112112

113113
1. When the test is complete either a **Success** or **Failed** test status is displayed. If the test failed, you could select *View details* to get more information.
114114
![Test sample failed](./media/action-groups/test-sample-failed.png)
115115

116116
You can use the information in the **Error details section**, to understand the issue so that you can edit and test the action group again.
117-
To allow you to check the action groups are working as expected before you enable them in a production environment, you will get email and SMS alerts with the subject: Test.
117+
To allow you to check the action groups are working as expected before you enable them in a production environment, you'll get email and SMS alerts with the subject: Test.
118118

119119
All the details and links in Test email notifications for the alerts fired are a sample set for reference.
120120

121121
> [!NOTE]
122122
> You may have a limited number of actions in a test Action Group. See the [rate limiting information](./alerts-rate-limiting.md) article.
123123
>
124124
> You can opt in or opt out to the common alert schema through Action Groups, on the portal. You can [find common schema samples for test action groups for all the sample types](./alerts-common-schema-test-action-definitions.md).
125+
> You can opt in or opt out to the non-common alert schema through Action Groups, on the portal. You can [find non-common schema alert definitions](./alerts-non-common-schema-definitions.md).
125126
126127
## Manage your action groups
127128

@@ -130,7 +131,7 @@ After you create an action group, you can view **Action groups** by selecting **
130131
* Add, edit, or remove actions.
131132
* Delete the action group.
132133

133-
## Action specific information
134+
## Action-specific information
134135

135136
> [!NOTE]
136137
> See [Subscription Service Limits for Monitoring](../../azure-resource-manager/management/azure-subscription-service-limits.md#azure-monitor-limits) for numeric limits on each of the items below.
@@ -154,25 +155,25 @@ Emails will be sent from the following email addresses. Ensure that your email f
154155
You may have a limited number of email actions in an Action Group. See the [rate limiting information](./alerts-rate-limiting.md) article.
155156

156157
### Email Azure Resource Manager Role
157-
Send email to the members of the subscription's role. Email will only be sent to **Azure AD user** members of the role. Email will not be sent to Azure AD groups or service principals.
158+
Send email to the members of the subscription's role. Email will only be sent to **Azure AD user** members of the role. Email won't be sent to Azure AD groups or service principals.
158159

159160
A notification email is sent only to the *primary email* address.
160161

161-
If you are not receiving Notifications on your *primary email*, then you can try following steps:
162+
If you aren't receiving Notifications on your *primary email*, then you can try following steps:
162163

163-
1. In Azure portal go to *Active Directory*.
164+
1. In Azure portal, go to *Active Directory*.
164165
2. Click on All users (in left pane), you will see list of users (in right pane).
165166
3. Select the user for which you want to review the *primary email* information.
166167

167-
:::image type="content" source="media/action-groups/active-directory-user-profile.png" alt-text="Example on how to review user profile." border="true":::
168+
:::image type="content" source="media/action-groups/active-directory-user-profile.png" alt-text="Example of how to review user profile." border="true":::
168169

169170
4. In User profile under Contact Info if "Email" tab is blank then click on *edit* button on the top and add your *primary email* and hit *save* button on the top.
170171

171-
:::image type="content" source="media/action-groups/active-directory-add-primary-email.png" alt-text="Example on how to add primary email." border="true":::
172+
:::image type="content" source="media/action-groups/active-directory-add-primary-email.png" alt-text="Example of how to add primary email." border="true":::
172173

173174
You may have a limited number of email actions in an Action Group. See the [rate limiting information](./alerts-rate-limiting.md) article.
174175

175-
While setting up *Email ARM Role* you need to make sure below 3 conditions are met:
176+
While setting up *Email ARM Role*, you need to make sure below three conditions are met:
176177

177178
1. The type of the entity being assigned to the role needs to be **“User”**.
178179
2. The assignment needs to be done at the **subscription** level.
@@ -190,7 +191,7 @@ An event hub action publishes notifications to [Azure Event Hubs](~/articles/eve
190191
### Function
191192
Calls an existing HTTP trigger endpoint in [Azure Functions](../../azure-functions/functions-get-started.md). To handle a request, your endpoint must handle the HTTP POST verb.
192193

193-
When defining the Function action the the Function's httptrigger endpoint and access key are saved in the action definition. For example: `https://azfunctionurl.azurewebsites.net/api/httptrigger?code=this_is_access_key`. If you change the access key for the function you will need to remove and recreate the Function action in the Action Group.
194+
When defining the Function action the Function's httptrigger endpoint and access key are saved in the action definition. For example: `https://azfunctionurl.azurewebsites.net/api/httptrigger?code=this_is_access_key`. If you change the access key for the function, you will need to remove and recreate the Function action in the Action Group.
194195

195196
You may have a limited number of Function actions in an Action Group.
196197

@@ -211,7 +212,7 @@ The Action Groups Secure Webhook action enables you to take advantage of Azure A
211212
1. Create an Azure AD Application for your protected web API. See [Protected web API: App registration](../../active-directory/develop/scenario-protected-web-api-app-registration.md).
212213
- Configure your protected API to be [called by a daemon app](../../active-directory/develop/scenario-protected-web-api-app-registration.md#if-your-web-api-is-called-by-a-daemon-app).
213214

214-
2. Enable Action Groups to use your Azure AD Application.
215+
2. Enable Action Group to use your Azure AD Application.
215216

216217
> [!NOTE]
217218
> You must be a member of the [Azure AD Application Administrator role](../../active-directory/roles/permissions-reference.md#all-roles) to execute this script.
@@ -236,7 +237,7 @@ Connect-AzureAD -TenantId "<provide your Azure AD tenant ID here>"
236237
# This is your Azure AD Application's ObjectId.
237238
$myAzureADApplicationObjectId = "<the Object ID of your Azure AD Application>"
238239
239-
# This is the Action Groups Azure AD AppId
240+
# This is the Action Group Azure AD AppId
240241
$actionGroupsAppId = "461e8683-5575-4561-ac7f-899cc907d62a"
241242
242243
# This is the name of the new role we will add to your Azure AD Application
@@ -267,14 +268,14 @@ Write-Host $myAppRoles
267268
# Create the role if it doesn't exist
268269
if ($myAppRoles -match "ActionGroupsSecureWebhook")
269270
{
270-
Write-Host "The Action Groups role is already defined.`n"
271+
Write-Host "The Action Group role is already defined.`n"
271272
}
272273
else
273274
{
274275
$myServicePrincipal = Get-AzureADServicePrincipal -Filter ("appId eq '" + $myApp.AppId + "'")
275276
276277
# Add our new role to the Azure AD Application
277-
$newRole = CreateAppRole -Name $actionGroupRoleName -Description "This is a role for Action Groups to join"
278+
$newRole = CreateAppRole -Name $actionGroupRoleName -Description "This is a role for Action Group to join"
278279
$myAppRoles.Add($newRole)
279280
Set-AzureADApplication -ObjectId $myApp.ObjectId -AppRoles $myAppRoles
280281
}
@@ -286,7 +287,7 @@ if ($actionGroupsSP -match "AzNS AAD Webhook")
286287
}
287288
else
288289
{
289-
# Create a service principal for the Action Groups Azure AD Application and add it to the role
290+
# Create a service principal for the Action Group Azure AD Application and add it to the role
290291
$actionGroupsSP = New-AzureADServicePrincipal -AppId $actionGroupsAppId
291292
}
292293
@@ -303,7 +304,7 @@ See the [rate limiting information](./alerts-rate-limiting.md) and [SMS alert be
303304
You may have a limited number of SMS actions in an Action Group.
304305

305306
> [!NOTE]
306-
> If the Azure portal action group user interface does not let you select your country/region code, then SMS is not supported for your country/region. If your country/region code is not available, you can vote to have your country/region added at [user voice](https://feedback.azure.com/d365community/idea/e527eaa6-2025-ec11-b6e6-000d3a4f09d0). In the meantime, a work around is to have your action group call a webhook to a third-party SMS provider with support in your country/region.
307+
> If the Azure portal Action Group user interface does not let you select your country/region code, then SMS is not supported for your country/region. If your country/region code is not available, you can vote to have your country/region added at [user voice](https://feedback.azure.com/d365community/idea/e527eaa6-2025-ec11-b6e6-000d3a4f09d0). In the meantime, a work around is to have your Action Group call a webhook to a third-party SMS provider with support in your country/region.
307308
308309
Pricing for supported countries/regions is listed in the [Azure Monitor pricing page](https://azure.microsoft.com/pricing/details/monitor/).
309310

@@ -356,8 +357,8 @@ See the [rate limiting information](./alerts-rate-limiting.md) article for addit
356357
You may have a limited number of Voice actions in an Action Group.
357358

358359
> [!NOTE]
359-
> If the Azure portal action group user interface does not let you select your country/region code, then voice calls are not supported for your country/region. If your country/region code is not available, you can vote to have your country/region added at [user voice](https://feedback.azure.com/d365community/idea/e527eaa6-2025-ec11-b6e6-000d3a4f09d0). In the meantime, a work around is to have your action group call a webhook to a third-party voice call provider with support in your country/region.
360-
> Only Country code supported today in Azure portal action group for Voice Notification is +1(United States).
360+
> If the Azure portal Action Group user interface does not let you select your country/region code, then voice calls are not supported for your country/region. If your country/region code is not available, you can vote to have your country/region added at [user voice](https://feedback.azure.com/d365community/idea/e527eaa6-2025-ec11-b6e6-000d3a4f09d0). In the meantime, a work around is to have your Action Group call a webhook to a third-party voice call provider with support in your country/region.
361+
> Only Country code supported today in Azure portal Action Group for Voice Notification is +1(United States).
361362
362363
Pricing for supported countries/regions is listed in the [Azure Monitor pricing page](https://azure.microsoft.com/pricing/details/monitor/).
363364

@@ -368,11 +369,11 @@ Pricing for supported countries/regions is listed in the [Azure Monitor pricing
368369
> If the webhook endpoint can't handle the alert context information on its own, you can use a solution like a [Logic App action](./action-groups-logic-app.md) for a custom manipulation of the alert context information to match the webhook's expected data format.
369370
370371
Webhooks are processed using the following rules
371-
- A webhook call is attempted a maximum of 3 times.
372+
- A webhook call is attempted a maximum of three times.
372373
- The call will be retried if a response is not received within the timeout period or one of the following HTTP status codes is returned: 408, 429, 503 or 504.
373374
- The first call will wait 10 seconds for a response.
374375
- The second and third attempts will wait 30 seconds for a response.
375-
- After the 3 attempts to call the webhook have failed no action group will call the endpoint for 15 minutes.
376+
- After the three attempts to call the webhook have failed no Action Group will call the endpoint for 15 minutes.
376377

377378
Please see [Action Group IP Addresses](../app/ip-addresses.md) for source IP address ranges.
378379

0 commit comments

Comments
 (0)