Metric Alerts - Update
Atualizar uma definição de alerta de métrica.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/metricAlerts/{ruleName}?api-version=2018-03-01
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
resource
|
path | True |
string |
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas. |
rule
|
path | True |
string |
O nome da regra. |
subscription
|
path | True |
string |
O ID da subscrição de destino. |
api-version
|
query | True |
string |
A versão da API a utilizar para esta operação. |
Corpo do Pedido
Name | Tipo | Description |
---|---|---|
properties.actions |
a matriz de ações que são executadas quando a regra de alerta fica ativa e quando uma condição de alerta é resolvida. |
|
properties.autoMitigate |
boolean |
o sinalizador que indica se o alerta deve ser resolvido automaticamente ou não. A predefinição é verdadeira. |
properties.criteria | MetricAlertCriteria: |
define as informações de critérios de alerta específicos. |
properties.description |
string |
a descrição do alerta de métrica que será incluída no e-mail de alerta. |
properties.enabled |
boolean |
o sinalizador que indica se o alerta de métricas está ativado. |
properties.evaluationFrequency |
string |
com que frequência o alerta de métrica é avaliado representado no formato de duração ISO 8601. |
properties.scopes |
string[] |
a lista de IDs de recursos para os quais este alerta de métrica está confinado. |
properties.severity |
integer |
Gravidade do alerta {0, 1, 2, 3, 4} |
properties.targetResourceRegion |
string |
a região dos recursos de destino em que o alerta é criado/atualizado. Obrigatório para MultipleResourceMultipleMetricCriteria. |
properties.targetResourceType |
string |
o tipo de recurso dos recursos de destino nos quais o alerta é criado/atualizado. Obrigatório para MultipleResourceMultipleMetricCriteria. |
properties.windowSize |
string |
o período de tempo (no formato de duração ISO 8601) utilizado para monitorizar a atividade de alertas com base no limiar. |
tags |
object |
Etiquetas de recursos |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
BadRequest |
Segurança
azure_auth
Fluxo OAuth2 do Azure Active Directory
Tipo:
oauth2
Fluxo:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Âmbitos
Name | Description |
---|---|
user_impersonation | representar a sua conta de utilizador |
Exemplos
Create or update an alert rule
Pedido de amostra
PATCH https://management.azure.com/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Insights/metricAlerts/chiricutin?api-version=2018-03-01
{
"tags": {},
"properties": {
"description": "This is the description of the rule1",
"severity": 3,
"enabled": true,
"scopes": [
"/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme"
],
"evaluationFrequency": "Pt1m",
"windowSize": "Pt15m",
"criteria": {
"odata.type": "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria",
"allOf": [
{
"criterionType": "StaticThresholdCriterion",
"name": "High_CPU_80",
"metricName": "\\Processor(_Total)\\% Processor Time",
"dimensions": [],
"operator": "GreaterThan",
"threshold": 80.5,
"timeAggregation": "Average"
}
]
},
"autoMitigate": true,
"actions": [
{
"actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
"webHookProperties": {
"key11": "value11",
"key12": "value12"
}
}
]
}
}
Resposta da amostra
{
"id": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/chiricutin",
"type": "Microsoft.Insights/metricAlerts",
"location": "global",
"tags": {
"hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": "Resource"
},
"properties": {
"description": "This is the description of the rule1",
"severity": 3,
"enabled": true,
"scopes": [
"/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme"
],
"evaluationFrequency": "Pt1m",
"windowSize": "Pt15m",
"criteria": {
"odata.type": "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria",
"allOf": [
{
"criterionType": "StaticThresholdCriterion",
"name": "High_CPU_80",
"metricName": "\\Processor(_Total)\\% Processor Time",
"dimensions": [],
"operator": "GreaterThan",
"threshold": 80.5,
"timeAggregation": "Average"
}
]
},
"autoMitigate": true,
"actions": [
{
"actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
"webHookProperties": {
"key11": "value11",
"key12": "value12"
}
}
]
}
}
Definições
Name | Description |
---|---|
Aggregation |
os tipos de agregação de tempo dos critérios. |
Dynamic |
Critério para o limiar dinâmico. |
Dynamic |
O número mínimo de violações necessárias na janela de tempo de pesquisa selecionada necessária para emitir um alerta. |
Dynamic |
O operador utilizado para comparar o valor da métrica com o limiar. |
Dynamic |
A extensão do desvio necessário para acionar um alerta. Isto afetará o quão apertado é o limiar para o padrão de série de métricas. |
Error |
Descreve o formato da resposta de Erro. |
Metric |
Uma ação de alerta. |
Metric |
Especifica os critérios de alerta de métricas para vários recursos que têm vários critérios de métricas. |
Metric |
O recurso de alerta de métricas. |
Metric |
O recurso de alerta de métricas para operações de patch. |
Metric |
Especifica os critérios de alerta de métricas para um único recurso que tem vários critérios de métricas. |
Metric |
Critério para filtrar métricas. |
Metric |
Especifica uma dimensão de métrica. |
Operator |
o operador critérios. |
Webtest |
Especifica os critérios da regra de alerta de métricas para um recurso de teste Web. |
AggregationTypeEnum
os tipos de agregação de tempo dos critérios.
Name | Tipo | Description |
---|---|---|
Average |
string |
|
Count |
string |
|
Maximum |
string |
|
Minimum |
string |
|
Total |
string |
DynamicMetricCriteria
Critério para o limiar dinâmico.
Name | Tipo | Description |
---|---|---|
alertSensitivity |
A extensão do desvio necessário para acionar um alerta. Isto afetará o quão apertado é o limiar para o padrão de série de métricas. |
|
criterionType |
string:
Dynamic |
Especifica o tipo de critérios de limiar |
dimensions |
Lista de condições de dimensão. |
|
failingPeriods |
O número mínimo de violações necessárias na janela de tempo de pesquisa selecionada necessária para emitir um alerta. |
|
ignoreDataBefore |
string |
Utilize esta opção para definir a data a partir da qual começar a aprender os dados históricos das métricas e calcular os limiares dinâmicos (no formato ISO8601) |
metricName |
string |
Nome da métrica. |
metricNamespace |
string |
Espaço de nomes da métrica. |
name |
string |
Nome dos critérios. |
operator |
O operador utilizado para comparar o valor da métrica com o limiar. |
|
skipMetricValidation |
boolean |
Permite criar uma regra de alerta em uma métrica personalizada que ainda não foi emitida, fazendo com que a validação da métrica seja ignorada. |
timeAggregation |
os tipos de agregação de tempo dos critérios. |
DynamicThresholdFailingPeriods
O número mínimo de violações necessárias na janela de tempo de pesquisa selecionada necessária para emitir um alerta.
Name | Tipo | Description |
---|---|---|
minFailingPeriodsToAlert |
number |
O número de violações para acionar um alerta. Deve ser menor ou igual a numberOfEvaluationPeriods. |
numberOfEvaluationPeriods |
number |
O número de pontos de pesquisa agregados. A janela de tempo de pesquisa é calculada com base na granularidade da agregação (windowSize) e no número selecionado de pontos agregados. |
DynamicThresholdOperator
O operador utilizado para comparar o valor da métrica com o limiar.
Name | Tipo | Description |
---|---|---|
GreaterOrLessThan |
string |
|
GreaterThan |
string |
|
LessThan |
string |
DynamicThresholdSensitivity
A extensão do desvio necessário para acionar um alerta. Isto afetará o quão apertado é o limiar para o padrão de série de métricas.
Name | Tipo | Description |
---|---|---|
High |
string |
|
Low |
string |
|
Medium |
string |
ErrorResponse
Descreve o formato da resposta de Erro.
Name | Tipo | Description |
---|---|---|
code |
string |
Código de erro |
message |
string |
Mensagem de erro a indicar o motivo pela qual a operação falhou. |
MetricAlertAction
Uma ação de alerta.
Name | Tipo | Description |
---|---|---|
actionGroupId |
string |
o ID do grupo de ações a utilizar. |
webHookProperties |
object |
Este campo permite especificar propriedades personalizadas, que seriam anexadas ao payload de alerta enviado como entrada para o webhook. |
MetricAlertMultipleResourceMultipleMetricCriteria
Especifica os critérios de alerta de métricas para vários recursos que têm vários critérios de métricas.
Name | Tipo | Description |
---|---|---|
allOf | MultiMetricCriteria[]: |
a lista de múltiplos critérios de métricas para esta operação "tudo". |
odata.type |
string:
Microsoft. |
especifica o tipo de critérios de alerta. |
MetricAlertResource
O recurso de alerta de métricas.
Name | Tipo | Description |
---|---|---|
id |
string |
ID do recurso do Azure |
location |
string |
Localização do recurso |
name |
string |
Nome do recurso do Azure |
properties.actions |
a matriz de ações que são executadas quando a regra de alerta fica ativa e quando uma condição de alerta é resolvida. |
|
properties.autoMitigate |
boolean |
o sinalizador que indica se o alerta deve ser resolvido automaticamente ou não. A predefinição é verdadeira. |
properties.criteria | MetricAlertCriteria: |
define as informações de critérios de alerta específicos. |
properties.description |
string |
a descrição do alerta de métrica que será incluída no e-mail de alerta. |
properties.enabled |
boolean |
o sinalizador que indica se o alerta de métricas está ativado. |
properties.evaluationFrequency |
string |
com que frequência o alerta de métrica é avaliado representado no formato de duração ISO 8601. |
properties.isMigrated |
boolean |
o valor que indica se esta regra de alerta é migrada. |
properties.lastUpdatedTime |
string |
A última vez que a regra foi atualizada no formato ISO8601. |
properties.scopes |
string[] |
a lista de IDs de recursos para os quais este alerta de métrica está confinado. |
properties.severity |
integer |
Gravidade do alerta {0, 1, 2, 3, 4} |
properties.targetResourceRegion |
string |
a região dos recursos de destino em que o alerta é criado/atualizado. Obrigatório se o âmbito contiver uma subscrição, um grupo de recursos ou mais do que um recurso. |
properties.targetResourceType |
string |
o tipo de recurso dos recursos de destino nos quais o alerta é criado/atualizado. Obrigatório se o âmbito contiver uma subscrição, um grupo de recursos ou mais do que um recurso. |
properties.windowSize |
string |
o período de tempo (no formato de duração ISO 8601) utilizado para monitorizar a atividade de alertas com base no limiar. |
tags |
object |
Etiquetas de recursos |
type |
string |
Tipo de recurso do Azure |
MetricAlertResourcePatch
O recurso de alerta de métricas para operações de patch.
Name | Tipo | Description |
---|---|---|
properties.actions |
a matriz de ações que são executadas quando a regra de alerta fica ativa e quando uma condição de alerta é resolvida. |
|
properties.autoMitigate |
boolean |
o sinalizador que indica se o alerta deve ser resolvido automaticamente ou não. A predefinição é verdadeira. |
properties.criteria | MetricAlertCriteria: |
define as informações de critérios de alerta específicos. |
properties.description |
string |
a descrição do alerta de métrica que será incluída no e-mail de alerta. |
properties.enabled |
boolean |
o sinalizador que indica se o alerta de métricas está ativado. |
properties.evaluationFrequency |
string |
com que frequência o alerta de métrica é avaliado representado no formato de duração ISO 8601. |
properties.isMigrated |
boolean |
o valor que indica se esta regra de alerta é migrada. |
properties.lastUpdatedTime |
string |
A última vez que a regra foi atualizada no formato ISO8601. |
properties.scopes |
string[] |
a lista de IDs de recursos para os quais este alerta de métrica está confinado. |
properties.severity |
integer |
Gravidade do alerta {0, 1, 2, 3, 4} |
properties.targetResourceRegion |
string |
a região dos recursos de destino em que o alerta é criado/atualizado. Obrigatório para MultipleResourceMultipleMetricCriteria. |
properties.targetResourceType |
string |
o tipo de recurso dos recursos de destino nos quais o alerta é criado/atualizado. Obrigatório para MultipleResourceMultipleMetricCriteria. |
properties.windowSize |
string |
o período de tempo (no formato de duração ISO 8601) utilizado para monitorizar a atividade de alertas com base no limiar. |
tags |
object |
Etiquetas de recursos |
MetricAlertSingleResourceMultipleMetricCriteria
Especifica os critérios de alerta de métricas para um único recurso que tem vários critérios de métricas.
Name | Tipo | Description |
---|---|---|
allOf |
A lista de critérios de métricas para esta operação "tudo". |
|
odata.type |
string:
Microsoft. |
especifica o tipo de critérios de alerta. |
MetricCriteria
Critério para filtrar métricas.
Name | Tipo | Description |
---|---|---|
criterionType |
string:
Static |
Especifica o tipo de critérios de limiar |
dimensions |
Lista de condições de dimensão. |
|
metricName |
string |
Nome da métrica. |
metricNamespace |
string |
Espaço de nomes da métrica. |
name |
string |
Nome dos critérios. |
operator |
o operador critérios. |
|
skipMetricValidation |
boolean |
Permite criar uma regra de alerta em uma métrica personalizada que ainda não foi emitida, fazendo com que a validação da métrica seja ignorada. |
threshold |
number |
o valor do limiar de critérios que ativa o alerta. |
timeAggregation |
os tipos de agregação de tempo dos critérios. |
MetricDimension
Especifica uma dimensão de métrica.
Name | Tipo | Description |
---|---|---|
name |
string |
Nome da dimensão. |
operator |
string |
o operador de dimensão. Só são suportados "Incluir" e "Excluir" |
values |
string[] |
lista de valores de dimensão. |
Operator
o operador critérios.
Name | Tipo | Description |
---|---|---|
Equals |
string |
|
GreaterThan |
string |
|
GreaterThanOrEqual |
string |
|
LessThan |
string |
|
LessThanOrEqual |
string |
WebtestLocationAvailabilityCriteria
Especifica os critérios da regra de alerta de métricas para um recurso de teste Web.
Name | Tipo | Description |
---|---|---|
componentId |
string |
O ID de recurso do Application Insights. |
failedLocationCount |
number |
O número de localizações falhadas. |
odata.type |
string:
Microsoft. |
especifica o tipo de critérios de alerta. |
webTestId |
string |
O ID de teste Web do Application Insights. |