Freigeben über


Action Groups - Create Notifications At Resource Group Level

Senden von Testbenachrichtigungen an eine Reihe von bereitgestellten Empfängern

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
resourceGroupName
path True

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

subscriptionId
path True

string

Hierbei handelt es sich um die ID des Zielabonnements.

api-version
query True

string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name Erforderlich Typ Beschreibung
alertType True

string

Der Wert des unterstützten Warnungstyps. Unterstützte Warnungstypwerte sind: servicehealth, metricstaticthreshold, metricsdynamicthreshold, logalertv2, smartalert, webtestalert, logalertv1numresult, logalertv1metricmeasurement, resourcehealth, activitylog, actualcostbudget, forecastedbudget

armRoleReceivers

ArmRoleReceiver[]

Die Liste der ARM-Rollenempfänger, die Teil dieser Aktionsgruppe sind. Rollen sind Azure RBAC-Rollen, und nur integrierte Rollen werden unterstützt.

automationRunbookReceivers

AutomationRunbookReceiver[]

Die Liste der AutomationRunbook-Empfänger, die Teil dieser Aktionsgruppe sind.

azureAppPushReceivers

AzureAppPushReceiver[]

Die Liste der AzureAppPush-Empfänger, die Teil dieser Aktionsgruppe sind.

azureFunctionReceivers

AzureFunctionReceiver[]

Die Liste der Azure-Funktionsempfänger, die Teil dieser Aktionsgruppe sind.

emailReceivers

EmailReceiver[]

Die Liste der E-Mail-Empfänger, die Teil dieser Aktionsgruppe sind.

eventHubReceivers

EventHubReceiver[]

Die Liste der Event Hub-Empfänger, die Teil dieser Aktionsgruppe sind.

itsmReceivers

ItsmReceiver[]

Die Liste der ITSM-Empfänger, die Teil dieser Aktionsgruppe sind.

logicAppReceivers

LogicAppReceiver[]

Die Liste der Logik-App-Empfänger, die Teil dieser Aktionsgruppe sind.

smsReceivers

SmsReceiver[]

Die Liste der SMS-Empfänger, die Teil dieser Aktionsgruppe sind.

voiceReceivers

VoiceReceiver[]

Die Liste der Sprachempfänger, die Teil dieser Aktionsgruppe sind.

webhookReceivers

WebhookReceiver[]

Die Liste der Webhookempfänger, die Teil dieser Aktionsgruppe sind.

Antworten

Name Typ Beschreibung
200 OK

TestNotificationDetailsResponse

Die Benachrichtigung war erfolgreich.

202 Accepted

Die akzeptierte Benachrichtigungsanforderung

Header

location: string

Other Status Codes

ErrorResponse

Fehler beim Senden der Testbenachrichtigungen

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

Create notifications at resource group level

Beispielanforderung

POST https://management.azure.com/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/Default-TestNotifications/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
    }
  ]
}

Beispiel für eine Antwort

location: https://management.azure.com/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/Test-Rg/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
    }
  ]
}

Definitionen

Name Beschreibung
ActionDetail

Aktionsdetails

ArmRoleReceiver

Ein Armrollenempfänger.

AutomationRunbookReceiver

Der Azure Automation Runbook-Benachrichtigungsempfänger.

AzureAppPushReceiver

Der Azure Mobile App-Pushbenachrichtigungsempfänger.

AzureFunctionReceiver

Ein Azure-Funktionsempfänger.

Context

Kontextinformationen

EmailReceiver

Ein E-Mail-Empfänger.

ErrorResponse

Beschreibt das Format der Fehlerantwort.

EventHubReceiver

Ein Event Hub-Empfänger.

ItsmReceiver

Ein Itsm-Empfänger.

LogicAppReceiver

Ein Logik-App-Empfänger.

NotificationRequestBody

Der Anforderungstext, der Metadaten für Kontaktdetails enthält

ReceiverStatus

Gibt die status des Empfängers an. Empfänger, die nicht aktiviert sind, erhalten keine Kommunikation.

SmsReceiver

Ein SMS-Empfänger.

TestNotificationDetailsResponse

Die Details der Testbenachrichtigungsergebnisse.

VoiceReceiver

Ein Sprachempfänger.

WebhookReceiver

Ein Webhookempfänger.

ActionDetail

Aktionsdetails

Name Typ Beschreibung
Detail

string

Das Detail der benutzerfreundlichen Fehlermeldung

MechanismType

string

Der Mechanismustyp

Name

string

Der Name der Aktion

SendTime

string

Sendezeit

Status

string

Die status der Aktion

SubState

string

Der Unterstatus der Aktion

ArmRoleReceiver

Ein Armrollenempfänger.

Name Typ Standardwert Beschreibung
name

string

Der Name des Empfängers der Armrolle. Namen müssen für alle Empfänger innerhalb einer Aktionsgruppe eindeutig sein.

roleId

string

Die ARM-Rollen-ID.

useCommonAlertSchema

boolean

False

Gibt an, ob allgemeines Warnungsschema verwendet werden soll.

AutomationRunbookReceiver

Der Azure Automation Runbook-Benachrichtigungsempfänger.

Name Typ Standardwert Beschreibung
automationAccountId

string

Die Azure Automation-Konto-ID, die dieses Runbook enthält und sich bei der Azure-Ressource authentifiziert.

isGlobalRunbook

boolean

Gibt an, ob es sich bei diesem instance um ein globales Runbook handelt.

name

string

Gibt den Namen des Webhooks an.

runbookName

string

Der Name für dieses Runbook.

serviceUri

string

Der URI, an den Webhooks gesendet werden sollen.

useCommonAlertSchema

boolean

False

Gibt an, ob allgemeines Warnungsschema verwendet werden soll.

webhookResourceId

string

Die Ressourcen-ID für den Webhook, der mit diesem Runbook verknüpft ist.

AzureAppPushReceiver

Der Azure Mobile App-Pushbenachrichtigungsempfänger.

Name Typ Beschreibung
emailAddress

string

Die für die mobile Azure-App registrierte E-Mail-Adresse.

name

string

Der Name des Pushempfängers für die mobile Azure-App. Namen müssen für alle Empfänger innerhalb einer Aktionsgruppe eindeutig sein.

AzureFunctionReceiver

Ein Azure-Funktionsempfänger.

Name Typ Standardwert Beschreibung
functionAppResourceId

string

Die Azure-Ressourcen-ID der Funktions-App.

functionName

string

Der Funktionsname in der Funktions-App.

httpTriggerUrl

string

Die HTTP-Trigger-URL, an die die HTTP-Anforderung gesendet wird.

name

string

Der Name des Azure-Funktionsempfängers. Namen müssen für alle Empfänger innerhalb einer Aktionsgruppe eindeutig sein.

useCommonAlertSchema

boolean

False

Gibt an, ob allgemeines Warnungsschema verwendet werden soll.

Context

Kontextinformationen

Name Typ Beschreibung
contextType

string

Der Kontext-ID-Typ

notificationSource

string

Die Quelle der Benachrichtigungsanforderung

EmailReceiver

Ein E-Mail-Empfänger.

Name Typ Standardwert Beschreibung
emailAddress

string

Die E-Mail-Adresse dieses Empfängers.

name

string

Der Name des E-Mail-Empfängers. Namen müssen für alle Empfänger innerhalb einer Aktionsgruppe eindeutig sein.

status

ReceiverStatus

Der Empfänger status der E-Mail.

useCommonAlertSchema

boolean

False

Gibt an, ob allgemeines Warnungsschema verwendet werden soll.

ErrorResponse

Beschreibt das Format der Fehlerantwort.

Name Typ Beschreibung
code

string

Fehlercode

message

string

Eine Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

EventHubReceiver

Ein Event Hub-Empfänger.

Name Typ Standardwert Beschreibung
eventHubName

string

Der Name der spezifischen Event Hub-Warteschlange

eventHubNameSpace

string

Der Event Hub-Namespace

name

string

Der Name des Event Hub-Empfängers. Namen müssen für alle Empfänger innerhalb einer Aktionsgruppe eindeutig sein.

subscriptionId

string

Die ID für das Abonnement, das diesen Event Hub enthält.

tenantId

string

Die Mandanten-ID für das Abonnement, das diesen Event Hub enthält.

useCommonAlertSchema

boolean

False

Gibt an, ob allgemeines Warnungsschema verwendet werden soll.

ItsmReceiver

Ein Itsm-Empfänger.

Name Typ Beschreibung
connectionId

string

Eindeutige Identifizierung der ITSM-Verbindung zwischen mehreren, die im obigen Arbeitsbereich definiert sind.

name

string

Der Name des Itsm-Empfängers. Namen müssen für alle Empfänger innerhalb einer Aktionsgruppe eindeutig sein.

region

string

Region, in der sich der Arbeitsbereich befindet. Unterstützte Werte:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'

ticketConfiguration

string

JSON-Blob für die Konfigurationen der ITSM-Aktion. Die Option CreateMultipleWorkItems ist ebenfalls Teil dieses Blobs.

workspaceId

string

OMS LA instance Bezeichner.

LogicAppReceiver

Ein Logik-App-Empfänger.

Name Typ Standardwert Beschreibung
callbackUrl

string

Die Rückruf-URL, an die die HTTP-Anforderung gesendet wurde.

name

string

Der Name des Logik-App-Empfängers. Namen müssen für alle Empfänger innerhalb einer Aktionsgruppe eindeutig sein.

resourceId

string

Die Azure-Ressourcen-ID des Logik-App-Empfängers.

useCommonAlertSchema

boolean

False

Gibt an, ob allgemeines Warnungsschema verwendet werden soll.

NotificationRequestBody

Der Anforderungstext, der Metadaten für Kontaktdetails enthält

Name Typ Beschreibung
alertType

string

Der Wert des unterstützten Warnungstyps. Unterstützte Warnungstypwerte sind: servicehealth, metricstaticthreshold, metricsdynamicthreshold, logalertv2, smartalert, webtestalert, logalertv1numresult, logalertv1metricmeasurement, resourcehealth, activitylog, actualcostbudget, forecastedbudget

armRoleReceivers

ArmRoleReceiver[]

Die Liste der ARM-Rollenempfänger, die Teil dieser Aktionsgruppe sind. Rollen sind Azure RBAC-Rollen, und nur integrierte Rollen werden unterstützt.

automationRunbookReceivers

AutomationRunbookReceiver[]

Die Liste der AutomationRunbook-Empfänger, die Teil dieser Aktionsgruppe sind.

azureAppPushReceivers

AzureAppPushReceiver[]

Die Liste der AzureAppPush-Empfänger, die Teil dieser Aktionsgruppe sind.

azureFunctionReceivers

AzureFunctionReceiver[]

Die Liste der Azure-Funktionsempfänger, die Teil dieser Aktionsgruppe sind.

emailReceivers

EmailReceiver[]

Die Liste der E-Mail-Empfänger, die Teil dieser Aktionsgruppe sind.

eventHubReceivers

EventHubReceiver[]

Die Liste der Event Hub-Empfänger, die Teil dieser Aktionsgruppe sind.

itsmReceivers

ItsmReceiver[]

Die Liste der ITSM-Empfänger, die Teil dieser Aktionsgruppe sind.

logicAppReceivers

LogicAppReceiver[]

Die Liste der Logik-App-Empfänger, die Teil dieser Aktionsgruppe sind.

smsReceivers

SmsReceiver[]

Die Liste der SMS-Empfänger, die Teil dieser Aktionsgruppe sind.

voiceReceivers

VoiceReceiver[]

Die Liste der Sprachempfänger, die Teil dieser Aktionsgruppe sind.

webhookReceivers

WebhookReceiver[]

Die Liste der Webhookempfänger, die Teil dieser Aktionsgruppe sind.

ReceiverStatus

Gibt die status des Empfängers an. Empfänger, die nicht aktiviert sind, erhalten keine Kommunikation.

Name Typ Beschreibung
Disabled

string

Enabled

string

NotSpecified

string

SmsReceiver

Ein SMS-Empfänger.

Name Typ Beschreibung
countryCode

string

Die Landesvorwahl des SMS-Empfängers.

name

string

Der Name des SMS-Empfängers. Namen müssen für alle Empfänger innerhalb einer Aktionsgruppe eindeutig sein.

phoneNumber

string

Die Telefonnummer des SMS-Empfängers.

status

ReceiverStatus

Die status des Empfängers.

TestNotificationDetailsResponse

Die Details der Testbenachrichtigungsergebnisse.

Name Typ Beschreibung
actionDetails

ActionDetail[]

Die Liste der Aktionsdetails

completedTime

string

Die abgeschlossene Zeit

context

Context

Die Kontextinformationen

createdTime

string

Die Erstellungszeit

state

string

Der Gesamtzustand

VoiceReceiver

Ein Sprachempfänger.

Name Typ Beschreibung
countryCode

string

Die Länderkennzahl des Sprachempfängers.

name

string

Der Name des Sprachempfängers. Namen müssen für alle Empfänger innerhalb einer Aktionsgruppe eindeutig sein.

phoneNumber

string

Die Telefonnummer des Sprachempfängers.

WebhookReceiver

Ein Webhookempfänger.

Name Typ Standardwert Beschreibung
identifierUri

string

Gibt den Bezeichner-URI für die aad-Authentifizierung an.

name

string

Der Name des Webhookempfängers. Namen müssen für alle Empfänger innerhalb einer Aktionsgruppe eindeutig sein.

objectId

string

Gibt die Webhook-App-Objekt-ID für die aad-Authentifizierung an.

serviceUri

string

Der URI, an den Webhooks gesendet werden sollen.

tenantId

string

Gibt die Mandanten-ID für aad-Authentifizierung an.

useAadAuth

boolean

False

Gibt an, ob die AAD-Authentifizierung verwendet wird.

useCommonAlertSchema

boolean

False

Gibt an, ob allgemeines Warnungsschema verwendet werden soll.