Action Groups - Create Notifications At Resource Group Level
Mengirim pemberitahuan pengujian ke sekumpulan penerima yang disediakan
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/createNotifications?api-version=2021-09-01
Parameter URI
Nama | Dalam | Diperlukan | Jenis | Deskripsi |
---|---|---|---|---|
resource
|
path | True |
string |
Nama grup sumber daya. Nama tidak peka huruf besar/kecil. |
subscription
|
path | True |
string |
ID langganan target. |
api-version
|
query | True |
string |
Versi API yang digunakan untuk operasi ini. |
Isi Permintaan
Nama | Diperlukan | Jenis | Deskripsi |
---|---|---|---|
alertType | True |
string |
Nilai jenis pemberitahuan yang didukung. Nilai jenis pemberitahuan yang didukung adalah: servicehealth, metricstaticthreshold, metricsdynamicthreshold, logalertv2, smartalert, webtestalert, logalertv1numresult, logalertv1metricmeasurement, resourcehealth, activitylog, actualcostbudget, forecastedbudget |
armRoleReceivers |
Daftar penerima peran ARM yang merupakan bagian dari grup tindakan ini. Peran adalah peran Azure RBAC dan hanya peran bawaan yang didukung. |
||
automationRunbookReceivers |
Daftar penerima AutomationRunbook yang merupakan bagian dari grup tindakan ini. |
||
azureAppPushReceivers |
Daftar penerima AzureAppPush yang merupakan bagian dari grup tindakan ini. |
||
azureFunctionReceivers |
Daftar penerima fungsi azure yang merupakan bagian dari grup tindakan ini. |
||
emailReceivers |
Daftar penerima email yang merupakan bagian dari grup tindakan ini. |
||
eventHubReceivers |
Daftar penerima pusat aktivitas yang merupakan bagian dari grup tindakan ini. |
||
itsmReceivers |
Daftar penerima ITSM yang merupakan bagian dari grup tindakan ini. |
||
logicAppReceivers |
Daftar penerima aplikasi logika yang merupakan bagian dari grup tindakan ini. |
||
smsReceivers |
Daftar penerima SMS yang merupakan bagian dari grup tindakan ini. |
||
voiceReceivers |
Daftar penerima suara yang merupakan bagian dari grup tindakan ini. |
||
webhookReceivers |
Daftar penerima webhook yang merupakan bagian dari grup tindakan ini. |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
200 OK |
Pemberitahuan berhasil |
|
202 Accepted |
Permintaan pemberitahuan diterima Headers location: string |
|
Other Status Codes |
Terjadi kesalahan saat mengirim pemberitahuan pengujian |
Keamanan
azure_auth
Alur OAuth2 Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nama | Deskripsi |
---|---|
user_impersonation | meniru akun pengguna Anda |
Contoh
Create notifications at resource group level
Sample Request
POST https://management.azure.com/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/Default-TestNotifications/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/resourceGroups/Test-Rg/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
}
]
}
Definisi
Nama | Deskripsi |
---|---|
Action |
Detail tindakan |
Arm |
Penerima peran lengan. |
Automation |
Penerima pemberitahuan Azure Automation Runbook. |
Azure |
Penerima pemberitahuan push Aplikasi seluler Azure. |
Azure |
Penerima fungsi azure. |
Context |
Info konteks |
Email |
Penerima email. |
Error |
Menjelaskan format respons Kesalahan. |
Event |
Penerima pusat aktivitas. |
Itsm |
Penerima Itsm. |
Logic |
Penerima aplikasi logika. |
Notification |
Isi permintaan yang berisi metadata detail kontak |
Receiver |
Menunjukkan status penerima. Penerima yang tidak Diaktifkan tidak akan menerima komunikasi apa pun. |
Sms |
Penerima SMS. |
Test |
Detail hasil pemberitahuan pengujian. |
Voice |
Penerima suara. |
Webhook |
Penerima webhook. |
ActionDetail
Detail tindakan
Nama | Jenis | Deskripsi |
---|---|---|
Detail |
string |
Detail pesan kesalahan yang mudah diingat |
MechanismType |
string |
Jenis mekanisme |
Name |
string |
Nama tindakan |
SendTime |
string |
Waktu pengiriman |
Status |
string |
Status tindakan |
SubState |
string |
Substatus tindakan |
ArmRoleReceiver
Penerima peran lengan.
Nama | Jenis | Nilai Default | Deskripsi |
---|---|---|---|
name |
string |
Nama penerima peran lengan. Nama harus unik di semua penerima dalam grup tindakan. |
|
roleId |
string |
Id peran lengan. |
|
useCommonAlertSchema |
boolean |
False |
Menunjukkan apakah akan menggunakan skema pemberitahuan umum. |
AutomationRunbookReceiver
Penerima pemberitahuan Azure Automation Runbook.
Nama | Jenis | Nilai Default | Deskripsi |
---|---|---|---|
automationAccountId |
string |
Id akun azure automation yang menyimpan runbook ini dan mengautentikasi ke sumber daya Azure. |
|
isGlobalRunbook |
boolean |
Menunjukkan apakah instans ini adalah runbook global. |
|
name |
string |
Menunjukkan nama webhook. |
|
runbookName |
string |
Nama untuk runbook ini. |
|
serviceUri |
string |
URI tempat webhook harus dikirim. |
|
useCommonAlertSchema |
boolean |
False |
Menunjukkan apakah akan menggunakan skema pemberitahuan umum. |
webhookResourceId |
string |
Id sumber daya untuk webhook yang ditautkan ke runbook ini. |
AzureAppPushReceiver
Penerima pemberitahuan push Aplikasi seluler Azure.
Nama | Jenis | Deskripsi |
---|---|---|
emailAddress |
string |
Alamat email yang terdaftar untuk aplikasi seluler Azure. |
name |
string |
Nama penerima push aplikasi seluler Azure. Nama harus unik di semua penerima dalam grup tindakan. |
AzureFunctionReceiver
Penerima fungsi azure.
Nama | Jenis | Nilai Default | Deskripsi |
---|---|---|---|
functionAppResourceId |
string |
Id sumber daya azure dari aplikasi fungsi. |
|
functionName |
string |
Nama fungsi di aplikasi fungsi. |
|
httpTriggerUrl |
string |
Url pemicu http tempat permintaan http dikirim. |
|
name |
string |
Nama penerima fungsi azure. Nama harus unik di semua penerima dalam grup tindakan. |
|
useCommonAlertSchema |
boolean |
False |
Menunjukkan apakah akan menggunakan skema pemberitahuan umum. |
Context
Info konteks
Nama | Jenis | Deskripsi |
---|---|---|
contextType |
string |
Jenis id konteks |
notificationSource |
string |
Sumber permintaan pemberitahuan |
EmailReceiver
Penerima email.
Nama | Jenis | Nilai Default | Deskripsi |
---|---|---|---|
emailAddress |
string |
Alamat email penerima ini. |
|
name |
string |
Nama penerima email. Nama harus unik di semua penerima dalam grup tindakan. |
|
status |
Status penerima email. |
||
useCommonAlertSchema |
boolean |
False |
Menunjukkan apakah akan menggunakan skema pemberitahuan umum. |
ErrorResponse
Menjelaskan format respons Kesalahan.
Nama | Jenis | Deskripsi |
---|---|---|
code |
string |
Kode kesalahan |
message |
string |
Pesan kesalahan yang menunjukkan mengapa operasi gagal. |
EventHubReceiver
Penerima pusat aktivitas.
Nama | Jenis | Nilai Default | Deskripsi |
---|---|---|---|
eventHubName |
string |
Nama antrean Pusat Aktivitas tertentu |
|
eventHubNameSpace |
string |
Namespace layanan Pusat Aktivitas |
|
name |
string |
Nama penerima Event hub. Nama harus unik di semua penerima dalam grup tindakan. |
|
subscriptionId |
string |
Id untuk langganan yang berisi hub kejadian ini |
|
tenantId |
string |
Id penyewa untuk langganan yang berisi hub kejadian ini |
|
useCommonAlertSchema |
boolean |
False |
Menunjukkan apakah akan menggunakan skema pemberitahuan umum. |
ItsmReceiver
Penerima Itsm.
Nama | Jenis | Deskripsi |
---|---|---|
connectionId |
string |
Identifikasi unik koneksi ITSM di antara beberapa yang ditentukan di ruang kerja di atas. |
name |
string |
Nama penerima Itsm. Nama harus unik di semua penerima dalam grup tindakan. |
region |
string |
Wilayah tempat ruang kerja berada. Nilai yang didukung:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope' |
ticketConfiguration |
string |
Blob JSON untuk konfigurasi tindakan ITSM. Opsi CreateMultipleWorkItems juga akan menjadi bagian dari blob ini. |
workspaceId |
string |
Pengidentifikasi instans OMS LA. |
LogicAppReceiver
Penerima aplikasi logika.
Nama | Jenis | Nilai Default | Deskripsi |
---|---|---|---|
callbackUrl |
string |
Url panggilan balik tempat permintaan http dikirim. |
|
name |
string |
Nama penerima aplikasi logika. Nama harus unik di semua penerima dalam grup tindakan. |
|
resourceId |
string |
Id sumber daya azure penerima aplikasi logika. |
|
useCommonAlertSchema |
boolean |
False |
Menunjukkan apakah akan menggunakan skema pemberitahuan umum. |
NotificationRequestBody
Isi permintaan yang berisi metadata detail kontak
Nama | Jenis | Deskripsi |
---|---|---|
alertType |
string |
Nilai jenis pemberitahuan yang didukung. Nilai jenis pemberitahuan yang didukung adalah: servicehealth, metricstaticthreshold, metricsdynamicthreshold, logalertv2, smartalert, webtestalert, logalertv1numresult, logalertv1metricmeasurement, resourcehealth, activitylog, actualcostbudget, forecastedbudget |
armRoleReceivers |
Daftar penerima peran ARM yang merupakan bagian dari grup tindakan ini. Peran adalah peran Azure RBAC dan hanya peran bawaan yang didukung. |
|
automationRunbookReceivers |
Daftar penerima AutomationRunbook yang merupakan bagian dari grup tindakan ini. |
|
azureAppPushReceivers |
Daftar penerima AzureAppPush yang merupakan bagian dari grup tindakan ini. |
|
azureFunctionReceivers |
Daftar penerima fungsi azure yang merupakan bagian dari grup tindakan ini. |
|
emailReceivers |
Daftar penerima email yang merupakan bagian dari grup tindakan ini. |
|
eventHubReceivers |
Daftar penerima pusat aktivitas yang merupakan bagian dari grup tindakan ini. |
|
itsmReceivers |
Daftar penerima ITSM yang merupakan bagian dari grup tindakan ini. |
|
logicAppReceivers |
Daftar penerima aplikasi logika yang merupakan bagian dari grup tindakan ini. |
|
smsReceivers |
Daftar penerima SMS yang merupakan bagian dari grup tindakan ini. |
|
voiceReceivers |
Daftar penerima suara yang merupakan bagian dari grup tindakan ini. |
|
webhookReceivers |
Daftar penerima webhook yang merupakan bagian dari grup tindakan ini. |
ReceiverStatus
Menunjukkan status penerima. Penerima yang tidak Diaktifkan tidak akan menerima komunikasi apa pun.
Nama | Jenis | Deskripsi |
---|---|---|
Disabled |
string |
|
Enabled |
string |
|
NotSpecified |
string |
SmsReceiver
Penerima SMS.
Nama | Jenis | Deskripsi |
---|---|---|
countryCode |
string |
Kode negara penerima SMS. |
name |
string |
Nama penerima SMS. Nama harus unik di semua penerima dalam grup tindakan. |
phoneNumber |
string |
Nomor telepon penerima SMS. |
status |
Status penerima. |
TestNotificationDetailsResponse
Detail hasil pemberitahuan pengujian.
Nama | Jenis | Deskripsi |
---|---|---|
actionDetails |
Daftar detail tindakan |
|
completedTime |
string |
Waktu selesai |
context |
Info konteks |
|
createdTime |
string |
Waktu yang dibuat |
state |
string |
Status keseluruhan |
VoiceReceiver
Penerima suara.
Nama | Jenis | Deskripsi |
---|---|---|
countryCode |
string |
Kode negara penerima suara. |
name |
string |
Nama penerima suara. Nama harus unik di semua penerima dalam grup tindakan. |
phoneNumber |
string |
Nomor telepon penerima suara. |
WebhookReceiver
Penerima webhook.
Nama | Jenis | Nilai Default | Deskripsi |
---|---|---|---|
identifierUri |
string |
Menunjukkan uri pengidentifikasi untuk autentikasi aad. |
|
name |
string |
Nama penerima webhook. Nama harus unik di semua penerima dalam grup tindakan. |
|
objectId |
string |
Menunjukkan Id objek aplikasi webhook untuk autentikasi aad. |
|
serviceUri |
string |
URI tempat webhook harus dikirim. |
|
tenantId |
string |
Menunjukkan id penyewa untuk autentikasi aad. |
|
useAadAuth |
boolean |
False |
Menunjukkan apakah menggunakan autentikasi AAD atau tidak. |
useCommonAlertSchema |
boolean |
False |
Menunjukkan apakah akan menggunakan skema pemberitahuan umum. |