Action Groups - Post Test Notifications

Odesílání testovacích oznámení sadě zadaných příjemců

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Insights/createNotifications?api-version=2021-09-01

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
subscriptionId
path True

string

ID cílového předplatného.

api-version
query True

string

Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name Vyžadováno Typ Description
alertType True

string

Hodnota podporovaného typu upozornění. Podporované hodnoty typu upozornění jsou: servicehealth, metricstaticthreshold, metricsdynamicthreshold, logalertv2, smartalert, webtestalert, logalertv1numresult, logalertv1metricmeasurement, resourcehealth, activitylog, actualcostbudget, forecastedbudget

armRoleReceivers

ArmRoleReceiver[]

Seznam příjemců rolí ARM, kteří jsou součástí této skupiny akcí. Role jsou role Azure RBAC a podporují se jenom předdefinované role.

automationRunbookReceivers

AutomationRunbookReceiver[]

Seznam příjemců AutomationRunbook, kteří jsou součástí této skupiny akcí.

azureAppPushReceivers

AzureAppPushReceiver[]

Seznam příjemců AzureAppPush, které jsou součástí této skupiny akcí.

azureFunctionReceivers

AzureFunctionReceiver[]

Seznam příjemců funkcí Azure, které jsou součástí této skupiny akcí.

emailReceivers

EmailReceiver[]

Seznam příjemců e-mailů, kteří jsou součástí této skupiny akcí.

eventHubReceivers

EventHubReceiver[]

Seznam příjemců centra událostí, kteří jsou součástí této skupiny akcí.

itsmReceivers

ItsmReceiver[]

Seznam příjemců ITSM, kteří jsou součástí této skupiny akcí.

logicAppReceivers

LogicAppReceiver[]

Seznam příjemců aplikace logiky, kteří jsou součástí této skupiny akcí.

smsReceivers

SmsReceiver[]

Seznam příjemců SMS, kteří jsou součástí této skupiny akcí.

voiceReceivers

VoiceReceiver[]

Seznam hlasových přijímačů, které jsou součástí této skupiny akcí.

webhookReceivers

WebhookReceiver[]

Seznam příjemců webhooku, kteří jsou součástí této skupiny akcí.

Odpovědi

Name Typ Description
200 OK

TestNotificationDetailsResponse

Oznámení bylo úspěšné.

202 Accepted

Žádost o oznámení byla přijata.

Headers

location: string

Other Status Codes

ErrorResponse

Při odesílání testovacích oznámení došlo k chybě.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

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
    }
  ]
}

Definice

Name Description
ActionDetail

Podrobnosti o akci

ArmRoleReceiver

Přijímač role arm.

AutomationRunbookReceiver

Příjemce oznámení runbooku Azure Automation.

AzureAppPushReceiver

Příjemce nabízených oznámení mobilní aplikace Azure

AzureFunctionReceiver

Přijímač funkce Azure.

Context

Kontextové informace

EmailReceiver

Příjemce e-mailu.

ErrorResponse

Popisuje formát chybové odpovědi.

EventHubReceiver

Příjemce centra událostí.

ItsmReceiver

Přijímač itsm.

LogicAppReceiver

Příjemce aplikace logiky.

NotificationRequestBody

Text požadavku, který obsahuje metadata podrobností o kontaktu

ReceiverStatus

Označuje stav příjemce. Příjemci, kteří nejsou povoleni, nebudou dostávat žádnou komunikaci.

SmsReceiver

Příjemce SMS.

TestNotificationDetailsResponse

Podrobnosti o výsledcích oznámení testu

VoiceReceiver

Hlasový přijímač.

WebhookReceiver

Přijímač webhooku.

ActionDetail

Podrobnosti o akci

Name Typ Description
Detail

string

Podrobnosti popisné chybové zprávy

MechanismType

string

Typ mechanismu

Name

string

Název akce

SendTime

string

Čas odeslání

Status

string

Stav akce

SubState

string

Dílčí stav akce

ArmRoleReceiver

Přijímač role arm.

Name Typ Výchozí hodnota Description
name

string

Název příjemce role arm. Názvy musí být jedinečné pro všechny příjemce v rámci skupiny akcí.

roleId

string

ID role arm.

useCommonAlertSchema

boolean

False

Určuje, jestli se má použít běžné schéma upozornění.

AutomationRunbookReceiver

Příjemce oznámení runbooku Azure Automation.

Name Typ Výchozí hodnota Description
automationAccountId

string

ID účtu Azure Automation, který obsahuje tento runbook a ověřuje se pro prostředek Azure.

isGlobalRunbook

boolean

Určuje, jestli je tato instance globální runbook.

name

string

Označuje název webhooku.

runbookName

string

Název tohoto runbooku.

serviceUri

string

Identifikátor URI, kam se mají odesílat webhooky.

useCommonAlertSchema

boolean

False

Určuje, jestli se má použít běžné schéma upozornění.

webhookResourceId

string

ID prostředku webhooku propojeného s tímto runbookem

AzureAppPushReceiver

Příjemce nabízených oznámení mobilní aplikace Azure

Name Typ Description
emailAddress

string

E-mailová adresa zaregistrovaná pro mobilní aplikaci Azure

name

string

Název nabízeného přijímače mobilní aplikace Azure. Názvy musí být jedinečné pro všechny příjemce v rámci skupiny akcí.

AzureFunctionReceiver

Přijímač funkce Azure.

Name Typ Výchozí hodnota Description
functionAppResourceId

string

ID prostředku Azure aplikace funkcí.

functionName

string

Název funkce v aplikaci funkcí.

httpTriggerUrl

string

Adresa URL triggeru http, kam se požadavek HTTP odeslal.

name

string

Název příjemce funkce Azure. Názvy musí být jedinečné pro všechny příjemce v rámci skupiny akcí.

useCommonAlertSchema

boolean

False

Určuje, jestli se má použít běžné schéma upozornění.

Context

Kontextové informace

Name Typ Description
contextType

string

Typ ID kontextu

notificationSource

string

Zdroj žádosti o oznámení

EmailReceiver

Příjemce e-mailu.

Name Typ Výchozí hodnota Description
emailAddress

string

E-mailová adresa tohoto příjemce.

name

string

Jméno příjemce e-mailu. Názvy musí být jedinečné pro všechny příjemce v rámci skupiny akcí.

status

ReceiverStatus

Stav příjemce e-mailu.

useCommonAlertSchema

boolean

False

Určuje, jestli se má použít běžné schéma upozornění.

ErrorResponse

Popisuje formát chybové odpovědi.

Name Typ Description
code

string

Kód chyby

message

string

Chybová zpráva označující, proč operace selhala.

EventHubReceiver

Příjemce centra událostí.

Name Typ Výchozí hodnota Description
eventHubName

string

Název konkrétní fronty centra událostí

eventHubNameSpace

string

Obor názvů centra událostí

name

string

Název příjemce centra událostí. Názvy musí být jedinečné pro všechny příjemce v rámci skupiny akcí.

subscriptionId

string

ID předplatného obsahujícího toto centrum událostí

tenantId

string

ID tenanta pro předplatné obsahující toto centrum událostí

useCommonAlertSchema

boolean

False

Určuje, jestli se má použít běžné schéma upozornění.

ItsmReceiver

Přijímač itsm.

Name Typ Description
connectionId

string

Jedinečná identifikace připojení ITSM mezi několika definovanými ve výše uvedeném pracovním prostoru.

name

string

Název přijímače Itsm. Názvy musí být jedinečné pro všechny příjemce v rámci skupiny akcí.

region

string

Oblast, ve které se nachází pracovní prostor. Podporované hodnoty: centralindia, japaneast, southeastasia, australiasoutheast, uksouth, westcentralus, canadacentral, eastus, westeurope

ticketConfiguration

string

Objekt blob JSON pro konfiguraci akce ITSM Součástí tohoto objektu blob bude také možnost CreateMultipleWorkItems.

workspaceId

string

Identifikátor instance OMS LA.

LogicAppReceiver

Příjemce aplikace logiky.

Name Typ Výchozí hodnota Description
callbackUrl

string

Adresa URL zpětného volání, kam se požadavek HTTP odeslal.

name

string

Název příjemce aplikace logiky. Názvy musí být jedinečné pro všechny příjemce v rámci skupiny akcí.

resourceId

string

ID prostředku Azure příjemce aplikace logiky

useCommonAlertSchema

boolean

False

Určuje, jestli se má použít běžné schéma upozornění.

NotificationRequestBody

Text požadavku, který obsahuje metadata podrobností o kontaktu

Name Typ Description
alertType

string

Hodnota podporovaného typu upozornění. Podporované hodnoty typu upozornění jsou: servicehealth, metricstaticthreshold, metricsdynamicthreshold, logalertv2, smartalert, webtestalert, logalertv1numresult, logalertv1metricmeasurement, resourcehealth, activitylog, actualcostbudget, forecastedbudget

armRoleReceivers

ArmRoleReceiver[]

Seznam příjemců rolí ARM, kteří jsou součástí této skupiny akcí. Role jsou role Azure RBAC a podporují se jenom předdefinované role.

automationRunbookReceivers

AutomationRunbookReceiver[]

Seznam příjemců AutomationRunbook, kteří jsou součástí této skupiny akcí.

azureAppPushReceivers

AzureAppPushReceiver[]

Seznam příjemců AzureAppPush, které jsou součástí této skupiny akcí.

azureFunctionReceivers

AzureFunctionReceiver[]

Seznam příjemců funkcí Azure, které jsou součástí této skupiny akcí.

emailReceivers

EmailReceiver[]

Seznam příjemců e-mailů, kteří jsou součástí této skupiny akcí.

eventHubReceivers

EventHubReceiver[]

Seznam příjemců centra událostí, kteří jsou součástí této skupiny akcí.

itsmReceivers

ItsmReceiver[]

Seznam příjemců ITSM, kteří jsou součástí této skupiny akcí.

logicAppReceivers

LogicAppReceiver[]

Seznam příjemců aplikace logiky, kteří jsou součástí této skupiny akcí.

smsReceivers

SmsReceiver[]

Seznam příjemců SMS, kteří jsou součástí této skupiny akcí.

voiceReceivers

VoiceReceiver[]

Seznam hlasových přijímačů, které jsou součástí této skupiny akcí.

webhookReceivers

WebhookReceiver[]

Seznam příjemců webhooku, kteří jsou součástí této skupiny akcí.

ReceiverStatus

Označuje stav příjemce. Příjemci, kteří nejsou povoleni, nebudou dostávat žádnou komunikaci.

Name Typ Description
Disabled

string

Enabled

string

NotSpecified

string

SmsReceiver

Příjemce SMS.

Name Typ Description
countryCode

string

Kód země příjemce SMS.

name

string

Název příjemce SMS. Názvy musí být jedinečné pro všechny příjemce v rámci skupiny akcí.

phoneNumber

string

Telefonní číslo příjemce SMS.

status

ReceiverStatus

Stav příjemce.

TestNotificationDetailsResponse

Podrobnosti o výsledcích oznámení testu

Name Typ Description
actionDetails

ActionDetail[]

Seznam podrobností o akci

completedTime

string

Čas dokončení

context

Context

Kontextové informace

createdTime

string

Čas vytvoření

state

string

Celkový stav

VoiceReceiver

Hlasový přijímač.

Name Typ Description
countryCode

string

Kód země přijímače hlasu.

name

string

Název hlasového přijímače. Názvy musí být jedinečné pro všechny příjemce v rámci skupiny akcí.

phoneNumber

string

Telefonní číslo přijímače hlasu.

WebhookReceiver

Přijímač webhooku.

Name Typ Výchozí hodnota Description
identifierUri

string

Označuje identifikátor URI pro ověřování aad.

name

string

Název příjemce webhooku. Názvy musí být jedinečné pro všechny příjemce v rámci skupiny akcí.

objectId

string

Označuje ID objektu aplikace webhooku pro ověřování aad.

serviceUri

string

Identifikátor URI, kam se mají odesílat webhooky.

tenantId

string

Označuje ID tenanta pro ověřování aad.

useAadAuth

boolean

False

Určuje, jestli se používá ověřování AAD.

useCommonAlertSchema

boolean

False

Určuje, jestli se má použít běžné schéma upozornění.