Metric Alerts - List By Subscription
Recuperar definições de regra de alerta em uma assinatura.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Insights/metricAlerts?api-version=2018-03-01
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
subscription
|
path | True |
string |
A ID da assinatura de destino. |
api-version
|
query | True |
string |
A versão da API a ser usada para esta operação. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
Solicitação bem-sucedida para uma lista de alertas de métrica |
|
Other Status Codes |
BadRequest |
Segurança
azure_auth
Fluxo OAuth2 do Azure Active Directory
Tipo:
oauth2
Flow:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Escopos
Nome | Description |
---|---|
user_impersonation | representar sua conta de usuário |
Exemplos
List metric alert rules
Solicitação de exemplo
GET https://management.azure.com/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/providers/Microsoft.Insights/metricAlerts?api-version=2018-03-01
Resposta de exemplo
{
"value": [
{
"id": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/highcpu",
"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": "CustomMetric_\\Processor(_Total)\\% Processor Time",
"dimensions": [],
"operator": "GreaterThan",
"threshold": 80.5,
"timeAggregation": "Average"
}
]
},
"actions": [
{
"actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
"webHookProperties": {
"key11": "value11",
"key12": "value12"
}
}
]
}
},
{
"id": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/mediumcpu",
"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": "Med cpu alert",
"severity": 4,
"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": "Medium_CPU_50",
"metricName": "CustomMetric_\\Processor(_Total)\\% Processor Time",
"dimensions": [],
"operator": "GreaterThan",
"threshold": 50.5,
"timeAggregation": "Average"
}
]
},
"actions": [
{
"actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
"webHookProperties": {
"key11": "value11",
"key12": "value12"
}
}
]
}
}
]
}
Definições
Nome | Description |
---|---|
Additional |
Uma matriz de objetos com propriedades 'type' e 'info'. O esquema de 'info' é específico do serviço e depende da cadeia de caracteres 'type'. |
Aggregation |
os tipos de agregação de tempo de critérios. |
Dynamic |
Critério para limite dinâmico. |
Dynamic |
O número mínimo de violações necessárias na janela de tempo de pesquisa selecionada necessária para gerar um alerta. |
Dynamic |
O operador usado para comparar o valor da métrica com o limite. |
Dynamic |
A extensão do desvio necessária para disparar um alerta. Isso afetará o quão apertado é o limite para o padrão da série de métricas. |
Error | |
Error |
Descreve os detalhes de uma resposta de erro. |
Error |
Descreve o formato da resposta de erro. |
Metric |
Uma ação de alerta. |
Metric |
Especifica os critérios de alerta de métrica para vários recursos que têm vários critérios de métrica. |
Metric |
O recurso de alerta de métrica. |
Metric |
Representa uma coleção de recursos de regra de alerta. |
Metric |
Especifica os critérios de alerta de métrica para um único recurso que tem vários critérios de métrica. |
Metric |
Critério para filtrar métricas. |
Metric |
Especifica uma dimensão de métrica. |
Operator |
o operador de critérios. |
Webtest |
Especifica os critérios de regra de alerta de métrica para um recurso de teste da Web. |
AdditionalInfo
Uma matriz de objetos com propriedades 'type' e 'info'. O esquema de 'info' é específico do serviço e depende da cadeia de caracteres 'type'.
Nome | Tipo | Description |
---|---|---|
info |
object |
As informações adicionais específicas para o tipo. |
type |
string |
O tipo de informações adicionais. |
AggregationTypeEnum
os tipos de agregação de tempo de critérios.
Nome | Tipo | Description |
---|---|---|
Average |
string |
|
Count |
string |
|
Maximum |
string |
|
Minimum |
string |
|
Total |
string |
DynamicMetricCriteria
Critério para limite dinâmico.
Nome | Tipo | Description |
---|---|---|
alertSensitivity |
A extensão do desvio necessária para disparar um alerta. Isso afetará o quão apertado é o limite para o padrão da série de métricas. |
|
criterionType |
string:
Dynamic |
Especifica o tipo de critério de limite |
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 gerar um alerta. |
|
ignoreDataBefore |
string |
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) |
metricName |
string |
Nome da métrica. |
metricNamespace |
string |
Namespace da métrica. |
name |
string |
Nome dos critérios. |
operator |
O operador usado para comparar o valor da métrica com o limite. |
|
skipMetricValidation |
boolean |
Permite a criação de 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 de critérios. |
DynamicThresholdFailingPeriods
O número mínimo de violações necessárias na janela de tempo de pesquisa selecionada necessária para gerar um alerta.
Nome | Tipo | Description |
---|---|---|
minFailingPeriodsToAlert |
number |
O número de violações para disparar 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 de agregação (windowSize) e no número selecionado de pontos agregados. |
DynamicThresholdOperator
O operador usado para comparar o valor da métrica com o limite.
Nome | Tipo | Description |
---|---|---|
GreaterOrLessThan |
string |
|
GreaterThan |
string |
|
LessThan |
string |
DynamicThresholdSensitivity
A extensão do desvio necessária para disparar um alerta. Isso afetará o quão apertado é o limite para o padrão da série de métricas.
Nome | Tipo | Description |
---|---|---|
High |
string |
|
Low |
string |
|
Medium |
string |
Error
Nome | Tipo | Description |
---|---|---|
additionalInfo |
Uma matriz de objetos com propriedades 'type' e 'info'. O esquema de 'info' é específico do serviço e depende da cadeia de caracteres 'type'. |
|
code |
string |
Cadeia de caracteres não dimensionada que pode ser usada para identificar o erro programaticamente. |
details |
Uma matriz de objetos de informações de resposta de erro aninhados adicionais, conforme descrito por este contrato. |
|
message |
string |
Descreve o erro em detalhes e fornece informações de depuração. Se Accept-Language estiver definido na solicitação, ele deverá ser localizado nesse idioma. |
target |
string |
O destino do erro específico (por exemplo, o nome da propriedade em erro). |
ErrorDetail
Descreve os detalhes de uma resposta de erro.
Nome | Tipo | Description |
---|---|---|
additionalInfo |
Uma matriz de objetos com propriedades 'type' e 'info'. O esquema de 'info' é específico do serviço e depende da cadeia de caracteres 'type'. |
|
code |
string |
Cadeia de caracteres não dimensionada que pode ser usada para identificar o erro programaticamente. |
message |
string |
Descreve o erro em detalhes e fornece informações de depuração. |
target |
string |
O destino do erro específico (por exemplo, o nome da propriedade em erro). |
ErrorResponse
Descreve o formato da resposta de erro.
Nome | Tipo | Description |
---|---|---|
error |
MetricAlertAction
Uma ação de alerta.
Nome | Tipo | Description |
---|---|---|
actionGroupId |
string |
a ID do grupo de ações a ser usado. |
webHookProperties |
object |
Esse campo permite especificar propriedades personalizadas, que seriam acrescentadas ao conteúdo do alerta enviado como entrada para o webhook. |
MetricAlertMultipleResourceMultipleMetricCriteria
Especifica os critérios de alerta de métrica para vários recursos que têm vários critérios de métrica.
Nome | Tipo | Description |
---|---|---|
allOf | MultiMetricCriteria[]: |
a lista de vários critérios de métrica para essa operação "tudo". |
odata.type |
string:
Microsoft. |
especifica o tipo dos critérios de alerta. |
MetricAlertResource
O recurso de alerta de métrica.
Nome | Tipo | Description |
---|---|---|
id |
string |
ID de recurso do Azure |
location |
string |
Local do recurso |
name |
string |
Nome do recurso do Azure |
properties.actions |
a matriz de ações executadas quando a regra de alerta se torna 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. O padrão é verdadeiro. |
properties.criteria | MetricAlertCriteria: |
define as informações específicas de critérios de alerta. |
properties.description |
string |
a descrição do alerta de métrica que será incluído no email de alerta. |
properties.enabled |
boolean |
o sinalizador que indica se o alerta de métrica está habilitado. |
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 essa regra de alerta é migrada. |
properties.lastUpdatedTime |
string |
Última vez em que a regra foi atualizada no formato ISO8601. |
properties.scopes |
string[] |
a lista de IDs de recurso à qual esse alerta de métrica está no escopo. |
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 escopo contiver uma assinatura, um grupo de recursos ou mais de um recurso. |
properties.targetResourceType |
string |
o tipo de recurso dos recursos de destino nos quais o alerta é criado/atualizado. Obrigatório se o escopo contiver uma assinatura, um grupo de recursos ou mais de um recurso. |
properties.windowSize |
string |
o período de tempo (no formato de duração ISO 8601) usado para monitorar a atividade de alerta com base no limite. |
tags |
object |
Marcas de recurso |
type |
string |
Tipo de recurso do Azure |
MetricAlertResourceCollection
Representa uma coleção de recursos de regra de alerta.
Nome | Tipo | Description |
---|---|---|
value |
os valores dos recursos da regra de alerta. |
MetricAlertSingleResourceMultipleMetricCriteria
Especifica os critérios de alerta de métrica para um único recurso que tem vários critérios de métrica.
Nome | Tipo | Description |
---|---|---|
allOf |
A lista de critérios de métrica para esta operação "tudo". |
|
odata.type |
string:
Microsoft. |
especifica o tipo dos critérios de alerta. |
MetricCriteria
Critério para filtrar métricas.
Nome | Tipo | Description |
---|---|---|
criterionType |
string:
Static |
Especifica o tipo de critério de limite |
dimensions |
Lista de condições de dimensão. |
|
metricName |
string |
Nome da métrica. |
metricNamespace |
string |
Namespace da métrica. |
name |
string |
Nome dos critérios. |
operator |
o operador de critérios. |
|
skipMetricValidation |
boolean |
Permite a criação de 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 limite de critérios que ativa o alerta. |
timeAggregation |
os tipos de agregação de tempo de critérios. |
MetricDimension
Especifica uma dimensão de métrica.
Nome | Tipo | Description |
---|---|---|
name |
string |
Nome da dimensão. |
operator |
string |
o operador de dimensão. Há suporte apenas para 'Incluir' e 'Excluir' |
values |
string[] |
lista de valores de dimensão. |
Operator
o operador de critérios.
Nome | Tipo | Description |
---|---|---|
Equals |
string |
|
GreaterThan |
string |
|
GreaterThanOrEqual |
string |
|
LessThan |
string |
|
LessThanOrEqual |
string |
WebtestLocationAvailabilityCriteria
Especifica os critérios de regra de alerta de métrica para um recurso de teste da Web.
Nome | Tipo | Description |
---|---|---|
componentId |
string |
A ID do recurso do Application Insights. |
failedLocationCount |
number |
O número de locais com falha. |
odata.type |
string:
Microsoft. |
especifica o tipo dos critérios de alerta. |
webTestId |
string |
A ID de teste da Web do Application Insights. |