Observação
O acesso a essa página exige autorização. Você pode tentar entrar ou alterar diretórios.
O acesso a essa página exige autorização. Você pode tentar alterar os diretórios.
Observações
Para orientações sobre a implantação de soluções de monitoramento, veja 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 - Vejagrupos de recursos c1
Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.
Exemplos de uso
Exemplos do Bicep
Um exemplo básico de implantação do recurso AlertingAction Scheduled Query Rules dentro do Azure Monitor.
param resourceName string = 'acctest0001'
param location string = 'westeurope'
resource component 'Microsoft.Insights/components@2020-02-02' = {
name: resourceName
location: location
kind: 'web'
properties: {
Application_Type: 'web'
DisableIpMasking: false
DisableLocalAuth: false
ForceCustomerStorageForProfiler: false
RetentionInDays: 90
SamplingPercentage: 100
publicNetworkAccessForIngestion: 'Enabled'
publicNetworkAccessForQuery: 'Enabled'
}
}
resource scheduledQueryRule 'Microsoft.Insights/scheduledQueryRules@2021-08-01' = {
name: resourceName
location: location
kind: 'LogAlert'
properties: {
autoMitigate: false
checkWorkspaceAlertsStorageConfigured: false
criteria: {
allOf: [
{
operator: 'Equal'
query: ''' requests
| summarize CountByCountry=count() by client_CountryOrRegion
'''
threshold: 5
timeAggregation: 'Count'
}
]
}
enabled: true
evaluationFrequency: 'PT5M'
scopes: [
component.id
]
severity: 3
skipQueryValidation: false
windowSize: 'PT5M'
}
}
Módulos verificados do Azure
Os seguintes módulos Azure Verificados podem ser usados para implantar esse tipo de recurso.
| Módulo | Descrição |
|---|---|
| Módulo de recurso AVM para regra de consulta agendada |
Formato de recurso
Para criar um recurso Microsoft.Insights/scheduledQueryRules, adicione o Bicep a seguir ao modelo.
resource symbolicname 'Microsoft.Insights/scheduledQueryRules@2021-08-01' = {
kind: 'string'
location: 'string'
name: 'string'
properties: {
actions: {
actionGroups: [
'string'
]
customProperties: {
{customized property}: 'string'
}
}
autoMitigate: bool
checkWorkspaceAlertsStorageConfigured: bool
criteria: {
allOf: [
{
dimensions: [
{
name: 'string'
operator: 'string'
values: [
'string'
]
}
]
failingPeriods: {
minFailingPeriodsToAlert: int
numberOfEvaluationPeriods: int
}
metricMeasureColumn: 'string'
metricName: 'string'
operator: 'string'
query: 'string'
resourceIdColumn: 'string'
threshold: int
timeAggregation: 'string'
}
]
}
description: 'string'
displayName: 'string'
enabled: bool
evaluationFrequency: 'string'
muteActionsDuration: 'string'
overrideQueryTimeRange: 'string'
scopes: [
'string'
]
severity: int
skipQueryValidation: bool
targetResourceTypes: [
'string'
]
windowSize: 'string'
}
tags: {
{customized property}: 'string'
}
}
Valores de propriedade
Microsoft.Insights/scheduledQueryRules
| Nome | Descrição | Valor |
|---|---|---|
| tipo | Indica o tipo de regra de consulta agendada. O padrão é LogAlert. | 'LogAlert' 'LogToMetric' |
| local | A localização geográfica onde o recurso reside | cadeia de caracteres (obrigatório) |
| nome | O nome do recurso | cadeia de caracteres (obrigatório) |
| Propriedades | As propriedades da regra do recurso. | ScheduledQueryRuleProperties (obrigatório) |
| Tags | Marcas de recurso | Dicionário de nomes e valores de marca. Veja Tags nos templates |
Ações
| Nome | Descrição | Valor |
|---|---|---|
| actionGroups | IDs de recurso do Grupo de Ações a serem invocadas quando o alerta é acionado. | cadeia de caracteres[] |
| Propriedades personalizadas | As propriedades de um conteúdo de alerta. | actionsCustomProperties |
AçõesCustomProperties
| Nome | Descrição | Valor |
|---|
Condição
| Nome | Descrição | Valor |
|---|---|---|
| Dimensões | Lista de condições de dimensões | dimensionar[] |
| failPeriods | O número mínimo de violações necessárias na janela de tempo de pesquisa selecionada necessária para gerar um alerta. Relevante apenas para regras do tipo LogAlert. | ConditionFailingPeriods |
| metricMeasureColumn | A coluna que contém o número da medida de métrica. Relevante apenas para regras do tipo LogAlert. | cadeia |
| nome_da_métrica | O nome da métrica a ser enviada. Relevante e necessário somente para regras do tipo LogToMetric. | cadeia |
| operador | O operador de critérios. Relevante e necessário somente para regras do tipo LogAlert. | 'Iguais' 'Maior que' 'Maior que Ou Igual' 'Menos que' 'LessThanOrEqual' |
| consulta | Alerta de consulta de log | cadeia |
| resourceIdColumn | A coluna que contém a ID do recurso. O conteúdo da coluna deve ser um uri formatado como id de recurso. Relevante apenas para regras do tipo LogAlert. | cadeia |
| limite | o valor do limite de critérios que ativa o alerta. Relevante e necessário somente para regras do tipo LogAlert. | int |
| timeAggregation | Tipo de agregação. Relevante e necessário somente para regras do tipo LogAlert. | 'Média' 'Conde' 'Máximo' 'Mínimo' 'Total' |
ConditionFailingPeriods
| Nome | Descrição | Valor |
|---|---|---|
| minFailingPeriodsToAlert | O número de violações para disparar um alerta. Deve ser menor ou igual a numberOfEvaluationPeriods. O valor padrão é 1 | int |
| númeroDePeríodosDeAvaliação | O número de pontos de pesquisa agregados. A janela de tempo de pesquisa é calculada com base na granularidade de agregação (windowSize) e no número selecionado de pontos agregados. O valor padrão é 1 | int |
Dimensão
| Nome | Descrição | Valor |
|---|---|---|
| nome | Nome da dimensão | cadeia de caracteres (obrigatório) |
| operador | Operador para valores de dimensão | 'Excluir' 'Include' (obrigatório) |
| Valores | Lista de valores de dimensão | string[] (obrigatório) |
ScheduledQueryRuleCriteria
| Nome | Descrição | Valor |
|---|---|---|
| allOf | Uma lista de condições a serem avaliadas em relação aos escopos especificados | de Condição [] |
ScheduledQueryRuleProperties
TrackedResourceTags
| Nome | Descrição | Valor |
|---|
Definição de recurso de modelo do ARM
O tipo de recurso scheduledQueryRules pode ser implantado com operações de destino:
- Grupos de recursos - Veja comandos de implantação de grupos de recursos Para uma lista de propriedades alteradas em cada versão da API, veja registro de alterações.
Exemplos de uso
Modelos de Início Rápido do Azure
Os seguintes modelos Azure Quickstart implantam esse tipo de recurso.
| Modelo | Descrição |
|---|---|
|
Regra de Criar alerta para azure itens de continuidade de negócios |
Esses modelos criam uma regra de alerta e uma MSI atribuída pelo usuário. Também atribui o acesso do leitor MSI à assinatura, de modo que a regra de alerta tenha acesso para consultar os itens protegidos necessários e os detalhes mais recentes dos pontos de recuperação. |
Formato de recurso
Para criar um recurso Microsoft.Insights/scheduledQueryRules, adicione o JSON a seguir ao modelo.
{
"type": "Microsoft.Insights/scheduledQueryRules",
"apiVersion": "2021-08-01",
"name": "string",
"kind": "string",
"location": "string",
"properties": {
"actions": {
"actionGroups": [ "string" ],
"customProperties": {
"{customized property}": "string"
}
},
"autoMitigate": "bool",
"checkWorkspaceAlertsStorageConfigured": "bool",
"criteria": {
"allOf": [
{
"dimensions": [
{
"name": "string",
"operator": "string",
"values": [ "string" ]
}
],
"failingPeriods": {
"minFailingPeriodsToAlert": "int",
"numberOfEvaluationPeriods": "int"
},
"metricMeasureColumn": "string",
"metricName": "string",
"operator": "string",
"query": "string",
"resourceIdColumn": "string",
"threshold": "int",
"timeAggregation": "string"
}
]
},
"description": "string",
"displayName": "string",
"enabled": "bool",
"evaluationFrequency": "string",
"muteActionsDuration": "string",
"overrideQueryTimeRange": "string",
"scopes": [ "string" ],
"severity": "int",
"skipQueryValidation": "bool",
"targetResourceTypes": [ "string" ],
"windowSize": "string"
},
"tags": {
"{customized property}": "string"
}
}
Valores de propriedade
Microsoft.Insights/scheduledQueryRules
| Nome | Descrição | Valor |
|---|---|---|
| apiVersion | A versão da API | '2021-08-01' |
| tipo | Indica o tipo de regra de consulta agendada. O padrão é LogAlert. | 'LogAlert' 'LogToMetric' |
| local | A localização geográfica onde o recurso reside | cadeia de caracteres (obrigatório) |
| nome | O nome do recurso | cadeia de caracteres (obrigatório) |
| Propriedades | As propriedades da regra do recurso. | ScheduledQueryRuleProperties (obrigatório) |
| Tags | Marcas de recurso | Dicionário de nomes e valores de marca. Veja Tags nos templates |
| tipo | O tipo de recurso | 'Microsoft.Insights/scheduledQueryRules' |
Ações
| Nome | Descrição | Valor |
|---|---|---|
| actionGroups | IDs de recurso do Grupo de Ações a serem invocadas quando o alerta é acionado. | cadeia de caracteres[] |
| Propriedades personalizadas | As propriedades de um conteúdo de alerta. | actionsCustomProperties |
AçõesCustomProperties
| Nome | Descrição | Valor |
|---|
Condição
| Nome | Descrição | Valor |
|---|---|---|
| Dimensões | Lista de condições de dimensões | dimensionar[] |
| failPeriods | O número mínimo de violações necessárias na janela de tempo de pesquisa selecionada necessária para gerar um alerta. Relevante apenas para regras do tipo LogAlert. | ConditionFailingPeriods |
| metricMeasureColumn | A coluna que contém o número da medida de métrica. Relevante apenas para regras do tipo LogAlert. | cadeia |
| nome_da_métrica | O nome da métrica a ser enviada. Relevante e necessário somente para regras do tipo LogToMetric. | cadeia |
| operador | O operador de critérios. Relevante e necessário somente para regras do tipo LogAlert. | 'Iguais' 'Maior que' 'Maior que Ou Igual' 'Menos que' 'LessThanOrEqual' |
| consulta | Alerta de consulta de log | cadeia |
| resourceIdColumn | A coluna que contém a ID do recurso. O conteúdo da coluna deve ser um uri formatado como id de recurso. Relevante apenas para regras do tipo LogAlert. | cadeia |
| limite | o valor do limite de critérios que ativa o alerta. Relevante e necessário somente para regras do tipo LogAlert. | int |
| timeAggregation | Tipo de agregação. Relevante e necessário somente para regras do tipo LogAlert. | 'Média' 'Conde' 'Máximo' 'Mínimo' 'Total' |
ConditionFailingPeriods
| Nome | Descrição | Valor |
|---|---|---|
| minFailingPeriodsToAlert | O número de violações para disparar um alerta. Deve ser menor ou igual a numberOfEvaluationPeriods. O valor padrão é 1 | int |
| númeroDePeríodosDeAvaliação | O número de pontos de pesquisa agregados. A janela de tempo de pesquisa é calculada com base na granularidade de agregação (windowSize) e no número selecionado de pontos agregados. O valor padrão é 1 | int |
Dimensão
| Nome | Descrição | Valor |
|---|---|---|
| nome | Nome da dimensão | cadeia de caracteres (obrigatório) |
| operador | Operador para valores de dimensão | 'Excluir' 'Include' (obrigatório) |
| Valores | Lista de valores de dimensão | string[] (obrigatório) |
ScheduledQueryRuleCriteria
| Nome | Descrição | Valor |
|---|---|---|
| allOf | Uma lista de condições a serem avaliadas em relação aos escopos especificados | de Condição [] |
ScheduledQueryRuleProperties
TrackedResourceTags
| Nome | Descrição | Valor |
|---|
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 uma lista das propriedades alteradas em cada versão da API, veja o registro de alterações.
Exemplos de uso
Exemplos do Terraform
Um exemplo básico de implantação do recurso AlertingAction Scheduled Query Rules dentro do Azure Monitor.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "westeurope"
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = var.resource_name
location = var.location
}
resource "azapi_resource" "component" {
type = "Microsoft.Insights/components@2020-02-02"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
kind = "web"
properties = {
Application_Type = "web"
DisableIpMasking = false
DisableLocalAuth = false
ForceCustomerStorageForProfiler = false
RetentionInDays = 90
SamplingPercentage = 100
publicNetworkAccessForIngestion = "Enabled"
publicNetworkAccessForQuery = "Enabled"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
resource "azapi_resource" "scheduledQueryRule" {
type = "Microsoft.Insights/scheduledQueryRules@2021-08-01"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
kind = "LogAlert"
properties = {
autoMitigate = false
checkWorkspaceAlertsStorageConfigured = false
criteria = {
allOf = [
{
dimensions = null
operator = "Equal"
query = " requests\n| summarize CountByCountry=count() by client_CountryOrRegion\n"
threshold = 5
timeAggregation = "Count"
},
]
}
enabled = true
evaluationFrequency = "PT5M"
scopes = [
azapi_resource.component.id,
]
severity = 3
skipQueryValidation = false
targetResourceTypes = null
windowSize = "PT5M"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
Um exemplo básico de implantação do recurso AlertingAction Scheduled Query Rules dentro do Azure Monitor.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "westeurope"
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = var.resource_name
location = var.location
}
resource "azapi_resource" "component" {
type = "Microsoft.Insights/components@2020-02-02"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
kind = "web"
properties = {
Application_Type = "web"
DisableIpMasking = false
DisableLocalAuth = false
ForceCustomerStorageForProfiler = false
RetentionInDays = 90
SamplingPercentage = 100
publicNetworkAccessForIngestion = "Enabled"
publicNetworkAccessForQuery = "Enabled"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
resource "azapi_resource" "scheduledQueryRule" {
type = "Microsoft.Insights/scheduledQueryRules@2021-08-01"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
kind = "LogAlert"
properties = {
autoMitigate = false
checkWorkspaceAlertsStorageConfigured = false
criteria = {
allOf = [
{
dimensions = null
operator = "Equal"
query = " requests\n| summarize CountByCountry=count() by client_CountryOrRegion\n"
threshold = 5
timeAggregation = "Count"
},
]
}
enabled = true
evaluationFrequency = "PT5M"
scopes = [
azapi_resource.component.id,
]
severity = 3
skipQueryValidation = false
targetResourceTypes = null
windowSize = "PT5M"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
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@2021-08-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
kind = "string"
properties = {
actions = {
actionGroups = [
"string"
]
customProperties = {
{customized property} = "string"
}
}
autoMitigate = bool
checkWorkspaceAlertsStorageConfigured = bool
criteria = {
allOf = [
{
dimensions = [
{
name = "string"
operator = "string"
values = [
"string"
]
}
]
failingPeriods = {
minFailingPeriodsToAlert = int
numberOfEvaluationPeriods = int
}
metricMeasureColumn = "string"
metricName = "string"
operator = "string"
query = "string"
resourceIdColumn = "string"
threshold = int
timeAggregation = "string"
}
]
}
description = "string"
displayName = "string"
enabled = bool
evaluationFrequency = "string"
muteActionsDuration = "string"
overrideQueryTimeRange = "string"
scopes = [
"string"
]
severity = int
skipQueryValidation = bool
targetResourceTypes = [
"string"
]
windowSize = "string"
}
}
}
Valores de propriedade
Microsoft.Insights/scheduledQueryRules
Ações
| Nome | Descrição | Valor |
|---|---|---|
| actionGroups | IDs de recurso do Grupo de Ações a serem invocadas quando o alerta é acionado. | cadeia de caracteres[] |
| Propriedades personalizadas | As propriedades de um conteúdo de alerta. | actionsCustomProperties |
AçõesCustomProperties
| Nome | Descrição | Valor |
|---|
Condição
| Nome | Descrição | Valor |
|---|---|---|
| Dimensões | Lista de condições de dimensões | dimensionar[] |
| failPeriods | O número mínimo de violações necessárias na janela de tempo de pesquisa selecionada necessária para gerar um alerta. Relevante apenas para regras do tipo LogAlert. | ConditionFailingPeriods |
| metricMeasureColumn | A coluna que contém o número da medida de métrica. Relevante apenas para regras do tipo LogAlert. | cadeia |
| nome_da_métrica | O nome da métrica a ser enviada. Relevante e necessário somente para regras do tipo LogToMetric. | cadeia |
| operador | O operador de critérios. Relevante e necessário somente para regras do tipo LogAlert. | 'Iguais' 'Maior que' 'Maior que Ou Igual' 'Menos que' 'LessThanOrEqual' |
| consulta | Alerta de consulta de log | cadeia |
| resourceIdColumn | A coluna que contém a ID do recurso. O conteúdo da coluna deve ser um uri formatado como id de recurso. Relevante apenas para regras do tipo LogAlert. | cadeia |
| limite | o valor do limite de critérios que ativa o alerta. Relevante e necessário somente para regras do tipo LogAlert. | int |
| timeAggregation | Tipo de agregação. Relevante e necessário somente para regras do tipo LogAlert. | 'Média' 'Conde' 'Máximo' 'Mínimo' 'Total' |
ConditionFailingPeriods
| Nome | Descrição | Valor |
|---|---|---|
| minFailingPeriodsToAlert | O número de violações para disparar um alerta. Deve ser menor ou igual a numberOfEvaluationPeriods. O valor padrão é 1 | int |
| númeroDePeríodosDeAvaliação | O número de pontos de pesquisa agregados. A janela de tempo de pesquisa é calculada com base na granularidade de agregação (windowSize) e no número selecionado de pontos agregados. O valor padrão é 1 | int |
Dimensão
| Nome | Descrição | Valor |
|---|---|---|
| nome | Nome da dimensão | cadeia de caracteres (obrigatório) |
| operador | Operador para valores de dimensão | 'Excluir' 'Include' (obrigatório) |
| Valores | Lista de valores de dimensão | string[] (obrigatório) |
ScheduledQueryRuleCriteria
| Nome | Descrição | Valor |
|---|---|---|
| allOf | Uma lista de condições a serem avaliadas em relação aos escopos especificados | de Condição [] |
ScheduledQueryRuleProperties
TrackedResourceTags
| Nome | Descrição | Valor |
|---|