Alert Rules - Create Or Update

Tworzy lub aktualizuje regułę klasycznego alertu dotyczącego metryki.

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

Parametry identyfikatora URI

Name In Required Type Description
resourceGroupName
path True
  • string

Nazwa grupy zasobów.

ruleName
path True
  • string

Nazwa reguły.

subscriptionId
path True
  • string

Identyfikator subskrypcji docelowej.

api-version
query True
  • string

Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Name Required Type Description
location True
  • string

Lokalizacja zasobu

properties.condition True RuleCondition:

warunek, który powoduje aktywowanie reguły alertu.

properties.isEnabled True
  • boolean

Flaga wskazująca, czy reguła alertu jest włączona.

properties.name True
  • string

Nazwa reguły alertu.

properties.action RuleAction:

Akcja wykonywana, gdy reguła alertu stanie się aktywna i gdy warunek alertu zostanie rozwiązany.

properties.actions RuleAction[]:

Tablica akcji, które są wykonywane, gdy reguła alertu stanie się aktywna i gdy zostanie rozpoznany warunek alertu.

properties.description
  • string

Opis reguły alertu, który zostanie uwzględniony w wiadomości e-mail dotyczącej alertu.

properties.provisioningState
  • string

stan aprowizacji.

tags
  • object

Tagi zasobów

Odpowiedzi

Name Type Description
200 OK

Pomyślne żądanie zaktualizowania reguły alertu

201 Created

Utworzona reguła alertu

Other Status Codes

Odpowiedź na błąd z opisem przyczyny niepowodzenia operacji.

Zabezpieczenia

azure_auth

Azure Active Directory przepływ OAuth2

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

Scopes

Name Description
user_impersonation Personifikuj konto użytkownika

Przykłady

Create or update an alert rule

Sample Request

PUT https://management.azure.com/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourcegroups/Rac46PostSwapRG/providers/Microsoft.Insights/alertrules/chiricutin?api-version=2016-03-01
{
  "location": "West US",
  "tags": {},
  "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"
    },
    "actions": []
  }
}

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": []
  }
}
{
  "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": []
  }
}

Definicje

AlertRuleResource

Zasób reguły alertu.

ConditionOperator

Operatory dozwolone w warunku reguły.

ErrorResponse

Opisuje format odpowiedzi na błąd.

LocationThresholdRuleCondition

Warunek reguły oparty na określonej liczbie lokalizacji zakończonych niepowodzeniem.

ManagementEventAggregationCondition

Sposób, w jaki zbierane dane powinny być połączone z upływem czasu.

ManagementEventRuleCondition

Warunek reguły zdarzenia zarządzania.

RuleEmailAction

Określa akcję do wysłania wiadomości e-mail w przypadku szacowania warunku reguły. Rozróżniacz jest zawsze RuleEmailAction w tym przypadku.

RuleManagementEventClaimsDataSource

Oświadczenia dla źródła danych zdarzeń zarządzania regułą.

RuleManagementEventDataSource

Źródło danych zdarzeń zarządzania regułą. Pola rozróżniacza są zawsze RuleManagementEventDataSource w tym przypadku.

RuleMetricDataSource

Źródło danych metryki reguły. Wartość rozróżniacza jest zawsze RuleMetricDataSource w tym przypadku.

RuleWebhookAction

Określa akcję, która ma zostać opublikowana w usłudze w przypadku szacowania warunku reguły. Rozróżniacz jest zawsze RuleWebhookAction w tym przypadku.

ThresholdRuleCondition

Warunek reguły na podstawie metryki przekraczającej próg.

TimeAggregationOperator

Operatory agregacji dozwolone w regule.

AlertRuleResource

Zasób reguły alertu.

Name Type Description
id
  • string

Identyfikator zasobu platformy Azure

location
  • string

Lokalizacja zasobu

name
  • string

Nazwa zasobu platformy Azure

properties.action RuleAction:

Akcja wykonywana, gdy reguła alertu stanie się aktywna i gdy warunek alertu zostanie rozwiązany.

properties.actions RuleAction[]:

Tablica akcji, które są wykonywane, gdy reguła alertu stanie się aktywna i gdy zostanie rozpoznany warunek alertu.

properties.condition RuleCondition:

warunek, który powoduje aktywowanie reguły alertu.

properties.description
  • string

Opis reguły alertu, który zostanie uwzględniony w wiadomości e-mail dotyczącej alertu.

properties.isEnabled
  • boolean

Flaga wskazująca, czy reguła alertu jest włączona.

properties.lastUpdatedTime
  • string

Godzina ostatniej aktualizacji reguły w formacie ISO8601.

properties.name
  • string

Nazwa reguły alertu.

properties.provisioningState
  • string

stan aprowizacji.

tags
  • object

Tagi zasobów

type
  • string

Typ zasobu platformy Azure

ConditionOperator

Operatory dozwolone w warunku reguły.

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

ErrorResponse

Opisuje format odpowiedzi na błąd.

Name Type Description
code
  • string

Kod błędu

message
  • string

Komunikat o błędzie informujący o tym, dlaczego operacja nie powiodła się.

LocationThresholdRuleCondition

Warunek reguły oparty na określonej liczbie lokalizacji zakończonych niepowodzeniem.

Name Type Description
dataSource RuleDataSource:

zasób, z którego dana reguła zbiera dane. Dla tego typu źródła danych będzie zawsze typu RuleMetricDataSource.

failedLocationCount
  • integer

Liczba lokalizacji, które nie mogą aktywować alertu.

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

Określa typ warunku. Może to być jeden z trzech typów: ManagementEventRuleCondition (wystąpienia zdarzeń zarządzania), LocationThresholdRuleCondition (na podstawie liczby błędów testu sieci Web) i ThresholdRuleCondition (na podstawie progu metryki).

windowSize
  • string

okres (w formacie ISO 8601), który służy do monitorowania aktywności alertu na podstawie progu. Jeśli zostanie określony, musi ona należeć do przedziału od 5 minut do 1 dnia.

ManagementEventAggregationCondition

Sposób, w jaki zbierane dane powinny być połączone z upływem czasu.

Name Type Description
operator

operator warunku.

threshold
  • number

Wartość progowa, która aktywuje alert.

windowSize
  • string

okres (w formacie ISO 8601), który służy do monitorowania aktywności alertu na podstawie progu. Jeśli zostanie określony, musi ona należeć do przedziału od 5 minut do 1 dnia.

ManagementEventRuleCondition

Warunek reguły zdarzenia zarządzania.

Name Type Description
aggregation

Sposób, w jaki zbierane dane powinny być połączone wraz z upływem czasu i po aktywowaniu alertu. Należy pamiętać, że w przypadku agregacji alertów dotyczących zdarzeń zarządzania jest opcjonalne — Jeśli nie zostanie ona podana, każde zdarzenie spowoduje aktywację alertu.

dataSource RuleDataSource:

zasób, z którego dana reguła zbiera dane. Dla tego typu źródła danych będzie zawsze typu RuleMetricDataSource.

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

Określa typ warunku. Może to być jeden z trzech typów: ManagementEventRuleCondition (wystąpienia zdarzeń zarządzania), LocationThresholdRuleCondition (na podstawie liczby błędów testu sieci Web) i ThresholdRuleCondition (na podstawie progu metryki).

RuleEmailAction

Określa akcję do wysłania wiadomości e-mail w przypadku szacowania warunku reguły. Rozróżniacz jest zawsze RuleEmailAction w tym przypadku.

Name Type Description
customEmails
  • string[]

Lista niestandardowych adresów e-mail administratorów do powiadomienia o aktywacji alertu.

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

Określa typ akcji. Istnieją dwa typy akcji: RuleEmailAction i RuleWebhookAction.

sendToServiceOwners
  • boolean

Określa, czy Administratorzy (usługa i współadministratorzy) usługi powinni otrzymywać powiadomienia o aktywacji alertu.

RuleManagementEventClaimsDataSource

Oświadczenia dla źródła danych zdarzeń zarządzania regułą.

Name Type Description
emailAddress
  • string

adres e-mail.

RuleManagementEventDataSource

Źródło danych zdarzeń zarządzania regułą. Pola rozróżniacza są zawsze RuleManagementEventDataSource w tym przypadku.

Name Type Description
claims

oświadczenia.

eventName
  • string

Nazwa zdarzenia.

eventSource
  • string

Źródło zdarzenia.

legacyResourceId
  • string

Identyfikator zasobu starszej wersji zasobu monitorowanej przez regułę. Uwaga: tej właściwości nie można zaktualizować dla istniejącej reguły.

level
  • string

poziom.

metricNamespace
  • string

Przestrzeń nazw metryki.

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

Określa typ źródła danych. Istnieją dwa typy źródeł danych reguł: RuleMetricDataSource i RuleManagementEventDataSource

operationName
  • string

Nazwa operacji, która ma zostać sprawdzona. Jeśli nie podano nazwy, każda operacja będzie pasować.

resourceGroupName
  • string

Nazwa grupy zasobów.

resourceLocation
  • string

Lokalizacja zasobu.

resourceProviderName
  • string

Nazwa dostawcy zasobów.

resourceUri
  • string

Identyfikator zasobu monitorowanej przez regułę. Uwaga: tej właściwości nie można zaktualizować dla istniejącej reguły.

status
  • string

Stan operacji, która ma zostać sprawdzona. Jeśli nie podano stanu, wszystkie stany będą zgodne.

subStatus
  • string

podstanu.

RuleMetricDataSource

Źródło danych metryki reguły. Wartość rozróżniacza jest zawsze RuleMetricDataSource w tym przypadku.

Name Type Description
legacyResourceId
  • string

Identyfikator zasobu starszej wersji zasobu monitorowanej przez regułę. Uwaga: tej właściwości nie można zaktualizować dla istniejącej reguły.

metricName
  • string

Nazwa metryki, która definiuje elementy monitorowane przez regułę.

metricNamespace
  • string

Przestrzeń nazw metryki.

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

Określa typ źródła danych. Istnieją dwa typy źródeł danych reguł: RuleMetricDataSource i RuleManagementEventDataSource

resourceLocation
  • string

Lokalizacja zasobu.

resourceUri
  • string

Identyfikator zasobu monitorowanej przez regułę. Uwaga: tej właściwości nie można zaktualizować dla istniejącej reguły.

RuleWebhookAction

Określa akcję, która ma zostać opublikowana w usłudze w przypadku szacowania warunku reguły. Rozróżniacz jest zawsze RuleWebhookAction w tym przypadku.

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

Określa typ akcji. Istnieją dwa typy akcji: RuleEmailAction i RuleWebhookAction.

properties
  • object

słownik właściwości niestandardowych do dołączenia do operacji post. Te dane są dołączane do ładunku elementu webhook.

serviceUri
  • string

Identyfikator URI usługi do opublikowania powiadomienia w przypadku aktywacji lub rozwiązania alertu.

ThresholdRuleCondition

Warunek reguły na podstawie metryki przekraczającej próg.

Name Type Description
dataSource RuleDataSource:

zasób, z którego dana reguła zbiera dane. Dla tego typu źródła danych będzie zawsze typu RuleMetricDataSource.

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

Określa typ warunku. Może to być jeden z trzech typów: ManagementEventRuleCondition (wystąpienia zdarzeń zarządzania), LocationThresholdRuleCondition (na podstawie liczby błędów testu sieci Web) i ThresholdRuleCondition (na podstawie progu metryki).

operator

operator używany do porównywania danych i wartości progowej.

threshold
  • number

wartość progowa, która aktywuje alert.

timeAggregation

operator agregacji czasu. Sposób, w jaki zbierane dane powinny być połączone z upływem czasu. Wartość domyślna to PrimaryAggregationType metryki.

windowSize
  • string

okres (w formacie ISO 8601), który służy do monitorowania aktywności alertu na podstawie progu. Jeśli zostanie określony, musi ona należeć do przedziału od 5 minut do 1 dnia.

TimeAggregationOperator

Operatory agregacji dozwolone w regule.

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