Action Groups - Create Notifications At Resource Group Level

Testmeldingen verzenden naar een set opgegeven ontvangers

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

URI-parameters

Name In Vereist Type Description
resourceGroupName
path True

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

subscriptionId
path True

string

De id van het doelabonnement.

api-version
query True

string

De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name Vereist Type Description
alertType True

string

De waarde van het ondersteunde waarschuwingstype. Ondersteunde waarschuwingstypewaarden zijn: servicehealth, metricstaticthreshold, metricsdynamicthreshold, logalertv2, smartalert, webtestalert, logalertv1numresult, logalertv1metricmeasurement, resourcehealth, activitylog, actualcostbudget, forecastedbudget

armRoleReceivers

ArmRoleReceiver[]

De lijst met ARM-rolontvangers die deel uitmaken van deze actiegroep. Rollen zijn Azure RBAC-rollen en alleen ingebouwde rollen worden ondersteund.

automationRunbookReceivers

AutomationRunbookReceiver[]

De lijst met AutomationRunbook-ontvangers die deel uitmaken van deze actiegroep.

azureAppPushReceivers

AzureAppPushReceiver[]

De lijst met AzureAppPush-ontvangers die deel uitmaken van deze actiegroep.

azureFunctionReceivers

AzureFunctionReceiver[]

De lijst met ontvangers van azure-functies die deel uitmaken van deze actiegroep.

emailReceivers

EmailReceiver[]

De lijst met e-mailontvangers die deel uitmaken van deze actiegroep.

eventHubReceivers

EventHubReceiver[]

De lijst met Event Hub-ontvangers die deel uitmaken van deze actiegroep.

itsmReceivers

ItsmReceiver[]

De lijst met ITSM-ontvangers die deel uitmaken van deze actiegroep.

logicAppReceivers

LogicAppReceiver[]

De lijst met ontvangers van logische apps die deel uitmaken van deze actiegroep.

smsReceivers

SmsReceiver[]

De lijst met sms-ontvangers die deel uitmaken van deze actiegroep.

voiceReceivers

VoiceReceiver[]

De lijst met spraakontvangers die deel uitmaken van deze actiegroep.

webhookReceivers

WebhookReceiver[]

De lijst met webhook-ontvangers die deel uitmaken van deze actiegroep.

Antwoorden

Name Type Description
200 OK

TestNotificationDetailsResponse

De melding is voltooid

202 Accepted

De meldingsaanvraag is geaccepteerd

Headers

location: string

Other Status Codes

ErrorResponse

Er is een fout opgetreden tijdens het verzenden van de testmeldingen

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

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

Scopes

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

Create notifications at resource group level

Sample Request

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

Sample Response

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

Definities

Name Description
ActionDetail

De actiedetails

ArmRoleReceiver

Een armrolontvanger.

AutomationRunbookReceiver

De Azure Automation Runbook-meldingsontvanger.

AzureAppPushReceiver

De ontvanger van pushmeldingen voor mobiele Azure-apps.

AzureFunctionReceiver

Een azure-functieontvanger.

Context

De contextinformatie

EmailReceiver

Een e-mailontvanger.

ErrorResponse

Beschrijft de indeling van foutantwoord.

EventHubReceiver

Een Event Hub-ontvanger.

ItsmReceiver

Een Itsm-ontvanger.

LogicAppReceiver

Een ontvanger van logische apps.

NotificationRequestBody

De aanvraagbody die metagegevens van contactgegevens bevat

ReceiverStatus

Geeft de status van de ontvanger aan. Ontvangers die niet zijn ingeschakeld, ontvangen geen communicatie.

SmsReceiver

Een sms-ontvanger.

TestNotificationDetailsResponse

De details van de testmeldingsresultaten.

VoiceReceiver

Een spraakontvanger.

WebhookReceiver

Een webhookontvanger.

ActionDetail

De actiedetails

Name Type Description
Detail

string

De details van het beschrijvende foutbericht

MechanismType

string

Het mechanismetype

Name

string

De naam van de actie

SendTime

string

De verzendtijd

Status

string

De status van de actie

SubState

string

De substatus van de actie

ArmRoleReceiver

Een armrolontvanger.

Name Type Standaardwaarde Description
name

string

De naam van de ontvanger van de armrol. Namen moeten uniek zijn voor alle ontvangers binnen een actiegroep.

roleId

string

De arm-rol-id.

useCommonAlertSchema

boolean

False

Hiermee wordt aangegeven of een algemeen waarschuwingsschema moet worden gebruikt.

AutomationRunbookReceiver

De Azure Automation Runbook-meldingsontvanger.

Name Type Standaardwaarde Description
automationAccountId

string

De Azure Automation-account-id die dit runbook bevat en verifieert bij de Azure-resource.

isGlobalRunbook

boolean

Hiermee wordt aangegeven of dit exemplaar een globaal runbook is.

name

string

Geeft de naam van de webhook aan.

runbookName

string

De naam voor dit runbook.

serviceUri

string

De URI waarnaar webhooks moeten worden verzonden.

useCommonAlertSchema

boolean

False

Hiermee wordt aangegeven of een algemeen waarschuwingsschema moet worden gebruikt.

webhookResourceId

string

De resource-id voor webhook die is gekoppeld aan dit runbook.

AzureAppPushReceiver

De ontvanger van pushmeldingen voor mobiele Azure-apps.

Name Type Description
emailAddress

string

Het e-mailadres dat is geregistreerd voor de mobiele Azure-app.

name

string

De naam van de pushontvanger van de mobiele Azure-app. Namen moeten uniek zijn voor alle ontvangers binnen een actiegroep.

AzureFunctionReceiver

Een azure-functieontvanger.

Name Type Standaardwaarde Description
functionAppResourceId

string

De Azure-resource-id van de functie-app.

functionName

string

De functienaam in de functie-app.

httpTriggerUrl

string

De HTTP-trigger-URL waarnaar de HTTP-aanvraag wordt verzonden.

name

string

De naam van de ontvanger van de azure-functie. Namen moeten uniek zijn voor alle ontvangers binnen een actiegroep.

useCommonAlertSchema

boolean

False

Hiermee wordt aangegeven of een algemeen waarschuwingsschema moet worden gebruikt.

Context

De contextinformatie

Name Type Description
contextType

string

Het type context-id

notificationSource

string

De bron van de meldingsaanvraag

EmailReceiver

Een e-mailontvanger.

Name Type Standaardwaarde Description
emailAddress

string

Het e-mailadres van deze ontvanger.

name

string

De naam van de e-mailontvanger. Namen moeten uniek zijn voor alle ontvangers binnen een actiegroep.

status

ReceiverStatus

De ontvangststatus van het e-mailbericht.

useCommonAlertSchema

boolean

False

Hiermee wordt aangegeven of een algemeen waarschuwingsschema moet worden gebruikt.

ErrorResponse

Beschrijft de indeling van foutantwoord.

Name Type Description
code

string

Foutcode

message

string

Foutbericht waarin wordt aangegeven waarom de bewerking is mislukt.

EventHubReceiver

Een Event Hub-ontvanger.

Name Type Standaardwaarde Description
eventHubName

string

De naam van de specifieke Event Hub-wachtrij

eventHubNameSpace

string

De Event Hub-naamruimte

name

string

De naam van de Event Hub-ontvanger. Namen moeten uniek zijn voor alle ontvangers binnen een actiegroep.

subscriptionId

string

De id voor het abonnement dat deze Event Hub bevat

tenantId

string

De tenant-id voor het abonnement dat deze Event Hub bevat

useCommonAlertSchema

boolean

False

Hiermee wordt aangegeven of een algemeen waarschuwingsschema moet worden gebruikt.

ItsmReceiver

Een Itsm-ontvanger.

Name Type Description
connectionId

string

Unieke identificatie van ITSM-verbinding tussen meerdere die in de bovenstaande werkruimte zijn gedefinieerd.

name

string

De naam van de Itsm-ontvanger. Namen moeten uniek zijn voor alle ontvangers binnen een actiegroep.

region

string

Regio waarin de werkruimte zich bevindt. Ondersteunde waarden:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'

ticketConfiguration

string

JSON-blob voor de configuraties van de ITSM-actie. De optie CreateMultipleWorkItems maakt ook deel uit van deze blob.

workspaceId

string

OMS LA-exemplaar-id.

LogicAppReceiver

Een ontvanger van logische apps.

Name Type Standaardwaarde Description
callbackUrl

string

De callback-URL waarnaar de HTTP-aanvraag wordt verzonden.

name

string

De naam van de ontvanger van de logische app. Namen moeten uniek zijn voor alle ontvangers binnen een actiegroep.

resourceId

string

De Azure-resource-id van de ontvanger van de logische app.

useCommonAlertSchema

boolean

False

Hiermee wordt aangegeven of een algemeen waarschuwingsschema moet worden gebruikt.

NotificationRequestBody

De aanvraagbody die metagegevens van contactgegevens bevat

Name Type Description
alertType

string

De waarde van het ondersteunde waarschuwingstype. Ondersteunde waarschuwingstypewaarden zijn: servicehealth, metricstaticthreshold, metricsdynamicthreshold, logalertv2, smartalert, webtestalert, logalertv1numresult, logalertv1metricmeasurement, resourcehealth, activitylog, actualcostbudget, forecastedbudget

armRoleReceivers

ArmRoleReceiver[]

De lijst met ARM-rolontvangers die deel uitmaken van deze actiegroep. Rollen zijn Azure RBAC-rollen en alleen ingebouwde rollen worden ondersteund.

automationRunbookReceivers

AutomationRunbookReceiver[]

De lijst met AutomationRunbook-ontvangers die deel uitmaken van deze actiegroep.

azureAppPushReceivers

AzureAppPushReceiver[]

De lijst met AzureAppPush-ontvangers die deel uitmaken van deze actiegroep.

azureFunctionReceivers

AzureFunctionReceiver[]

De lijst met ontvangers van azure-functies die deel uitmaken van deze actiegroep.

emailReceivers

EmailReceiver[]

De lijst met e-mailontvangers die deel uitmaken van deze actiegroep.

eventHubReceivers

EventHubReceiver[]

De lijst met Event Hub-ontvangers die deel uitmaken van deze actiegroep.

itsmReceivers

ItsmReceiver[]

De lijst met ITSM-ontvangers die deel uitmaken van deze actiegroep.

logicAppReceivers

LogicAppReceiver[]

De lijst met ontvangers van logische apps die deel uitmaken van deze actiegroep.

smsReceivers

SmsReceiver[]

De lijst met sms-ontvangers die deel uitmaken van deze actiegroep.

voiceReceivers

VoiceReceiver[]

De lijst met spraakontvangers die deel uitmaken van deze actiegroep.

webhookReceivers

WebhookReceiver[]

De lijst met webhook-ontvangers die deel uitmaken van deze actiegroep.

ReceiverStatus

Geeft de status van de ontvanger aan. Ontvangers die niet zijn ingeschakeld, ontvangen geen communicatie.

Name Type Description
Disabled

string

Enabled

string

NotSpecified

string

SmsReceiver

Een sms-ontvanger.

Name Type Description
countryCode

string

De landcode van de sms-ontvanger.

name

string

De naam van de sms-ontvanger. Namen moeten uniek zijn voor alle ontvangers binnen een actiegroep.

phoneNumber

string

Het telefoonnummer van de sms-ontvanger.

status

ReceiverStatus

De status van de ontvanger.

TestNotificationDetailsResponse

De details van de testmeldingsresultaten.

Name Type Description
actionDetails

ActionDetail[]

De lijst met actiedetails

completedTime

string

De voltooide tijd

context

Context

De contextinformatie

createdTime

string

De aan te maken tijd

state

string

De algehele status

VoiceReceiver

Een spraakontvanger.

Name Type Description
countryCode

string

De landcode van de spraakontvanger.

name

string

De naam van de spraakontvanger. Namen moeten uniek zijn voor alle ontvangers binnen een actiegroep.

phoneNumber

string

Het telefoonnummer van de spraakontvanger.

WebhookReceiver

Een webhookontvanger.

Name Type Standaardwaarde Description
identifierUri

string

Geeft de id-URI voor aad-verificatie aan.

name

string

De naam van de webhookontvanger. Namen moeten uniek zijn voor alle ontvangers binnen een actiegroep.

objectId

string

Geeft de object-id van de webhook-app aan voor aad-verificatie.

serviceUri

string

De URI waarnaar webhooks moeten worden verzonden.

tenantId

string

Geeft de tenant-id voor aad-verificatie aan.

useAadAuth

boolean

False

Hiermee wordt aangegeven of AAD-verificatie al dan niet wordt gebruikt.

useCommonAlertSchema

boolean

False

Hiermee wordt aangegeven of een algemeen waarschuwingsschema moet worden gebruikt.