Metric Alerts - Get

Serviço:
Monitor
Versão da API:
2024-03-01-preview

Recupere uma definição de regra de alerta.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/metricAlerts/{ruleName}?api-version=2024-03-01-preview

Parâmetros de URI

Nome Em Obrigatório Tipo Description
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
ruleName
 path True

string

O nome da regra.
subscriptionId
 path True

string

minLength: 1

A ID da assinatura de destino.
api-version
 query True

string

minLength: 1

A versão da API a ser usada para esta operação.

Respostas

Nome Tipo Description
200 OK

MetricAlertResource

Operação do Azure concluída com sucesso.
Other Status Codes

MetricAlertErrorResponse

Uma resposta de erro inesperada.

Segurança

azure_auth

Azure Active Directory OAuth2 Flow.

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

Get a dynamic alert rule for multiple resources
Get a dynamic alert rule for single resource
Get a query based alert rule
Get a web test alert rule
Get an alert rule for multiple resources
Get an alert rule for single resource
Get an alert rule on resource group(s)
Get an alert rule on subscription

Get a dynamic alert rule for multiple resources

Solicitação de exemplo

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/gigtest/providers/Microsoft.Insights/metricAlerts/MetricAlertOnMultipleResources?api-version=2024-03-01-preview

Resposta de exemplo

Código de status:
200 
{
  "type": "Microsoft.Insights/metricAlerts",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/MetricAlertOnMultipleResources",
  "location": "global",
  "properties": {
    "description": "This is the description of the rule1",
    "actions": [
      {
        "actionGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
        "webHookProperties": {
          "key11": "value11",
          "key12": "value12"
        }
      }
    ],
    "autoMitigate": false,
    "criteria": {
      "allOf": [
        {
          "name": "High_CPU_80",
          "alertSensitivity": "Medium",
          "criterionType": "DynamicThresholdCriterion",
          "dimensions": [],
          "failingPeriods": {
            "minFailingPeriodsToAlert": 4,
            "numberOfEvaluationPeriods": 4
          },
          "metricName": "Percentage CPU",
          "metricNamespace": "microsoft.compute/virtualmachines",
          "operator": "GreaterOrLessThan",
          "timeAggregation": "Average"
        }
      ],
      "odata.type": "Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria"
    },
    "enabled": true,
    "evaluationFrequency": "PT1M",
    "scopes": [
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme1",
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme2"
    ],
    "severity": 3,
    "targetResourceRegion": "southcentralus",
    "targetResourceType": "Microsoft.Compute/virtualMachines",
    "windowSize": "PT15M"
  },
  "tags": {
    "hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": "Resource"
  }
}

Get a dynamic alert rule for single resource

Solicitação de exemplo

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/gigtest/providers/Microsoft.Insights/metricAlerts/chiricutin?api-version=2024-03-01-preview

Resposta de exemplo

Código de status:
200 
{
  "type": "Microsoft.Insights/metricAlerts",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/chiricutin",
  "location": "global",
  "properties": {
    "description": "This is the description of the rule1",
    "actions": [
      {
        "actionGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
        "webHookProperties": {
          "key11": "value11",
          "key12": "value12"
        }
      }
    ],
    "autoMitigate": false,
    "criteria": {
      "allOf": [
        {
          "name": "High_CPU_80",
          "alertSensitivity": "Medium",
          "criterionType": "DynamicThresholdCriterion",
          "dimensions": [],
          "failingPeriods": {
            "minFailingPeriodsToAlert": 4,
            "numberOfEvaluationPeriods": 4
          },
          "ignoreDataBefore": null,
          "metricName": "Percentage CPU",
          "metricNamespace": "microsoft.compute/virtualmachines",
          "operator": "GreaterOrLessThan",
          "timeAggregation": "Average"
        }
      ],
      "odata.type": "Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria"
    },
    "enabled": true,
    "evaluationFrequency": "PT1M",
    "scopes": [
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme"
    ],
    "severity": 3,
    "windowSize": "PT15M"
  },
  "tags": {
    "hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": "Resource"
  }
}

Get a query based alert rule

Solicitação de exemplo

GET https://management.azure.com/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Insights/metricAlerts/chiricutin?api-version=2024-03-01-preview

Resposta de exemplo

Código de status:
200 
{
  "type": "Microsoft.Insights/metricAlerts",
  "id": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/chiricutin",
  "identity": {
    "type": "UserAssigned",
    "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
    "userAssignedIdentities": {
      "/subscriptions/2f1a501a-6e1d-4f37-a445-462d7f8a563d/resourceGroups/AdisTest/providers/Microsoft.ManagedIdentity/userAssignedIdentities/msi-test-euap": {
        "clientId": "778f4d04-3c60-4622-a839-5cf05866c983",
        "principalId": "669dd76d-cde8-4dc3-b882-1de566b0c628"
      }
    }
  },
  "location": "eastus",
  "properties": {
    "description": "This is the description of the rule1",
    "actions": [
      {
        "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
        "webHookProperties": {
          "key11": "value11",
          "key12": "value12"
        }
      }
    ],
    "criteria": {
      "allOf": [
        {
          "name": "Metric1",
          "criterionType": "StaticThresholdCriterion",
          "query": "floor(minute(vector(time())) / 10 ) % 2 == 1"
        }
      ],
      "odata.type": "Microsoft.Azure.Monitor.PromQLCriteria"
    },
    "enabled": true,
    "evaluationFrequency": "PT1M",
    "resolveConfiguration": {
      "autoResolved": true,
      "timeToResolve": "PT10M"
    },
    "scopes": [
      "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/microsoft.monitor/accounts/gigwadme"
    ],
    "severity": 3
  },
  "tags": {
    "hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": "Resource"
  }
}

Get a web test alert rule

Solicitação de exemplo

GET https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789101/resourceGroups/rg-example/providers/Microsoft.Insights/metricAlerts/webtest-name-example?api-version=2024-03-01-preview

Resposta de exemplo

Código de status:
200 
{
  "name": "webtest-name-example",
  "type": "Microsoft.Insights/metricAlerts",
  "id": "/subscriptions/12345678-1234-1234-1234-123456789101/resourcegroups/rg-example/providers/microsoft.insights/metricalerts/webtest-name-example",
  "location": "global",
  "properties": {
    "description": "Automatically created alert rule for availability test \"webtest-name-example\"",
    "actions": [],
    "criteria": {
      "componentId": "/subscriptions/12345678-1234-1234-1234-123456789101/resourcegroups/rg-example/providers/microsoft.insights/components/component-example",
      "failedLocationCount": 2,
      "odata.type": "Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria",
      "webTestId": "/subscriptions/12345678-1234-1234-1234-123456789101/resourcegroups/rg-example/providers/microsoft.insights/webtests/webtest-name-example"
    },
    "enabled": true,
    "evaluationFrequency": "PT1M",
    "scopes": [
      "/subscriptions/12345678-1234-1234-1234-123456789101/resourcegroups/rg-example/providers/microsoft.insights/webtests/webtest-name-example",
      "/subscriptions/12345678-1234-1234-1234-123456789101/resourcegroups/rg-example/providers/microsoft.insights/components/component-example"
    ],
    "severity": 4,
    "windowSize": "PT15M"
  },
  "tags": {
    "hidden-link:/subscriptions/12345678-1234-1234-1234-123456789101/resourcegroups/rg-example/providers/microsoft.insights/components/component-example": "Resource",
    "hidden-link:/subscriptions/12345678-1234-1234-1234-123456789101/resourcegroups/rg-example/providers/microsoft.insights/webtests/webtest-name-example": "Resource"
  }
}

Get an alert rule for multiple resources

Solicitação de exemplo

GET https://management.azure.com/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Insights/metricAlerts/MetricAlertOnMultipleResources?api-version=2024-03-01-preview

Resposta de exemplo

Código de status:
200 
{
  "type": "Microsoft.Insights/metricAlerts",
  "id": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/MetricAlertOnMultipleResources",
  "location": "global",
  "properties": {
    "description": "This is the description of the rule1",
    "actions": [
      {
        "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
        "webHookProperties": {
          "key11": "value11",
          "key12": "value12"
        }
      }
    ],
    "autoMitigate": false,
    "criteria": {
      "allOf": [
        {
          "name": "High_CPU_80",
          "criterionType": "StaticThresholdCriterion",
          "dimensions": [],
          "metricName": "Percentage CPU",
          "metricNamespace": "microsoft.compute/virtualmachines",
          "operator": "GreaterThan",
          "threshold": 80.5,
          "timeAggregation": "Average"
        }
      ],
      "odata.type": "Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria"
    },
    "enabled": true,
    "evaluationFrequency": "PT1M",
    "scopes": [
      "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme1",
      "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme2"
    ],
    "severity": 3,
    "targetResourceRegion": "southcentralus",
    "targetResourceType": "Microsoft.Compute/virtualMachines",
    "windowSize": "PT15M"
  },
  "tags": {
    "hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": "Resource"
  }
}

Get an alert rule for single resource

Solicitação de exemplo

GET https://management.azure.com/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Insights/metricAlerts/chiricutin?api-version=2024-03-01-preview

Resposta de exemplo

Código de status:
200 
{
  "type": "Microsoft.Insights/metricAlerts",
  "id": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/chiricutin",
  "location": "global",
  "properties": {
    "description": "This is the description of the rule1",
    "actions": [
      {
        "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
        "webHookProperties": {
          "key11": "value11",
          "key12": "value12"
        }
      }
    ],
    "autoMitigate": false,
    "criteria": {
      "allOf": [
        {
          "name": "High_CPU_80",
          "criterionType": "StaticThresholdCriterion",
          "dimensions": [],
          "metricName": "\\Processor(_Total)\\% Processor Time",
          "operator": "GreaterThan",
          "threshold": 80.5,
          "timeAggregation": "Average"
        }
      ],
      "odata.type": "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria"
    },
    "enabled": true,
    "evaluationFrequency": "PT1M",
    "scopes": [
      "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme"
    ],
    "severity": 3,
    "windowSize": "PT15M"
  },
  "tags": {
    "hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": "Resource"
  }
}

Get an alert rule on resource group(s)

Solicitação de exemplo

GET https://management.azure.com/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest1/providers/Microsoft.Insights/metricAlerts/MetricAlertAtResourceGroupLevel?api-version=2024-03-01-preview

Resposta de exemplo

Código de status:
200 
{
  "type": "Microsoft.Insights/metricAlerts",
  "id": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest1/providers/providers/microsoft.insights/metricalerts/MetricAlertAtResourceGroupLevel",
  "location": "global",
  "properties": {
    "description": "This is the description of the rule1",
    "actions": [
      {
        "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
        "webHookProperties": {
          "key11": "value11",
          "key12": "value12"
        }
      }
    ],
    "autoMitigate": false,
    "criteria": {
      "allOf": [
        {
          "name": "High_CPU_80",
          "criterionType": "StaticThresholdCriterion",
          "dimensions": [],
          "metricName": "Percentage CPU",
          "metricNamespace": "microsoft.compute/virtualmachines",
          "operator": "GreaterThan",
          "threshold": 80.5,
          "timeAggregation": "Average"
        }
      ],
      "odata.type": "Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria"
    },
    "enabled": true,
    "evaluationFrequency": "PT1M",
    "scopes": [
      "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest1",
      "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest2"
    ],
    "severity": 3,
    "targetResourceRegion": "southcentralus",
    "targetResourceType": "Microsoft.Compute/virtualMachines",
    "windowSize": "PT15M"
  },
  "tags": {
    "hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": "Resource"
  }
}

Get an alert rule on subscription

Solicitação de exemplo

GET https://management.azure.com/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Insights/metricAlerts/MetricAlertAtSubscriptionLevel?api-version=2024-03-01-preview

Resposta de exemplo

Código de status:
200 
{
  "type": "Microsoft.Insights/metricAlerts",
  "id": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/MetricAlertAtSubscriptionLevel",
  "location": "global",
  "properties": {
    "description": "This is the description of the rule1",
    "actions": [
      {
        "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
        "webHookProperties": {
          "key11": "value11",
          "key12": "value12"
        }
      }
    ],
    "autoMitigate": false,
    "criteria": {
      "allOf": [
        {
          "name": "High_CPU_80",
          "criterionType": "StaticThresholdCriterion",
          "dimensions": [],
          "metricName": "Percentage CPU",
          "metricNamespace": "microsoft.compute/virtualmachines",
          "operator": "GreaterThan",
          "threshold": 80.5,
          "timeAggregation": "Average"
        }
      ],
      "odata.type": "Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria"
    },
    "enabled": true,
    "evaluationFrequency": "PT1M",
    "scopes": [
      "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7"
    ],
    "severity": 3,
    "targetResourceRegion": "southcentralus",
    "targetResourceType": "Microsoft.Compute/virtualMachines",
    "windowSize": "PT15M"
  },
  "tags": {
    "hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": "Resource"
  }
}

Definições

Nome Description
AggregationTypeEnum

Os tipos de agregação de tempo de critérios. Valores não documentados anteriormente podem ser retornados
createdByType

O tipo de identidade que criou o recurso.
DynamicMetricCriteria

Critério para limiar dinâmico.
DynamicPromQLCriteria

O critério para a consulta dinâmica do baile.
DynamicThresholdFailingPeriods

O número mínimo de violações necessárias na janela de tempo de pesquisa selecionada necessária para gerar um alerta.
DynamicThresholdOperator

O operador usado para comparar o valor da métrica com o limite. Valores não documentados anteriormente podem ser retornados
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. Valores não documentados anteriormente podem ser retornados
IdentityType

Tipo de identidade de serviço gerenciado.
MetricAlertAction

Uma ação de alerta.
MetricAlertErrorResponse

Descreve o formato da resposta de erro.
MetricAlertMultipleResourceMultipleMetricCriteria

Especifica os critérios de alerta de métrica para múltiplos recursos que possuem múltiplos critérios de métrica.
MetricAlertResource

O recurso de alerta métrico.
MetricAlertSingleResourceMultipleMetricCriteria

Especifica os critérios de alerta de métrica para um único recurso que possui múltiplos critérios de métrica.
MetricCriteria

Critério para filtrar métricas.
MetricDimension

Especifica uma dimensão métrica.
Microsoft.Common.ErrorDetail

Descreve detalhes de uma resposta de erro.
Microsoft.Common.ErrorDetailAdditionalInfoItem
Microsoft.Common.ErrorResponseError
Microsoft.Common.ErrorResponseErrorAdditionalInfoItem
Microsoft.Common.Identity

Identidade do recurso.
Microsoft.Common.UserIdentityProperties

Propriedades da identidade atribuída pelo usuário.
Odatatype

Especifica o tipo dos critérios de alerta. Valores não documentados anteriormente podem ser retornados
Operator

O operador de critérios. Valores não documentados anteriormente podem ser retornados
PromQLCriteria

Especifica os critérios PromQL para o recurso de alerta métrico.
QueryFailingPeriods

Configuração para períodos de falha em alertas baseados em consulta.
ResolveConfiguration
StaticPromQLCriteria

O critério para consulta estática do baile.
systemData

Metadados relativos à criação e última modificação do recurso.
WebtestLocationAvailabilityCriteria

Especifica os critérios da regra de alerta métrico para um recurso de teste web.

AggregationTypeEnum

Enumeração

Os tipos de agregação de tempo de critérios. Valores não documentados anteriormente podem ser retornados

Valor Description
Average

Média
Count

Count
Minimum

Mínimo
Maximum

Máximo
Total

Total

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor Description
User
Application
ManagedIdentity
Key

DynamicMetricCriteria

Objeto

Critério para limiar dinâmico.

Nome Tipo Description
alertSensitivity

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. Valores não documentados anteriormente podem ser retornados
criterionType string:

DynamicThresholdCriterion

Especifica o tipo de critério de limite. Valores não documentados anteriormente podem ser retornados
dimensions

MetricDimension[]

Lista de condições de dimensão.
failingPeriods

DynamicThresholdFailingPeriods

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 (date-time)

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

DynamicThresholdOperator

O operador usado para comparar o valor da métrica com o limite. Valores não documentados anteriormente podem ser retornados
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

AggregationTypeEnum

Os tipos de agregação de tempo de critérios. Valores não documentados anteriormente podem ser retornados

DynamicPromQLCriteria

Objeto

O critério para a consulta dinâmica do baile.

Nome Tipo Description
alertSensitivity

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. Valores não documentados anteriormente podem ser retornados
criterionType string:

DynamicThresholdCriterion

Especifica o tipo de critério de limite. Valores não documentados anteriormente podem ser retornados
ignoreDataBefore

string (date-time)

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)
name

string

Nome dos critérios.
operator

DynamicThresholdOperator

O operador usado para comparar o valor da métrica com o limite. Valores não documentados anteriormente podem ser retornados
query

string

A consulta usada para avaliar a regra de alerta

DynamicThresholdFailingPeriods

Objeto

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 (float)

O número de violações para disparar um alerta. Deve ser menor ou igual a numberOfEvaluationPeriods.
numberOfEvaluationPeriods

number (float)

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

Enumeração

O operador usado para comparar o valor da métrica com o limite. Valores não documentados anteriormente podem ser retornados

Valor Description
GreaterThan

GreaterThan
LessThan

LessThan
GreaterOrLessThan

MaiorOuMenosQue

DynamicThresholdSensitivity

Enumeração

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. Valores não documentados anteriormente podem ser retornados

Valor Description
Low

Low
Medium

Medium
High

Alto

IdentityType

Enumeração

Tipo de identidade de serviço gerenciado.

Valor Description
SystemAssigned

AtribuídoPeloSistema
UserAssigned

UserAssigned
None

None

MetricAlertAction

Objeto

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.

MetricAlertErrorResponse

Objeto

Descreve o formato da resposta de erro.

Nome Tipo Description
error

Microsoft.Common.ErrorResponseError

MetricAlertMultipleResourceMultipleMetricCriteria

Objeto

Especifica os critérios de alerta de métrica para múltiplos recursos que possuem múltiplos critérios de métrica.

Nome Tipo Description
allOf MultiMetricCriteria[]:

A lista de vários critérios de métrica para essa operação "toda".
odata.type string:

Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria

Especifica o tipo dos critérios de alerta. Valores não documentados anteriormente podem ser retornados

MetricAlertResource

Objeto

O recurso de alerta métrico.

Nome Tipo Description
id

string

ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity

Microsoft.Common.Identity

A identidade do recurso.
location

string

A localização geográfica onde o recurso reside
name

string

O nome do recurso
properties.actionProperties

object

As propriedades de uma ação.
properties.actions

MetricAlertAction[]

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 dos critérios de alerta.
properties.customProperties

object

As propriedades de um conteúdo de alerta.
properties.description

string

A descrição do alerta de métrica que será incluído no e-mail de alerta.
properties.enabled

boolean

O sinalizador que indica se o alerta de métrica está habilitado.
properties.evaluationFrequency

string (duration)

A frequência com que o alerta de métrica é avaliado é representada no formato de duração ISO 8601.
properties.isMigrated

boolean

O valor indica se essa regra de alerta foi migrada.
properties.lastUpdatedTime

string (date-time)

Da última vez, a regra foi atualizada em formato ISO8601.
properties.resolveConfiguration

ResolveConfiguration

A configuração de como o alerta é resolvido. Aplicável para PromQLCriteria.
properties.scopes

string[]

A lista de IDs de recurso para as quais esse alerta de métrica tem como escopo. Não é possível alterar o escopo de uma regra de métrica com base em logs.
properties.severity

integer (int32)

Gravidade do alerta {0, 1, 2, 3, 4}
properties.targetResourceRegion

string

A região do(s) recurso(s) 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 do(s) recurso(s) de destino no(s) qual(is) o alerta é criado/atualizado. Obrigatório se o escopo contiver uma assinatura, um grupo de recursos ou mais de um recurso.
properties.windowSize

string (duration)

O período de tempo (no formato de duração ISO 8601) usado para monitorar a atividade de alerta com base no limite.
systemData

systemData

Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
tags

object

Tags de recursos.
type

string

O tipo do recurso. Por exemplo, "Microsoft. Compute/virtualMachines" ou "Microsoft. ContasArmazenamento/Armazenamento"

MetricAlertSingleResourceMultipleMetricCriteria

Objeto

Especifica os critérios de alerta de métrica para um único recurso que possui múltiplos critérios de métrica.

Nome Tipo Description
allOf

MetricCriteria[]

A lista de critérios de métrica para esta operação "tudo".
odata.type string:

Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria

Especifica o tipo dos critérios de alerta. Valores não documentados anteriormente podem ser retornados

MetricCriteria

Objeto

Critério para filtrar métricas.

Nome Tipo Description
criterionType string:

StaticThresholdCriterion

Especifica o tipo de critério de limite. Valores não documentados anteriormente podem ser retornados
dimensions

MetricDimension[]

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

Operator

O operador de critérios. Valores não documentados anteriormente podem ser retornados
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 (double)

O valor limite de critérios que ativa o alerta.
timeAggregation

AggregationTypeEnum

Os tipos de agregação de tempo de critérios. Valores não documentados anteriormente podem ser retornados

MetricDimension

Objeto

Especifica uma dimensão 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.

Microsoft.Common.ErrorDetail

Objeto

Descreve detalhes de uma resposta de erro.

Nome Tipo Description
additionalInfo

Microsoft.Common.ErrorDetailAdditionalInfoItem[]

Um array de objetos com propriedades 'tipo' e 'informação'. O esquema de 'info' é específico de cada serviço e depende da string 'type'.
code

string

Cadeia não localizada que pode ser usada para identificar programaticamente o erro.
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 com erro).

Microsoft.Common.ErrorDetailAdditionalInfoItem

Objeto
Nome Tipo Description
info

As informações adicionais específicas para o tipo.
type

string

O tipo de informação adicional.

Microsoft.Common.ErrorResponseError

Objeto
Nome Tipo Description
additionalInfo

Microsoft.Common.ErrorResponseErrorAdditionalInfoItem[]

Um array de objetos com propriedades 'tipo' e 'informação'. O esquema de 'info' é específico de cada serviço e depende da string 'type'.
code

string

Cadeia não localizada que pode ser usada para identificar programaticamente o erro.
details

Microsoft.Common.ErrorDetail[]

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 requisição, ele deve ser localizado para aquele idioma.
target

string

O destino do erro específico (por exemplo, o nome da propriedade com erro).

Microsoft.Common.ErrorResponseErrorAdditionalInfoItem

Objeto
Nome Tipo Description
info

As informações adicionais específicas para o tipo.
type

string

O tipo de informação adicional.

Microsoft.Common.Identity

Objeto

Identidade do recurso.

Nome Tipo Description
principalId

string

A ID principal da identidade do recurso.
tenantId

string

A ID do locatário do recurso.
type

IdentityType

Tipo de identidade de serviço gerenciado.
userAssignedIdentities

<string,  Microsoft.Common.UserIdentityProperties>

A lista de identidades de usuário associadas ao recurso. As referências-chave do dicionário de identidade do usuário serão IDs de recursos ARM na forma: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft. GerenciadoIdentidade/usuárioIdIdêsAssignadas/{NomeIdIdê}'.

Microsoft.Common.UserIdentityProperties

Objeto

Propriedades da identidade atribuída pelo usuário.

Nome Tipo Description
clientId

string

O ID do cliente da identidade do recurso.
principalId

string

A ID principal da identidade do recurso.

Odatatype

Enumeração

Especifica o tipo dos critérios de alerta. Valores não documentados anteriormente podem ser retornados

Valor Description
Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria

Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria
Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria

Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria
Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria

Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria
Microsoft.Azure.Monitor.PromQLCriteria

Microsoft.Azure.Monitor.PromQLCriteria

Operator

Enumeração

O operador de critérios. Valores não documentados anteriormente podem ser retornados

Valor Description
Equals

Igual
GreaterThan

GreaterThan
GreaterThanOrEqual

GreaterThanOrEqual
LessThan

LessThan
LessThanOrEqual

LessThanOrEqual

PromQLCriteria

Objeto

Especifica os critérios PromQL para o recurso de alerta métrico.

Nome Tipo Description
allOf MultiPromQLCriteria[]:

A lista de critérios do promQL. O alerta será gerado quando todas as condições forem atendidas.
failingPeriods

QueryFailingPeriods

Configuração para períodos de falha em alertas baseados em consulta.
odata.type string:

Microsoft.Azure.Monitor.PromQLCriteria

Especifica o tipo dos critérios de alerta. Valores não documentados anteriormente podem ser retornados

QueryFailingPeriods

Objeto

Configuração para períodos de falha em alertas baseados em consulta.

Nome Tipo Description
for

string (duration)

O alerta de quantidade de tempo (no formato de duração ISO 8601) deve estar ativo antes do disparo.

ResolveConfiguration

Objeto
Nome Tipo Description
autoResolved

boolean

Indica se o alerta deve ser resolvido automaticamente
timeToResolve

string (duration)

O tempo (no formato de duração ISO 8601) após o qual o alerta deve ser resolvido automaticamente

StaticPromQLCriteria

Objeto

O critério para consulta estática do baile.

Nome Tipo Description
criterionType string:

StaticThresholdCriterion

Especifica o tipo de critério de limite. Valores não documentados anteriormente podem ser retornados
name

string

Nome dos critérios.
query

string

A consulta usada para avaliar a regra de alerta

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome Tipo Description
createdAt

string (date-time)

O carimbo de data/hora da criação de recursos (UTC).
createdBy

string

A identidade que criou o recurso.
createdByType

createdByType

O tipo de identidade que criou o recurso.
lastModifiedAt

string (date-time)

O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy

string

A identidade que modificou o recurso pela última vez.
lastModifiedByType

createdByType

O tipo de identidade que modificou o recurso pela última vez.

WebtestLocationAvailabilityCriteria

Objeto

Especifica os critérios da regra de alerta métrico para um recurso de teste web.

Nome Tipo Description
componentId

string

A ID do recurso do Application Insights.
failedLocationCount

number (float)

O número de locais com falha.
odata.type string:

Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria

Especifica o tipo dos critérios de alerta. Valores não documentados anteriormente podem ser retornados
webTestId

string

A ID de teste da Web do Application Insights.