Action Groups - Create Notifications At Resource Group Level

Riferimento

Servizio:: Monitor

Versione API:: 2021-09-01

Inviare notifiche di test a un set di ricevitori forniti

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string	Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
subscriptionId	path	True	string	ID della sottoscrizione di destinazione.
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
alertType	True	string	Valore del tipo di avviso supportato. I valori del tipo di avviso supportati sono: servicehealth, metricstaticthreshold, metricsdynamicthreshold, logalertv2, smartalert, webtestalert, logalertv1numresult, logalertv1metricmeasurement, resourcehealth, activitylog, actualcostbudget, forecastedbudget
armRoleReceivers		ArmRoleReceiver[]	Elenco dei ricevitori di ruoli ARM che fanno parte di questo gruppo di azioni. I ruoli sono ruoli di Controllo degli accessi in base al ruolo di Azure e sono supportati solo i ruoli predefiniti.
automationRunbookReceivers		AutomationRunbookReceiver[]	Elenco dei ricevitori AutomationRunbook che fanno parte di questo gruppo di azioni.
azureAppPushReceivers		AzureAppPushReceiver[]	Elenco dei ricevitori AzureAppPush che fanno parte di questo gruppo di azioni.
azureFunctionReceivers		AzureFunctionReceiver[]	Elenco dei ricevitori di funzioni di Azure che fanno parte di questo gruppo di azioni.
emailReceivers		EmailReceiver[]	Elenco dei ricevitori di posta elettronica che fanno parte di questo gruppo di azioni.
eventHubReceivers		EventHubReceiver[]	Elenco dei ricevitori dell'hub eventi che fanno parte di questo gruppo di azioni.
itsmReceivers		ItsmReceiver[]	Elenco dei ricevitori ITSM che fanno parte di questo gruppo di azioni.
logicAppReceivers		LogicAppReceiver[]	Elenco dei ricevitori di app per la logica che fanno parte di questo gruppo di azioni.
smsReceivers		SmsReceiver[]	Elenco dei ricevitori SMS che fanno parte di questo gruppo di azioni.
voiceReceivers		VoiceReceiver[]	Elenco dei ricevitori vocali che fanno parte di questo gruppo di azioni.
webhookReceivers		WebhookReceiver[]	Elenco dei ricevitori webhook che fanno parte di questo gruppo di azioni.

Risposte

Nome	Tipo	Descrizione
200 OK	TestNotificationDetailsResponse	La notifica ha avuto esito positivo
202 Accepted		Richiesta di notifica accettata Intestazioni location: string
Other Status Codes	ErrorResponse	Errore durante l'invio delle notifiche di test

Nome

Tipo

Descrizione

200 OK

TestNotificationDetailsResponse

La notifica ha avuto esito positivo

202 Accepted

Richiesta di notifica accettata

Intestazioni

location: string

Other Status Codes

ErrorResponse

Errore durante l'invio delle notifiche di test

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Create notifications at resource group level

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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

Codice di stato:: 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
    }
  ]
}

Definizioni

Nome	Descrizione
ActionDetail	Dettagli azione
ArmRoleReceiver	Ricevitore del ruolo del braccio.
AutomationRunbookReceiver	Ricevitore di notifica Automazione di Azure runbook.
AzureAppPushReceiver	Ricevitore di notifica push dell'app per dispositivi mobili di Azure.
AzureFunctionReceiver	Ricevitore di funzioni di Azure.
Context	Informazioni sul contesto
EmailReceiver	Ricevitore di posta elettronica.
ErrorResponse	Descrive il formato della risposta di errore.
EventHubReceiver	Ricevitore dell'hub eventi.
ItsmReceiver	Ricevitore Itsm.
LogicAppReceiver	Ricevitore di app per la logica.
NotificationRequestBody	Corpo della richiesta che contiene i metadati dei dettagli contatto
ReceiverStatus	Indica lo stato del ricevitore. I ricevitori che non sono abilitati non riceveranno alcuna comunicazione.
SmsReceiver	Ricevitore SMS.
TestNotificationDetailsResponse	Dettagli dei risultati della notifica di test.
VoiceReceiver	Ricevitore vocale.
WebhookReceiver	Ricevitore webhook.

ActionDetail

Dettagli azione

Nome	Tipo	Descrizione
Detail	string	Dettaglio del messaggio di errore descrittivo
MechanismType	string	Tipo di meccanismo
Name	string	Nome dell'azione
SendTime	string	Ora di invio
Status	string	Stato dell'azione
SubState	string	Sottostatus dell'azione

ArmRoleReceiver

Ricevitore del ruolo del braccio.

Nome	Tipo	Valore predefinito	Descrizione
name	string		Nome del ricevitore del ruolo arm. I nomi devono essere univoci in tutti i ricevitori all'interno di un gruppo di azioni.
roleId	string		ID ruolo arm.
useCommonAlertSchema	boolean	False	Indica se utilizzare lo schema di avviso comune.

AutomationRunbookReceiver

Ricevitore di notifica Automazione di Azure runbook.

Nome	Tipo	Valore predefinito	Descrizione
automationAccountId	string		ID dell'account di Automazione di Azure che contiene questo runbook ed esegue l'autenticazione nella risorsa di Azure.
isGlobalRunbook	boolean		Indica se questa istanza è un runbook globale.
name	string		Indica il nome del webhook.
runbookName	string		Nome del runbook.
serviceUri	string		URI in cui devono essere inviati i webhook.
useCommonAlertSchema	boolean	False	Indica se utilizzare lo schema di avviso comune.
webhookResourceId	string		ID risorsa per il webhook collegato a questo runbook.

AzureAppPushReceiver

Ricevitore di notifica push dell'app per dispositivi mobili di Azure.

Nome	Tipo	Descrizione
emailAddress	string	Indirizzo di posta elettronica registrato per l'app per dispositivi mobili di Azure.
name	string	Nome del ricevitore push dell'app per dispositivi mobili di Azure. I nomi devono essere univoci in tutti i ricevitori all'interno di un gruppo di azioni.

AzureFunctionReceiver

Ricevitore di funzioni di Azure.

Nome	Tipo	Valore predefinito	Descrizione
functionAppResourceId	string		ID risorsa di Azure dell'app per le funzioni.
functionName	string		Nome della funzione nell'app per le funzioni.
httpTriggerUrl	string		URL del trigger HTTP a cui viene inviata la richiesta HTTP.
name	string		Nome del ricevitore della funzione di Azure. I nomi devono essere univoci in tutti i ricevitori all'interno di un gruppo di azioni.
useCommonAlertSchema	boolean	False	Indica se utilizzare lo schema di avviso comune.

Context

Informazioni sul contesto

Nome	Tipo	Descrizione
contextType	string	Tipo id contesto
notificationSource	string	Origine della richiesta di notifica

EmailReceiver

Ricevitore di posta elettronica.

Nome	Tipo	Valore predefinito	Descrizione
emailAddress	string		Indirizzo di posta elettronica del ricevitore.
name	string		Nome del destinatario del messaggio di posta elettronica. I nomi devono essere univoci in tutti i ricevitori all'interno di un gruppo di azioni.
status	ReceiverStatus		Stato del destinatario del messaggio di posta elettronica.
useCommonAlertSchema	boolean	False	Indica se utilizzare lo schema di avviso comune.

ErrorResponse

Descrive il formato della risposta di errore.

Nome	Tipo	Descrizione
code	string	Codice di errore
message	string	Messaggio di errore che indica il motivo per cui l'operazione non è riuscita.

EventHubReceiver

Ricevitore dell'hub eventi.

Nome	Tipo	Valore predefinito	Descrizione
eventHubName	string		Nome della coda dell'hub eventi specifica
eventHubNameSpace	string		Spazio dei nomi dell'hub eventi
name	string		Nome del ricevitore dell'hub eventi. I nomi devono essere univoci in tutti i ricevitori all'interno di un gruppo di azioni.
subscriptionId	string		ID per la sottoscrizione contenente questo hub eventi
tenantId	string		ID tenant per la sottoscrizione contenente questo hub eventi
useCommonAlertSchema	boolean	False	Indica se utilizzare lo schema di avviso comune.

ItsmReceiver

Ricevitore Itsm.

Nome	Tipo	Descrizione
connectionId	string	Identificazione univoca della connessione di Gestione dei servizi IT tra più definiti nell'area di lavoro precedente.
name	string	Nome del ricevitore Itsm. I nomi devono essere univoci in tutti i ricevitori all'interno di un gruppo di azioni.
region	string	Area in cui risiede l'area di lavoro. Valori supportati:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'
ticketConfiguration	string	BLOB JSON per le configurazioni dell'azione gestione dei servizi IT. Anche l'opzione CreateMultipleWorkItems farà parte di questo BLOB.
workspaceId	string	Identificatore dell'istanza di OMS LA.

LogicAppReceiver

Ricevitore di app per la logica.

Nome	Tipo	Valore predefinito	Descrizione
callbackUrl	string		URL di callback a cui viene inviata la richiesta HTTP.
name	string		Nome del ricevitore dell'app per la logica. I nomi devono essere univoci in tutti i ricevitori all'interno di un gruppo di azioni.
resourceId	string		ID risorsa di Azure del ricevitore dell'app per la logica.
useCommonAlertSchema	boolean	False	Indica se utilizzare lo schema di avviso comune.

NotificationRequestBody

Corpo della richiesta che contiene i metadati dei dettagli contatto

Nome	Tipo	Descrizione
alertType	string	Valore del tipo di avviso supportato. I valori del tipo di avviso supportati sono: servicehealth, metricstaticthreshold, metricsdynamicthreshold, logalertv2, smartalert, webtestalert, logalertv1numresult, logalertv1metricmeasurement, resourcehealth, activitylog, actualcostbudget, forecastedbudget
armRoleReceivers	ArmRoleReceiver[]	Elenco di ricevitori di ruoli ARM che fanno parte di questo gruppo di azioni. I ruoli sono ruoli controllo degli accessi in base al ruolo di Azure e sono supportati solo i ruoli predefiniti.
automationRunbookReceivers	AutomationRunbookReceiver[]	Elenco dei ricevitori automationRunbook che fanno parte di questo gruppo di azioni.
azureAppPushReceivers	AzureAppPushReceiver[]	Elenco dei ricevitori AzureAppPush che fanno parte di questo gruppo di azioni.
azureFunctionReceivers	AzureFunctionReceiver[]	Elenco di ricevitori di funzioni di Azure che fanno parte di questo gruppo di azioni.
emailReceivers	EmailReceiver[]	Elenco di ricevitori di posta elettronica che fanno parte di questo gruppo di azioni.
eventHubReceivers	EventHubReceiver[]	Elenco dei ricevitori dell'hub eventi che fanno parte di questo gruppo di azioni.
itsmReceivers	ItsmReceiver[]	Elenco di ricevitori ITSM che fanno parte di questo gruppo di azioni.
logicAppReceivers	LogicAppReceiver[]	Elenco di ricevitori di app per la logica che fanno parte di questo gruppo di azioni.
smsReceivers	SmsReceiver[]	Elenco di ricevitori SMS che fanno parte di questo gruppo di azioni.
voiceReceivers	VoiceReceiver[]	Elenco di ricevitori vocali che fanno parte di questo gruppo di azioni.
webhookReceivers	WebhookReceiver[]	Elenco di ricevitori webhook che fanno parte di questo gruppo di azioni.

ReceiverStatus

Indica lo stato del ricevitore. I ricevitori che non sono abilitati non riceveranno alcuna comunicazione.

Nome	Tipo	Descrizione
Disabled	string
Enabled	string
NotSpecified	string

SmsReceiver

Ricevitore SMS.

Nome	Tipo	Descrizione
countryCode	string	Codice paese del ricevitore SMS.
name	string	Nome del ricevitore SMS. I nomi devono essere univoci in tutti i ricevitori all'interno di un gruppo di azioni.
phoneNumber	string	Numero di telefono del ricevitore SMS.
status	ReceiverStatus	Stato del ricevitore.

TestNotificationDetailsResponse

Dettagli dei risultati della notifica di test.

Nome	Tipo	Descrizione
actionDetails	ActionDetail[]	Elenco dei dettagli dell'azione
completedTime	string	Ora completata
context	Context	Informazioni sul contesto
createdTime	string	Ora di creazione
state	string	Stato complessivo

VoiceReceiver

Ricevitore vocale.

Nome	Tipo	Descrizione
countryCode	string	Codice paese del ricevitore vocale.
name	string	Nome del ricevitore vocale. I nomi devono essere univoci in tutti i ricevitori all'interno di un gruppo di azioni.
phoneNumber	string	Numero di telefono del ricevitore vocale.

WebhookReceiver

Ricevitore webhook.

Nome	Tipo	Valore predefinito	Descrizione
identifierUri	string		Indica l'URI dell'identificatore per l'autenticazione aad.
name	string		Nome del ricevitore webhook. I nomi devono essere univoci in tutti i ricevitori all'interno di un gruppo di azioni.
objectId	string		Indica l'ID oggetto app webhook per l'autenticazione aad.
serviceUri	string		URI in cui devono essere inviati i webhook.
tenantId	string		Indica l'ID tenant per l'autenticazione aad.
useAadAuth	boolean	False	Indica se usare o meno l'autenticazione AAD.
useCommonAlertSchema	boolean	False	Indica se utilizzare lo schema di avviso comune.

Condividi tramite

Action Groups - Create Notifications At Resource Group Level

Parametri dell'URI

Corpo della richiesta

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

Create notifications at resource group level

Esempio di richiesta

Risposta di esempio

Definizioni

ActionDetail

ArmRoleReceiver

AutomationRunbookReceiver

AzureAppPushReceiver

AzureFunctionReceiver

Context

EmailReceiver

ErrorResponse

EventHubReceiver

ItsmReceiver

LogicAppReceiver

NotificationRequestBody

ReceiverStatus

SmsReceiver

TestNotificationDetailsResponse

VoiceReceiver

WebhookReceiver

Risorse aggiuntive