Action Groups - Create Notifications At Resource Group Level

Referência

Serviço:: Monitor

Versão da API:: 2021-09-01

Enviar notificações de teste para um conjunto de recetores fornecidos

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
subscriptionId	path	True	string	O ID da subscrição de destino.
api-version	query	True	string	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
alertType	True	string	O valor do tipo de alerta suportado. Os valores do tipo de alerta suportados são: servicehealth, metricstaticthreshold, metricsdynamicthreshold, logalertv2, smartalert, webtestalert, logalertv1numresult, logalertv1metricmeasurement, resourcehealth, activitylog, actualcostbudget, forecastedbudget
armRoleReceivers		ArmRoleReceiver[]	A lista de recetores de função ARM que fazem parte deste grupo de ações. As funções são funções RBAC do Azure e só são suportadas funções incorporadas.
automationRunbookReceivers		AutomationRunbookReceiver[]	A lista de recetores automationRunbook que fazem parte deste grupo de ações.
azureAppPushReceivers		AzureAppPushReceiver[]	A lista de recetores do AzureAppPush que fazem parte deste grupo de ações.
azureFunctionReceivers		AzureFunctionReceiver[]	A lista de recetores de funções do Azure que fazem parte deste grupo de ações.
emailReceivers		EmailReceiver[]	A lista de recetores de e-mail que fazem parte deste grupo de ações.
eventHubReceivers		EventHubReceiver[]	A lista de recetores do hub de eventos que fazem parte deste grupo de ações.
itsmReceivers		ItsmReceiver[]	A lista de recetores ITSM que fazem parte deste grupo de ações.
logicAppReceivers		LogicAppReceiver[]	A lista de recetores de aplicações lógicas que fazem parte deste grupo de ações.
smsReceivers		SmsReceiver[]	A lista de recetores de SMS que fazem parte deste grupo de ações.
voiceReceivers		VoiceReceiver[]	A lista de recetores de voz que fazem parte deste grupo de ações.
webhookReceivers		WebhookReceiver[]	A lista de recetores de webhook que fazem parte deste grupo de ações.

Respostas

Name	Tipo	Description
200 OK	TestNotificationDetailsResponse	A notificação foi esclarcida
202 Accepted		O pedido de notificação aceite Cabeçalhos location: string
Other Status Codes	ErrorResponse	Ocorreu um erro ao enviar as notificações de teste

Name

Tipo

Description

200 OK

TestNotificationDetailsResponse

A notificação foi esclarcida

202 Accepted

O pedido de notificação aceite

Cabeçalhos

location: string

Other Status Codes

ErrorResponse

Ocorreu um erro ao enviar as notificações de teste

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

Create notifications at resource group level

Pedido de amostra

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

Resposta da amostra

Código de estado:: 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

Código de estado:: 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
    }
  ]
}

Definições

Name	Description
ActionDetail	O detalhe da ação
ArmRoleReceiver	Um recetor de função de braço.
AutomationRunbookReceiver	O recetor de notificação Automatização do Azure Runbook.
AzureAppPushReceiver	O recetor de notificação push da Aplicação móvel do Azure.
AzureFunctionReceiver	Um recetor de funções do Azure.
Context	As informações de contexto
EmailReceiver	Um recetor de e-mail.
ErrorResponse	Descreve o formato de Resposta a erros.
EventHubReceiver	Um recetor do Hub de Eventos.
ItsmReceiver	Um recetor Itsm.
LogicAppReceiver	Um recetor de aplicação lógica.
NotificationRequestBody	O corpo do pedido que contém metadados de detalhes de contacto
ReceiverStatus	Indica o estado do recetor. Os recetores que não estejam Ativados não receberão comunicações.
SmsReceiver	Um recetor SMS.
TestNotificationDetailsResponse	Os detalhes dos resultados da notificação de teste.
VoiceReceiver	Um recetor de voz.
WebhookReceiver	Um recetor de webhook.

ActionDetail

O detalhe da ação

Name	Tipo	Description
Detail	string	O detalhe da mensagem de erro amigável
MechanismType	string	O tipo de mecanismo
Name	string	O nome da ação
SendTime	string	A hora de envio
Status	string	O estado da ação
SubState	string	O substatus da ação

ArmRoleReceiver

Um recetor de função de braço.

Name	Tipo	Default value	Description
name	string		O nome do recetor da função de braço. Os nomes têm de ser exclusivos em todos os recetores dentro de um grupo de ações.
roleId	string		O ID da função do braço.
useCommonAlertSchema	boolean	False	Indica se deve utilizar um esquema de alerta comum.

AutomationRunbookReceiver

O recetor de notificação Automatização do Azure Runbook.

Name	Tipo	Default value	Description
automationAccountId	string		O ID da conta de automatização do Azure que contém este runbook e autentica-se no recurso do Azure.
isGlobalRunbook	boolean		Indica se esta instância é um runbook global.
name	string		Indica o nome do webhook.
runbookName	string		O nome deste runbook.
serviceUri	string		O URI para onde os webhooks devem ser enviados.
useCommonAlertSchema	boolean	False	Indica se deve utilizar um esquema de alerta comum.
webhookResourceId	string		O ID de recurso do webhook ligado a este runbook.

AzureAppPushReceiver

O recetor de notificação push da Aplicação móvel do Azure.

Name	Tipo	Description
emailAddress	string	O endereço de e-mail registado para a aplicação móvel do Azure.
name	string	O nome do recetor push da aplicação móvel do Azure. Os nomes têm de ser exclusivos em todos os recetores dentro de um grupo de ações.

AzureFunctionReceiver

Um recetor de funções do Azure.

Name	Tipo	Default value	Description
functionAppResourceId	string		O ID de recurso do azure da aplicação de funções.
functionName	string		O nome da função na aplicação de funções.
httpTriggerUrl	string		O url do acionador http para o qual o pedido http foi enviado.
name	string		O nome do recetor de funções do azure. Os nomes têm de ser exclusivos em todos os recetores dentro de um grupo de ações.
useCommonAlertSchema	boolean	False	Indica se deve utilizar um esquema de alerta comum.

Context

As informações de contexto

Name	Tipo	Description
contextType	string	O tipo de ID de contexto
notificationSource	string	A origem do pedido de notificação

EmailReceiver

Um recetor de e-mail.

Name	Tipo	Default value	Description
emailAddress	string		O endereço de e-mail deste recetor.
name	string		O nome do recetor de e-mail. Os nomes têm de ser exclusivos em todos os recetores dentro de um grupo de ações.
status	ReceiverStatus		O estado do recetor do e-mail.
useCommonAlertSchema	boolean	False	Indica se deve utilizar um esquema de alerta comum.

ErrorResponse

Descreve o formato de Resposta a erros.

Name	Tipo	Description
code	string	Código de erro
message	string	Mensagem de erro a indicar por que motivo a operação falhou.

EventHubReceiver

Um recetor do Hub de Eventos.

Name	Tipo	Default value	Description
eventHubName	string		O nome da fila específica do Hub de Eventos
eventHubNameSpace	string		O espaço de nomes do Hub de Eventos
name	string		O nome do recetor do Hub de Eventos. Os nomes têm de ser exclusivos em todos os recetores dentro de um grupo de ações.
subscriptionId	string		O ID da subscrição que contém este hub de eventos
tenantId	string		O ID do inquilino da subscrição que contém este hub de eventos
useCommonAlertSchema	boolean	False	Indica se deve utilizar um esquema de alerta comum.

ItsmReceiver

Um recetor Itsm.

Name	Tipo	Description
connectionId	string	Identificação exclusiva da ligação ITSM entre múltiplos definidos na área de trabalho acima.
name	string	O nome do recetor Itsm. Os nomes têm de ser exclusivos em todos os recetores dentro de um grupo de ações.
region	string	Região onde reside a área de trabalho. Valores suportados:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'
ticketConfiguration	string	Blob JSON para as configurações da ação ITSM. A opção CreateMultipleWorkItems também fará parte deste blob.
workspaceId	string	Identificador de instância do OMS LA.

LogicAppReceiver

Um recetor de aplicação lógica.

Name	Tipo	Default value	Description
callbackUrl	string		O url de chamada de retorno para o qual o pedido http foi enviado.
name	string		O nome do recetor da aplicação lógica. Os nomes têm de ser exclusivos em todos os recetores dentro de um grupo de ações.
resourceId	string		O ID de recurso do azure do recetor da aplicação lógica.
useCommonAlertSchema	boolean	False	Indica se deve utilizar um esquema de alerta comum.

NotificationRequestBody

O corpo do pedido que contém metadados de detalhes de contacto

Name	Tipo	Description
alertType	string	O valor do tipo de alerta suportado. Os valores do tipo de alerta suportados são: servicehealth, metricstaticthreshold, metricsdynamicthreshold, logalertv2, smartalert, webtestalert, logalertv1numresult, logalertv1metricmeasurement, resourcehealth, activitylog, actualcostbudget, forecastedbudget
armRoleReceivers	ArmRoleReceiver[]	A lista de recetores de função ARM que fazem parte deste grupo de ações. As funções são funções RBAC do Azure e só são suportadas funções incorporadas.
automationRunbookReceivers	AutomationRunbookReceiver[]	A lista de recetores automationRunbook que fazem parte deste grupo de ações.
azureAppPushReceivers	AzureAppPushReceiver[]	A lista de recetores do AzureAppPush que fazem parte deste grupo de ações.
azureFunctionReceivers	AzureFunctionReceiver[]	A lista de recetores de funções do Azure que fazem parte deste grupo de ações.
emailReceivers	EmailReceiver[]	A lista de recetores de e-mail que fazem parte deste grupo de ações.
eventHubReceivers	EventHubReceiver[]	A lista de recetores do hub de eventos que fazem parte deste grupo de ações.
itsmReceivers	ItsmReceiver[]	A lista de recetores ITSM que fazem parte deste grupo de ações.
logicAppReceivers	LogicAppReceiver[]	A lista de recetores de aplicações lógicas que fazem parte deste grupo de ações.
smsReceivers	SmsReceiver[]	A lista de recetores de SMS que fazem parte deste grupo de ações.
voiceReceivers	VoiceReceiver[]	A lista de recetores de voz que fazem parte deste grupo de ações.
webhookReceivers	WebhookReceiver[]	A lista de recetores de webhook que fazem parte deste grupo de ações.

ReceiverStatus

Indica o estado do recetor. Os recetores que não estejam Ativados não receberão comunicações.

Name	Tipo	Description
Disabled	string
Enabled	string
NotSpecified	string

SmsReceiver

Um recetor SMS.

Name	Tipo	Description
countryCode	string	O código de país do recetor de SMS.
name	string	O nome do recetor de SMS. Os nomes têm de ser exclusivos em todos os recetores dentro de um grupo de ações.
phoneNumber	string	O número de telefone do recetor de SMS.
status	ReceiverStatus	O estado do recetor.

TestNotificationDetailsResponse

Os detalhes dos resultados da notificação de teste.

Name	Tipo	Description
actionDetails	ActionDetail[]	A lista de detalhes da ação
completedTime	string	A hora concluída
context	Context	As informações de contexto
createdTime	string	A hora de criação
state	string	O estado geral

VoiceReceiver

Um recetor de voz.

Name	Tipo	Description
countryCode	string	O código de país do recetor de voz.
name	string	O nome do recetor de voz. Os nomes têm de ser exclusivos em todos os recetores dentro de um grupo de ações.
phoneNumber	string	O número de telefone do recetor de voz.

WebhookReceiver

Um recetor de webhook.

Name	Tipo	Default value	Description
identifierUri	string		Indica o uri do identificador para aad auth.
name	string		O nome do recetor do webhook. Os nomes têm de ser exclusivos em todos os recetores dentro de um grupo de ações.
objectId	string		Indica o ID do objeto da aplicação webhook para autenticação de aad.
serviceUri	string		O URI para onde os webhooks devem ser enviados.
tenantId	string		Indica o ID do inquilino para aad auth.
useAadAuth	boolean	False	Indica se utiliza ou não a autenticação do AAD.
useCommonAlertSchema	boolean	False	Indica se deve utilizar um esquema de alerta comum.

Partilhar via

Action Groups - Create Notifications At Resource Group Level

Parâmetros do URI

Corpo do Pedido

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

Create notifications at resource group level

Pedido de amostra

Resposta da amostra

Definições

ActionDetail

ArmRoleReceiver

AutomationRunbookReceiver

AzureAppPushReceiver

AzureFunctionReceiver

Context

EmailReceiver

ErrorResponse

EventHubReceiver

ItsmReceiver

LogicAppReceiver

NotificationRequestBody

ReceiverStatus

SmsReceiver

TestNotificationDetailsResponse

VoiceReceiver

WebhookReceiver

Recursos adicionais