Microsoft.Insights scheduledQueryRules 2018-04-16
Observações
Para obter diretrizes sobre como implantar soluções de monitoramento, consulte Criar recursos de monitoramento usando o Bicep.
Definição de recurso do Bicep
O tipo de recurso scheduledQueryRules pode ser implantado com operações de destino:
- Grupos de recursos - Consulte comandos de implantação do grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.
Formato de recurso
Para criar um recurso Microsoft.Insights/scheduledQueryRules, adicione o Bicep a seguir ao modelo.
resource symbolicname 'Microsoft.Insights/scheduledQueryRules@2018-04-16' = {
location: 'string'
name: 'string'
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: 'string'
}
}
tags: {
{customized property}: 'string'
}
}
Objetos de ação
Defina a propriedade odata.type para especificar o tipo de objeto.
Para Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction, use:
{
aznsAction: {
actionGroup: [
'string'
]
customWebhookPayload: 'string'
emailSubject: 'string'
}
odata.type: 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction'
severity: 'string'
throttlingInMin: int
trigger: {
metricTrigger: {
metricColumn: 'string'
metricTriggerType: 'string'
threshold: int
thresholdOperator: 'string'
}
threshold: int
thresholdOperator: 'string'
}
}
Para Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction, use:
{
criteria: [
{
dimensions: [
{
name: 'string'
operator: 'string'
values: [
'string'
]
}
]
metricName: 'string'
}
]
odata.type: 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction'
}
Valores de propriedade
Ação
Nome | Descrição | Valor |
---|---|---|
odata.type | Defina como 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction' para o tipo AlertingAction. Defina como 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction' para o tipo LogToMetricAction. | 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction' 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction' (obrigatório) |
AlertingAction
AzNsActionGroup
Nome | Descrição | Valor |
---|---|---|
actionGroup | Referência do Grupo de Ações do Azure. | string[] |
customWebhookPayload | Conteúdo personalizado a ser enviado para todo o URI de webhook no grupo de ações do Azure | corda |
emailSubject | Substituição de assunto personalizado para todas as IDs de email no grupo de ação do Azure | corda |
Critérios
Nome | Descrição | Valor |
---|---|---|
Dimensões | Lista de dimensões para criar métrica | dimensionar[] |
metricName | Nome da métrica | cadeia de caracteres (obrigatório) |
Dimensão
Nome | Descrição | Valor |
---|---|---|
nome | Nome da dimensão | cadeia de caracteres (obrigatório) |
operador | Operador para valores de dimensão | 'Include' (obrigatório) |
Valores | Lista de valores de dimensão | string[] (obrigatório) |
LogMetricTrigger
Nome | Descrição | Valor |
---|---|---|
metricColumn | Avaliação da métrica em uma coluna específica | corda |
metricTriggerType | Tipo de gatilho de métrica – 'Consecutivo' ou 'Total' | 'Consecutivo' 'Total' |
limiar | O limite do gatilho de métrica. | int |
thresholdOperator | Operação de avaliação para métrica -'GreaterThan' ou 'LessThan' ou 'Equal'. | 'Igual' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' |
LogSearchRule
Nome | Descrição | Valor |
---|---|---|
ação | A ação precisa ser tomada na execução da regra. | Ação (obrigatório) |
autoMitigate | O sinalizador que indica se o alerta deve ser resolvido automaticamente ou não. O padrão é false. | Bool |
descrição | A descrição da regra de Pesquisa de Logs. | corda |
displayName | O nome de exibição da regra de alerta | corda |
Habilitado | O sinalizador que indica se a regra de Pesquisa de Log está habilitada. O valor deve ser verdadeiro ou falso | 'false' 'true' |
horário | Agendamento (Frequência, Janela de Tempo) para a regra. Necessário para o tipo de ação – AlertingAction | Agenda |
fonte | Fonte de dados em relação a qual regra consultará dados | de origem (obrigatório) |
LogToMetricAction
Nome | Descrição | Valor |
---|---|---|
Critérios | Critérios de métrica | Critérios[] (obrigatório) |
odata.type | Especifica a ação. Valores com suporte – AlertingAction, LogToMetricAction | 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction' (obrigatório) |
Microsoft.Insights/scheduledQueryRules
Nome | Descrição | Valor |
---|---|---|
localização | Local do recurso | cadeia de caracteres (obrigatório) |
nome | O nome do recurso | cadeia de caracteres (obrigatório) |
Propriedades | As propriedades da regra do recurso. | LogSearchRule (obrigatório) |
Tags | Marcas de recurso | Dicionário de nomes e valores de marca. Consulte Marcas em modelos |
ResourceTags
Nome | Descrição | Valor |
---|
Horário
Nome | Descrição | Valor |
---|---|---|
frequencyInMinutes | frequência (em minutos) na qual a condição da regra deve ser avaliada. | int (obrigatório) |
timeWindowInMinutes | Janela de tempo para a qual os dados precisam ser buscados para consulta (deve ser maior ou igual a frequencyInMinutes). | int (obrigatório) |
Fonte
Nome | Descrição | Valor |
---|---|---|
authorizedResources | Lista de recursos referenciados em consulta | string[] |
dataSourceId | O uri de recurso sobre o qual a consulta de pesquisa de log deve ser executada. | cadeia de caracteres (obrigatório) |
consulta | Consulta de pesquisa de log. Necessário para o tipo de ação – AlertingAction | corda |
queryType | Defina o valor como 'ResultCount' . | 'ResultCount' |
TriggerCondition
Nome | Descrição | Valor |
---|---|---|
metricTrigger | Condição de gatilho para a regra de consulta de métrica | |
limiar | Limite de resultado ou contagem com base em qual regra deve ser disparada. | int (obrigatório) |
thresholdOperator | Operação de avaliação para a regra – 'GreaterThan' ou 'LessThan. | 'Igual' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' (obrigatório) |
Definição de recurso de modelo do ARM
O tipo de recurso scheduledQueryRules pode ser implantado com operações de destino:
- Grupos de recursos - Consulte comandos de implantação do grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.
Formato de recurso
Para criar um recurso Microsoft.Insights/scheduledQueryRules, adicione o JSON a seguir ao modelo.
{
"type": "Microsoft.Insights/scheduledQueryRules",
"apiVersion": "2018-04-16",
"name": "string",
"location": "string",
"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": "string"
}
},
"tags": {
"{customized property}": "string"
}
}
Objetos de ação
Defina a propriedade odata.type para especificar o tipo de objeto.
Para Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction, use:
{
"aznsAction": {
"actionGroup": [ "string" ],
"customWebhookPayload": "string",
"emailSubject": "string"
},
"odata.type": "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction",
"severity": "string",
"throttlingInMin": "int",
"trigger": {
"metricTrigger": {
"metricColumn": "string",
"metricTriggerType": "string",
"threshold": "int",
"thresholdOperator": "string"
},
"threshold": "int",
"thresholdOperator": "string"
}
}
Para Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction, use:
{
"criteria": [
{
"dimensions": [
{
"name": "string",
"operator": "string",
"values": [ "string" ]
}
],
"metricName": "string"
}
],
"odata.type": "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction"
}
Valores de propriedade
Ação
Nome | Descrição | Valor |
---|---|---|
odata.type | Defina como 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction' para o tipo AlertingAction. Defina como 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction' para o tipo LogToMetricAction. | 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction' 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction' (obrigatório) |
AlertingAction
AzNsActionGroup
Nome | Descrição | Valor |
---|---|---|
actionGroup | Referência do Grupo de Ações do Azure. | string[] |
customWebhookPayload | Conteúdo personalizado a ser enviado para todo o URI de webhook no grupo de ações do Azure | corda |
emailSubject | Substituição de assunto personalizado para todas as IDs de email no grupo de ação do Azure | corda |
Critérios
Nome | Descrição | Valor |
---|---|---|
Dimensões | Lista de dimensões para criar métrica | dimensionar[] |
metricName | Nome da métrica | cadeia de caracteres (obrigatório) |
Dimensão
Nome | Descrição | Valor |
---|---|---|
nome | Nome da dimensão | cadeia de caracteres (obrigatório) |
operador | Operador para valores de dimensão | 'Include' (obrigatório) |
Valores | Lista de valores de dimensão | string[] (obrigatório) |
LogMetricTrigger
Nome | Descrição | Valor |
---|---|---|
metricColumn | Avaliação da métrica em uma coluna específica | corda |
metricTriggerType | Tipo de gatilho de métrica – 'Consecutivo' ou 'Total' | 'Consecutivo' 'Total' |
limiar | O limite do gatilho de métrica. | int |
thresholdOperator | Operação de avaliação para métrica -'GreaterThan' ou 'LessThan' ou 'Equal'. | 'Igual' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' |
LogSearchRule
Nome | Descrição | Valor |
---|---|---|
ação | A ação precisa ser tomada na execução da regra. | Ação (obrigatório) |
autoMitigate | O sinalizador que indica se o alerta deve ser resolvido automaticamente ou não. O padrão é false. | Bool |
descrição | A descrição da regra de Pesquisa de Logs. | corda |
displayName | O nome de exibição da regra de alerta | corda |
Habilitado | O sinalizador que indica se a regra de Pesquisa de Log está habilitada. O valor deve ser verdadeiro ou falso | 'false' 'true' |
horário | Agendamento (Frequência, Janela de Tempo) para a regra. Necessário para o tipo de ação – AlertingAction | Agenda |
fonte | Fonte de dados em relação a qual regra consultará dados | de origem (obrigatório) |
LogToMetricAction
Nome | Descrição | Valor |
---|---|---|
Critérios | Critérios de métrica | Critérios[] (obrigatório) |
odata.type | Especifica a ação. Valores com suporte – AlertingAction, LogToMetricAction | 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction' (obrigatório) |
Microsoft.Insights/scheduledQueryRules
Nome | Descrição | Valor |
---|---|---|
apiVersion | A versão da API | '2018-04-16' |
localização | Local do recurso | cadeia de caracteres (obrigatório) |
nome | O nome do recurso | cadeia de caracteres (obrigatório) |
Propriedades | As propriedades da regra do recurso. | LogSearchRule (obrigatório) |
Tags | Marcas de recurso | Dicionário de nomes e valores de marca. Consulte Marcas em modelos |
tipo | O tipo de recurso | 'Microsoft.Insights/scheduledQueryRules' |
ResourceTags
Nome | Descrição | Valor |
---|
Horário
Nome | Descrição | Valor |
---|---|---|
frequencyInMinutes | frequência (em minutos) na qual a condição da regra deve ser avaliada. | int (obrigatório) |
timeWindowInMinutes | Janela de tempo para a qual os dados precisam ser buscados para consulta (deve ser maior ou igual a frequencyInMinutes). | int (obrigatório) |
Fonte
Nome | Descrição | Valor |
---|---|---|
authorizedResources | Lista de recursos referenciados em consulta | string[] |
dataSourceId | O uri de recurso sobre o qual a consulta de pesquisa de log deve ser executada. | cadeia de caracteres (obrigatório) |
consulta | Consulta de pesquisa de log. Necessário para o tipo de ação – AlertingAction | corda |
queryType | Defina o valor como 'ResultCount' . | 'ResultCount' |
TriggerCondition
Nome | Descrição | Valor |
---|---|---|
metricTrigger | Condição de gatilho para a regra de consulta de métrica | |
limiar | Limite de resultado ou contagem com base em qual regra deve ser disparada. | int (obrigatório) |
thresholdOperator | Operação de avaliação para a regra – 'GreaterThan' ou 'LessThan. | 'Igual' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' (obrigatório) |
Modelos de início rápido
Os modelos de início rápido a seguir implantam esse tipo de recurso.
Modelo | Descrição |
---|---|
Criar regra de alerta para itens de continuidade de negócios do Azure |
Esses modelos criam uma regra de alerta e uma MSI atribuída pelo usuário. Ele também atribui o acesso do leitor MSI à assinatura para que a regra de alerta tenha acesso para consultar os itens protegidos necessários e os detalhes mais recentes do ponto de recuperação. |
Definição de recurso do Terraform (provedor de AzAPI)
O tipo de recurso scheduledQueryRules pode ser implantado com operações de destino:
- grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.
Formato de recurso
Para criar um recurso Microsoft.Insights/scheduledQueryRules, adicione o Terraform a seguir ao seu modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Insights/scheduledQueryRules@2018-04-16"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
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 = "string"
}
}
})
}
Objetos de ação
Defina a propriedade odata.type para especificar o tipo de objeto.
Para Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction, use:
{
aznsAction = {
actionGroup = [
"string"
]
customWebhookPayload = "string"
emailSubject = "string"
}
odata.type = "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction"
severity = "string"
throttlingInMin = int
trigger = {
metricTrigger = {
metricColumn = "string"
metricTriggerType = "string"
threshold = int
thresholdOperator = "string"
}
threshold = int
thresholdOperator = "string"
}
}
Para Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction, use:
{
criteria = [
{
dimensions = [
{
name = "string"
operator = "string"
values = [
"string"
]
}
]
metricName = "string"
}
]
odata.type = "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction"
}
Valores de propriedade
Ação
Nome | Descrição | Valor |
---|---|---|
odata.type | Defina como 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction' para o tipo AlertingAction. Defina como 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction' para o tipo LogToMetricAction. | 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction' 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction' (obrigatório) |
AlertingAction
AzNsActionGroup
Nome | Descrição | Valor |
---|---|---|
actionGroup | Referência do Grupo de Ações do Azure. | string[] |
customWebhookPayload | Conteúdo personalizado a ser enviado para todo o URI de webhook no grupo de ações do Azure | corda |
emailSubject | Substituição de assunto personalizado para todas as IDs de email no grupo de ação do Azure | corda |
Critérios
Nome | Descrição | Valor |
---|---|---|
Dimensões | Lista de dimensões para criar métrica | dimensionar[] |
metricName | Nome da métrica | cadeia de caracteres (obrigatório) |
Dimensão
Nome | Descrição | Valor |
---|---|---|
nome | Nome da dimensão | cadeia de caracteres (obrigatório) |
operador | Operador para valores de dimensão | 'Include' (obrigatório) |
Valores | Lista de valores de dimensão | string[] (obrigatório) |
LogMetricTrigger
Nome | Descrição | Valor |
---|---|---|
metricColumn | Avaliação da métrica em uma coluna específica | corda |
metricTriggerType | Tipo de gatilho de métrica – 'Consecutivo' ou 'Total' | 'Consecutivo' 'Total' |
limiar | O limite do gatilho de métrica. | int |
thresholdOperator | Operação de avaliação para métrica -'GreaterThan' ou 'LessThan' ou 'Equal'. | 'Igual' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' |
LogSearchRule
Nome | Descrição | Valor |
---|---|---|
ação | A ação precisa ser tomada na execução da regra. | Ação (obrigatório) |
autoMitigate | O sinalizador que indica se o alerta deve ser resolvido automaticamente ou não. O padrão é false. | Bool |
descrição | A descrição da regra de Pesquisa de Logs. | corda |
displayName | O nome de exibição da regra de alerta | corda |
Habilitado | O sinalizador que indica se a regra de Pesquisa de Log está habilitada. O valor deve ser verdadeiro ou falso | 'false' 'true' |
horário | Agendamento (Frequência, Janela de Tempo) para a regra. Necessário para o tipo de ação – AlertingAction | Agenda |
fonte | Fonte de dados em relação a qual regra consultará dados | de origem (obrigatório) |
LogToMetricAction
Nome | Descrição | Valor |
---|---|---|
Critérios | Critérios de métrica | Critérios[] (obrigatório) |
odata.type | Especifica a ação. Valores com suporte – AlertingAction, LogToMetricAction | 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction' (obrigatório) |
Microsoft.Insights/scheduledQueryRules
ResourceTags
Nome | Descrição | Valor |
---|
Horário
Nome | Descrição | Valor |
---|---|---|
frequencyInMinutes | frequência (em minutos) na qual a condição da regra deve ser avaliada. | int (obrigatório) |
timeWindowInMinutes | Janela de tempo para a qual os dados precisam ser buscados para consulta (deve ser maior ou igual a frequencyInMinutes). | int (obrigatório) |
Fonte
Nome | Descrição | Valor |
---|---|---|
authorizedResources | Lista de recursos referenciados em consulta | string[] |
dataSourceId | O uri de recurso sobre o qual a consulta de pesquisa de log deve ser executada. | cadeia de caracteres (obrigatório) |
consulta | Consulta de pesquisa de log. Necessário para o tipo de ação – AlertingAction | corda |
queryType | Defina o valor como 'ResultCount' . | 'ResultCount' |
TriggerCondition
Nome | Descrição | Valor |
---|---|---|
metricTrigger | Condição de gatilho para a regra de consulta de métrica | |
limiar | Limite de resultado ou contagem com base em qual regra deve ser disparada. | int (obrigatório) |
thresholdOperator | Operação de avaliação para a regra – 'GreaterThan' ou 'LessThan. | 'Igual' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' (obrigatório) |