Action Groups - Create Notifications At Resource Group Level

Tjänst:: Monitor

API-version:: 2021-09-01

Skicka testmeddelanden till en uppsättning tillhandahållna mottagare

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string minLength: 1	ID för målprenumerationen.
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.

Begärandetext

Name	Obligatorisk	Typ	Description
alertType	True	string maxLength: 30	Värdet för den aviseringstyp som stöds. Aviseringstypvärden som stöds är: servicehealth, metricstaticthreshold, metricsdynamicthreshold, logalertv2, smartalert, webtestalert, logalertv1numresult, logalertv1metricmeasurement, resourcehealth, activitylog, actualcostbudget, forecastedbudget
armRoleReceivers		ArmRoleReceiver[]	Listan över ARM-rollmottagare som ingår i den här åtgärdsgruppen. Roller är Azure RBAC-roller och endast inbyggda roller stöds.
automationRunbookReceivers		AutomationRunbookReceiver[]	Listan över AutomationRunbook-mottagare som ingår i den här åtgärdsgruppen.
azureAppPushReceivers		AzureAppPushReceiver[]	Listan över AzureAppPush-mottagare som ingår i den här åtgärdsgruppen.
azureFunctionReceivers		AzureFunctionReceiver[]	Listan över azure-funktionsmottagare som ingår i den här åtgärdsgruppen.
emailReceivers		EmailReceiver[]	Listan över e-postmottagare som ingår i den här åtgärdsgruppen.
eventHubReceivers		EventHubReceiver[]	Listan över händelsehubbmottagare som ingår i den här åtgärdsgruppen.
itsmReceivers		ItsmReceiver[]	Listan över ITSM-mottagare som ingår i den här åtgärdsgruppen.
logicAppReceivers		LogicAppReceiver[]	Listan över logic app-mottagare som ingår i den här åtgärdsgruppen.
smsReceivers		SmsReceiver[]	Listan över SMS-mottagare som ingår i den här åtgärdsgruppen.
voiceReceivers		VoiceReceiver[]	Listan över röstmottagare som ingår i den här åtgärdsgruppen.
webhookReceivers		WebhookReceiver[]	Listan över webhook-mottagare som ingår i den här åtgärdsgruppen.

Svar

Name	Typ	Description
200 OK	TestNotificationDetailsResponse	Meddelandet lyckades
202 Accepted		Meddelandebegäran har godkänts Sidhuvuden location: string
Other Status Codes	ErrorResponse	Ett fel uppstod när testmeddelandena skulle skickas

Name

Typ

Description

200 OK

TestNotificationDetailsResponse

Meddelandet lyckades

202 Accepted

Meddelandebegäran har godkänts

Sidhuvuden

location: string

Other Status Codes

ErrorResponse

Ett fel uppstod när testmeddelandena skulle skickas

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Create notifications at resource group level

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 202

location: https://management.azure.com/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/Test-Rg/providers/microsoft.insights/notificationStatus/11111111111111?api-version=2022-06-01

Statuskod:: 200

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

Definitioner

Name	Description
ActionDetail	Åtgärdsinformationen
ArmRoleReceiver	En armrollsmottagare.
AutomationRunbookReceiver	Azure Automation Runbook-meddelandemottagaren.
AzureAppPushReceiver	Azure Mobile App push notification receiver.
AzureFunctionReceiver	En azure-funktionsmottagare.
Context	Kontextinformationen
EmailReceiver	En e-postmottagare.
ErrorResponse	Beskriver formatet för Felsvar.
EventHubReceiver	En händelsehubbmottagare.
ItsmReceiver	En Itsm-mottagare.
LogicAppReceiver	En logikappsmottagare.
NotificationRequestBody	Begärandetexten som innehåller metadata för kontaktinformation
ReceiverStatus	Anger mottagarens status. Mottagare som inte är aktiverade får ingen kommunikation.
SmsReceiver	En SMS-mottagare.
TestNotificationDetailsResponse	Information om testmeddelanderesultatet.
VoiceReceiver	En röstmottagare.
WebhookReceiver	En webhook-mottagare.

ActionDetail

Objekt

Åtgärdsinformationen

Name	Typ	Description
Detail	string	Information om det egna felmeddelandet
MechanismType	string	Mekanismtypen
Name	string	Namnet på åtgärden
SendTime	string	Sändningstiden
Status	string	Åtgärdens status
SubState	string	Åtgärdens understatus

ArmRoleReceiver

Objekt

En armrollsmottagare.

Name	Typ	Standardvärde	Description
name	string		Namnet på armrollmottagaren. Namn måste vara unika för alla mottagare i en åtgärdsgrupp.
roleId	string		Armrolls-ID:t.
useCommonAlertSchema	boolean	False	Anger om du vill använda ett vanligt aviseringsschema.

AutomationRunbookReceiver

Objekt

Azure Automation Runbook-meddelandemottagaren.

Name	Typ	Standardvärde	Description
automationAccountId	string		Azure Automation-konto-ID:t som innehåller den här runbooken och autentiserar till Azure-resursen.
isGlobalRunbook	boolean		Anger om den här instansen är global runbook.
name	string		Anger namnet på webhooken.
runbookName	string		Namnet på den här runbooken.
serviceUri	string		Den URI där webhooks ska skickas.
useCommonAlertSchema	boolean	False	Anger om du vill använda ett vanligt aviseringsschema.
webhookResourceId	string		Resurs-ID:t för webhook som är länkat till den här runbooken.

AzureAppPushReceiver

Objekt

Azure Mobile App push notification receiver.

Name	Typ	Description
emailAddress	string	E-postadressen som registrerats för Azure-mobilappen.
name	string	Namnet på Azure-mobilappens push-mottagare. Namn måste vara unika för alla mottagare i en åtgärdsgrupp.

AzureFunctionReceiver

Objekt

En azure-funktionsmottagare.

Name	Typ	Standardvärde	Description
functionAppResourceId	string		Funktionsappens azure-resurs-ID.
functionName	string		Funktionsnamnet i funktionsappen.
httpTriggerUrl	string		URL:en för http-utlösaren som http-begäran skickades till.
name	string		Namnet på azure-funktionsmottagaren. Namn måste vara unika för alla mottagare i en åtgärdsgrupp.
useCommonAlertSchema	boolean	False	Anger om du vill använda ett vanligt aviseringsschema.

Context

Objekt

Kontextinformationen

Name	Typ	Description
contextType	string	Kontext-ID-typen
notificationSource	string	Källan för meddelandebegäran

EmailReceiver

Objekt

En e-postmottagare.

Name	Typ	Standardvärde	Description
emailAddress	string		Mottagarens e-postadress.
name	string		Namnet på e-postmottagaren. Namn måste vara unika för alla mottagare i en åtgärdsgrupp.
status	ReceiverStatus		Mottagarens status för e-postmeddelandet.
useCommonAlertSchema	boolean	False	Anger om du vill använda ett vanligt aviseringsschema.

ErrorResponse

Objekt

Beskriver formatet för Felsvar.

Name	Typ	Description
code	string	Felkod
message	string	Felmeddelande som anger varför åtgärden misslyckades.

EventHubReceiver

Objekt

En händelsehubbmottagare.

Name	Typ	Standardvärde	Description
eventHubName	string		Namnet på den specifika Event Hub-kön
eventHubNameSpace	string		Event Hub-namnområdet
name	string		Namnet på händelsehubbens mottagare. Namn måste vara unika för alla mottagare i en åtgärdsgrupp.
subscriptionId	string		ID:t för prenumerationen som innehåller den här händelsehubben
tenantId	string		Klientorganisations-ID:t för prenumerationen som innehåller den här händelsehubben
useCommonAlertSchema	boolean	False	Anger om du vill använda ett vanligt aviseringsschema.

ItsmReceiver

Objekt

En Itsm-mottagare.

Name	Typ	Description
connectionId	string	Unik identifiering av ITSM-anslutning mellan flera definierade i ovanstående arbetsyta.
name	string	Namnet på Itsm-mottagaren. Namn måste vara unika för alla mottagare i en åtgärdsgrupp.
region	string	Region där arbetsytan finns. Värden som stöds:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'
ticketConfiguration	string	JSON-blob för konfigurationerna av ITSM-åtgärden. Alternativet CreateMultipleWorkItems kommer också att ingå i den här bloben.
workspaceId	string	OMS LA-instansidentifierare.

LogicAppReceiver

Objekt

En logikappsmottagare.

Name	Typ	Standardvärde	Description
callbackUrl	string		Återanrops-URL:en som http-begäran skickades till.
name	string		Namnet på logikappmottagaren. Namn måste vara unika för alla mottagare i en åtgärdsgrupp.
resourceId	string		Azure-resurs-ID för logikappmottagaren.
useCommonAlertSchema	boolean	False	Anger om du vill använda ett vanligt aviseringsschema.

NotificationRequestBody

Objekt

Begärandetexten som innehåller metadata för kontaktinformation

Name	Typ	Description
alertType	string maxLength: 30	Värdet för den aviseringstyp som stöds. Aviseringstypvärden som stöds är: servicehealth, metricstaticthreshold, metricsdynamicthreshold, logalertv2, smartalert, webtestalert, logalertv1numresult, logalertv1metricmeasurement, resourcehealth, activitylog, actualcostbudget, forecastedbudget
armRoleReceivers	ArmRoleReceiver[]	Listan över ARM-rollmottagare som ingår i den här åtgärdsgruppen. Roller är Azure RBAC-roller och endast inbyggda roller stöds.
automationRunbookReceivers	AutomationRunbookReceiver[]	Listan över AutomationRunbook-mottagare som ingår i den här åtgärdsgruppen.
azureAppPushReceivers	AzureAppPushReceiver[]	Listan över AzureAppPush-mottagare som ingår i den här åtgärdsgruppen.
azureFunctionReceivers	AzureFunctionReceiver[]	Listan över azure-funktionsmottagare som ingår i den här åtgärdsgruppen.
emailReceivers	EmailReceiver[]	Listan över e-postmottagare som ingår i den här åtgärdsgruppen.
eventHubReceivers	EventHubReceiver[]	Listan över händelsehubbmottagare som ingår i den här åtgärdsgruppen.
itsmReceivers	ItsmReceiver[]	Listan över ITSM-mottagare som ingår i den här åtgärdsgruppen.
logicAppReceivers	LogicAppReceiver[]	Listan över logic app-mottagare som ingår i den här åtgärdsgruppen.
smsReceivers	SmsReceiver[]	Listan över SMS-mottagare som ingår i den här åtgärdsgruppen.
voiceReceivers	VoiceReceiver[]	Listan över röstmottagare som ingår i den här åtgärdsgruppen.
webhookReceivers	WebhookReceiver[]	Listan över webhook-mottagare som ingår i den här åtgärdsgruppen.

ReceiverStatus

Uppräkning

Anger mottagarens status. Mottagare som inte är aktiverade får ingen kommunikation.

Värde	Description
NotSpecified
Enabled
Disabled

SmsReceiver

Objekt

En SMS-mottagare.

Name	Typ	Description
countryCode	string	Landskoden för SMS-mottagaren.
name	string	Namnet på SMS-mottagaren. Namn måste vara unika för alla mottagare i en åtgärdsgrupp.
phoneNumber	string	Sms-mottagarens telefonnummer.
status	ReceiverStatus	Mottagarens status.

TestNotificationDetailsResponse

Objekt

Information om testmeddelanderesultatet.

Name	Typ	Description
actionDetails	ActionDetail[]	Listan med åtgärdsinformation
completedTime	string	Den slutförda tiden
context	Context	Kontextinformationen
createdTime	string	Den skapade tiden
state	string	Det övergripande tillståndet

VoiceReceiver

Objekt

En röstmottagare.

Name	Typ	Description
countryCode	string	Landskoden för röstmottagaren.
name	string	Namnet på röstmottagaren. Namn måste vara unika för alla mottagare i en åtgärdsgrupp.
phoneNumber	string	Telefonnumret till röstmottagaren.

WebhookReceiver

Objekt

En webhook-mottagare.

Name	Typ	Standardvärde	Description
identifierUri	string		Anger identifierarens URI för aad-autentisering.
name	string		Namnet på webhookens mottagare. Namn måste vara unika för alla mottagare i en åtgärdsgrupp.
objectId	string		Anger webhooksappens objekt-ID för aad-autentisering.
serviceUri	string		Den URI där webhooks ska skickas.
tenantId	string		Anger klient-ID för aad-autentisering.
useAadAuth	boolean	False	Anger om AAD-autentisering ska användas eller inte.
useCommonAlertSchema	boolean	False	Anger om du vill använda ett vanligt aviseringsschema.