Microsoft.Insights scheduledQueryRules
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@2024-01-01-preview' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
kind: 'string'
location: 'string'
name: 'string'
properties: {
actions: {
actionGroups: [
'string'
]
actionProperties: {
{customized property}: 'string'
}
customProperties: {
{customized property}: 'string'
}
}
autoMitigate: bool
checkWorkspaceAlertsStorageConfigured: bool
criteria: {
allOf: [
{
alertSensitivity: 'string'
criterionType: 'string'
dimensions: [
{
name: 'string'
operator: 'string'
values: [
'string'
]
}
]
failingPeriods: {
minFailingPeriodsToAlert: int
numberOfEvaluationPeriods: int
}
ignoreDataBefore: 'string'
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'
resolveConfiguration: {
autoResolved: bool
timeToResolve: 'string'
}
scopes: [
'string'
]
severity: int
skipQueryValidation: bool
targetResourceTypes: [
'string'
]
windowSize: 'string'
}
tags: {
{customized property}: 'string'
}
}
Valores de propriedade
Ações
| Nome | Descrição | Valor |
|---|---|---|
| actionGroups | IDs de recurso do Grupo de Ações a serem invocadas quando o alerta é acionado. | string[] |
| actionProperties | As propriedades de uma ação. | ActionsActionProperties |
| customProperties | As propriedades de um conteúdo de alerta. | actionsCustomProperties |
ActionsActionProperties
| Nome | Descrição | Valor |
|---|
ActionsCustomProperties
| Nome | Descrição | Valor |
|---|
Condição
| Nome | Descrição | Valor |
|---|---|---|
| alertSensitivity | A extensão do desvio necessária para disparar um alerta. Os valores permitidos são 'Baixo', 'Médio' e 'Alto'. Isso afetará o quão apertado é o limite para o padrão da série de métricas. Relevante e necessário apenas para regras de limite dinâmico do tipo LogAlert. | corda |
| criterionType | Especifica o tipo de critério de limite | 'DynamicThresholdCriterion' 'StaticThresholdCriterion' |
| 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 |
| ignoreDataBefore | Use essa opção para definir a data da qual começar a aprender os dados históricos da métrica e calcular os limites dinâmicos (no formato ISO8601). Relevante apenas para regras de limite dinâmico do tipo LogAlert. | corda |
| metricMeasureColumn | A coluna que contém o número da medida de métrica. Relevante apenas para regras do tipo LogAlert. | corda |
| metricName | O nome da métrica a ser enviada. Relevante e necessário somente para regras do tipo LogToMetric. | corda |
| operador | O operador de critérios. Relevante e necessário somente para regras do tipo LogAlert. | 'Equals' 'GreaterOrLessThan' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' |
| consulta | Alerta de consulta de log | corda |
| 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. | corda |
| limiar | o valor do limite de critérios que ativa o alerta. Relevante e necessário apenas para regras de limite estático do tipo LogAlert. | int |
| timeAggregation | Tipo de agregação. Relevante e necessário somente para regras do tipo LogAlert. | 'Média' 'Count' '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 |
| numberOfEvaluationPeriods | 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) |
Identidade
| Nome | Descrição | Valor |
|---|---|---|
| tipo | Tipo de identidade de serviço gerenciado. | 'None' 'SystemAssigned' 'UserAssigned' (obrigatório) |
| userAssignedIdentities | A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. | IdentityUserAssignedIdentities |
IdentityUserAssignedIdentities
| Nome | Descrição | Valor |
|---|
Microsoft.Insights/scheduledQueryRules
| Nome | Descrição | Valor |
|---|---|---|
| identidade | A identidade do recurso. | Identity |
| tipo | Indica o tipo de regra de consulta agendada. O padrão é LogAlert. | 'EventLogAlert' 'LogAlert' 'LogToMetric' |
| localização | A localização geográfica onde o recurso reside | cadeia de caracteres (obrigatório) |
| nome | O nome do recurso | corda Restrições: Padrão = ^[^#<>%&:\?/{}*]{1,260}$ (obrigatório) |
| Propriedades | As propriedades da regra do recurso. | ScheduledQueryRuleProperties (obrigatório) |
| Tags | Marcas de recurso | Dicionário de nomes e valores de marca. Consulte Marcas em modelos |
RuleResolveConfiguration
| Nome | Descrição | Valor |
|---|---|---|
| autoReolução | O sinalizador que indica se um alerta disparado deve ou não ser resolvido automaticamente. | Bool |
| timeToResolve | A duração que uma regra deve avaliar como íntegra antes que o alerta disparado seja resolvido automaticamente representado no formato de duração ISO 8601. | corda |
ScheduledQueryRuleCriteria
| Nome | Descrição | Valor |
|---|---|---|
| allOf | Uma lista de condições a serem avaliadas em relação aos escopos especificados | de Condição [] |
ScheduledQueryRuleProperties
ScheduledQueryRuleResourceTags
| Nome | Descrição | Valor |
|---|
UserIdentityProperties
| 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 - 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": "2024-01-01-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"kind": "string",
"location": "string",
"properties": {
"actions": {
"actionGroups": [ "string" ],
"actionProperties": {
"{customized property}": "string"
},
"customProperties": {
"{customized property}": "string"
}
},
"autoMitigate": "bool",
"checkWorkspaceAlertsStorageConfigured": "bool",
"criteria": {
"allOf": [
{
"alertSensitivity": "string",
"criterionType": "string",
"dimensions": [
{
"name": "string",
"operator": "string",
"values": [ "string" ]
}
],
"failingPeriods": {
"minFailingPeriodsToAlert": "int",
"numberOfEvaluationPeriods": "int"
},
"ignoreDataBefore": "string",
"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",
"resolveConfiguration": {
"autoResolved": "bool",
"timeToResolve": "string"
},
"scopes": [ "string" ],
"severity": "int",
"skipQueryValidation": "bool",
"targetResourceTypes": [ "string" ],
"windowSize": "string"
},
"tags": {
"{customized property}": "string"
}
}
Valores de propriedade
Ações
| Nome | Descrição | Valor |
|---|---|---|
| actionGroups | IDs de recurso do Grupo de Ações a serem invocadas quando o alerta é acionado. | string[] |
| actionProperties | As propriedades de uma ação. | ActionsActionProperties |
| customProperties | As propriedades de um conteúdo de alerta. | actionsCustomProperties |
ActionsActionProperties
| Nome | Descrição | Valor |
|---|
ActionsCustomProperties
| Nome | Descrição | Valor |
|---|
Condição
| Nome | Descrição | Valor |
|---|---|---|
| alertSensitivity | A extensão do desvio necessária para disparar um alerta. Os valores permitidos são 'Baixo', 'Médio' e 'Alto'. Isso afetará o quão apertado é o limite para o padrão da série de métricas. Relevante e necessário apenas para regras de limite dinâmico do tipo LogAlert. | corda |
| criterionType | Especifica o tipo de critério de limite | 'DynamicThresholdCriterion' 'StaticThresholdCriterion' |
| 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 |
| ignoreDataBefore | Use essa opção para definir a data da qual começar a aprender os dados históricos da métrica e calcular os limites dinâmicos (no formato ISO8601). Relevante apenas para regras de limite dinâmico do tipo LogAlert. | corda |
| metricMeasureColumn | A coluna que contém o número da medida de métrica. Relevante apenas para regras do tipo LogAlert. | corda |
| metricName | O nome da métrica a ser enviada. Relevante e necessário somente para regras do tipo LogToMetric. | corda |
| operador | O operador de critérios. Relevante e necessário somente para regras do tipo LogAlert. | 'Equals' 'GreaterOrLessThan' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' |
| consulta | Alerta de consulta de log | corda |
| 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. | corda |
| limiar | o valor do limite de critérios que ativa o alerta. Relevante e necessário apenas para regras de limite estático do tipo LogAlert. | int |
| timeAggregation | Tipo de agregação. Relevante e necessário somente para regras do tipo LogAlert. | 'Média' 'Count' '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 |
| numberOfEvaluationPeriods | 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) |
Identidade
| Nome | Descrição | Valor |
|---|---|---|
| tipo | Tipo de identidade de serviço gerenciado. | 'None' 'SystemAssigned' 'UserAssigned' (obrigatório) |
| userAssignedIdentities | A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. | IdentityUserAssignedIdentities |
IdentityUserAssignedIdentities
| Nome | Descrição | Valor |
|---|
Microsoft.Insights/scheduledQueryRules
| Nome | Descrição | Valor |
|---|---|---|
| apiVersion | A versão da API | '2024-01-01-preview' |
| identidade | A identidade do recurso. | Identity |
| tipo | Indica o tipo de regra de consulta agendada. O padrão é LogAlert. | 'EventLogAlert' 'LogAlert' 'LogToMetric' |
| localização | A localização geográfica onde o recurso reside | cadeia de caracteres (obrigatório) |
| nome | O nome do recurso | corda Restrições: Padrão = ^[^#<>%&:\?/{}*]{1,260}$ (obrigatório) |
| Propriedades | As propriedades da regra do recurso. | ScheduledQueryRuleProperties (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' |
RuleResolveConfiguration
| Nome | Descrição | Valor |
|---|---|---|
| autoReolução | O sinalizador que indica se um alerta disparado deve ou não ser resolvido automaticamente. | Bool |
| timeToResolve | A duração que uma regra deve avaliar como íntegra antes que o alerta disparado seja resolvido automaticamente representado no formato de duração ISO 8601. | corda |
ScheduledQueryRuleCriteria
| Nome | Descrição | Valor |
|---|---|---|
| allOf | Uma lista de condições a serem avaliadas em relação aos escopos especificados | de Condição [] |
ScheduledQueryRuleProperties
ScheduledQueryRuleResourceTags
| Nome | Descrição | Valor |
|---|
UserIdentityProperties
| Nome | Descrição | Valor |
|---|
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@2024-01-01-preview"
name = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
kind = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
actions = {
actionGroups = [
"string"
]
actionProperties = {
{customized property} = "string"
}
customProperties = {
{customized property} = "string"
}
}
autoMitigate = bool
checkWorkspaceAlertsStorageConfigured = bool
criteria = {
allOf = [
{
alertSensitivity = "string"
criterionType = "string"
dimensions = [
{
name = "string"
operator = "string"
values = [
"string"
]
}
]
failingPeriods = {
minFailingPeriodsToAlert = int
numberOfEvaluationPeriods = int
}
ignoreDataBefore = "string"
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"
resolveConfiguration = {
autoResolved = bool
timeToResolve = "string"
}
scopes = [
"string"
]
severity = int
skipQueryValidation = bool
targetResourceTypes = [
"string"
]
windowSize = "string"
}
})
}
Valores de propriedade
Ações
| Nome | Descrição | Valor |
|---|---|---|
| actionGroups | IDs de recurso do Grupo de Ações a serem invocadas quando o alerta é acionado. | string[] |
| actionProperties | As propriedades de uma ação. | ActionsActionProperties |
| customProperties | As propriedades de um conteúdo de alerta. | actionsCustomProperties |
ActionsActionProperties
| Nome | Descrição | Valor |
|---|
ActionsCustomProperties
| Nome | Descrição | Valor |
|---|
Condição
| Nome | Descrição | Valor |
|---|---|---|
| alertSensitivity | A extensão do desvio necessária para disparar um alerta. Os valores permitidos são 'Baixo', 'Médio' e 'Alto'. Isso afetará o quão apertado é o limite para o padrão da série de métricas. Relevante e necessário apenas para regras de limite dinâmico do tipo LogAlert. | corda |
| criterionType | Especifica o tipo de critério de limite | 'DynamicThresholdCriterion' 'StaticThresholdCriterion' |
| 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 |
| ignoreDataBefore | Use essa opção para definir a data da qual começar a aprender os dados históricos da métrica e calcular os limites dinâmicos (no formato ISO8601). Relevante apenas para regras de limite dinâmico do tipo LogAlert. | corda |
| metricMeasureColumn | A coluna que contém o número da medida de métrica. Relevante apenas para regras do tipo LogAlert. | corda |
| metricName | O nome da métrica a ser enviada. Relevante e necessário somente para regras do tipo LogToMetric. | corda |
| operador | O operador de critérios. Relevante e necessário somente para regras do tipo LogAlert. | 'Equals' 'GreaterOrLessThan' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' |
| consulta | Alerta de consulta de log | corda |
| 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. | corda |
| limiar | o valor do limite de critérios que ativa o alerta. Relevante e necessário apenas para regras de limite estático do tipo LogAlert. | int |
| timeAggregation | Tipo de agregação. Relevante e necessário somente para regras do tipo LogAlert. | 'Média' 'Count' '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 |
| numberOfEvaluationPeriods | 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) |
Identidade
| Nome | Descrição | Valor |
|---|---|---|
| tipo | Tipo de identidade de serviço gerenciado. | 'None' 'SystemAssigned' 'UserAssigned' (obrigatório) |
| userAssignedIdentities | A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. | IdentityUserAssignedIdentities |
IdentityUserAssignedIdentities
| Nome | Descrição | Valor |
|---|
Microsoft.Insights/scheduledQueryRules
| Nome | Descrição | Valor |
|---|---|---|
| identidade | A identidade do recurso. | Identity |
| tipo | Indica o tipo de regra de consulta agendada. O padrão é LogAlert. | 'EventLogAlert' 'LogAlert' 'LogToMetric' |
| localização | A localização geográfica onde o recurso reside | cadeia de caracteres (obrigatório) |
| nome | O nome do recurso | corda Restrições: Padrão = ^[^#<>%&:\?/{}*]{1,260}$ (obrigatório) |
| Propriedades | As propriedades da regra do recurso. | ScheduledQueryRuleProperties (obrigatório) |
| Tags | Marcas de recurso | Dicionário de nomes e valores de marca. |
| tipo | O tipo de recurso | "Microsoft.Insights/scheduledQueryRules@2024-01-01-preview" |
RuleResolveConfiguration
| Nome | Descrição | Valor |
|---|---|---|
| autoReolução | O sinalizador que indica se um alerta disparado deve ou não ser resolvido automaticamente. | Bool |
| timeToResolve | A duração que uma regra deve avaliar como íntegra antes que o alerta disparado seja resolvido automaticamente representado no formato de duração ISO 8601. | corda |
ScheduledQueryRuleCriteria
| Nome | Descrição | Valor |
|---|---|---|
| allOf | Uma lista de condições a serem avaliadas em relação aos escopos especificados | de Condição [] |
ScheduledQueryRuleProperties
ScheduledQueryRuleResourceTags
| Nome | Descrição | Valor |
|---|
UserIdentityProperties
| Nome | Descrição | Valor |
|---|