Share via


Action Groups - Post Test Notifications

Envoyer des notifications de test à un ensemble de récepteurs fournis

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

Paramètres URI

Nom Dans Obligatoire Type Description
subscriptionId
path True

string

ID de l’abonnement cible.

api-version
query True

string

Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom Obligatoire Type Description
alertType True

string

Valeur du type d’alerte pris en charge. Les valeurs de type d’alerte prises en charge sont : servicehealth, metricstaticthreshold, metricsdynamicthreshold, logalertv2, smartalert, webtestalert, logalertv1numresult, logalertv1metricmeasurement, resourcehealth, activitylog, actualcostbudget, forecastedbudget

armRoleReceivers

ArmRoleReceiver[]

Liste des récepteurs de rôles ARM qui font partie de ce groupe d’actions. Les rôles sont des rôles RBAC Azure et seuls les rôles intégrés sont pris en charge.

automationRunbookReceivers

AutomationRunbookReceiver[]

Liste des récepteurs AutomationRunbook qui font partie de ce groupe d’actions.

azureAppPushReceivers

AzureAppPushReceiver[]

Liste des récepteurs AzureAppPush qui font partie de ce groupe d’actions.

azureFunctionReceivers

AzureFunctionReceiver[]

Liste des récepteurs de fonction Azure qui font partie de ce groupe d’actions.

emailReceivers

EmailReceiver[]

Liste des destinataires de messagerie qui font partie de ce groupe d’actions.

eventHubReceivers

EventHubReceiver[]

Liste des récepteurs event hub qui font partie de ce groupe d’actions.

itsmReceivers

ItsmReceiver[]

Liste des récepteurs ITSM qui font partie de ce groupe d’actions.

logicAppReceivers

LogicAppReceiver[]

Liste des récepteurs d’application logique qui font partie de ce groupe d’actions.

smsReceivers

SmsReceiver[]

Liste des récepteurs SMS qui font partie de ce groupe d’actions.

voiceReceivers

VoiceReceiver[]

Liste des récepteurs vocaux qui font partie de ce groupe d’actions.

webhookReceivers

WebhookReceiver[]

Liste des récepteurs webhook qui font partie de ce groupe d’actions.

Réponses

Nom Type Description
200 OK

TestNotificationDetailsResponse

La notification a réussi

202 Accepted

Demande de notification acceptée

Headers

location: string

Other Status Codes

ErrorResponse

Une erreur s’est produite lors de l’envoi des notifications de test

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

Scopes

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

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

Définitions

Nom Description
ActionDetail

Détails de l’action

ArmRoleReceiver

Récepteur de rôle arm.

AutomationRunbookReceiver

Récepteur de notification de runbook Azure Automation.

AzureAppPushReceiver

Récepteur de notification Push d’application mobile Azure.

AzureFunctionReceiver

Un récepteur de fonction Azure.

Context

Informations de contexte

EmailReceiver

Un récepteur de courrier électronique.

ErrorResponse

Décrit le format de la réponse d’erreur.

EventHubReceiver

Un récepteur Event Hub.

ItsmReceiver

Récepteur Itsm.

LogicAppReceiver

Récepteur d’application logique.

NotificationRequestBody

Corps de la demande qui contient les métadonnées des détails du contact

ReceiverStatus

Indique le status du récepteur. Les récepteurs qui ne sont pas activés ne recevront aucune communication.

SmsReceiver

Un récepteur SMS.

TestNotificationDetailsResponse

Détails des résultats des notifications de test.

VoiceReceiver

Un récepteur vocal.

WebhookReceiver

Un récepteur webhook.

ActionDetail

Détails de l’action

Nom Type Description
Detail

string

Détails du message d’erreur convivial

MechanismType

string

Type de mécanisme

Name

string

Nom de l’action

SendTime

string

Heure d’envoi

Status

string

La status de l’action

SubState

string

Sous-état de l’action

ArmRoleReceiver

Récepteur de rôle arm.

Nom Type Valeur par défaut Description
name

string

Nom du récepteur de rôle arm. Les noms doivent être uniques dans tous les récepteurs au sein d’un groupe d’actions.

roleId

string

ID de rôle arm.

useCommonAlertSchema

boolean

False

Indique s’il faut utiliser le schéma d’alerte commun.

AutomationRunbookReceiver

Récepteur de notification de runbook Azure Automation.

Nom Type Valeur par défaut Description
automationAccountId

string

ID de compte Azure Automation qui contient ce runbook et s’authentifie auprès de la ressource Azure.

isGlobalRunbook

boolean

Indique si ce instance est un runbook global.

name

string

Indique le nom du webhook.

runbookName

string

Nom de ce runbook.

serviceUri

string

URI où les webhooks doivent être envoyés.

useCommonAlertSchema

boolean

False

Indique s’il faut utiliser le schéma d’alerte commun.

webhookResourceId

string

ID de ressource pour le webhook lié à ce runbook.

AzureAppPushReceiver

Récepteur de notification Push d’application mobile Azure.

Nom Type Description
emailAddress

string

Adresse e-mail inscrite pour l’application mobile Azure.

name

string

Nom du récepteur Push de l’application mobile Azure. Les noms doivent être uniques dans tous les récepteurs au sein d’un groupe d’actions.

AzureFunctionReceiver

Un récepteur de fonction Azure.

Nom Type Valeur par défaut Description
functionAppResourceId

string

ID de ressource Azure de l’application de fonction.

functionName

string

Nom de la fonction dans l’application de fonction.

httpTriggerUrl

string

URL du déclencheur HTTP à laquelle la requête http a été envoyée.

name

string

Nom du récepteur de fonction Azure. Les noms doivent être uniques dans tous les récepteurs au sein d’un groupe d’actions.

useCommonAlertSchema

boolean

False

Indique s’il faut utiliser le schéma d’alerte commun.

Context

Informations de contexte

Nom Type Description
contextType

string

Type d’ID de contexte

notificationSource

string

Source de la demande de notification

EmailReceiver

Un récepteur de courrier électronique.

Nom Type Valeur par défaut Description
emailAddress

string

Adresse e-mail de ce récepteur.

name

string

Nom du destinataire de l’e-mail. Les noms doivent être uniques dans tous les récepteurs au sein d’un groupe d’actions.

status

ReceiverStatus

Le destinataire status de l’e-mail.

useCommonAlertSchema

boolean

False

Indique s’il faut utiliser le schéma d’alerte commun.

ErrorResponse

Décrit le format de la réponse d’erreur.

Nom Type Description
code

string

Code d'erreur

message

string

Message d’erreur indiquant la raison de l’échec de l’opération.

EventHubReceiver

Un récepteur Event Hub.

Nom Type Valeur par défaut Description
eventHubName

string

Nom de la file d’attente Event Hub spécifique

eventHubNameSpace

string

Espace de noms Event Hub

name

string

Nom du récepteur Event Hub. Les noms doivent être uniques dans tous les récepteurs au sein d’un groupe d’actions.

subscriptionId

string

ID de l’abonnement contenant ce hub d’événements

tenantId

string

ID de locataire de l’abonnement contenant ce hub d’événements

useCommonAlertSchema

boolean

False

Indique s’il faut utiliser le schéma d’alerte commun.

ItsmReceiver

Récepteur Itsm.

Nom Type Description
connectionId

string

Identification unique de la connexion ITSM parmi les multiples définis dans l’espace de travail ci-dessus.

name

string

Nom du récepteur Itsm. Les noms doivent être uniques dans tous les récepteurs au sein d’un groupe d’actions.

region

string

Région dans laquelle réside l’espace de travail. Valeurs prises en charge :'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'

ticketConfiguration

string

Objet blob JSON pour les configurations de l’action ITSM. L’option CreateMultipleWorkItems fait également partie de cet objet blob.

workspaceId

string

Identificateur de instance OMS LA.

LogicAppReceiver

Récepteur d’application logique.

Nom Type Valeur par défaut Description
callbackUrl

string

URL de rappel à laquelle la requête http a été envoyée.

name

string

Nom du récepteur d’application logique. Les noms doivent être uniques dans tous les récepteurs au sein d’un groupe d’actions.

resourceId

string

ID de ressource Azure du récepteur d’application logique.

useCommonAlertSchema

boolean

False

Indique s’il faut utiliser le schéma d’alerte commun.

NotificationRequestBody

Corps de la demande qui contient les métadonnées des détails du contact

Nom Type Description
alertType

string

Valeur du type d’alerte pris en charge. Les valeurs de type d’alerte prises en charge sont : servicehealth, metricstaticthreshold, metricsdynamicthreshold, logalertv2, smartalert, webtestalert, logalertv1numresult, logalertv1metricmeasurement, resourcehealth, activitylog, actualcostbudget, forecastedbudget

armRoleReceivers

ArmRoleReceiver[]

Liste des récepteurs de rôles ARM qui font partie de ce groupe d’actions. Les rôles sont des rôles RBAC Azure et seuls les rôles intégrés sont pris en charge.

automationRunbookReceivers

AutomationRunbookReceiver[]

Liste des récepteurs AutomationRunbook qui font partie de ce groupe d’actions.

azureAppPushReceivers

AzureAppPushReceiver[]

Liste des récepteurs AzureAppPush qui font partie de ce groupe d’actions.

azureFunctionReceivers

AzureFunctionReceiver[]

Liste des récepteurs de fonction Azure qui font partie de ce groupe d’actions.

emailReceivers

EmailReceiver[]

Liste des destinataires de messagerie qui font partie de ce groupe d’actions.

eventHubReceivers

EventHubReceiver[]

Liste des récepteurs event hub qui font partie de ce groupe d’actions.

itsmReceivers

ItsmReceiver[]

Liste des récepteurs ITSM qui font partie de ce groupe d’actions.

logicAppReceivers

LogicAppReceiver[]

Liste des récepteurs d’application logique qui font partie de ce groupe d’actions.

smsReceivers

SmsReceiver[]

Liste des récepteurs SMS qui font partie de ce groupe d’actions.

voiceReceivers

VoiceReceiver[]

Liste des récepteurs vocaux qui font partie de ce groupe d’actions.

webhookReceivers

WebhookReceiver[]

Liste des récepteurs webhook qui font partie de ce groupe d’actions.

ReceiverStatus

Indique le status du récepteur. Les récepteurs qui ne sont pas activés ne recevront aucune communication.

Nom Type Description
Disabled

string

Enabled

string

NotSpecified

string

SmsReceiver

Un récepteur SMS.

Nom Type Description
countryCode

string

Code de pays du destinataire SMS.

name

string

Nom du récepteur SMS. Les noms doivent être uniques dans tous les récepteurs au sein d’un groupe d’actions.

phoneNumber

string

Numéro de téléphone du récepteur SMS.

status

ReceiverStatus

Status du récepteur.

TestNotificationDetailsResponse

Détails des résultats des notifications de test.

Nom Type Description
actionDetails

ActionDetail[]

Liste des détails de l’action

completedTime

string

Heure d’achèvement

context

Context

Informations de contexte

createdTime

string

Heure de création

state

string

État global

VoiceReceiver

Un récepteur vocal.

Nom Type Description
countryCode

string

L’indicatif de pays du récepteur vocal.

name

string

Nom du récepteur vocal. Les noms doivent être uniques dans tous les récepteurs au sein d’un groupe d’actions.

phoneNumber

string

Numéro de téléphone du récepteur vocal.

WebhookReceiver

Un récepteur webhook.

Nom Type Valeur par défaut Description
identifierUri

string

Indique l’URI d’identificateur pour l’authentification aad.

name

string

Nom du récepteur de webhook. Les noms doivent être uniques dans tous les récepteurs au sein d’un groupe d’actions.

objectId

string

Indique l’ID d’objet de l’application webhook pour l’authentification aad.

serviceUri

string

URI où les webhooks doivent être envoyés.

tenantId

string

Indique l’ID de locataire pour l’authentification aad.

useAadAuth

boolean

False

Indique si l’authentification AAD est utilisée ou non.

useCommonAlertSchema

boolean

False

Indique s’il faut utiliser le schéma d’alerte commun.