Action Groups - Post Test Notifications
Wysyłanie powiadomień testowych do zestawu podanych odbiorników
POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Insights/createNotifications?api-version=2021-09-01
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
subscription
|
path | True |
string |
Identyfikator subskrypcji docelowej. |
api-version
|
query | True |
string |
Wersja interfejsu API do użycia dla tej operacji. |
Treść żądania
Nazwa | Wymagane | Typ | Opis |
---|---|---|---|
alertType | True |
string |
Wartość obsługiwanego typu alertu. Obsługiwane wartości typów alertów to: servicehealth, metricstaticthreshold, metricsdynamicthreshold, logalertv2, smartalert, webtestalert, logalertv1numresult, logalertv1metricmeasurement, resourcehealth, activitylog, actualcostbudget, forecastedbudget |
armRoleReceivers |
Lista odbiorników ról usługi ARM, które są częścią tej grupy akcji. Role to role RBAC platformy Azure i obsługiwane są tylko role wbudowane. |
||
automationRunbookReceivers |
Lista odbiorników AutomationRunbook, które są częścią tej grupy akcji. |
||
azureAppPushReceivers |
Lista odbiorników usługi AzureAppPush, które są częścią tej grupy akcji. |
||
azureFunctionReceivers |
Lista odbiorników funkcji platformy Azure, które są częścią tej grupy akcji. |
||
emailReceivers |
Lista odbiorców poczty e-mail, które są częścią tej grupy akcji. |
||
eventHubReceivers |
Lista odbiorników centrum zdarzeń, które są częścią tej grupy akcji. |
||
itsmReceivers |
Lista odbiorników ITSM, które są częścią tej grupy akcji. |
||
logicAppReceivers |
Lista odbiorników aplikacji logiki, które są częścią tej grupy akcji. |
||
smsReceivers |
Lista odbiorników programu SMS, które są częścią tej grupy akcji. |
||
voiceReceivers |
Lista odbiorników głosowych, które są częścią tej grupy akcji. |
||
webhookReceivers |
Lista odbiorników elementów webhook będących częścią tej grupy akcji. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
Powiadomienie powiodło się |
|
202 Accepted |
Zaakceptowano żądanie powiadomienia Nagłówki location: string |
|
Other Status Codes |
Wystąpił błąd podczas wysyłania powiadomień testowych |
Zabezpieczenia
azure_auth
Przepływ OAuth2 usługi Azure Active Directory
Typ:
oauth2
Flow:
implicit
Adres URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/authorize
Zakresy
Nazwa | Opis |
---|---|
user_impersonation | personifikacja konta użytkownika |
Przykłady
Create notifications at subscription level
Przykładowe żądanie
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
}
]
}
Przykładowa odpowiedź
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
}
]
}
Definicje
Nazwa | Opis |
---|---|
Action |
Szczegóły akcji |
Arm |
Odbiornik roli arm. |
Automation |
Odbiornik powiadomień elementu Runbook Azure Automation. |
Azure |
Odbiornik powiadomień wypychanych aplikacji mobilnych platformy Azure. |
Azure |
Odbiornik funkcji platformy Azure. |
Context |
Informacje kontekstowe |
Email |
Odbiorca wiadomości e-mail. |
Error |
Opisuje format odpowiedzi Błąd. |
Event |
Odbiornik centrum zdarzeń. |
Itsm |
Odbiornik Itsm. |
Logic |
Odbiornik aplikacji logiki. |
Notification |
Treść żądania zawierająca metadane szczegółów kontaktu |
Receiver |
Wskazuje stan odbiornika. Odbiorniki, które nie są włączone, nie będą otrzymywać żadnej komunikacji. |
Sms |
Odbiornik SMS. |
Test |
Szczegóły wyników powiadomienia testowego. |
Voice |
Odbiornik głosowy. |
Webhook |
Odbiornik elementu webhook. |
ActionDetail
Szczegóły akcji
Nazwa | Typ | Opis |
---|---|---|
Detail |
string |
Szczegóły przyjaznego komunikatu o błędzie |
MechanismType |
string |
Typ mechanizmu |
Name |
string |
Nazwa akcji |
SendTime |
string |
Czas wysyłania |
Status |
string |
Stan akcji |
SubState |
string |
Podstatu akcji |
ArmRoleReceiver
Odbiornik roli arm.
Nazwa | Typ | Domyślna wartość | Opis |
---|---|---|---|
name |
string |
Nazwa odbiornika roli arm. Nazwy muszą być unikatowe we wszystkich odbiornikach w grupie akcji. |
|
roleId |
string |
Identyfikator roli arm. |
|
useCommonAlertSchema |
boolean |
False |
Wskazuje, czy używać wspólnego schematu alertów. |
AutomationRunbookReceiver
Odbiornik powiadomień elementu Runbook Azure Automation.
Nazwa | Typ | Domyślna wartość | Opis |
---|---|---|---|
automationAccountId |
string |
Identyfikator konta usługi Azure Automation, który przechowuje ten element Runbook i uwierzytelnia się w zasobie platformy Azure. |
|
isGlobalRunbook |
boolean |
Wskazuje, czy to wystąpienie jest globalnym elementem Runbook. |
|
name |
string |
Wskazuje nazwę elementu webhook. |
|
runbookName |
string |
Nazwa tego elementu Runbook. |
|
serviceUri |
string |
Identyfikator URI, w którym powinny być wysyłane elementy webhook. |
|
useCommonAlertSchema |
boolean |
False |
Wskazuje, czy używać wspólnego schematu alertów. |
webhookResourceId |
string |
Identyfikator zasobu elementu webhook połączony z tym elementem Runbook. |
AzureAppPushReceiver
Odbiornik powiadomień wypychanych aplikacji mobilnych platformy Azure.
Nazwa | Typ | Opis |
---|---|---|
emailAddress |
string |
Adres e-mail zarejestrowany dla aplikacji mobilnej platformy Azure. |
name |
string |
Nazwa odbiornika wypychania aplikacji mobilnej platformy Azure. Nazwy muszą być unikatowe we wszystkich odbiornikach w grupie akcji. |
AzureFunctionReceiver
Odbiornik funkcji platformy Azure.
Nazwa | Typ | Domyślna wartość | Opis |
---|---|---|---|
functionAppResourceId |
string |
Identyfikator zasobu platformy Azure aplikacji funkcji. |
|
functionName |
string |
Nazwa funkcji w aplikacji funkcji. |
|
httpTriggerUrl |
string |
Adres URL wyzwalacza HTTP, do którego wysłano żądanie HTTP. |
|
name |
string |
Nazwa odbiornika funkcji platformy Azure. Nazwy muszą być unikatowe we wszystkich odbiornikach w grupie akcji. |
|
useCommonAlertSchema |
boolean |
False |
Wskazuje, czy używać wspólnego schematu alertów. |
Context
Informacje kontekstowe
Nazwa | Typ | Opis |
---|---|---|
contextType |
string |
Typ identyfikatora kontekstu |
notificationSource |
string |
Źródło żądania powiadomienia |
EmailReceiver
Odbiorca wiadomości e-mail.
Nazwa | Typ | Domyślna wartość | Opis |
---|---|---|---|
emailAddress |
string |
Adres e-mail tego odbiorcy. |
|
name |
string |
Nazwa odbiorcy poczty e-mail. Nazwy muszą być unikatowe we wszystkich odbiornikach w grupie akcji. |
|
status |
Stan odbiorcy wiadomości e-mail. |
||
useCommonAlertSchema |
boolean |
False |
Wskazuje, czy używać wspólnego schematu alertów. |
ErrorResponse
Opisuje format odpowiedzi Błąd.
Nazwa | Typ | Opis |
---|---|---|
code |
string |
Kod błędu |
message |
string |
Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się. |
EventHubReceiver
Odbiornik centrum zdarzeń.
Nazwa | Typ | Domyślna wartość | Opis |
---|---|---|---|
eventHubName |
string |
Nazwa określonej kolejki centrum zdarzeń |
|
eventHubNameSpace |
string |
Przestrzeń nazw centrum zdarzeń |
|
name |
string |
Nazwa odbiorcy centrum zdarzeń. Nazwy muszą być unikatowe we wszystkich odbiornikach w grupie akcji. |
|
subscriptionId |
string |
Identyfikator subskrypcji zawierającej to centrum zdarzeń |
|
tenantId |
string |
Identyfikator dzierżawy subskrypcji zawierającej to centrum zdarzeń |
|
useCommonAlertSchema |
boolean |
False |
Wskazuje, czy używać wspólnego schematu alertów. |
ItsmReceiver
Odbiornik Itsm.
Nazwa | Typ | Opis |
---|---|---|
connectionId |
string |
Unikatowa identyfikacja połączenia ITSM między wieloma zdefiniowanymi w powyższym obszarze roboczym. |
name |
string |
Nazwa odbiornika Itsm. Nazwy muszą być unikatowe we wszystkich odbiornikach w grupie akcji. |
region |
string |
Region, w którym znajduje się obszar roboczy. Obsługiwane wartości:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope' |
ticketConfiguration |
string |
Obiekt blob JSON dla konfiguracji akcji ITSM. Opcja CreateMultipleWorkItems będzie również częścią tego obiektu blob. |
workspaceId |
string |
Identyfikator wystąpienia usługi OMS LA. |
LogicAppReceiver
Odbiornik aplikacji logiki.
Nazwa | Typ | Domyślna wartość | Opis |
---|---|---|---|
callbackUrl |
string |
Adres URL wywołania zwrotnego, do którego wysłano żądanie HTTP. |
|
name |
string |
Nazwa odbiornika aplikacji logiki. Nazwy muszą być unikatowe we wszystkich odbiornikach w grupie akcji. |
|
resourceId |
string |
Identyfikator zasobu platformy Azure odbiorcy aplikacji logiki. |
|
useCommonAlertSchema |
boolean |
False |
Wskazuje, czy używać wspólnego schematu alertów. |
NotificationRequestBody
Treść żądania zawierająca metadane szczegółów kontaktu
Nazwa | Typ | Opis |
---|---|---|
alertType |
string |
Wartość obsługiwanego typu alertu. Obsługiwane wartości typów alertów to: servicehealth, metricstaticthreshold, metricsdynamicthreshold, logalertv2, smartalert, webtestalert, logalertv1numresult, logalertv1metricmeasurement, resourcehealth, activitylog, actualcostbudget, forecastedbudget |
armRoleReceivers |
Lista odbiorników ról usługi ARM, które są częścią tej grupy akcji. Role to role RBAC platformy Azure i obsługiwane są tylko role wbudowane. |
|
automationRunbookReceivers |
Lista odbiorników AutomationRunbook, które są częścią tej grupy akcji. |
|
azureAppPushReceivers |
Lista odbiorników usługi AzureAppPush, które są częścią tej grupy akcji. |
|
azureFunctionReceivers |
Lista odbiorników funkcji platformy Azure, które są częścią tej grupy akcji. |
|
emailReceivers |
Lista odbiorców poczty e-mail, które są częścią tej grupy akcji. |
|
eventHubReceivers |
Lista odbiorników centrum zdarzeń, które są częścią tej grupy akcji. |
|
itsmReceivers |
Lista odbiorników ITSM, które są częścią tej grupy akcji. |
|
logicAppReceivers |
Lista odbiorników aplikacji logiki, które są częścią tej grupy akcji. |
|
smsReceivers |
Lista odbiorników programu SMS, które są częścią tej grupy akcji. |
|
voiceReceivers |
Lista odbiorników głosowych, które są częścią tej grupy akcji. |
|
webhookReceivers |
Lista odbiorników elementów webhook, które są częścią tej grupy akcji. |
ReceiverStatus
Wskazuje stan odbiornika. Odbiorniki, które nie są włączone, nie będą otrzymywać żadnej komunikacji.
Nazwa | Typ | Opis |
---|---|---|
Disabled |
string |
|
Enabled |
string |
|
NotSpecified |
string |
SmsReceiver
Odbiornik SMS.
Nazwa | Typ | Opis |
---|---|---|
countryCode |
string |
Kod kraju odbiorcy wiadomości SMS. |
name |
string |
Nazwa odbiornika programu SMS. Nazwy muszą być unikatowe we wszystkich odbiornikach w grupie akcji. |
phoneNumber |
string |
Numer telefonu odbiorcy wiadomości SMS. |
status |
Stan odbiornika. |
TestNotificationDetailsResponse
Szczegóły wyników powiadomienia testowego.
Nazwa | Typ | Opis |
---|---|---|
actionDetails |
Lista szczegółów akcji |
|
completedTime |
string |
Ukończony czas |
context |
Informacje kontekstowe |
|
createdTime |
string |
Czas utworzenia |
state |
string |
Ogólny stan |
VoiceReceiver
Odbiornik głosowy.
Nazwa | Typ | Opis |
---|---|---|
countryCode |
string |
Kod kraju odbiornika głosowego. |
name |
string |
Nazwa odbiornika głosowego. Nazwy muszą być unikatowe we wszystkich odbiornikach w grupie akcji. |
phoneNumber |
string |
Numer telefonu odbiornika głosowego. |
WebhookReceiver
Odbiornik elementu webhook.
Nazwa | Typ | Domyślna wartość | Opis |
---|---|---|---|
identifierUri |
string |
Wskazuje identyfikator URI dla uwierzytelniania usługi aad. |
|
name |
string |
Nazwa odbiornika elementu webhook. Nazwy muszą być unikatowe we wszystkich odbiornikach w grupie akcji. |
|
objectId |
string |
Wskazuje identyfikator obiektu aplikacji elementu webhook dla uwierzytelniania usługi aad. |
|
serviceUri |
string |
Identyfikator URI, w którym powinny być wysyłane elementy webhook. |
|
tenantId |
string |
Wskazuje identyfikator dzierżawy dla uwierzytelniania usługi aad. |
|
useAadAuth |
boolean |
False |
Wskazuje, czy używać uwierzytelniania usługi AAD. |
useCommonAlertSchema |
boolean |
False |
Wskazuje, czy używać wspólnego schematu alertów. |