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 receptores fornecidos

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string	A ID da assinatura de destino.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
alertType	True	string	O valor do tipo de alerta com suporte. Os valores de tipo de alerta com suporte são: servicehealth, metricstaticthreshold, metricsdynamicthreshold, logalertv2, smartalert, webtestalert, logalertv1numresult, logalertv1metricmeasurement, resourcehealth, activitylog, actualcostbudget, forecastedbudget
armRoleReceivers		ArmRoleReceiver[]	A lista de receptores de função arm que fazem parte desse grupo de ações. As funções são funções RBAC do Azure e há suporte apenas para funções internas.
automationRunbookReceivers		AutomationRunbookReceiver[]	A lista de receptores AutomationRunbook que fazem parte desse grupo de ações.
azureAppPushReceivers		AzureAppPushReceiver[]	A lista de receptores AzureAppPush que fazem parte desse grupo de ações.
azureFunctionReceivers		AzureFunctionReceiver[]	A lista de receptores de função do Azure que fazem parte desse grupo de ações.
emailReceivers		EmailReceiver[]	A lista de receptores de email que fazem parte desse grupo de ações.
eventHubReceivers		EventHubReceiver[]	A lista de receptores do hub de eventos que fazem parte desse grupo de ações.
itsmReceivers		ItsmReceiver[]	A lista de receptores ITSM que fazem parte desse grupo de ações.
logicAppReceivers		LogicAppReceiver[]	A lista de receptores de aplicativo lógico que fazem parte desse grupo de ações.
smsReceivers		SmsReceiver[]	A lista de receptores sms que fazem parte desse grupo de ações.
voiceReceivers		VoiceReceiver[]	A lista de receptores de voz que fazem parte desse grupo de ações.
webhookReceivers		WebhookReceiver[]	A lista de receptores de webhook que fazem parte desse grupo de ações.

Respostas

Nome	Tipo	Description
200 OK	TestNotificationDetailsResponse	A notificação foi bem-sucedida
202 Accepted		A solicitação de notificação aceita Cabeçalhos location: string
Other Status Codes	ErrorResponse	Ocorreu um erro ao enviar as notificações de teste

Nome

Tipo

Description

200 OK

TestNotificationDetailsResponse

A notificação foi bem-sucedida

202 Accepted

A solicitação de notificação aceita

Cabeçalhos

location: string

Other Status Codes

ErrorResponse

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

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Create notifications at resource group level

Solicitação de exemplo

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 de exemplo

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

Nome	Description
ActionDetail	Os detalhes da ação
ArmRoleReceiver	Um receptor de função de braço.
AutomationRunbookReceiver	O Automação do Azure receptor de notificação do Runbook.
AzureAppPushReceiver	O receptor de notificação por push do aplicativo móvel do Azure.
AzureFunctionReceiver	Um receptor de função do azure.
Context	As informações de contexto
EmailReceiver	Um receptor de email.
ErrorResponse	Descreve o formato da resposta de erro.
EventHubReceiver	Um receptor do hub de eventos.
ItsmReceiver	Um receptor Itsm.
LogicAppReceiver	Um receptor de aplicativo lógico.
NotificationRequestBody	O corpo da solicitação que contém metadados de detalhes do contato
ReceiverStatus	Indica o status do receptor. Os receptores que não estão habilitados não receberão nenhuma comunicação.
SmsReceiver	Um receptor SMS.
TestNotificationDetailsResponse	Os detalhes dos resultados da notificação de teste.
VoiceReceiver	Um receptor de voz.
WebhookReceiver	Um receptor de webhook.

ActionDetail

Os detalhes da ação

Nome	Tipo	Description
Detail	string	Os detalhes 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 status da ação
SubState	string	O substatus da ação

ArmRoleReceiver

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

Nome	Tipo	Valor padrão	Description
name	string		O nome do receptor da função de braço. Os nomes devem ser exclusivos em todos os receptores dentro de um grupo de ações.
roleId	string		A ID da função de braço.
useCommonAlertSchema	boolean	False	Indica se o esquema de alerta comum deve ser usado.

AutomationRunbookReceiver

O Automação do Azure receptor de notificação do Runbook.

Nome	Tipo	Valor padrão	Description
automationAccountId	string		A ID da conta de automação do Azure que contém esse runbook e se autentica no recurso do Azure.
isGlobalRunbook	boolean		Indica se essa 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 o esquema de alerta comum deve ser usado.
webhookResourceId	string		A ID do recurso para webhook vinculada a esse runbook.

AzureAppPushReceiver

O receptor de notificação por push do aplicativo móvel do Azure.

Nome	Tipo	Description
emailAddress	string	O endereço de email registrado para o aplicativo móvel do Azure.
name	string	O nome do receptor de push do aplicativo móvel do Azure. Os nomes devem ser exclusivos em todos os receptores dentro de um grupo de ações.

AzureFunctionReceiver

Um receptor de função do azure.

Nome	Tipo	Valor padrão	Description
functionAppResourceId	string		A ID do recurso do azure do aplicativo de funções.
functionName	string		O nome da função no aplicativo de funções.
httpTriggerUrl	string		A URL do gatilho http para a qual a solicitação http foi enviada.
name	string		O nome do receptor de função do azure. Os nomes devem ser exclusivos em todos os receptores dentro de um grupo de ações.
useCommonAlertSchema	boolean	False	Indica se o esquema de alerta comum deve ser usado.

Context

As informações de contexto

Nome	Tipo	Description
contextType	string	O tipo de ID de contexto
notificationSource	string	A origem da solicitação de notificação

EmailReceiver

Um receptor de email.

Nome	Tipo	Valor padrão	Description
emailAddress	string		O endereço de email deste receptor.
name	string		O nome do receptor de email. Os nomes devem ser exclusivos em todos os receptores dentro de um grupo de ações.
status	ReceiverStatus		O receptor status do email.
useCommonAlertSchema	boolean	False	Indica se o esquema de alerta comum deve ser usado.

ErrorResponse

Descreve o formato da resposta de erro.

Nome	Tipo	Description
code	string	Código do erro
message	string	Mensagem de erro indicando por que a operação falhou.

EventHubReceiver

Um receptor do hub de eventos.

Nome	Tipo	Valor padrão	Description
eventHubName	string		O nome da fila específica do Hub de Eventos
eventHubNameSpace	string		O namespace do Hub de Eventos
name	string		O nome do receptor do hub de eventos. Os nomes devem ser exclusivos em todos os receptores dentro de um grupo de ações.
subscriptionId	string		A ID da assinatura que contém esse hub de eventos
tenantId	string		A ID do locatário da assinatura que contém esse hub de eventos
useCommonAlertSchema	boolean	False	Indica se o esquema de alerta comum deve ser usado.

ItsmReceiver

Um receptor Itsm.

Nome	Tipo	Description
connectionId	string	Identificação exclusiva da conexão ITSM entre vários definidos no workspace acima.
name	string	O nome do receptor Itsm. Os nomes devem ser exclusivos em todos os receptores dentro de um grupo de ações.
region	string	Região na qual o workspace reside. Valores com suporte:'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 desse blob.
workspaceId	string	Identificador de instância do OMS LA.

LogicAppReceiver

Um receptor de aplicativo lógico.

Nome	Tipo	Valor padrão	Description
callbackUrl	string		A URL de retorno de chamada para a qual a solicitação http foi enviada.
name	string		O nome do receptor do aplicativo lógico. Os nomes devem ser exclusivos em todos os receptores dentro de um grupo de ações.
resourceId	string		A ID do recurso do azure do receptor do aplicativo lógico.
useCommonAlertSchema	boolean	False	Indica se o esquema de alerta comum deve ser usado.

NotificationRequestBody

O corpo da solicitação que contém metadados de detalhes do contato

Nome	Tipo	Description
alertType	string	O valor do tipo de alerta com suporte. Os valores de tipo de alerta com suporte são: servicehealth, metricstaticthreshold, metricsdynamicthreshold, logalertv2, smartalert, webtestalert, logalertv1numresult, logalertv1metricmeasurement, resourcehealth, activitylog, actualcostbudget, forecastedbudget
armRoleReceivers	ArmRoleReceiver[]	A lista de receptores de função arm que fazem parte desse grupo de ações. As funções são funções RBAC do Azure e há suporte apenas para funções internas.
automationRunbookReceivers	AutomationRunbookReceiver[]	A lista de receptores AutomationRunbook que fazem parte desse grupo de ações.
azureAppPushReceivers	AzureAppPushReceiver[]	A lista de receptores AzureAppPush que fazem parte desse grupo de ações.
azureFunctionReceivers	AzureFunctionReceiver[]	A lista de receptores de função do azure que fazem parte desse grupo de ações.
emailReceivers	EmailReceiver[]	A lista de receptores de email que fazem parte desse grupo de ações.
eventHubReceivers	EventHubReceiver[]	A lista de receptores do hub de eventos que fazem parte desse grupo de ações.
itsmReceivers	ItsmReceiver[]	A lista de receptores ITSM que fazem parte desse grupo de ações.
logicAppReceivers	LogicAppReceiver[]	A lista de receptores de aplicativo lógico que fazem parte desse grupo de ações.
smsReceivers	SmsReceiver[]	A lista de receptores SMS que fazem parte desse grupo de ações.
voiceReceivers	VoiceReceiver[]	A lista de receptores de voz que fazem parte desse grupo de ações.
webhookReceivers	WebhookReceiver[]	A lista de receptores de webhook que fazem parte desse grupo de ações.

ReceiverStatus

Indica o status do receptor. Os receptores que não estão habilitados não receberão nenhuma comunicação.

Nome	Tipo	Description
Disabled	string
Enabled	string
NotSpecified	string

SmsReceiver

Um receptor SMS.

Nome	Tipo	Description
countryCode	string	O código de país do receptor sms.
name	string	O nome do receptor SMS. Os nomes devem ser exclusivos em todos os receptores dentro de um grupo de ações.
phoneNumber	string	O número de telefone do receptor sms.
status	ReceiverStatus	O status do receptor.

TestNotificationDetailsResponse

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

Nome	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 criada
state	string	O estado geral

VoiceReceiver

Um receptor de voz.

Nome	Tipo	Description
countryCode	string	O código do país do receptor de voz.
name	string	O nome do receptor de voz. Os nomes devem ser exclusivos em todos os receptores dentro de um grupo de ações.
phoneNumber	string	O número de telefone do receptor de voz.

WebhookReceiver

Um receptor de webhook.

Nome	Tipo	Valor padrão	Description
identifierUri	string		Indica o uri do identificador para autenticação do aad.
name	string		O nome do receptor do webhook. Os nomes devem ser exclusivos em todos os receptores dentro de um grupo de ações.
objectId	string		Indica a ID do objeto do aplicativo webhook para autenticação do aad.
serviceUri	string		O URI para onde os webhooks devem ser enviados.
tenantId	string		Indica a ID do locatário para autenticação do aad.
useAadAuth	boolean	False	Indica se a autenticação do AAD deve ou não ser usada.
useCommonAlertSchema	boolean	False	Indica se o esquema de alerta comum deve ser usado.

Compartilhar via

Action Groups - Create Notifications At Resource Group Level

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

azure_auth

Escopos

Exemplos

Create notifications at resource group level

Solicitação de exemplo

Resposta de exemplo

Definições

ActionDetail

ArmRoleReceiver

AutomationRunbookReceiver

AzureAppPushReceiver

AzureFunctionReceiver

Context

EmailReceiver

ErrorResponse

EventHubReceiver

ItsmReceiver

LogicAppReceiver

NotificationRequestBody

ReceiverStatus

SmsReceiver

TestNotificationDetailsResponse

VoiceReceiver

WebhookReceiver

Recursos adicionais