Action Groups - Post Test Notifications
Tesztértesítések küldése megadott fogadóknak
POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Insights/createNotifications?api-version=2021-09-01
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
subscription
|
path | True |
string |
A cél-előfizetés azonosítója. |
api-version
|
query | True |
string |
A művelethez használandó API-verzió. |
Kérelem törzse
Name | Kötelező | Típus | Description |
---|---|---|---|
alertType | True |
string |
A támogatott riasztástípus értéke. Támogatott riasztástípus-értékek: servicehealth, metricstaticthreshold, metricsdynamicthreshold, logalertv2, smartalert, webtestalert, logalertv1numresult, logalertv1metricmeasurement, resourcehealth, activitylog, actualcostbudget, forecastedbudget |
armRoleReceivers |
A műveletcsoport részét képező ARM-szerepkör-fogadók listája. A szerepkörök Azure RBAC-szerepkörök, és csak a beépített szerepkörök támogatottak. |
||
automationRunbookReceivers |
A műveletcsoport részét képező AutomationRunbook-fogadók listája. |
||
azureAppPushReceivers |
A műveletcsoport részét képező AzureAppPush-fogadók listája. |
||
azureFunctionReceivers |
A műveletcsoport részét képező Azure-függvény fogadók listája. |
||
emailReceivers |
A műveletcsoporthoz tartozó e-mail-fogadók listája. |
||
eventHubReceivers |
A műveletcsoport részét képező eseményközpont-fogadók listája. |
||
itsmReceivers |
A műveletcsoport részét képező ITSM-fogadók listája. |
||
logicAppReceivers |
A műveletcsoport részét képező logikaialkalmazás-fogadók listája. |
||
smsReceivers |
A műveletcsoport részét képező SMS-fogadók listája. |
||
voiceReceivers |
A műveletcsoporthoz tartozó hangvevők listája. |
||
webhookReceivers |
A műveletcsoport részét képező webhook-fogadók listája. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
Az értesítés sikeres volt |
|
202 Accepted |
Az értesítési kérelem elfogadva Headers location: string |
|
Other Status Codes |
Hiba történt a tesztértesítések küldése közben |
Biztonság
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | felhasználói fiók megszemélyesítése |
Példák
Create notifications at subscription level
Sample Request
POST https://management.azure.com/subscriptions/187f412d-1758-44d9-b052-169e2564721d/providers/Microsoft.Insights/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
}
]
}
Sample Response
location: https://management.azure.com/subscriptions/11111111-1111-1111-1111-111111111111/providers/microsoft.insights/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
}
]
}
Definíciók
Name | Description |
---|---|
Action |
A művelet részletei |
Arm |
Egy arm szerepkör-fogadó. |
Automation |
A Azure Automation Runbook értesítési fogadója. |
Azure |
Az Azure Mobile App leküldéses értesítési fogadója. |
Azure |
Egy Azure-függvény fogadója. |
Context |
A környezeti adatok |
Email |
Egy e-mail-fogadó. |
Error |
A hibaválasz formátumát ismerteti. |
Event |
Eseményközpont-fogadó. |
Itsm |
Egy Itsm vevő. |
Logic |
Logikai alkalmazás fogadója. |
Notification |
A kapcsolati adatok metaadatait tartalmazó kérelemtörzs |
Receiver |
A fogadó állapotát jelzi. A nem engedélyezett fogadók nem kapnak kommunikációt. |
Sms |
Egy SMS-fogadó. |
Test |
A tesztértesítés eredményeinek részletei. |
Voice |
Egy hangvevő. |
Webhook |
Egy webhook fogadó. |
ActionDetail
A művelet részletei
Name | Típus | Description |
---|---|---|
Detail |
string |
A felhasználóbarát hibaüzenet részletei |
MechanismType |
string |
A mechanizmus típusa |
Name |
string |
A művelet neve |
SendTime |
string |
A küldés időpontja |
Status |
string |
A művelet állapota |
SubState |
string |
A művelet alállapota |
ArmRoleReceiver
Egy arm szerepkör-fogadó.
Name | Típus | Alapértelmezett érték | Description |
---|---|---|---|
name |
string |
Az arm-szerepkör fogadójának neve. A neveknek egyedinek kell lenniük a műveletcsoport összes fogadója között. |
|
roleId |
string |
Az arm szerepkör azonosítója. |
|
useCommonAlertSchema |
boolean |
False |
Azt jelzi, hogy a gyakori riasztási sémát kell-e használni. |
AutomationRunbookReceiver
A Azure Automation Runbook értesítési fogadója.
Name | Típus | Alapértelmezett érték | Description |
---|---|---|---|
automationAccountId |
string |
Az Azure Automation-fiók azonosítója, amely ezt a runbookot tárolja, és hitelesíti az Azure-erőforrást. |
|
isGlobalRunbook |
boolean |
Azt jelzi, hogy ez a példány globális runbook-e. |
|
name |
string |
A webhook nevét jelzi. |
|
runbookName |
string |
A runbook neve. |
|
serviceUri |
string |
Az URI, ahová a webhookokat el kell küldeni. |
|
useCommonAlertSchema |
boolean |
False |
Azt jelzi, hogy a gyakori riasztási sémát kell-e használni. |
webhookResourceId |
string |
A runbookhoz társított webhook erőforrás-azonosítója. |
AzureAppPushReceiver
Az Azure Mobile App leküldéses értesítési fogadója.
Name | Típus | Description |
---|---|---|
emailAddress |
string |
Az Azure-mobilalkalmazáshoz regisztrált e-mail-cím. |
name |
string |
Az Azure-mobilalkalmazás leküldéses fogadójának neve. A neveknek egyedinek kell lenniük a műveletcsoport összes fogadója között. |
AzureFunctionReceiver
Egy Azure-függvény fogadója.
Name | Típus | Alapértelmezett érték | Description |
---|---|---|---|
functionAppResourceId |
string |
A függvényalkalmazás Azure-erőforrás-azonosítója. |
|
functionName |
string |
A függvényalkalmazás függvényneve. |
|
httpTriggerUrl |
string |
A HTTP-eseményindító URL-címe, ahová a http-kérelem elküldve van. |
|
name |
string |
Az Azure-függvény fogadójának neve. A neveknek egyedinek kell lenniük a műveletcsoport összes fogadója között. |
|
useCommonAlertSchema |
boolean |
False |
Azt jelzi, hogy a gyakori riasztási sémát kell-e használni. |
Context
A környezeti adatok
Name | Típus | Description |
---|---|---|
contextType |
string |
A környezetazonosító típusa |
notificationSource |
string |
Az értesítési kérelem forrása |
EmailReceiver
Egy e-mail-fogadó.
Name | Típus | Alapértelmezett érték | Description |
---|---|---|---|
emailAddress |
string |
A fogadó e-mail-címe. |
|
name |
string |
Az e-mail-fogadó neve. A neveknek egyedinek kell lenniük a műveletcsoport összes fogadója között. |
|
status |
Az e-mail fogadó állapota. |
||
useCommonAlertSchema |
boolean |
False |
Azt jelzi, hogy a gyakori riasztási sémát kell-e használni. |
ErrorResponse
A hibaválasz formátumát ismerteti.
Name | Típus | Description |
---|---|---|
code |
string |
Hibakód |
message |
string |
Hibaüzenet jelzi, hogy a művelet miért nem sikerült. |
EventHubReceiver
Eseményközpont-fogadó.
Name | Típus | Alapértelmezett érték | Description |
---|---|---|---|
eventHubName |
string |
Az adott Event Hub-üzenetsor neve |
|
eventHubNameSpace |
string |
Az Event Hub névtere |
|
name |
string |
Az Eseményközpont fogadójának neve. A neveknek egyedinek kell lenniük a műveletcsoport összes fogadója között. |
|
subscriptionId |
string |
Az eseményközpontot tartalmazó előfizetés azonosítója |
|
tenantId |
string |
Az eseményközpontot tartalmazó előfizetés bérlőazonosítója |
|
useCommonAlertSchema |
boolean |
False |
Azt jelzi, hogy a gyakori riasztási sémát kell-e használni. |
ItsmReceiver
Egy Itsm vevő.
Name | Típus | Description |
---|---|---|
connectionId |
string |
Az ITSM-kapcsolat egyedi azonosítása a fenti munkaterületen definiált többszörösek között. |
name |
string |
Az Itsm-fogadó neve. A neveknek egyedinek kell lenniük a műveletcsoport összes fogadója között. |
region |
string |
Régió, amelyben a munkaterület található. Támogatott értékek:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope' |
ticketConfiguration |
string |
JSON-blob az ITSM-művelet konfigurációihoz. A CreateMultipleWorkItems beállítás is része lesz ennek a blobnak. |
workspaceId |
string |
OMS LA-példány azonosítója. |
LogicAppReceiver
Logikai alkalmazás fogadója.
Name | Típus | Alapértelmezett érték | Description |
---|---|---|---|
callbackUrl |
string |
A visszahívási URL-cím, ahová a http-kérelem elküldve van. |
|
name |
string |
A logikai alkalmazás fogadójának neve. A neveknek egyedinek kell lenniük a műveletcsoport összes fogadója között. |
|
resourceId |
string |
A logikai alkalmazás fogadójának Azure-erőforrás-azonosítója. |
|
useCommonAlertSchema |
boolean |
False |
Azt jelzi, hogy a gyakori riasztási sémát kell-e használni. |
NotificationRequestBody
A kapcsolati adatok metaadatait tartalmazó kérelemtörzs
Name | Típus | Description |
---|---|---|
alertType |
string |
A támogatott riasztástípus értéke. Támogatott riasztástípus-értékek: servicehealth, metricstaticthreshold, metricsdynamicthreshold, logalertv2, smartalert, webtestalert, logalertv1numresult, logalertv1metricmeasurement, resourcehealth, activitylog, actualcostbudget, forecastedbudget |
armRoleReceivers |
A műveletcsoport részét képező ARM-szerepkör-fogadók listája. A szerepkörök Azure RBAC-szerepkörök, és csak a beépített szerepkörök támogatottak. |
|
automationRunbookReceivers |
A műveletcsoport részét képező AutomationRunbook-fogadók listája. |
|
azureAppPushReceivers |
A műveletcsoport részét képező AzureAppPush-fogadók listája. |
|
azureFunctionReceivers |
A műveletcsoport részét képező Azure-függvény fogadók listája. |
|
emailReceivers |
A műveletcsoporthoz tartozó e-mail-fogadók listája. |
|
eventHubReceivers |
A műveletcsoport részét képező eseményközpont-fogadók listája. |
|
itsmReceivers |
A műveletcsoport részét képező ITSM-fogadók listája. |
|
logicAppReceivers |
A műveletcsoport részét képező logikaialkalmazás-fogadók listája. |
|
smsReceivers |
A műveletcsoport részét képező SMS-fogadók listája. |
|
voiceReceivers |
A műveletcsoporthoz tartozó hangvevők listája. |
|
webhookReceivers |
A műveletcsoport részét képező webhook-fogadók listája. |
ReceiverStatus
A fogadó állapotát jelzi. A nem engedélyezett fogadók nem kapnak kommunikációt.
Name | Típus | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
|
NotSpecified |
string |
SmsReceiver
Egy SMS-fogadó.
Name | Típus | Description |
---|---|---|
countryCode |
string |
Az SMS-fogadó országkódja. |
name |
string |
Az SMS-fogadó neve. A neveknek egyedinek kell lenniük a műveletcsoport összes fogadója között. |
phoneNumber |
string |
Az SMS-fogadó telefonszáma. |
status |
A fogadó állapota. |
TestNotificationDetailsResponse
A tesztértesítés eredményeinek részletei.
Name | Típus | Description |
---|---|---|
actionDetails |
A művelet részleteinek listája |
|
completedTime |
string |
A befejezett idő |
context |
A környezeti adatok |
|
createdTime |
string |
A létrehozott idő |
state |
string |
A teljes állapot |
VoiceReceiver
Egy hangvevő.
Name | Típus | Description |
---|---|---|
countryCode |
string |
A hangvevő országkódja. |
name |
string |
A hangvevő neve. A neveknek egyedinek kell lenniük a műveletcsoport összes fogadója között. |
phoneNumber |
string |
A hangvevő telefonszáma. |
WebhookReceiver
Egy webhook fogadó.
Name | Típus | Alapértelmezett érték | Description |
---|---|---|---|
identifierUri |
string |
Az aad auth azonosítójának URI-jára utal. |
|
name |
string |
A webhook fogadójának neve. A neveknek egyedinek kell lenniük a műveletcsoport összes fogadója között. |
|
objectId |
string |
Az aad auth webhook alkalmazásobjektum-azonosítóját jelzi. |
|
serviceUri |
string |
Az URI, ahová a webhookokat el kell küldeni. |
|
tenantId |
string |
Az aad hitelesítés bérlőazonosítóját jelzi. |
|
useAadAuth |
boolean |
False |
Azt jelzi, hogy AAD-hitelesítést használ-e vagy sem. |
useCommonAlertSchema |
boolean |
False |
Azt jelzi, hogy a gyakori riasztási sémát kell-e használni. |