Action Groups - Create Notifications At Action Group Resource Level
將測試通知傳送至一組提供的接收者
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/actionGroups/{actionGroupName}/createNotifications?api-version=2021-09-01
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
action
|
path | True |
string |
動作群組的名稱。 |
resource
|
path | True |
string |
資源群組的名稱。 名稱不區分大小寫。 |
subscription
|
path | True |
string |
目標訂用帳戶的標識碼。 |
api-version
|
query | True |
string |
用於此作業的 API 版本。 |
要求本文
名稱 | 必要 | 類型 | Description |
---|---|---|---|
alertType | True |
string |
支援的警示類型值。 支援的警示類型值包括:servicehealth、metricstaticthreshold、metricsdynamicthreshold、logalertv2、smartalert、webtestalert、logalertv1numresult、logalertv1metricmeasurement、resourcehealth、activitylog、actualcostbudget、forecastedbudget |
armRoleReceivers |
屬於此動作群組一部分的ARM角色接收者清單。 角色是 Azure RBAC 角色,且僅支持內建角色。 |
||
automationRunbookReceivers |
屬於此動作群組一部分的 AutomationRunbook 接收者清單。 |
||
azureAppPushReceivers |
屬於此動作群組一部分的 AzureAppPush 接收者清單。 |
||
azureFunctionReceivers |
屬於此動作群組一部分的 azure 函式接收者清單。 |
||
emailReceivers |
屬於此動作群組一部分的電子郵件接收者清單。 |
||
eventHubReceivers |
屬於此動作群組一部分的事件中樞接收者清單。 |
||
itsmReceivers |
屬於此動作群組一部分的 ITSM 接收者清單。 |
||
logicAppReceivers |
屬於此動作群組一部分的邏輯應用程式接收者清單。 |
||
smsReceivers |
屬於此動作群組一部分的SMS接收者清單。 |
||
voiceReceivers |
屬於此動作群組一部分的語音接收器清單。 |
||
webhookReceivers |
屬於此動作群組一部分的 Webhook 接收者清單。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
通知成功 |
|
202 Accepted |
已接受通知要求 標題 location: string |
|
Other Status Codes |
傳送測試通知時發生錯誤 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow
類型:
oauth2
Flow:
implicit
授權 URL:
https://login.microsoftonline.com/common/oauth2/authorize
範圍
名稱 | Description |
---|---|
user_impersonation | 模擬您的用戶帳戶 |
範例
Create notifications at resource group level
範例要求
POST https://management.azure.com/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/TestRgName/providers/Microsoft.Insights/actionGroups/TestAgName/createNotifications?api-version=2021-09-01
{
"alertType": "budget",
"emailReceivers": [
{
"name": "John Doe's email",
"emailAddress": "johndoe@email.com",
"useCommonAlertSchema": false
},
{
"name": "Jane Smith's email",
"emailAddress": "janesmith@email.com",
"useCommonAlertSchema": true
}
],
"smsReceivers": [
{
"name": "John Doe's mobile",
"countryCode": "1",
"phoneNumber": "1234567890"
},
{
"name": "Jane Smith's mobile",
"countryCode": "1",
"phoneNumber": "0987654321"
}
],
"webhookReceivers": [
{
"name": "Sample webhook 1",
"serviceUri": "http://www.example.com/webhook1",
"useCommonAlertSchema": true
},
{
"name": "Sample webhook 2",
"serviceUri": "http://www.example.com/webhook2",
"useCommonAlertSchema": true,
"useAadAuth": true,
"objectId": "d3bb868c-fe44-452c-aa26-769a6538c808",
"identifierUri": "http://someidentifier/d7811ba3-7996-4a93-99b6-6b2f3f355f8a",
"tenantId": "68a4459a-ccb8-493c-b9da-dd30457d1b84"
}
],
"itsmReceivers": [
{
"name": "Sample itsm",
"workspaceId": "5def922a-3ed4-49c1-b9fd-05ec533819a3|55dfd1f8-7e59-4f89-bf56-4c82f5ace23c",
"connectionId": "a3b9076c-ce8e-434e-85b4-aff10cb3c8f1",
"ticketConfiguration": "{\"PayloadRevision\":0,\"WorkItemType\":\"Incident\",\"UseTemplate\":false,\"WorkItemData\":\"{}\",\"CreateOneWIPerCI\":false}",
"region": "westcentralus"
}
],
"azureAppPushReceivers": [
{
"name": "Sample azureAppPush",
"emailAddress": "johndoe@email.com"
}
],
"automationRunbookReceivers": [
{
"automationAccountId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/runbookTest/providers/Microsoft.Automation/automationAccounts/runbooktest",
"runbookName": "Sample runbook",
"webhookResourceId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/runbookTest/providers/Microsoft.Automation/automationAccounts/runbooktest/webhooks/Alert1510184037084",
"isGlobalRunbook": false,
"name": "testRunbook",
"serviceUri": "http://test.me",
"useCommonAlertSchema": true
}
],
"voiceReceivers": [
{
"name": "Sample voice",
"countryCode": "1",
"phoneNumber": "1234567890"
}
],
"logicAppReceivers": [
{
"name": "Sample logicApp",
"resourceId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/LogicApp/providers/Microsoft.Logic/workflows/testLogicApp",
"callbackUrl": "https://prod-27.northcentralus.logic.azure.com/workflows/68e572e818e5457ba898763b7db90877/triggers/manual/paths/invoke/azns/test?api-version=2016-10-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=Abpsb72UYJxPPvmDo937uzofupO5r_vIeWEx7KVHo7w",
"useCommonAlertSchema": false
}
],
"azureFunctionReceivers": [
{
"name": "Sample azureFunction",
"functionAppResourceId": "/subscriptions/5def922a-3ed4-49c1-b9fd-05ec533819a3/resourceGroups/aznsTest/providers/Microsoft.Web/sites/testFunctionApp",
"functionName": "HttpTriggerCSharp1",
"httpTriggerUrl": "http://test.me",
"useCommonAlertSchema": true
}
],
"eventHubReceivers": [
{
"name": "Sample eventHub",
"eventHubNameSpace": "testEventHubNameSpace",
"eventHubName": "testEventHub",
"subscriptionId": "187f412d-1758-44d9-b052-169e2564721d",
"tenantId": "68a4459a-ccb8-493c-b9da-dd30457d1b84"
}
],
"armRoleReceivers": [
{
"name": "ArmRole-Common",
"roleId": "11111111-1111-1111-1111-111111111111",
"useCommonAlertSchema": true
},
{
"name": "ArmRole-nonCommon",
"roleId": "11111111-1111-1111-1111-111111111111",
"useCommonAlertSchema": false
}
]
}
範例回覆
location: https://management.azure.com/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/TestRgName/providers/microsoft.insights/actionGroups/TestAgName/notificationStatus/11111111111111?api-version=2022-06-01
{
"context": {
"notificationSource": "Microsoft.Insights/TestNotification",
"contextType": "Microsoft.Insights/Budget"
},
"state": "Completed",
"completedTime": "0001-01-01T00:00:00+00:00",
"createdTime": "2021-09-21T04:52:29.5091168+00:00",
"actionDetails": [
{
"MechanismType": "AzureAppPush",
"Name": "AzureAppPush-name",
"Status": "Completed",
"SubState": "Default",
"SendTime": "2021-09-21T04:52:42.8620629+00:00",
"Detail": null
},
{
"MechanismType": "AzureFunction",
"Name": "AzureFunction-name",
"Status": "Completed",
"SubState": "Default",
"SendTime": "2021-09-21T04:52:42.0623319+00:00",
"Detail": null
},
{
"MechanismType": "Email",
"Name": "Email-name",
"Status": "Completed",
"SubState": "Default",
"SendTime": "2021-09-21T04:52:40.7480368+00:00",
"Detail": null
},
{
"MechanismType": "LogicApp",
"Name": "LogicApp-Name",
"Status": "Completed",
"SubState": "Default",
"SendTime": "2021-09-21T04:52:42.2473419+00:00",
"Detail": null
},
{
"MechanismType": "Webhook",
"Name": "Webhook-name",
"Status": "Completed",
"SubState": "Default",
"SendTime": "2021-09-21T04:52:42.0723479+00:00",
"Detail": null
},
{
"MechanismType": "SecureWebhook",
"Name": "SecureWebhook-name",
"Status": "Completed",
"SubState": "Default",
"SendTime": "2021-09-21T04:52:42.0723479+00:00",
"Detail": null
},
{
"MechanismType": "Sms",
"Name": "Sms-name",
"Status": "Completed",
"SubState": "Default",
"SendTime": "2021-09-21T04:52:41.353015+00:00",
"Detail": null
},
{
"MechanismType": "Voice",
"Name": "Voice-name",
"Status": "Completed",
"SubState": "Default",
"SendTime": "2021-09-21T04:52:41.6330734+00:00",
"Detail": null
},
{
"MechanismType": "EventHub",
"Name": "EventHub-name",
"Status": "Completed",
"SubState": "Default",
"SendTime": "2021-09-21T04:52:42.0723479+00:00",
"Detail": null
},
{
"MechanismType": "AutomationRunbook",
"Name": "AutomationRunbook-name",
"Status": "Completed",
"SubState": "Default",
"SendTime": "2021-09-21T04:52:42.0723479+00:00",
"Detail": null
},
{
"MechanismType": "Itsm",
"Name": "Itsm-name",
"Status": "Completed",
"SubState": "Default",
"SendTime": "2021-09-21T04:52:42.0723479+00:00",
"Detail": null
}
]
}
定義
名稱 | Description |
---|---|
Action |
動作詳細數據 |
Arm |
arm 角色接收器。 |
Automation |
Azure 自動化 Runbook 通知接收者。 |
Azure |
Azure 行動應用程式推播通知接收者。 |
Azure |
azure 函式接收者。 |
Context |
內容資訊 |
Email |
電子郵件接收者。 |
Error |
描述錯誤回應的格式。 |
Event |
事件中樞接收者。 |
Itsm |
Itsm 接收者。 |
Logic |
邏輯應用程式接收者。 |
Notification |
包含聯繫人詳細數據元數據的要求本文 |
Receiver |
表示接收者的狀態。 未啟用的接收者將不會收到任何通訊。 |
Sms |
SMS 接收者。 |
Test |
測試通知結果的詳細數據。 |
Voice |
語音接收器。 |
Webhook |
Webhook 接收者。 |
ActionDetail
動作詳細數據
名稱 | 類型 | Description |
---|---|---|
Detail |
string |
易記錯誤訊息的詳細數據 |
MechanismType |
string |
機制類型 |
Name |
string |
動作的名稱 |
SendTime |
string |
傳送時間 |
Status |
string |
動作的狀態 |
SubState |
string |
動作的子狀態 |
ArmRoleReceiver
arm 角色接收器。
名稱 | 類型 | 預設值 | Description |
---|---|---|---|
name |
string |
arm 角色接收者的名稱。 名稱在動作群組內的所有接收者中都必須是唯一的。 |
|
roleId |
string |
arm 角色標識碼。 |
|
useCommonAlertSchema |
boolean |
False |
指出是否要使用一般警示架構。 |
AutomationRunbookReceiver
Azure 自動化 Runbook 通知接收者。
名稱 | 類型 | 預設值 | Description |
---|---|---|---|
automationAccountId |
string |
保留此 Runbook 並向 Azure 資源驗證的 Azure 自動化帳戶標識碼。 |
|
isGlobalRunbook |
boolean |
指出這個實例是否為全域 Runbook。 |
|
name |
string |
表示 Webhook 的名稱。 |
|
runbookName |
string |
此 Runbook 的名稱。 |
|
serviceUri |
string |
應傳送 Webhook 的 URI。 |
|
useCommonAlertSchema |
boolean |
False |
指出是否要使用一般警示架構。 |
webhookResourceId |
string |
連結至此 Runbook 之 Webhook 的資源識別碼。 |
AzureAppPushReceiver
Azure 行動應用程式推播通知接收者。
名稱 | 類型 | Description |
---|---|---|
emailAddress |
string |
為 Azure 行動應用程式註冊的電子郵件位址。 |
name |
string |
Azure 行動應用程式推播接收者的名稱。 名稱在動作群組內的所有接收者中都必須是唯一的。 |
AzureFunctionReceiver
azure 函式接收者。
名稱 | 類型 | 預設值 | Description |
---|---|---|---|
functionAppResourceId |
string |
函式應用程式的 Azure 資源識別碼。 |
|
functionName |
string |
函式應用程式中的函式名稱。 |
|
httpTriggerUrl |
string |
HTTP 觸發程式 URL,其中 HTTP 要求傳送到其中。 |
|
name |
string |
azure 函式接收者的名稱。 名稱在動作群組內的所有接收者中都必須是唯一的。 |
|
useCommonAlertSchema |
boolean |
False |
指出是否要使用一般警示架構。 |
Context
內容資訊
名稱 | 類型 | Description |
---|---|---|
contextType |
string |
內容識別碼類型 |
notificationSource |
string |
通知要求的來源 |
EmailReceiver
電子郵件接收者。
名稱 | 類型 | 預設值 | Description |
---|---|---|---|
emailAddress |
string |
此接收者的電子郵件位址。 |
|
name |
string |
電子郵件接收者的名稱。 名稱在動作群組內的所有接收者中都必須是唯一的。 |
|
status |
電子郵件的接收者狀態。 |
||
useCommonAlertSchema |
boolean |
False |
指出是否要使用一般警示架構。 |
ErrorResponse
描述錯誤回應的格式。
名稱 | 類型 | Description |
---|---|---|
code |
string |
錯誤碼 |
message |
string |
錯誤訊息,指出作業失敗的原因。 |
EventHubReceiver
事件中樞接收者。
名稱 | 類型 | 預設值 | Description |
---|---|---|---|
eventHubName |
string |
特定事件中樞佇列的名稱 |
|
eventHubNameSpace |
string |
事件中樞命名空間 |
|
name |
string |
事件中樞接收者的名稱。 名稱在動作群組內的所有接收者中都必須是唯一的。 |
|
subscriptionId |
string |
包含此事件中樞之訂用帳戶的標識碼 |
|
tenantId |
string |
包含此事件中樞之訂用帳戶的租用戶標識碼 |
|
useCommonAlertSchema |
boolean |
False |
指出是否要使用一般警示架構。 |
ItsmReceiver
Itsm 接收者。
名稱 | 類型 | Description |
---|---|---|
connectionId |
string |
在上述工作區中定義的多個之間唯一識別 ITSM 連線。 |
name |
string |
Itsm 接收者的名稱。 名稱在動作群組內的所有接收者中都必須是唯一的。 |
region |
string |
工作區所在的區域。 支援的值:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope' |
ticketConfiguration |
string |
ITSM 動作組態的 JSON Blob。 CreateMultipleWorkItems 選項也會是此 Blob 的一部分。 |
workspaceId |
string |
OMS LA 實例標識碼。 |
LogicAppReceiver
邏輯應用程式接收者。
名稱 | 類型 | 預設值 | Description |
---|---|---|---|
callbackUrl |
string |
HTTP 要求傳送至其中的回呼 URL。 |
|
name |
string |
邏輯應用程式接收者的名稱。 名稱在動作群組內的所有接收者中都必須是唯一的。 |
|
resourceId |
string |
邏輯應用程式接收者的 Azure 資源識別碼。 |
|
useCommonAlertSchema |
boolean |
False |
指出是否要使用一般警示架構。 |
NotificationRequestBody
包含聯繫人詳細數據元數據的要求本文
名稱 | 類型 | Description |
---|---|---|
alertType |
string |
支援的警示類型值。 支援的警示類型值包括:servicehealth、metricstaticthreshold、metricsdynamicthreshold、logalertv2、smartalert、webtestalert、logalertv1numresult、logalertv1metricmeasurement、resourcehealth、activitylog、actualcostbudget、forecastedbudget |
armRoleReceivers |
屬於此動作群組一部分的ARM角色接收者清單。 角色是 Azure RBAC 角色,且僅支持內建角色。 |
|
automationRunbookReceivers |
屬於此動作群組一部分的 AutomationRunbook 接收者清單。 |
|
azureAppPushReceivers |
屬於此動作群組一部分的 AzureAppPush 接收者清單。 |
|
azureFunctionReceivers |
屬於此動作群組一部分的 azure 函式接收者清單。 |
|
emailReceivers |
屬於此動作群組一部分的電子郵件接收者清單。 |
|
eventHubReceivers |
屬於此動作群組一部分的事件中樞接收者清單。 |
|
itsmReceivers |
屬於此動作群組一部分的 ITSM 接收者清單。 |
|
logicAppReceivers |
屬於此動作群組一部分的邏輯應用程式接收者清單。 |
|
smsReceivers |
屬於此動作群組一部分的SMS接收者清單。 |
|
voiceReceivers |
屬於此動作群組一部分的語音接收器清單。 |
|
webhookReceivers |
屬於此動作群組一部分的 Webhook 接收者清單。 |
ReceiverStatus
表示接收者的狀態。 未啟用的接收者將不會收到任何通訊。
名稱 | 類型 | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
|
NotSpecified |
string |
SmsReceiver
SMS 接收者。
名稱 | 類型 | Description |
---|---|---|
countryCode |
string |
SMS 接收者的國家/地區代碼。 |
name |
string |
SMS 接收者的名稱。 名稱在動作群組內的所有接收者中都必須是唯一的。 |
phoneNumber |
string |
SMS 接收者的電話號碼。 |
status |
接收者的狀態。 |
TestNotificationDetailsResponse
測試通知結果的詳細數據。
名稱 | 類型 | Description |
---|---|---|
actionDetails |
動作詳細數據的清單 |
|
completedTime |
string |
完成的時間 |
context |
內容資訊 |
|
createdTime |
string |
建立的時間 |
state |
string |
整體狀態 |
VoiceReceiver
語音接收器。
名稱 | 類型 | Description |
---|---|---|
countryCode |
string |
語音接收器的國家/地區代碼。 |
name |
string |
語音接收器的名稱。 名稱在動作群組內的所有接收者中都必須是唯一的。 |
phoneNumber |
string |
語音接收器的電話號碼。 |
WebhookReceiver
Webhook 接收者。
名稱 | 類型 | 預設值 | Description |
---|---|---|---|
identifierUri |
string |
指出 aad 驗證的識別碼 URI。 |
|
name |
string |
Webhook 接收者的名稱。 名稱在動作群組內的所有接收者中都必須是唯一的。 |
|
objectId |
string |
指出 aad 驗證的 Webhook 應用程式物件識別碼。 |
|
serviceUri |
string |
應傳送 Webhook 的 URI。 |
|
tenantId |
string |
指出 aad 驗證的租用戶標識碼。 |
|
useAadAuth |
boolean |
False |
指出是否使用 AAD 驗證。 |
useCommonAlertSchema |
boolean |
False |
指出是否要使用一般警示架構。 |