Microsoft.Insights scheduledQueryRules 2018-04-16
Définition de ressource Bicep
Le type de ressource scheduledQueryRules peut être déployé avec des opérations qui ciblent :
- Groupes de ressources - Voir commandes de déploiement de groupe de ressources
Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.
Notes
Pour obtenir des conseils sur le déploiement de solutions de supervision, consultez Créer des ressources de supervision à l’aide de Bicep.
Format des ressources
Pour créer une ressource Microsoft.Insights/scheduledQueryRules, ajoutez le Bicep suivant à votre modèle.
resource symbolicname 'Microsoft.Insights/scheduledQueryRules@2018-04-16' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
properties: {
action: {
'odata.type': 'string'
// For remaining properties, see Action objects
}
autoMitigate: bool
description: 'string'
displayName: 'string'
enabled: 'string'
schedule: {
frequencyInMinutes: int
timeWindowInMinutes: int
}
source: {
authorizedResources: [
'string'
]
dataSourceId: 'string'
query: 'string'
queryType: 'ResultCount'
}
}
}
Objets Action
Définissez la propriété odata.type pour spécifier le type d’objet.
Pour Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction, utilisez :
'odata.type': 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction'
aznsAction: {
actionGroup: [
'string'
]
customWebhookPayload: 'string'
emailSubject: 'string'
}
severity: 'string'
throttlingInMin: int
trigger: {
metricTrigger: {
metricColumn: 'string'
metricTriggerType: 'string'
threshold: int
thresholdOperator: 'string'
}
threshold: int
thresholdOperator: 'string'
}
Pour Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction, utilisez :
'odata.type': 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction'
criteria: [
{
dimensions: [
{
name: 'string'
operator: 'Include'
values: [
'string'
]
}
]
metricName: 'string'
}
]
Valeurs de propriétés
scheduledQueryRules
| Nom | Description | Valeur |
|---|---|---|
| name | Nom de la ressource | string (obligatoire) Limite de caractères : 1-260 Caractères valides : Impossibilité d’utiliser : *<>%{}&:\\?/# ou des caractères de contrôle.Ne peut pas se terminer par un espace ou un point. |
| location | Emplacement de la ressource | string (obligatoire) |
| tags | Balises de ressource | Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles |
| properties | Propriétés de règle de la ressource. | LogSearchRule (obligatoire) |
LogSearchRule
| Nom | Description | Valeur |
|---|---|---|
| action | Des mesures doivent être prises sur l’exécution de la règle. | Action (obligatoire) |
| autoMitigate | Indicateur qui indique si l’alerte doit être résolue automatiquement ou non. La valeur par défaut est false. | bool |
| description | Description de la règle recherche dans les journaux. | string |
| displayName | Nom complet de la règle d’alerte | string |
| enabled | Indicateur qui indique si la règle recherche dans les journaux est activée. La valeur doit être true ou false | 'false' 'true' |
| schedule | Planification (fréquence, fenêtre de temps) pour la règle. Requis pour le type d’action - AlertingAction | Planification |
| source | Source de données par rapport à quelle règle interrogera les données | Source (obligatoire) |
Action
AlertingAction
| Nom | Description | Valeur |
|---|---|---|
| odata.type | Spécifie l’action. Valeurs prises en charge - AlertingAction, LogToMetricAction | « Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction » (obligatoire) |
| aznsAction | Informations de référence sur les groupes d’actions Azure. | AzNsActionGroup |
| severity | Gravité de l'alerte | « 0 » « 1 » '2' '3' '4' (obligatoire) |
| throttlingInMin | heure (en minutes) pour laquelle les alertes doivent être limitées ou supprimées. | int |
| déclencheur | Condition de déclencheur qui entraîne l’exécution de la règle d’alerte. | TriggerCondition (obligatoire) |
AzNsActionGroup
| Nom | Description | Valeur |
|---|---|---|
| actionGroup | Informations de référence sur le groupe d’actions Azure. | string[] |
| customWebhookPayload | Charge utile personnalisée à envoyer pour tous les URI de webhook dans le groupe d’actions Azure | string |
| emailSubject | Remplacement d’objet personnalisé pour tous les ID de messagerie dans le groupe d’actions Azure | string |
TriggerCondition
| Nom | Description | Valeur |
|---|---|---|
| metricTrigger | Condition de déclencheur pour la règle de requête de métrique | LogMetricTrigger |
| threshold | Seuil de résultat ou de nombre en fonction de la règle à déclencher. | int (obligatoire) |
| thresholdOperator | Opération d’évaluation pour la règle - 'GreaterThan' ou 'LessThan. | 'Equal' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' (obligatoire) |
LogMetricTrigger
| Nom | Description | Valeur |
|---|---|---|
| metricColumn | Évaluation de la métrique sur une colonne particulière | string |
| metricTriggerType | Type de déclencheur de métrique : « Consécutif » ou « Total » | 'Consécutif' 'Total' |
| threshold | Seuil du déclencheur de métrique. | int |
| thresholdOperator | Opération d’évaluation pour Metric -'GreaterThan' ou 'LessThan' ou 'Equal'. | 'Equal' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' |
LogToMetricAction
| Nom | Description | Valeur |
|---|---|---|
| odata.type | Spécifie l’action. Valeurs prises en charge - AlertingAction, LogToMetricAction | « Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction » (obligatoire) |
| criteria | Critères de métrique | Critères[] (obligatoire) |
Critères
| Nom | Description | Valeur |
|---|---|---|
| dimensions | Liste des dimensions pour la création d’une métrique | Dimension[] |
| metricName | Nom de la métrique | chaîne (obligatoire) |
Dimension
| Nom | Description | Valeur |
|---|---|---|
| name | Nom de la dimension | chaîne (obligatoire) |
| operator | Opérateur pour les valeurs de dimension | 'Include' (obligatoire) |
| values | Liste des valeurs de dimension | string[] (obligatoire) |
Planifier
| Nom | Description | Valeur |
|---|---|---|
| frequencyInMinutes | fréquence (en minutes) à laquelle la condition de règle doit être évaluée. | int (obligatoire) |
| timeWindowInMinutes | Fenêtre de temps pour laquelle les données doivent être extraites pour la requête (doit être supérieure ou égale à frequencyInMinutes). | int (obligatoire) |
Source
| Nom | Description | Valeur |
|---|---|---|
| authorizedResources | Liste des ressources référencées dans la requête | string[] |
| dataSourceId | URI de ressource sur lequel la requête de recherche de journal doit être exécutée. | chaîne (obligatoire) |
| query | Requête de recherche dans les journaux. Obligatoire pour le type d’action - AlertingAction | string |
| queryType | Définissez la valeur « ResultCount » . | 'ResultCount' |
Définition de ressources de modèle ARM
Le type de ressource scheduledQueryRules peut être déployé avec des opérations qui ciblent :
- Groupes de ressources - Voir commandes de déploiement de groupes de ressources
Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.
Notes
Pour obtenir des conseils sur le déploiement de solutions de supervision, consultez Créer des ressources de supervision à l’aide de Bicep.
Format des ressources
Pour créer une ressource Microsoft.Insights/scheduledQueryRules, ajoutez le JSON suivant à votre modèle.
{
"type": "Microsoft.Insights/scheduledQueryRules",
"apiVersion": "2018-04-16",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"action": {
"odata.type": "string"
// For remaining properties, see Action objects
},
"autoMitigate": "bool",
"description": "string",
"displayName": "string",
"enabled": "string",
"schedule": {
"frequencyInMinutes": "int",
"timeWindowInMinutes": "int"
},
"source": {
"authorizedResources": [ "string" ],
"dataSourceId": "string",
"query": "string",
"queryType": "ResultCount"
}
}
}
Objets d’action
Définissez la propriété odata.type pour spécifier le type d’objet.
Pour Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction, utilisez :
"odata.type": "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction",
"aznsAction": {
"actionGroup": [ "string" ],
"customWebhookPayload": "string",
"emailSubject": "string"
},
"severity": "string",
"throttlingInMin": "int",
"trigger": {
"metricTrigger": {
"metricColumn": "string",
"metricTriggerType": "string",
"threshold": "int",
"thresholdOperator": "string"
},
"threshold": "int",
"thresholdOperator": "string"
}
Pour Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction, utilisez :
"odata.type": "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction",
"criteria": [
{
"dimensions": [
{
"name": "string",
"operator": "Include",
"values": [ "string" ]
}
],
"metricName": "string"
}
]
Valeurs de propriétés
scheduledQueryRules
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | « Microsoft.Insights/scheduledQueryRules » |
| apiVersion | Version de l’API de ressource | '2018-04-16' |
| name | Nom de la ressource | chaîne (obligatoire) Limite de caractères : 1-260 Caractères valides : Impossibilité d’utiliser : *<>%{}&:\\?/# ou des caractères de contrôle.Ne peut pas se terminer par un espace ou un point. |
| location | Emplacement de la ressource | chaîne (obligatoire) |
| tags | Balises de ressource | Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles |
| properties | Propriétés de règle de la ressource. | LogSearchRule (obligatoire) |
LogSearchRule
| Nom | Description | Valeur |
|---|---|---|
| action | Une action doit être effectuée sur l’exécution de la règle. | Action (obligatoire) |
| autoMitigate | Indicateur qui indique si l’alerte doit être résolue automatiquement ou non. La valeur par défaut est false. | bool |
| description | Description de la règle Recherche dans les journaux. | string |
| displayName | Nom d’affichage de la règle d’alerte | string |
| enabled | Indicateur qui indique si la règle Recherche dans les journaux est activée. La valeur doit être true ou false | 'false' 'true' |
| schedule | Planifier (Fréquence, fenêtre Heure) pour la règle. Obligatoire pour le type d’action - AlertingAction | Planification |
| source | Source de données par rapport à quelle règle interrogera les données | Source (obligatoire) |
Action
AlertingAction
| Nom | Description | Valeur |
|---|---|---|
| odata.type | Spécifie l’action. Valeurs prises en charge - AlertingAction, LogToMetricAction | « Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction » (obligatoire) |
| aznsAction | Informations de référence sur les groupes d’actions Azure. | AzNsActionGroup |
| severity | Gravité de l'alerte | « 0 » « 1 » '2' '3' '4' (obligatoire) |
| throttlingInMin | heure (en minutes) pendant laquelle les alertes doivent être limitées ou supprimées. | int |
| déclencheur | Condition de déclencheur qui entraîne l’exécution de la règle d’alerte. | TriggerCondition (obligatoire) |
AzNsActionGroup
| Nom | Description | Valeur |
|---|---|---|
| actionGroup | Informations de référence sur le groupe d’actions Azure. | string[] |
| customWebhookPayload | Charge utile personnalisée à envoyer pour tous les URI de webhook dans le groupe d’actions Azure | string |
| emailSubject | Remplacement d’objet personnalisé pour tous les ID d’e-mail dans le groupe d’actions Azure | string |
TriggerCondition
| Nom | Description | Valeur |
|---|---|---|
| metricTrigger | Condition de déclenchement pour la règle de requête de métrique | LogMetricTrigger |
| threshold | Seuil de résultat ou de nombre en fonction de la règle à déclencher. | int (obligatoire) |
| thresholdOperator | Opération d’évaluation pour la règle - 'GreaterThan' ou 'LessThan. | 'Equal' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' (obligatoire) |
LogMetricTrigger
| Nom | Description | Valeur |
|---|---|---|
| metricColumn | Évaluation de la métrique sur une colonne particulière | string |
| metricTriggerType | Type de déclencheur de métrique : « Consécutif » ou « Total » | 'Consécutif' 'Total' |
| threshold | Seuil du déclencheur de métrique. | int |
| thresholdOperator | Opération d’évaluation pour metric -'GreaterThan', 'LessThan' ou 'Equal'. | 'Equal' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' |
LogToMetricAction
| Nom | Description | Valeur |
|---|---|---|
| odata.type | Spécifie l’action. Valeurs prises en charge - AlertingAction, LogToMetricAction | « Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction » (obligatoire) |
| criteria | Critères de métrique | Critères[] (obligatoire) |
Critères
| Nom | Description | Valeur |
|---|---|---|
| dimensions | Liste de dimensions pour la création d’une métrique | Dimension[] |
| metricName | Nom de la métrique | string (obligatoire) |
Dimension
| Nom | Description | Valeur |
|---|---|---|
| name | Nom de la dimension | chaîne (obligatoire) |
| operator | Opérateur pour les valeurs de dimension | 'Include' (obligatoire) |
| values | Liste des valeurs de dimension | string[] (obligatoire) |
Planifier
| Nom | Description | Valeur |
|---|---|---|
| frequencyInMinutes | fréquence (en minutes) à laquelle la condition de règle doit être évaluée. | int (obligatoire) |
| timeWindowInMinutes | Fenêtre de temps pour laquelle les données doivent être extraites pour la requête (doit être supérieure ou égale à frequencyInMinutes). | int (obligatoire) |
Source
| Nom | Description | Valeur |
|---|---|---|
| authorizedResources | Liste des ressources référencées dans la requête | string[] |
| dataSourceId | URI de ressource sur lequel la requête de recherche de journal doit être exécutée. | chaîne (obligatoire) |
| query | Requête de recherche dans les journaux. Obligatoire pour le type d’action - AlertingAction | string |
| queryType | Définissez la valeur « ResultCount » . | 'ResultCount' |
Définition de ressource Terraform (fournisseur AzAPI)
Le type de ressource scheduledQueryRules peut être déployé avec des opérations qui ciblent :
- Groupes de ressources
Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.
Format des ressources
Pour créer une ressource Microsoft.Insights/scheduledQueryRules, ajoutez le Terraform suivant à votre modèle.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Insights/scheduledQueryRules@2018-04-16"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
action = {
odata.type = "string"
// For remaining properties, see Action objects
}
autoMitigate = bool
description = "string"
displayName = "string"
enabled = "string"
schedule = {
frequencyInMinutes = int
timeWindowInMinutes = int
}
source = {
authorizedResources = [
"string"
]
dataSourceId = "string"
query = "string"
queryType = "ResultCount"
}
}
})
}
Objets d’action
Définissez la propriété odata.type pour spécifier le type d’objet.
Pour Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction, utilisez :
odata.type = "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction"
aznsAction = {
actionGroup = [
"string"
]
customWebhookPayload = "string"
emailSubject = "string"
}
severity = "string"
throttlingInMin = int
trigger = {
metricTrigger = {
metricColumn = "string"
metricTriggerType = "string"
threshold = int
thresholdOperator = "string"
}
threshold = int
thresholdOperator = "string"
}
Pour Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction, utilisez :
odata.type = "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction"
criteria = [
{
dimensions = [
{
name = "string"
operator = "Include"
values = [
"string"
]
}
]
metricName = "string"
}
]
Valeurs de propriétés
scheduledQueryRules
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | « Microsoft.Insights/scheduledQueryRules@2018-04-16 » |
| name | Nom de la ressource | chaîne (obligatoire) Limite de caractères : 1-260 Caractères valides : Impossibilité d’utiliser : *<>%{}&:\\?/# ou des caractères de contrôle.Ne peut pas se terminer par un espace ou un point. |
| location | Emplacement de la ressource | chaîne (obligatoire) |
| parent_id | Pour effectuer un déploiement sur un groupe de ressources, utilisez l’ID de ce groupe de ressources. | chaîne (obligatoire) |
| tags | Balises de ressource | Dictionnaire de noms et de valeurs d’étiquettes. |
| properties | Propriétés de règle de la ressource. | LogSearchRule (obligatoire) |
LogSearchRule
| Nom | Description | Valeur |
|---|---|---|
| action | Une action doit être effectuée sur l’exécution de la règle. | Action (obligatoire) |
| autoMitigate | Indicateur qui indique si l’alerte doit être résolue automatiquement ou non. La valeur par défaut est false. | bool |
| description | Description de la règle Recherche dans les journaux. | string |
| displayName | Nom d’affichage de la règle d’alerte | string |
| enabled | Indicateur qui indique si la règle Recherche dans les journaux est activée. La valeur doit être true ou false | "false" "true" |
| schedule | Planifier (Fréquence, fenêtre Heure) pour la règle. Obligatoire pour le type d’action - AlertingAction | Planification |
| source | Source de données par rapport à quelle règle interrogera les données | Source (obligatoire) |
Action
AlertingAction
| Nom | Description | Valeur |
|---|---|---|
| odata.type | Spécifie l’action. Valeurs prises en charge - AlertingAction, LogToMetricAction | « Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction » (obligatoire) |
| aznsAction | Référence du groupe d’actions Azure. | AzNsActionGroup |
| severity | Gravité de l'alerte | "0" "1" "2" "3" « 4 » (obligatoire) |
| throttlingInMin | heure (en minutes) pour laquelle les alertes doivent être limitées ou supprimées. | int |
| déclencheur | Condition de déclencheur qui entraîne l’exécution de la règle d’alerte. | TriggerCondition (obligatoire) |
AzNsActionGroup
| Nom | Description | Valeur |
|---|---|---|
| actionGroup | Informations de référence sur le groupe d’actions Azure. | string[] |
| customWebhookPayload | Charge utile personnalisée à envoyer pour tous les URI de webhook dans le groupe d’actions Azure | string |
| emailSubject | Remplacement d’objet personnalisé pour tous les ID de messagerie dans le groupe d’actions Azure | string |
TriggerCondition
| Nom | Description | Valeur |
|---|---|---|
| metricTrigger | Condition de déclencheur pour la règle de requête de métrique | LogMetricTrigger |
| threshold | Seuil de résultat ou de nombre en fonction de la règle à déclencher. | int (obligatoire) |
| thresholdOperator | Opération d’évaluation pour la règle - 'GreaterThan' ou 'LessThan. | « Égal » « GreaterThan » « GreaterThanOrEqual » « LessThan » « LessThanOrEqual » (obligatoire) |
LogMetricTrigger
| Nom | Description | Valeur |
|---|---|---|
| metricColumn | Évaluation de la métrique sur une colonne particulière | string |
| metricTriggerType | Type de déclencheur de métrique : « Consécutif » ou « Total » | « Consécutif » « Total » |
| threshold | Seuil du déclencheur de métrique. | int |
| thresholdOperator | Opération d’évaluation pour Metric -'GreaterThan' ou 'LessThan' ou 'Equal'. | « Égal » « GreaterThan » « GreaterThanOrEqual » « LessThan » « LessThanOrEqual » |
LogToMetricAction
| Nom | Description | Valeur |
|---|---|---|
| odata.type | Spécifie l’action. Valeurs prises en charge - AlertingAction, LogToMetricAction | « Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction » (obligatoire) |
| criteria | Critères de métrique | Critères[] (obligatoire) |
Critères
| Nom | Description | Valeur |
|---|---|---|
| dimensions | Liste des dimensions pour la création d’une métrique | Dimension[] |
| metricName | Nom de la métrique | chaîne (obligatoire) |
Dimension
| Nom | Description | Valeur |
|---|---|---|
| name | Nom de la dimension | chaîne (obligatoire) |
| operator | Opérateur pour les valeurs de dimension | « Include » (obligatoire) |
| values | Liste des valeurs de dimension | string[] (obligatoire) |
Planifier
| Nom | Description | Valeur |
|---|---|---|
| frequencyInMinutes | fréquence (en minutes) à laquelle la condition de règle doit être évaluée. | int (obligatoire) |
| timeWindowInMinutes | Fenêtre de temps pour laquelle les données doivent être extraites pour la requête (doit être supérieure ou égale à frequencyInMinutes). | int (obligatoire) |
Source
| Nom | Description | Valeur |
|---|---|---|
| authorizedResources | Liste des ressources référencées dans la requête | string[] |
| dataSourceId | URI de ressource sur lequel la requête de recherche de journal doit être exécutée. | chaîne (obligatoire) |
| query | Requête de recherche dans les journaux. Obligatoire pour le type d’action - AlertingAction | string |
| queryType | Définissez la valeur « ResultCount » . | « ResultCount » |
Commentaires
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultez https://aka.ms/ContentUserFeedback.
Envoyer et afficher des commentaires pour