Action Groups - Post Test Notifications
Sağlanan alıcı kümesine test bildirimleri gönderme
POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Insights/createNotifications?api-version=2021-09-01
URI Parametreleri
Name | İçinde | Gerekli | Tür | Description |
---|---|---|---|---|
subscription
|
path | True |
string |
Hedef aboneliğin kimliği. |
api-version
|
query | True |
string |
Bu işlem için kullanılacak API sürümü. |
İstek Gövdesi
Name | Gerekli | Tür | Description |
---|---|---|---|
alertType | True |
string |
Desteklenen uyarı türünün değeri. Desteklenen uyarı türü değerleri şunlardır: servicehealth, metricstaticthreshold, metricsdynamicthreshold, logalertv2, smartalert, webtestalert, logalertv1numresult, logalertv1metricmeasurement, resourcehealth, activitylog, actualcostbudget, forecastedbudget |
armRoleReceivers |
Bu eylem grubunun parçası olan ARM rol alıcılarının listesi. Roller Azure RBAC rolleridir ve yalnızca yerleşik roller desteklenir. |
||
automationRunbookReceivers |
Bu eylem grubunun parçası olan AutomationRunbook alıcılarının listesi. |
||
azureAppPushReceivers |
Bu eylem grubunun parçası olan AzureAppPush alıcılarının listesi. |
||
azureFunctionReceivers |
Bu eylem grubunun parçası olan Azure işlev alıcılarının listesi. |
||
emailReceivers |
Bu eylem grubunun parçası olan e-posta alıcılarının listesi. |
||
eventHubReceivers |
Bu eylem grubunun parçası olan olay hub'ı alıcılarının listesi. |
||
itsmReceivers |
Bu eylem grubunun parçası olan ITSM alıcılarının listesi. |
||
logicAppReceivers |
Bu eylem grubunun parçası olan mantıksal uygulama alıcılarının listesi. |
||
smsReceivers |
Bu eylem grubunun parçası olan SMS alıcılarının listesi. |
||
voiceReceivers |
Bu eylem grubunun parçası olan ses alıcılarının listesi. |
||
webhookReceivers |
Bu eylem grubunun parçası olan web kancası alıcılarının listesi. |
Yanıtlar
Name | Tür | Description |
---|---|---|
200 OK |
Bildirim başarılı oldu |
|
202 Accepted |
Bildirim isteği kabul edildi Headers location: string |
|
Other Status Codes |
Test bildirimleri gönderilirken bir hata oluştu |
Güvenlik
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 | kullanıcı hesabınızın kimliğine bürünme |
Örnekler
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
}
]
}
Tanımlar
Name | Description |
---|---|
Action |
Eylem ayrıntısı |
Arm |
Bir kol rolü alıcısı. |
Automation |
runbook bildirim alıcısını Azure Otomasyonu. |
Azure |
Azure mobil Uygulama anında iletme bildirimi alıcısı. |
Azure |
Azure işlev alıcısı. |
Context |
Bağlam bilgisi |
Email |
E-posta alıcısı. |
Error |
Hata yanıtının biçimini açıklar. |
Event |
Olay hub'ı alıcısı. |
Itsm |
Itsm alıcısı. |
Logic |
Mantıksal uygulama alıcısı. |
Notification |
Kişi ayrıntısı meta verilerini içeren istek gövdesi |
Receiver |
Alıcının durumunu gösterir. Etkin olmayan alıcılar herhangi bir iletişim almaz. |
Sms |
SMS alıcısı. |
Test |
Test bildirimi sonuçlarının ayrıntıları. |
Voice |
Bir ses alıcısı. |
Webhook |
Web kancası alıcısı. |
ActionDetail
Eylem ayrıntısı
Name | Tür | Description |
---|---|---|
Detail |
string |
Kolay hata iletisinin ayrıntıları |
MechanismType |
string |
Mekanizma türü |
Name |
string |
Eylemin adı |
SendTime |
string |
Gönderme süresi |
Status |
string |
Eylemin durumu |
SubState |
string |
Eylemin alt durumu |
ArmRoleReceiver
Bir kol rolü alıcısı.
Name | Tür | Varsayılan değer | Description |
---|---|---|---|
name |
string |
Arm rol alıcısının adı. Adlar, bir eylem grubu içindeki tüm alıcılar arasında benzersiz olmalıdır. |
|
roleId |
string |
Arm rol kimliği. |
|
useCommonAlertSchema |
boolean |
False |
Ortak uyarı şemasının kullanılıp kullanılmayacağını gösterir. |
AutomationRunbookReceiver
runbook bildirim alıcısını Azure Otomasyonu.
Name | Tür | Varsayılan değer | Description |
---|---|---|---|
automationAccountId |
string |
Bu runbook'u tutan ve Azure kaynağında kimlik doğrulaması yapan Azure otomasyonu hesap kimliği. |
|
isGlobalRunbook |
boolean |
Bu örneğin genel runbook olup olmadığını gösterir. |
|
name |
string |
Web kancasının adını gösterir. |
|
runbookName |
string |
Bu runbook'un adı. |
|
serviceUri |
string |
Web kancalarının gönderilmesi gereken URI. |
|
useCommonAlertSchema |
boolean |
False |
Ortak uyarı şemasının kullanılıp kullanılmayacağını gösterir. |
webhookResourceId |
string |
Bu runbook'a bağlı web kancası için kaynak kimliği. |
AzureAppPushReceiver
Azure mobil Uygulama anında iletme bildirimi alıcısı.
Name | Tür | Description |
---|---|---|
emailAddress |
string |
Azure mobil uygulaması için kaydedilen e-posta adresi. |
name |
string |
Azure mobil uygulaması anında iletme alıcısının adı. Adlar, bir eylem grubu içindeki tüm alıcılar arasında benzersiz olmalıdır. |
AzureFunctionReceiver
Azure işlev alıcısı.
Name | Tür | Varsayılan değer | Description |
---|---|---|---|
functionAppResourceId |
string |
İşlev uygulamasının azure kaynak kimliği. |
|
functionName |
string |
İşlev uygulamasındaki işlev adı. |
|
httpTriggerUrl |
string |
Http isteğinin gönderildiği http tetikleyici url'si. |
|
name |
string |
Azure işlev alıcısının adı. Adlar, bir eylem grubu içindeki tüm alıcılar arasında benzersiz olmalıdır. |
|
useCommonAlertSchema |
boolean |
False |
Ortak uyarı şemasının kullanılıp kullanılmayacağını gösterir. |
Context
Bağlam bilgisi
Name | Tür | Description |
---|---|---|
contextType |
string |
Bağlam kimliği türü |
notificationSource |
string |
Bildirim isteğinin kaynağı |
EmailReceiver
E-posta alıcısı.
Name | Tür | Varsayılan değer | Description |
---|---|---|---|
emailAddress |
string |
Bu alıcının e-posta adresi. |
|
name |
string |
E-posta alıcısının adı. Adlar, bir eylem grubu içindeki tüm alıcılar arasında benzersiz olmalıdır. |
|
status |
E-postanın alıcı durumu. |
||
useCommonAlertSchema |
boolean |
False |
Ortak uyarı şemasının kullanılıp kullanılmayacağını gösterir. |
ErrorResponse
Hata yanıtının biçimini açıklar.
Name | Tür | Description |
---|---|---|
code |
string |
Hata kodu |
message |
string |
İşlemin neden başarısız olduğunu belirten hata iletisi. |
EventHubReceiver
Olay hub'ı alıcısı.
Name | Tür | Varsayılan değer | Description |
---|---|---|---|
eventHubName |
string |
Belirli bir Olay Hub'ı kuyruğunun adı |
|
eventHubNameSpace |
string |
Olay Hub'ı ad alanı |
|
name |
string |
Olay hub'ı alıcısının adı. Adlar, bir eylem grubu içindeki tüm alıcılar arasında benzersiz olmalıdır. |
|
subscriptionId |
string |
Bu olay hub'ını içeren aboneliğin kimliği |
|
tenantId |
string |
Bu olay hub'ını içeren aboneliğin kiracı kimliği |
|
useCommonAlertSchema |
boolean |
False |
Ortak uyarı şemasının kullanılıp kullanılmayacağını gösterir. |
ItsmReceiver
Itsm alıcısı.
Name | Tür | Description |
---|---|---|
connectionId |
string |
Yukarıdaki çalışma alanında tanımlanan birden çok arasında ITSM bağlantısının benzersiz kimliği. |
name |
string |
Itsm alıcısının adı. Adlar, bir eylem grubu içindeki tüm alıcılar arasında benzersiz olmalıdır. |
region |
string |
Çalışma alanının bulunduğu bölge. Desteklenen değerler:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope' |
ticketConfiguration |
string |
ITSM eyleminin yapılandırmaları için JSON blobu. CreateMultipleWorkItems seçeneği de bu blobun bir parçası olacaktır. |
workspaceId |
string |
OMS LA örnek tanımlayıcısı. |
LogicAppReceiver
Mantıksal uygulama alıcısı.
Name | Tür | Varsayılan değer | Description |
---|---|---|---|
callbackUrl |
string |
Http isteğinin gönderildiği geri çağırma URL'si. |
|
name |
string |
Mantıksal uygulama alıcısının adı. Adlar, bir eylem grubu içindeki tüm alıcılar arasında benzersiz olmalıdır. |
|
resourceId |
string |
Mantıksal uygulama alıcısının azure kaynak kimliği. |
|
useCommonAlertSchema |
boolean |
False |
Ortak uyarı şemasının kullanılıp kullanılmayacağını gösterir. |
NotificationRequestBody
Kişi ayrıntısı meta verilerini içeren istek gövdesi
Name | Tür | Description |
---|---|---|
alertType |
string |
Desteklenen uyarı türünün değeri. Desteklenen uyarı türü değerleri şunlardır: servicehealth, metricstaticthreshold, metricsdynamicthreshold, logalertv2, smartalert, webtestalert, logalertv1numresult, logalertv1metricmeasurement, resourcehealth, activitylog, actualcostbudget, forecastedbudget |
armRoleReceivers |
Bu eylem grubunun parçası olan ARM rol alıcılarının listesi. Roller Azure RBAC rolleridir ve yalnızca yerleşik roller desteklenir. |
|
automationRunbookReceivers |
Bu eylem grubunun parçası olan AutomationRunbook alıcılarının listesi. |
|
azureAppPushReceivers |
Bu eylem grubunun parçası olan AzureAppPush alıcılarının listesi. |
|
azureFunctionReceivers |
Bu eylem grubunun parçası olan Azure işlev alıcılarının listesi. |
|
emailReceivers |
Bu eylem grubunun parçası olan e-posta alıcılarının listesi. |
|
eventHubReceivers |
Bu eylem grubunun parçası olan olay hub'ı alıcılarının listesi. |
|
itsmReceivers |
Bu eylem grubunun parçası olan ITSM alıcılarının listesi. |
|
logicAppReceivers |
Bu eylem grubunun parçası olan mantıksal uygulama alıcılarının listesi. |
|
smsReceivers |
Bu eylem grubunun parçası olan SMS alıcılarının listesi. |
|
voiceReceivers |
Bu eylem grubunun parçası olan ses alıcılarının listesi. |
|
webhookReceivers |
Bu eylem grubunun parçası olan web kancası alıcılarının listesi. |
ReceiverStatus
Alıcının durumunu gösterir. Etkin olmayan alıcılar herhangi bir iletişim almaz.
Name | Tür | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
|
NotSpecified |
string |
SmsReceiver
SMS alıcısı.
Name | Tür | Description |
---|---|---|
countryCode |
string |
SMS alıcısının ülke kodu. |
name |
string |
SMS alıcısının adı. Adlar, bir eylem grubu içindeki tüm alıcılar arasında benzersiz olmalıdır. |
phoneNumber |
string |
SMS alıcısının telefon numarası. |
status |
Alıcının durumu. |
TestNotificationDetailsResponse
Test bildirimi sonuçlarının ayrıntıları.
Name | Tür | Description |
---|---|---|
actionDetails |
Eylem ayrıntısı listesi |
|
completedTime |
string |
Tamamlanan süre |
context |
Bağlam bilgisi |
|
createdTime |
string |
Oluşturulan saat |
state |
string |
Genel durum |
VoiceReceiver
Bir ses alıcısı.
Name | Tür | Description |
---|---|---|
countryCode |
string |
Ses alıcısının ülke kodu. |
name |
string |
Ses alıcısının adı. Adlar, bir eylem grubu içindeki tüm alıcılar arasında benzersiz olmalıdır. |
phoneNumber |
string |
Ses alıcısının telefon numarası. |
WebhookReceiver
Web kancası alıcısı.
Name | Tür | Varsayılan değer | Description |
---|---|---|---|
identifierUri |
string |
Aad kimlik doğrulaması için tanımlayıcı uri'sini gösterir. |
|
name |
string |
Web kancası alıcısının adı. Adlar, bir eylem grubu içindeki tüm alıcılar arasında benzersiz olmalıdır. |
|
objectId |
string |
Aad kimlik doğrulaması için web kancası uygulama nesne kimliğini gösterir. |
|
serviceUri |
string |
Web kancalarının gönderilmesi gereken URI. |
|
tenantId |
string |
Aad kimlik doğrulaması için kiracı kimliğini gösterir. |
|
useAadAuth |
boolean |
False |
AAD kimlik doğrulaması kullanılıp kullanılmayacağını gösterir. |
useCommonAlertSchema |
boolean |
False |
Ortak uyarı şemasının kullanılıp kullanılmayacağını gösterir. |