Action Groups - Post Test Notifications

  • Ссылка
Service:
Monitor
API Version:
2021-09-01

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

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

Параметры URI

Name In Required Type Description
subscriptionId
 path True
  • string

Идентификатор целевой подписки.
api-version
 query True
  • string

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

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

Name Required Type Description
alertType True
  • string

Имя поддерживаемого типа оповещения.
armRoleReceivers

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

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

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

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

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

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

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

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

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

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

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

Ответы

Name Type Description
202 Accepted

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

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

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

azure_auth

Flow OAuth2 Azure Active Directory

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

Scopes

Name Description
user_impersonation олицетворения учетной записи пользователя

Примеры

List action groups

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

Sample Response

Status code:
202 
{
  "notificationId": "11000222191287",
  "correlationId": "5000094c-7f6b-49f2-a0ad-c620c65d34b5",
  "createdTime": "2021-09-21T03:05:17+00:00"
}

Определения

ArmRoleReceiver

Приемник роли руки.
AutomationRunbookReceiver

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

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

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

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

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

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

Приемник Itsm.
LogicAppReceiver

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

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

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

Приемник SMS.
TestNotificationResponse

Ответ при успешном выполнении тестового уведомления
VoiceReceiver

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

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

ArmRoleReceiver

Приемник роли руки.

Name Type Default Value Description
name
  • string

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

Идентификатор роли руки.
useCommonAlertSchema
  • boolean
False

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

AutomationRunbookReceiver

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

Name Type Default Value Description
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.

Name Type Description
emailAddress
  • string

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

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

AzureFunctionReceiver

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

Name Type Default Value Description
functionAppResourceId
  • string

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

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

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

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

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

EmailReceiver

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

Name Type Default Value Description
emailAddress
  • string

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

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

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

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

ErrorResponse

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

Name Type Description
code
  • string

Код ошибки
message
  • string

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

EventHubReceiver

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

Name Type Default Value Description
eventHubName
  • string

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

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

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

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

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

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

ItsmReceiver

Приемник Itsm.

Name Type Description
connectionId
  • string

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

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

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

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

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

LogicAppReceiver

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

Name Type Default Value Description
callbackUrl
  • string

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

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

Идентификатор ресурса Azure приемника приложения логики.
useCommonAlertSchema
  • boolean
False

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

NotificationRequestBody

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

Name Type Description
alertType
  • string

Имя поддерживаемого типа оповещения.
armRoleReceivers

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

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

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

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

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

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

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

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

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

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

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

ReceiverStatus

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

Name Type Description
Disabled
  • string
Enabled
  • string
NotSpecified
  • string

SmsReceiver

Приемник SMS.

Name Type Description
countryCode
  • string

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

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

Номер телефона SMS приемника.
status

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

TestNotificationResponse

Ответ при успешном выполнении тестового уведомления

Name Type Description
correlationId
  • string

Идентификатор корреляции
createdTime
  • string

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

Идентификатор уведомления

VoiceReceiver

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

Name Type Description
countryCode
  • string

Код страны приемника голосовой связи.
name
  • string

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

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

WebhookReceiver

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

Name Type Default Value Description
identifierUri
  • string

Указывает универсальный код ресурса (URI) идентификатора для проверки подлинности aad.
name
  • string

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

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

URI, в котором должны отправляться веб-перехватчики.
tenantId
  • string

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

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

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