Action Groups - Post Test Notifications
Enviar notificaciones de prueba a un conjunto de receptores proporcionados
POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Insights/createNotifications?api-version=2021-09-01
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
subscription
|
path | True |
string |
Identificador de la suscripción de destino. |
api-version
|
query | True |
string |
Versión de API que se usará para la operación. |
Cuerpo de la solicitud
Nombre | Requerido | Tipo | Description |
---|---|---|---|
alertType | True |
string |
Valor del tipo de alerta admitido. Los valores de tipo de alerta admitidos son: servicehealth, metricstaticthreshold, metricsdynamicthreshold, logalertv2, smartalert, webtestalert, logalertv1numresult, logalertv1metricmeasurement, resourcehealth, activitylog, actualcostbudget, forecastedbudget |
armRoleReceivers |
Lista de receptores de roles arm que forman parte de este grupo de acciones. Los roles son roles RBAC de Azure y solo se admiten roles integrados. |
||
automationRunbookReceivers |
Lista de receptores AutomationRunbook que forman parte de este grupo de acciones. |
||
azureAppPushReceivers |
Lista de receptores de AzureAppPush que forman parte de este grupo de acciones. |
||
azureFunctionReceivers |
Lista de receptores de funciones de Azure que forman parte de este grupo de acciones. |
||
emailReceivers |
Lista de receptores de correo electrónico que forman parte de este grupo de acciones. |
||
eventHubReceivers |
Lista de receptores del centro de eventos que forman parte de este grupo de acciones. |
||
itsmReceivers |
Lista de receptores ITSM que forman parte de este grupo de acciones. |
||
logicAppReceivers |
Lista de receptores de aplicaciones lógicas que forman parte de este grupo de acciones. |
||
smsReceivers |
Lista de receptores sms que forman parte de este grupo de acciones. |
||
voiceReceivers |
Lista de receptores de voz que forman parte de este grupo de acciones. |
||
webhookReceivers |
Lista de receptores de webhook que forman parte de este grupo de acciones. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
La notificación se realizó correctamente |
|
202 Accepted |
La solicitud de notificación aceptada Encabezados location: string |
|
Other Status Codes |
Error al enviar las notificaciones de prueba |
Seguridad
azure_auth
Flujo OAuth2 de Azure Active Directory
Tipo:
oauth2
Flujo:
implicit
Dirección URL de autorización:
https://login.microsoftonline.com/common/oauth2/authorize
Ámbitos
Nombre | Description |
---|---|
user_impersonation | suplantación de su cuenta de usuario |
Ejemplos
Create notifications at subscription level
Solicitud de ejemplo
POST https://management.azure.com/subscriptions/187f412d-1758-44d9-b052-169e2564721d/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
}
]
}
Respuesta de muestra
location: https://management.azure.com/subscriptions/11111111-1111-1111-1111-111111111111/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
}
]
}
Definiciones
Nombre | Description |
---|---|
Action |
Detalles de la acción |
Arm |
Receptor de roles de brazo. |
Automation |
Receptor de notificaciones de runbook Azure Automation. |
Azure |
Receptor de notificaciones push de aplicación móvil de Azure. |
Azure |
Receptor de funciones de Azure. |
Context |
Información de contexto |
Email |
Un receptor de correo electrónico. |
Error |
Describe el formato de respuesta de error. |
Event |
Un receptor del centro de eventos. |
Itsm |
Un receptor Itsm. |
Logic |
Un receptor de aplicación lógica. |
Notification |
El cuerpo de la solicitud que contiene metadatos de detalles de contacto |
Receiver |
Indica el estado del receptor. Los receptores que no están habilitados no recibirán ninguna comunicación. |
Sms |
Un receptor sms. |
Test |
Detalles de los resultados de la notificación de prueba. |
Voice |
Un receptor de voz. |
Webhook |
Un receptor de webhook. |
ActionDetail
Detalles de la acción
Nombre | Tipo | Description |
---|---|---|
Detail |
string |
Detalles del mensaje de error descriptivo |
MechanismType |
string |
Tipo de mecanismo |
Name |
string |
Nombre de la acción |
SendTime |
string |
Hora de envío |
Status |
string |
Estado de la acción |
SubState |
string |
Subestado de la acción |
ArmRoleReceiver
Receptor de roles de brazo.
Nombre | Tipo | Valor predeterminado | Description |
---|---|---|---|
name |
string |
Nombre del receptor del rol de brazo. Los nombres deben ser únicos en todos los receptores de un grupo de acciones. |
|
roleId |
string |
Identificador del rol de brazo. |
|
useCommonAlertSchema |
boolean |
False |
Indica si se debe usar el esquema de alertas común. |
AutomationRunbookReceiver
Receptor de notificaciones de runbook Azure Automation.
Nombre | Tipo | Valor predeterminado | Description |
---|---|---|---|
automationAccountId |
string |
El identificador de la cuenta de Azure Automation que contiene este runbook y se autentica en el recurso de Azure. |
|
isGlobalRunbook |
boolean |
Indica si esta instancia es un runbook global. |
|
name |
string |
Indica el nombre del webhook. |
|
runbookName |
string |
Nombre de este runbook. |
|
serviceUri |
string |
URI donde se deben enviar webhooks. |
|
useCommonAlertSchema |
boolean |
False |
Indica si se debe usar el esquema de alertas común. |
webhookResourceId |
string |
Identificador de recurso del webhook vinculado a este runbook. |
AzureAppPushReceiver
Receptor de notificaciones push de aplicación móvil de Azure.
Nombre | Tipo | Description |
---|---|---|
emailAddress |
string |
La dirección de correo electrónico registrada para la aplicación móvil de Azure. |
name |
string |
Nombre del receptor de inserción de la aplicación móvil de Azure. Los nombres deben ser únicos en todos los receptores de un grupo de acciones. |
AzureFunctionReceiver
Receptor de funciones de Azure.
Nombre | Tipo | Valor predeterminado | Description |
---|---|---|---|
functionAppResourceId |
string |
Identificador de recurso de Azure de la aplicación de funciones. |
|
functionName |
string |
El nombre de la función en la aplicación de funciones. |
|
httpTriggerUrl |
string |
Dirección URL del desencadenador http a la que se envió la solicitud http. |
|
name |
string |
Nombre del receptor de la función de Azure. Los nombres deben ser únicos en todos los receptores de un grupo de acciones. |
|
useCommonAlertSchema |
boolean |
False |
Indica si se debe usar el esquema de alertas común. |
Context
Información de contexto
Nombre | Tipo | Description |
---|---|---|
contextType |
string |
Tipo de identificador de contexto |
notificationSource |
string |
Origen de la solicitud de notificación |
EmailReceiver
Un receptor de correo electrónico.
Nombre | Tipo | Valor predeterminado | Description |
---|---|---|---|
emailAddress |
string |
Dirección de correo electrónico de este receptor. |
|
name |
string |
Nombre del receptor de correo electrónico. Los nombres deben ser únicos en todos los receptores de un grupo de acciones. |
|
status |
Estado del receptor del correo electrónico. |
||
useCommonAlertSchema |
boolean |
False |
Indica si se debe usar el esquema de alertas común. |
ErrorResponse
Describe el formato de respuesta de error.
Nombre | Tipo | Description |
---|---|---|
code |
string |
Código de error |
message |
string |
Mensaje de error que indica por qué se produjo un error en la operación. |
EventHubReceiver
Un receptor del centro de eventos.
Nombre | Tipo | Valor predeterminado | Description |
---|---|---|---|
eventHubName |
string |
Nombre de la cola específica del centro de eventos |
|
eventHubNameSpace |
string |
El espacio de nombres del centro de eventos |
|
name |
string |
Nombre del receptor del centro de eventos. Los nombres deben ser únicos en todos los receptores de un grupo de acciones. |
|
subscriptionId |
string |
Identificador de la suscripción que contiene este centro de eventos |
|
tenantId |
string |
Identificador de inquilino de la suscripción que contiene este centro de eventos |
|
useCommonAlertSchema |
boolean |
False |
Indica si se debe usar el esquema de alertas común. |
ItsmReceiver
Un receptor Itsm.
Nombre | Tipo | Description |
---|---|---|
connectionId |
string |
Identificación única de la conexión itsm entre varias definidas en el área de trabajo anterior. |
name |
string |
Nombre del receptor itsm. Los nombres deben ser únicos en todos los receptores de un grupo de acciones. |
region |
string |
Región en la que reside el área de trabajo. Valores admitidos:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope' |
ticketConfiguration |
string |
Blob JSON para las configuraciones de la acción ITSM. La opción CreateMultipleWorkItems también formará parte de este blob. |
workspaceId |
string |
Identificador de instancia de OMS LA. |
LogicAppReceiver
Un receptor de aplicación lógica.
Nombre | Tipo | Valor predeterminado | Description |
---|---|---|---|
callbackUrl |
string |
Dirección URL de devolución de llamada a la que se envió la solicitud http. |
|
name |
string |
Nombre del receptor de la aplicación lógica. Los nombres deben ser únicos en todos los receptores de un grupo de acciones. |
|
resourceId |
string |
Identificador de recurso de Azure del receptor de la aplicación lógica. |
|
useCommonAlertSchema |
boolean |
False |
Indica si se debe usar el esquema de alertas común. |
NotificationRequestBody
El cuerpo de la solicitud que contiene metadatos de detalles de contacto
Nombre | Tipo | Description |
---|---|---|
alertType |
string |
Valor del tipo de alerta admitido. Los valores de tipo de alerta admitidos son: servicehealth, metricstaticthreshold, metricsdynamicthreshold, logalertv2, smartalert, webtestalert, logalertv1numresult, logalertv1metricmeasurement, resourcehealth, activitylog, actualcostbudget, forecastedbudget |
armRoleReceivers |
Lista de receptores de roles arm que forman parte de este grupo de acciones. Los roles son roles RBAC de Azure y solo se admiten los roles integrados. |
|
automationRunbookReceivers |
La lista de receptores AutomationRunbook que forman parte de este grupo de acciones. |
|
azureAppPushReceivers |
La lista de receptores de AzureAppPush que forman parte de este grupo de acciones. |
|
azureFunctionReceivers |
La lista de receptores de funciones de Azure que forman parte de este grupo de acciones. |
|
emailReceivers |
Lista de receptores de correo electrónico que forman parte de este grupo de acciones. |
|
eventHubReceivers |
Lista de receptores de centro de eventos que forman parte de este grupo de acciones. |
|
itsmReceivers |
Lista de receptores itsm que forman parte de este grupo de acciones. |
|
logicAppReceivers |
Lista de receptores de aplicaciones lógicas que forman parte de este grupo de acciones. |
|
smsReceivers |
Lista de receptores de SMS que forman parte de este grupo de acciones. |
|
voiceReceivers |
Lista de receptores de voz que forman parte de este grupo de acciones. |
|
webhookReceivers |
Lista de receptores de webhook que forman parte de este grupo de acciones. |
ReceiverStatus
Indica el estado del receptor. Los receptores que no están habilitados no recibirán ninguna comunicación.
Nombre | Tipo | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
|
NotSpecified |
string |
SmsReceiver
Un receptor sms.
Nombre | Tipo | Description |
---|---|---|
countryCode |
string |
Código de país del receptor sms. |
name |
string |
Nombre del receptor de SMS. Los nombres deben ser únicos en todos los receptores de un grupo de acciones. |
phoneNumber |
string |
Número de teléfono del receptor de SMS. |
status |
Estado del receptor. |
TestNotificationDetailsResponse
Detalles de los resultados de la notificación de prueba.
Nombre | Tipo | Description |
---|---|---|
actionDetails |
Lista de detalles de la acción |
|
completedTime |
string |
Hora de finalización |
context |
La información de contexto |
|
createdTime |
string |
Hora de creación |
state |
string |
El estado general |
VoiceReceiver
Un receptor de voz.
Nombre | Tipo | Description |
---|---|---|
countryCode |
string |
Código de país del receptor de voz. |
name |
string |
Nombre del receptor de voz. Los nombres deben ser únicos en todos los receptores de un grupo de acciones. |
phoneNumber |
string |
Número de teléfono del receptor de voz. |
WebhookReceiver
Un receptor de webhook.
Nombre | Tipo | Valor predeterminado | Description |
---|---|---|---|
identifierUri |
string |
Indica el identificador URI de la autenticación de aad. |
|
name |
string |
Nombre del receptor de webhook. Los nombres deben ser únicos en todos los receptores de un grupo de acciones. |
|
objectId |
string |
Indica el identificador de objeto de aplicación de webhook para la autenticación de aad. |
|
serviceUri |
string |
URI donde se deben enviar webhooks. |
|
tenantId |
string |
Indica el identificador de inquilino para la autenticación de aad. |
|
useAadAuth |
boolean |
False |
Indica si se usa o no la autenticación de AAD. |
useCommonAlertSchema |
boolean |
False |
Indica si se debe usar el esquema de alertas común. |