Alert Rules - Create Or Update
Tworzy lub aktualizuje regułę alertu dotyczącego metryk klasycznych.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/alertrules/{ruleName}?api-version=2016-03-01
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
resource
|
path | True |
string |
Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter. |
rule
|
path | True |
string |
Nazwa reguły. |
subscription
|
path | True |
string |
Identyfikator subskrypcji docelowej. |
api-version
|
query | True |
string |
Wersja interfejsu API do użycia dla tej operacji. |
Treść żądania
Nazwa | Wymagane | Typ | Opis |
---|---|---|---|
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 staje się aktywna, a po rozwiązaniu warunku alertu. |
|
properties.description |
string |
opis reguły alertu, która zostanie uwzględniona w wiadomości e-mail z alertem. |
|
properties.provisioningState |
string |
stan aprowizacji. |
|
tags |
object |
Tagi zasobów |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
Pomyślne żądanie zaktualizowania reguły alertu |
|
201 Created |
Utworzono regułę alertu |
|
Other Status Codes |
Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się. |
Zabezpieczenia
azure_auth
Przepływ OAuth2 usługi Azure Active Directory
Typ:
oauth2
Flow:
implicit
Adres URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/authorize
Zakresy
Nazwa | Opis |
---|---|
user_impersonation | personifikacja konta użytkownika |
Przykłady
Create or update an alert rule
Przykładowe żądanie
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": []
}
}
Przykładowa odpowiedź
{
"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
Nazwa | Opis |
---|---|
Alert |
Zasób reguły alertu. |
Condition |
Operatory dozwolone w warunku reguły. |
Error |
Opisuje format odpowiedzi na błąd. |
Location |
Warunek reguły oparty na określonej liczbie lokalizacji kończy się niepowodzeniem. |
Management |
Sposób łączenia zebranych danych w czasie. |
Management |
Warunek reguły zdarzenia zarządzania. |
Rule |
Określa akcję wysyłania wiadomości e-mail po ocenie warunku reguły. Dyskryminujące jest zawsze RuleEmailAction w tym przypadku. |
Rule |
Oświadczenia dotyczące źródła danych zdarzenia zarządzania regułami. |
Rule |
Źródło danych zdarzenia zarządzania regułami. Pola dyskryminujące są zawsze ruleManagementEventDataSource w tym przypadku. |
Rule |
Źródło danych metryki reguły. W tym przypadku wartość dyskryminująca jest zawsze RuleMetricDataSource. |
Rule |
Określa akcję, która ma być publikowana w usłudze po ocenie warunku reguły. Dyskryminujące jest zawsze RuleWebhookAction w tym przypadku. |
Threshold |
Warunek reguły oparty na metryce przekraczającej próg. |
Time |
Operatory agregacji dozwolone w regule. |
AlertRuleResource
Zasób reguły alertu.
Nazwa | Typ | Opis |
---|---|---|
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 zostanie rozwiązany warunek alertu. |
properties.actions | RuleAction[]: |
tablica akcji, które są wykonywane, gdy reguła alertu stanie się aktywna, a gdy warunek alertu zostanie rozwiązany. |
properties.condition | RuleCondition: |
warunek, który powoduje aktywowanie reguły alertu. |
properties.description |
string |
opis reguły alertu, która zostanie uwzględniona w wiadomości e-mail z alertem. |
properties.isEnabled |
boolean |
flaga wskazująca, czy reguła alertu jest włączona. |
properties.lastUpdatedTime |
string |
Ostatni raz reguła została zaktualizowana 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.
Nazwa | Typ | Opis |
---|---|---|
GreaterThan |
string |
|
GreaterThanOrEqual |
string |
|
LessThan |
string |
|
LessThanOrEqual |
string |
ErrorResponse
Opisuje format odpowiedzi na błąd.
Nazwa | Typ | Opis |
---|---|---|
code |
string |
Kod błędu |
message |
string |
Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się. |
LocationThresholdRuleCondition
Warunek reguły oparty na określonej liczbie lokalizacji kończy się niepowodzeniem.
Nazwa | Typ | Opis |
---|---|---|
dataSource | RuleDataSource: |
zasób, z którego reguła zbiera dane. W przypadku tego typu źródło danych zawsze będzie typu RuleMetricDataSource. |
failedLocationCount |
integer |
liczba lokalizacji, które nie mogą aktywować alertu. |
odata.type |
string:
Microsoft. |
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 internetowego) i ThresholdRuleCondition (na podstawie progu metryki). |
windowSize |
string |
okres czasu (w formacie czasu trwania ISO 8601), który służy do monitorowania aktywności alertów na podstawie progu. Jeśli zostanie określony, musi to być od 5 minut do 1 dnia. |
ManagementEventAggregationCondition
Sposób łączenia zebranych danych w czasie.
Nazwa | Typ | Opis |
---|---|---|
operator |
operator warunku. |
|
threshold |
number |
Wartość progowa, która aktywuje alert. |
windowSize |
string |
okres czasu (w formacie czasu trwania ISO 8601), który służy do monitorowania aktywności alertów na podstawie progu. Jeśli zostanie określony, musi to być od 5 minut do 1 dnia. |
ManagementEventRuleCondition
Warunek reguły zdarzenia zarządzania.
Nazwa | Typ | Opis |
---|---|---|
aggregation |
Sposób, w jaki dane są zbierane, powinny być łączone wraz z upływem czasu i po aktywowaniu alertu. Należy pamiętać, że agregacja alertów zdarzeń zarządzania jest opcjonalna — jeśli nie zostanie podana, jakiekolwiek zdarzenie spowoduje aktywowanie alertu. |
|
dataSource | RuleDataSource: |
zasób, z którego reguła zbiera dane. W przypadku tego typu źródło danych zawsze będzie typu RuleMetricDataSource. |
odata.type |
string:
Microsoft. |
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 internetowego) i ThresholdRuleCondition (na podstawie progu metryki). |
RuleEmailAction
Określa akcję wysyłania wiadomości e-mail po ocenie warunku reguły. Dyskryminujące jest zawsze RuleEmailAction w tym przypadku.
Nazwa | Typ | Opis |
---|---|---|
customEmails |
string[] |
lista niestandardowych adresów e-mail administratora w celu powiadomienia o aktywacji alertu. |
odata.type |
string:
Microsoft. |
określa typ akcji. Istnieją dwa typy akcji: RuleEmailAction i RuleWebhookAction. |
sendToServiceOwners |
boolean |
Czy administratorzy (usługa i współadministratorzy) usługi powinni otrzymywać powiadomienia po aktywowaniu alertu. |
RuleManagementEventClaimsDataSource
Oświadczenia dotyczące źródła danych zdarzenia zarządzania regułami.
Nazwa | Typ | Opis |
---|---|---|
emailAddress |
string |
adres e-mail. |
RuleManagementEventDataSource
Źródło danych zdarzenia zarządzania regułami. Pola dyskryminujące są zawsze ruleManagementEventDataSource w tym przypadku.
Nazwa | Typ | Opis |
---|---|---|
claims |
oświadczenia. |
|
eventName |
string |
nazwa zdarzenia. |
eventSource |
string |
źródło zdarzenia. |
legacyResourceId |
string |
starszy identyfikator zasobu zasobu, który monitoruje reguła. UWAGA: nie można zaktualizować tej właściwości dla istniejącej reguły. |
level |
string |
poziom. |
metricNamespace |
string |
przestrzeń nazw metryki. |
odata.type |
string:
Microsoft. |
określa typ źródła danych. Istnieją dwa typy źródeł danych reguł: RuleMetricDataSource i RuleManagementEventDataSource |
operationName |
string |
Nazwa operacji, która powinna zostać sprawdzona. Jeśli żadna nazwa nie zostanie podana, każda operacja będzie zgodna. |
resourceGroupName |
string |
nazwa grupy zasobów. |
resourceLocation |
string |
lokalizacja zasobu. |
resourceProviderName |
string |
nazwa dostawcy zasobów. |
resourceUri |
string |
identyfikator zasobu, który monitoruje reguła. UWAGA: nie można zaktualizować tej właściwości dla istniejącej reguły. |
status |
string |
Stan operacji, którą należy sprawdzić. Jeśli nie zostanie podany żaden stan, stan będzie zgodny. |
subStatus |
string |
podstatu. |
RuleMetricDataSource
Źródło danych metryki reguły. W tym przypadku wartość dyskryminująca jest zawsze RuleMetricDataSource.
Nazwa | Typ | Opis |
---|---|---|
legacyResourceId |
string |
starszy identyfikator zasobu zasobu, który monitoruje reguła. UWAGA: nie można zaktualizować tej właściwości dla istniejącej reguły. |
metricName |
string |
nazwa metryki, która definiuje, co monitoruje reguła. |
metricNamespace |
string |
przestrzeń nazw metryki. |
odata.type |
string:
Microsoft. |
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, który monitoruje reguła. UWAGA: nie można zaktualizować tej właściwości dla istniejącej reguły. |
RuleWebhookAction
Określa akcję, która ma być publikowana w usłudze po ocenie warunku reguły. Dyskryminujące jest zawsze RuleWebhookAction w tym przypadku.
Nazwa | Typ | Opis |
---|---|---|
odata.type |
string:
Microsoft. |
określa typ akcji. Istnieją dwa typy akcji: RuleEmailAction i RuleWebhookAction. |
properties |
object |
słownik właściwości niestandardowych do uwzględnienia w operacji po operacji. Te dane są dołączane do ładunku elementu webhook. |
serviceUri |
string |
identyfikator URI usługi, aby opublikować powiadomienie po aktywowaniu lub rozwiązaniu alertu. |
ThresholdRuleCondition
Warunek reguły oparty na metryce przekraczającej próg.
Nazwa | Typ | Opis |
---|---|---|
dataSource | RuleDataSource: |
zasób, z którego reguła zbiera dane. W przypadku tego typu źródło danych zawsze będzie typu RuleMetricDataSource. |
odata.type |
string:
Microsoft. |
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 internetowego) i ThresholdRuleCondition (na podstawie progu metryki). |
operator |
operator używany do porównywania danych i progu. |
|
threshold |
number |
wartość progowa, która aktywuje alert. |
timeAggregation |
operator agregacji czasu. Sposób łączenia zebranych danych w czasie. Wartość domyślna to PrimaryAggregationType Metryki. |
|
windowSize |
string |
okres czasu (w formacie czasu trwania ISO 8601), który służy do monitorowania aktywności alertów na podstawie progu. Jeśli zostanie określony, musi to być od 5 minut do 1 dnia. |
TimeAggregationOperator
Operatory agregacji dozwolone w regule.
Nazwa | Typ | Opis |
---|---|---|
Average |
string |
|
Last |
string |
|
Maximum |
string |
|
Minimum |
string |
|
Total |
string |