Alert Rules - Get

Obtém uma regra de alerta de métrica clássica

GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/alertrules/{ruleName}?api-version=2016-03-01

Parâmetros de URI

Name In Required Type Description
resourceGroupName
path True
  • string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

ruleName
path True
  • string

O nome da regra.

subscriptionId
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

Name Type Description
200 OK

Solicitação bem-sucedida para obter uma regra de alerta

Other Status Codes

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation representar sua conta de usuário

Exemplos

Get an alert rule

Sample Request

GET https://management.azure.com/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourcegroups/Rac46PostSwapRG/providers/Microsoft.Insights/alertrules/chiricutin?api-version=2016-03-01

Sample Response

{
  "id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/alertrules/chiricutin",
  "name": "chiricutin",
  "type": "Microsoft.Insights/alertRules",
  "location": "West US",
  "tags": {
    "$type": "Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary, Microsoft.WindowsAzure.Management.Common.Storage",
    "hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": "Resource"
  },
  "properties": {
    "name": "chiricutin",
    "description": "Pura Vida",
    "isEnabled": true,
    "condition": {
      "odata.type": "Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition",
      "dataSource": {
        "odata.type": "Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource",
        "resourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest",
        "metricName": "Requests"
      },
      "operator": "GreaterThan",
      "threshold": 3,
      "windowSize": "PT5M",
      "timeAggregation": "Total"
    },
    "lastUpdatedTime": "2016-11-23T21:23:52.0221265Z",
    "actions": []
  }
}

Definições

AlertRuleResource

O recurso de regra de alerta.

ConditionOperator

Operadores permitidos na condição de regra.

ErrorResponse

Descreve o formato da resposta de erro.

LocationThresholdRuleCondition

Uma condição de regra com base em um determinado número de locais falhando.

ManagementEventAggregationCondition

Como os dados coletados devem ser combinados ao longo do tempo.

ManagementEventRuleCondition

Uma condição de regra de evento de gerenciamento.

RuleEmailAction

Especifica a ação para enviar email quando a condição de regra é avaliada. O discriminador é sempre RuleEmailAction neste caso.

RuleManagementEventClaimsDataSource

As declarações de uma fonte de dados de evento de gerenciamento de regras.

RuleManagementEventDataSource

Uma fonte de dados de evento de gerenciamento de regras. Os campos discriminatórios são sempre RuleManagementEventDataSource neste caso.

RuleMetricDataSource

Uma fonte de dados de métrica de regra. O valor discriminatório é sempre RuleMetricDataSource neste caso.

RuleWebhookAction

Especifica a ação a ser postada no serviço quando a condição de regra é avaliada. O discriminador é sempre RuleWebhookAction neste caso.

ThresholdRuleCondition

Uma condição de regra com base em uma métrica que cruza um limite.

TimeAggregationOperator

Operadores de agregação permitidos em uma regra.

AlertRuleResource

O recurso de regra de alerta.

Name Type Description
id
  • string

ID do recurso do Azure

location
  • string

Localização do recurso

name
  • string

Nome do recurso do Azure

properties.action RuleAction:

ação que é executada quando a regra de alerta se torna ativa e quando uma condição de alerta é resolvida.

properties.actions RuleAction[]:

a matriz de ações executadas quando a regra de alerta se torna ativa e quando uma condição de alerta é resolvida.

properties.condition RuleCondition:

a condição que resulta na ativação da regra de alerta.

properties.description
  • string

a descrição da regra de alerta que será incluída no email de alerta.

properties.isEnabled
  • boolean

o sinalizador que indica se a regra de alerta está habilitada.

properties.lastUpdatedTime
  • string

Última vez em que a regra foi atualizada no formato ISO8601.

properties.name
  • string

o nome da regra de alerta.

properties.provisioningState
  • string

o estado de provisionamento.

tags
  • object

Marcações de recursos

type
  • string

Tipo de recurso do Azure

ConditionOperator

Operadores permitidos na condição de regra.

Name Type Description
GreaterThan
  • string
GreaterThanOrEqual
  • string
LessThan
  • string
LessThanOrEqual
  • string

ErrorResponse

Descreve o formato da resposta de erro.

Name Type Description
code
  • string

Código do erro

message
  • string

Mensagem de erro indicando por que a operação falhou.

LocationThresholdRuleCondition

Uma condição de regra com base em um determinado número de locais falhando.

Name Type Description
dataSource RuleDataSource:

o recurso do qual a regra coleta seus dados. Para esse tipo, dataSource sempre será do tipo RuleMetricDataSource.

failedLocationCount
  • integer

o número de locais que devem falhar ao ativar o alerta.

odata.type string:
  • Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition

especifica o tipo de condição. Esse pode ser um dos três tipos: ManagementEventRuleCondition (ocorrências de eventos de gerenciamento), LocationThresholdRuleCondition (com base no número de falhas de um teste web) e ThresholdRuleCondition (com base no limite de uma métrica).

windowSize
  • string

o período de tempo (no formato de duração ISO 8601) que é usado para monitorar a atividade de alerta com base no limite. Se especificado, deve ser entre 5 minutos e 1 dia.

ManagementEventAggregationCondition

Como os dados coletados devem ser combinados ao longo do tempo.

Name Type Description
operator

o operador de condição.

threshold
  • number

O valor de limite que ativa o alerta.

windowSize
  • string

o período de tempo (no formato de duração ISO 8601) que é usado para monitorar a atividade de alerta com base no limite. Se especificado, deve ser entre 5 minutos e 1 dia.

ManagementEventRuleCondition

Uma condição de regra de evento de gerenciamento.

Name Type Description
aggregation

Como os dados coletados devem ser combinados ao longo do tempo e quando o alerta é ativado. Observe que a agregação é opcional para alertas de eventos de gerenciamento; se nenhuma agregação for fornecida, o evento fará com que o alerta seja ativado.

dataSource RuleDataSource:

o recurso do qual a regra coleta seus dados. Para esse tipo, dataSource sempre será do tipo RuleMetricDataSource.

odata.type string:
  • Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition

especifica o tipo de condição. Esse pode ser um dos três tipos: ManagementEventRuleCondition (ocorrências de eventos de gerenciamento), LocationThresholdRuleCondition (com base no número de falhas de um teste web) e ThresholdRuleCondition (com base no limite de uma métrica).

RuleEmailAction

Especifica a ação para enviar email quando a condição de regra é avaliada. O discriminador é sempre RuleEmailAction neste caso.

Name Type Description
customEmails
  • string[]

a lista de endereços de email personalizados do administrador para notificar a ativação do alerta.

odata.type string:
  • Microsoft.Azure.Management.Insights.Models.RuleEmailAction

especifica o tipo da ação. Há dois tipos de ações: RuleEmailAction e RuleWebhookAction.

sendToServiceOwners
  • boolean

Se os administradores (serviço e co-administradores) do serviço devem ser notificados quando o alerta for ativado.

RuleManagementEventClaimsDataSource

As declarações de uma fonte de dados de evento de gerenciamento de regras.

Name Type Description
emailAddress
  • string

o endereço de email.

RuleManagementEventDataSource

Uma fonte de dados de evento de gerenciamento de regras. Os campos discriminatórios são sempre RuleManagementEventDataSource neste caso.

Name Type Description
claims

as declarações.

eventName
  • string

o nome do evento.

eventSource
  • string

a origem do evento.

legacyResourceId
  • string

o identificador de recurso herdado do recurso que a regra monitora. OBSERVAÇÃO: essa propriedade não pode ser atualizada para uma regra existente.

level
  • string

o nível.

metricNamespace
  • string

o namespace da métrica.

odata.type string:
  • Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource

especifica o tipo de fonte de dados. Há dois tipos de fontes de dados de regra: RuleMetricDataSource e RuleManagementEventDataSource

operationName
  • string

O nome da operação que deve ser verificada. Se nenhum nome for fornecido, qualquer operação será compatível.

resourceGroupName
  • string

o nome do grupo de recursos.

resourceLocation
  • string

o local do recurso.

resourceProviderName
  • string

o nome do provedor de recursos.

resourceUri
  • string

o identificador de recurso do recurso que a regra monitora. OBSERVAÇÃO: essa propriedade não pode ser atualizada para uma regra existente.

status
  • string

O status da operação que deve ser verificada. Se nenhum status for fornecido, qualquer status será compatível.

subStatus
  • string

o substatus.

RuleMetricDataSource

Uma fonte de dados de métrica de regra. O valor discriminatório é sempre RuleMetricDataSource neste caso.

Name Type Description
legacyResourceId
  • string

o identificador de recurso herdado do recurso que a regra monitora. OBSERVAÇÃO: essa propriedade não pode ser atualizada para uma regra existente.

metricName
  • string

o nome da métrica que define o que a regra monitora.

metricNamespace
  • string

o namespace da métrica.

odata.type string:
  • Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource

especifica o tipo de fonte de dados. Há dois tipos de fontes de dados de regra: RuleMetricDataSource e RuleManagementEventDataSource

resourceLocation
  • string

o local do recurso.

resourceUri
  • string

o identificador de recurso do recurso que a regra monitora. OBSERVAÇÃO: essa propriedade não pode ser atualizada para uma regra existente.

RuleWebhookAction

Especifica a ação a ser postada no serviço quando a condição de regra é avaliada. O discriminador é sempre RuleWebhookAction neste caso.

Name Type Description
odata.type string:
  • Microsoft.Azure.Management.Insights.Models.RuleWebhookAction

especifica o tipo da ação. Há dois tipos de ações: RuleEmailAction e RuleWebhookAction.

properties
  • object

o dicionário de propriedades personalizadas a serem incluídas com a operação pós-operação. Esses dados são acrescentados ao conteúdo do webhook.

serviceUri
  • string

o uri de serviço para Postar a notificação quando o alerta é ativado ou resolvido.

ThresholdRuleCondition

Uma condição de regra com base em uma métrica que cruza um limite.

Name Type Description
dataSource RuleDataSource:

o recurso do qual a regra coleta seus dados. Para esse tipo, dataSource sempre será do tipo RuleMetricDataSource.

odata.type string:
  • Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition

especifica o tipo de condição. Esse pode ser um dos três tipos: ManagementEventRuleCondition (ocorrências de eventos de gerenciamento), LocationThresholdRuleCondition (com base no número de falhas de um teste web) e ThresholdRuleCondition (com base no limite de uma métrica).

operator

o operador usado para comparar os dados e o limite.

threshold
  • number

o valor limite que ativa o alerta.

timeAggregation

o operador de agregação de tempo. Como os dados coletados devem ser combinados ao longo do tempo. O valor padrão é PrimaryAggregationType da Métrica.

windowSize
  • string

o período de tempo (no formato de duração ISO 8601) que é usado para monitorar a atividade de alerta com base no limite. Se especificado, deve ser entre 5 minutos e 1 dia.

TimeAggregationOperator

Operadores de agregação permitidos em uma regra.

Name Type Description
Average
  • string
Last
  • string
Maximum
  • string
Minimum
  • string
Total
  • string