Поделиться через


Action Groups - Post Test Notifications

Отправка тестовых уведомлений набору предоставленных получателей

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

Параметры URI

Имя В Обязательно Тип Описание
subscriptionId
path True

string

Идентификатор целевой подписки.

api-version
query True

string

Версия API, используемая для данной операции.

Текст запроса

Имя Обязательно Тип Описание
alertType True

string

Значение поддерживаемого типа оповещения. Поддерживаемые значения типов оповещений: servicehealth, metricstaticthreshold, metricsdynamicthreshold, logalertv2, smartalert, webtestalert, logalertv1numresult, logalertv1metricmeasurement, resourcehealth, activitylog, actualcostbudget, forecastedbudget

armRoleReceivers

ArmRoleReceiver[]

Список получателей ролей ARM, входящих в эту группу действий. Роли — это роли RBAC Azure, и поддерживаются только встроенные роли.

automationRunbookReceivers

AutomationRunbookReceiver[]

Список приемников AutomationRunbook, входящих в эту группу действий.

azureAppPushReceivers

AzureAppPushReceiver[]

Список получателей AzureAppPush, входящих в эту группу действий.

azureFunctionReceivers

AzureFunctionReceiver[]

Список получателей функций Azure, входящих в эту группу действий.

emailReceivers

EmailReceiver[]

Список получателей электронной почты, входящих в эту группу действий.

eventHubReceivers

EventHubReceiver[]

Список приемников концентраторов событий, входящих в эту группу действий.

itsmReceivers

ItsmReceiver[]

Список получателей ITSM, входящих в эту группу действий.

logicAppReceivers

LogicAppReceiver[]

Список получателей приложений логики, входящих в эту группу действий.

smsReceivers

SmsReceiver[]

Список получателей SMS, входящих в эту группу действий.

voiceReceivers

VoiceReceiver[]

Список голосовых приемников, входящих в эту группу действий.

webhookReceivers

WebhookReceiver[]

Список приемников веб-перехватчиков, входящих в эту группу действий.

Ответы

Имя Тип Описание
200 OK

TestNotificationDetailsResponse

Уведомление выполнено успешно

202 Accepted

Запрос на уведомление принят

Заголовки

location: string

Other Status Codes

ErrorResponse

Ошибка при отправке тестовых уведомлений

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

Create notifications at subscription level

Образец запроса

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": "[email protected]",
      "useCommonAlertSchema": false
    },
    {
      "name": "Jane Smith's email",
      "emailAddress": "[email protected]",
      "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": "[email protected]"
    }
  ],
  "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
    }
  ]
}

Пример ответа

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

Определения

Имя Описание
ActionDetail

Сведения о действии

ArmRoleReceiver

Получатель роли руки.

AutomationRunbookReceiver

Приемник уведомлений Runbook служба автоматизации Azure.

AzureAppPushReceiver

Приемник push-уведомлений мобильного приложения Azure.

AzureFunctionReceiver

Приемник функции Azure.

Context

Сведения о контексте

EmailReceiver

Получатель электронной почты.

ErrorResponse

Описывает формат ответа об ошибке.

EventHubReceiver

Приемник концентратора событий.

ItsmReceiver

Приемник Itsm.

LogicAppReceiver

Приемник приложения логики.

NotificationRequestBody

Текст запроса, содержащий метаданные сведений о контакте

ReceiverStatus

Указывает состояние получателя. Получатели, которые не включены, не будут получать никаких сообщений.

SmsReceiver

Получатель SMS.

TestNotificationDetailsResponse

Сведения о результатах тестового уведомления.

VoiceReceiver

Голосовой приемник.

WebhookReceiver

Приемник веб-перехватчика.

ActionDetail

Сведения о действии

Имя Тип Описание
Detail

string

Сведения о понятном сообщении об ошибке

MechanismType

string

Тип механизма

Name

string

Имя действия

SendTime

string

Время отправки

Status

string

Состояние действия

SubState

string

Подсостояние действия

ArmRoleReceiver

Получатель роли руки.

Имя Тип Default value Описание
name

string

Имя получателя роли руки. Имена должны быть уникальными для всех получателей в группе действий.

roleId

string

Идентификатор роли руки.

useCommonAlertSchema

boolean

False

Указывает, следует ли использовать общую схему оповещений.

AutomationRunbookReceiver

Приемник уведомлений Runbook служба автоматизации Azure.

Имя Тип Default value Описание
automationAccountId

string

Идентификатор учетной записи службы автоматизации Azure, в которой хранится этот модуль Runbook, и выполняется проверка подлинности в ресурсе Azure.

isGlobalRunbook

boolean

Указывает, является ли этот экземпляр глобальным runbook.

name

string

Указывает имя веб-перехватчика.

runbookName

string

Имя этого модуля Runbook.

serviceUri

string

Универсальный код ресурса (URI), по которому должны отправляться веб-перехватчики.

useCommonAlertSchema

boolean

False

Указывает, следует ли использовать общую схему оповещений.

webhookResourceId

string

Идентификатор ресурса для веб-перехватчика, связанного с этим модулю Runbook.

AzureAppPushReceiver

Приемник push-уведомлений мобильного приложения Azure.

Имя Тип Описание
emailAddress

string

Адрес электронной почты, зарегистрированный для мобильного приложения Azure.

name

string

Имя получателя push-уведомлений мобильного приложения Azure. Имена должны быть уникальными для всех получателей в группе действий.

AzureFunctionReceiver

Приемник функции Azure.

Имя Тип Default value Описание
functionAppResourceId

string

Идентификатор ресурса Azure приложения-функции.

functionName

string

Имя функции в приложении-функции.

httpTriggerUrl

string

URL-адрес триггера HTTP, куда отправляется HTTP-запрос.

name

string

Имя приемника функции Azure. Имена должны быть уникальными для всех получателей в группе действий.

useCommonAlertSchema

boolean

False

Указывает, следует ли использовать общую схему оповещений.

Context

Сведения о контексте

Имя Тип Описание
contextType

string

Тип идентификатора контекста

notificationSource

string

Источник запроса уведомления

EmailReceiver

Получатель электронной почты.

Имя Тип Default value Описание
emailAddress

string

Адрес электронной почты этого получателя.

name

string

Имя получателя электронной почты. Имена должны быть уникальными для всех получателей в группе действий.

status

ReceiverStatus

Состояние получателя сообщения электронной почты.

useCommonAlertSchema

boolean

False

Указывает, следует ли использовать общую схему оповещений.

ErrorResponse

Описывает формат ответа об ошибке.

Имя Тип Описание
code

string

Код ошибки

message

string

Сообщение об ошибке, указывающее, почему операция завершилась сбоем.

EventHubReceiver

Приемник концентратора событий.

Имя Тип Default value Описание
eventHubName

string

Имя конкретной очереди концентратора событий

eventHubNameSpace

string

Пространство имен концентратора событий

name

string

Имя приемника концентратора событий. Имена должны быть уникальными для всех получателей в группе действий.

subscriptionId

string

Идентификатор подписки, содержащей этот концентратор событий.

tenantId

string

Идентификатор клиента для подписки, содержащей этот концентратор событий.

useCommonAlertSchema

boolean

False

Указывает, следует ли использовать общую схему оповещений.

ItsmReceiver

Приемник Itsm.

Имя Тип Описание
connectionId

string

Уникальная идентификация подключения ITSM между несколькими элементами, определенными в приведенной выше рабочей области.

name

string

Имя приемника Itsm. Имена должны быть уникальными для всех получателей в группе действий.

region

string

Регион, в котором находится рабочая область. Поддерживаемые значения:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'

ticketConfiguration

string

Большой двоичный объект JSON для конфигураций действия ITSM. Параметр CreateMultipleWorkItems также будет частью этого большого двоичного объекта.

workspaceId

string

Идентификатор экземпляра OMS LA.

LogicAppReceiver

Приемник приложения логики.

Имя Тип Default value Описание
callbackUrl

string

URL-адрес обратного вызова, куда отправляется HTTP-запрос.

name

string

Имя получателя приложения логики. Имена должны быть уникальными для всех получателей в группе действий.

resourceId

string

Идентификатор ресурса Azure получателя приложения логики.

useCommonAlertSchema

boolean

False

Указывает, следует ли использовать общую схему оповещений.

NotificationRequestBody

Текст запроса, содержащий метаданные сведений о контакте

Имя Тип Описание
alertType

string

Значение поддерживаемого типа оповещения. Поддерживаемые значения типов оповещений: servicehealth, metricstaticthreshold, metricsdynamicthreshold, logalertv2, smartalert, webtestalert, logalertv1numresult, logalertv1metricmeasurement, resourcehealth, activitylog, actualcostbudget, forecastedbudget

armRoleReceivers

ArmRoleReceiver[]

Список получателей ролей ARM, входящих в эту группу действий. Роли — это роли RBAC Azure, и поддерживаются только встроенные роли.

automationRunbookReceivers

AutomationRunbookReceiver[]

Список приемников AutomationRunbook, входящих в эту группу действий.

azureAppPushReceivers

AzureAppPushReceiver[]

Список получателей AzureAppPush, входящих в эту группу действий.

azureFunctionReceivers

AzureFunctionReceiver[]

Список получателей функций Azure, входящих в эту группу действий.

emailReceivers

EmailReceiver[]

Список получателей электронной почты, входящих в эту группу действий.

eventHubReceivers

EventHubReceiver[]

Список приемников концентраторов событий, входящих в эту группу действий.

itsmReceivers

ItsmReceiver[]

Список получателей ITSM, входящих в эту группу действий.

logicAppReceivers

LogicAppReceiver[]

Список получателей приложений логики, входящих в эту группу действий.

smsReceivers

SmsReceiver[]

Список получателей SMS, входящих в эту группу действий.

voiceReceivers

VoiceReceiver[]

Список голосовых приемников, входящих в эту группу действий.

webhookReceivers

WebhookReceiver[]

Список приемников веб-перехватчиков, входящих в эту группу действий.

ReceiverStatus

Указывает состояние получателя. Получатели, которые не включены, не будут получать никаких сообщений.

Имя Тип Описание
Disabled

string

Enabled

string

NotSpecified

string

SmsReceiver

Получатель SMS.

Имя Тип Описание
countryCode

string

Код страны получателя SMS.

name

string

Имя получателя SMS. Имена должны быть уникальными для всех получателей в группе действий.

phoneNumber

string

Номер телефона получателя SMS.

status

ReceiverStatus

Состояние получателя.

TestNotificationDetailsResponse

Сведения о результатах тестового уведомления.

Имя Тип Описание
actionDetails

ActionDetail[]

Список сведений о действии

completedTime

string

Время завершения

context

Context

Сведения о контексте

createdTime

string

Время создания

state

string

Общее состояние

VoiceReceiver

Голосовой приемник.

Имя Тип Описание
countryCode

string

Код страны голосового приемника.

name

string

Имя голосового приемника. Имена должны быть уникальными для всех получателей в группе действий.

phoneNumber

string

Номер телефона голосового приемника.

WebhookReceiver

Приемник веб-перехватчика.

Имя Тип Default value Описание
identifierUri

string

Указывает URI идентификатора для проверки подлинности aad.

name

string

Имя получателя веб-перехватчика. Имена должны быть уникальными для всех получателей в группе действий.

objectId

string

Указывает идентификатор объекта приложения веб-перехватчика для проверки подлинности aad.

serviceUri

string

Универсальный код ресурса (URI), по которому должны отправляться веб-перехватчики.

tenantId

string

Указывает идентификатор клиента для проверки подлинности aad.

useAadAuth

boolean

False

Указывает, используется ли проверка подлинности AAD.

useCommonAlertSchema

boolean

False

Указывает, следует ли использовать общую схему оповещений.