Alert Rules - List By Subscription
Wyświetl listę reguł alertów dotyczących metryk klasycznych w ramach subskrypcji.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Insights/alertrules?api-version=2016-03-01
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
subscription
|
path | True |
string |
Identyfikator subskrypcji docelowej. |
api-version
|
query | True |
string |
Wersja interfejsu API do użycia dla tej operacji. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
Pomyślne żądanie listy reguł alertów |
|
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
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nazwa | Opis |
---|---|
user_impersonation | personifikacja konta użytkownika |
Przykłady
List alert rules
Sample Request
GET https://management.azure.com/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/providers/Microsoft.Insights/alertrules?api-version=2016-03-01
Sample Response
{
"value": [
{
"id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/alertrules/myRuleName",
"name": "myRuleName",
"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": "myRuleName",
"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": 2,
"windowSize": "PT5M",
"timeAggregation": "Total"
},
"lastUpdatedTime": "2016-11-10T21:04:39.0005255Z",
"actions": [
{
"odata.type": "Microsoft.Azure.Management.Insights.Models.RuleEmailAction",
"sendToServiceOwners": true,
"customEmails": [
"gu@ms.com",
"su@ms.net"
]
}
]
}
},
{
"id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/alertrules/chiricutin0",
"name": "chiricutin0",
"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": "chiricutin0",
"description": "Pura Vida 0",
"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": 2,
"windowSize": "PT5M",
"timeAggregation": "Total"
},
"lastUpdatedTime": "2016-11-10T21:04:39.1082596Z",
"actions": []
}
}
]
}
Definicje
Nazwa | Opis |
---|---|
Alert |
Zasób reguły alertu. |
Alert |
Reprezentuje kolekcję zasobów reguły alertu. |
Condition |
Operatory dozwolone w warunku reguły. |
Error |
Opisuje format odpowiedzi Błąd. |
Location |
Warunek reguły na podstawie określonej liczby lokalizacji kończy się niepowodzeniem. |
Management |
Sposób łączenia zbieranych danych w czasie. |
Management |
Warunek reguły zdarzenia zarządzania. |
Rule |
Określa akcję wysyłania wiadomości e-mail po obliczeniu warunku reguły. Dyskryminator jest zawsze RuleEmailAction w tym przypadku. |
Rule |
Oświadczenia dla źródła danych zdarzenia zarządzania regułami. |
Rule |
Źródło danych zdarzenia zarządzania regułami. W tym przypadku pola dyskryminujące są zawsze regułą RuleManagementEventDataSource. |
Rule |
Źródło danych metryki reguły. W tym przypadku wartość dyskryminująca to zawsze RuleMetricDataSource. |
Rule |
Określa akcję do opublikowania w usłudze po obliczeniu warunku reguły. Dyskryminator jest zawsze RuleWebhookAction w tym przypadku. |
Threshold |
Warunek reguły na podstawie metryki 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 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.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 |
Czas 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 |
AlertRuleResourceCollection
Reprezentuje kolekcję zasobów reguły alertu.
Nazwa | Typ | Opis |
---|---|---|
value |
wartości zasobów reguły alertu. |
ConditionOperator
Operatory dozwolone w warunku reguły.
Nazwa | Typ | Opis |
---|---|---|
GreaterThan |
string |
|
GreaterThanOrEqual |
string |
|
LessThan |
string |
|
LessThanOrEqual |
string |
ErrorResponse
Opisuje format odpowiedzi 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 na podstawie określonej liczby 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 niepowodzeń testu internetowego) i ThresholdRuleCondition (na podstawie progu metryki). |
windowSize |
string |
okres czasu (w formacie czasu trwania ISO 8601) używany 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 zbieranych 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) używany 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, żadne 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 niepowodzeń testu internetowego) i ThresholdRuleCondition (na podstawie progu metryki). |
RuleEmailAction
Określa akcję wysyłania wiadomości e-mail po obliczeniu warunku reguły. Dyskryminator 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ługi (usługi i współadministratorzy) usługi powinni zostać powiadomieni o aktywowaniu alertu. |
RuleManagementEventClaimsDataSource
Oświadczenia dla ź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. W tym przypadku pola dyskryminujące są zawsze regułą RuleManagementEventDataSource.
Nazwa | Typ | Opis |
---|---|---|
claims |
roszczenia. |
|
eventName |
string |
nazwa zdarzenia. |
eventSource |
string |
źródło zdarzenia. |
legacyResourceId |
string |
starszy identyfikator zasobu, który monitoruje reguła. 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. |
określa typ źródła danych. Istnieją dwa typy źródeł danych reguły: RuleMetricDataSource i RuleManagementEventDataSource |
operationName |
string |
Nazwa operacji, którą należy sprawdzić. Jeśli żadna nazwa nie zostanie podana, dowolna 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: tej właściwości nie można zaktualizować dla istniejącej reguły. |
status |
string |
Stan operacji, którą należy sprawdzić. Jeśli nie zostanie podany żaden stan, dowolny stan będzie zgodny. |
subStatus |
string |
podstatu. |
RuleMetricDataSource
Źródło danych metryki reguły. W tym przypadku wartość dyskryminująca to zawsze RuleMetricDataSource.
Nazwa | Typ | Opis |
---|---|---|
legacyResourceId |
string |
starszy identyfikator zasobu, który monitoruje reguła. UWAGA: tej właściwości nie można zaktualizować dla istniejącej reguły. |
metricName |
string |
nazwa metryki definiującej, 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ły: RuleMetricDataSource i RuleManagementEventDataSource |
resourceLocation |
string |
lokalizacja zasobu. |
resourceUri |
string |
identyfikator zasobu, który monitoruje reguła. UWAGA: tej właściwości nie można zaktualizować dla istniejącej reguły. |
RuleWebhookAction
Określa akcję do opublikowania w usłudze po obliczeniu warunku reguły. Dyskryminator 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 post. Te dane są dołączane do ładunku elementu webhook. |
serviceUri |
string |
identyfikator URI usługi w celu opublikowania powiadomienia po aktywowaniu lub rozwiązaniu alertu. |
ThresholdRuleCondition
Warunek reguły na podstawie metryki 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 niepowodzeń 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 zbieranych danych w czasie. Wartość domyślna to PrimaryAggregationType Metryki. |
|
windowSize |
string |
okres czasu (w formacie czasu trwania ISO 8601) używany 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 |