Microsoft.Insights alertrules
Definicja zasobu Bicep
Typ zasobu alertrules można wdrożyć przy użyciu operacji docelowych:
- grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.
Format zasobu
Aby utworzyć zasób Microsoft.Insights/alertrules, dodaj następujący kod Bicep do szablonu.
resource symbolicname 'Microsoft.Insights/alertrules@2016-03-01' = {
location: 'string'
name: 'string'
properties: {
action: {
odata.type: 'string'
// For remaining properties, see RuleAction objects
}
actions: [
{
odata.type: 'string'
// For remaining properties, see RuleAction objects
}
]
condition: {
dataSource: {
legacyResourceId: 'string'
metricNamespace: 'string'
resourceLocation: 'string'
resourceUri: 'string'
odata.type: 'string'
// For remaining properties, see RuleDataSource objects
}
odata.type: 'string'
// For remaining properties, see RuleCondition objects
}
description: 'string'
isEnabled: bool
name: 'string'
provisioningState: 'string'
}
tags: {
{customized property}: 'string'
}
}
Obiekty RuleAction
Ustaw właściwość odata.type, aby określić typ obiektu.
W przypadku Microsoft.Azure.Management.Insights.Models.RuleEmailActionużyj:
{
customEmails: [
'string'
]
odata.type: 'Microsoft.Azure.Management.Insights.Models.RuleEmailAction'
sendToServiceOwners: bool
}
W przypadku Microsoft.Azure.Management.Insights.Models.RuleWebhookActionużyj:
{
odata.type: 'Microsoft.Azure.Management.Insights.Models.RuleWebhookAction'
properties: {
{customized property}: 'string'
}
serviceUri: 'string'
}
Obiekty RuleDataSource
Ustaw właściwość odata.type, aby określić typ obiektu.
W przypadku Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSourceużyj:
{
claims: {
emailAddress: 'string'
}
eventName: 'string'
eventSource: 'string'
level: 'string'
odata.type: 'Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource'
operationName: 'string'
resourceGroupName: 'string'
resourceProviderName: 'string'
status: 'string'
subStatus: 'string'
}
W przypadku Microsoft.Azure.Management.Insights.Models.RuleMetricDataSourceużyj:
{
metricName: 'string'
odata.type: 'Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource'
}
Obiekty RuleCondition
Ustaw właściwość odata.type, aby określić typ obiektu.
W przypadku Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleConditionużyj:
{
failedLocationCount: int
odata.type: 'Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition'
windowSize: 'string'
}
W przypadku Microsoft.Azure.Management.Insights.Models.ManagementEventRuleConditionużyj:
{
aggregation: {
operator: 'string'
threshold: int
windowSize: 'string'
}
odata.type: 'Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition'
}
W przypadku Microsoft.Azure.Management.Insights.Models.ThresholdRuleConditionużyj:
{
odata.type: 'Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition'
operator: 'string'
threshold: int
timeAggregation: 'string'
windowSize: 'string'
}
Wartości właściwości
AlertRule
Nazwa | Opis | Wartość |
---|---|---|
akcja | akcja wykonywana, gdy reguła alertu stanie się aktywna, a po rozwiązaniu warunku alertu. | RuleAction |
akcje | tablica akcji, które są wykonywane, gdy reguła alertu stanie się aktywna, i gdy warunek alertu zostanie rozwiązany. | RuleAction[] |
warunek | warunek, który powoduje aktywowanie reguły alertu. | RuleCondition (wymagane) |
opis | opis reguły alertu, która zostanie uwzględniona w wiadomości e-mail z alertem. | struna |
isEnabled | flaga wskazująca, czy reguła alertu jest włączona. | bool (wymagane) |
nazwa | nazwa reguły alertu. | ciąg (wymagany) |
provisioningState | stan aprowizacji. | struna |
LocationThresholdRuleCondition
Nazwa | Opis | Wartość |
---|---|---|
failedLocationCount | liczba lokalizacji, które nie mogą aktywować alertu. | Int Ograniczenia: Minimalna wartość = 0 (wymagane) |
odata.type | 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). | "Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition" (wymagane) |
windowSize | 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. | struna |
ManagementEventAggregationCondition
Nazwa | Opis | Wartość |
---|---|---|
operator | operator warunku. | "GreaterThan" "GreaterThanOrEqual" "LessThan" "LessThanOrEqual" |
próg | Wartość progowa, która aktywuje alert. | Int |
windowSize | 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. | struna |
ZarządzanieEventRuleCondition
Nazwa | Opis | Wartość |
---|---|---|
agregacja | 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 aktywację alertu. | ManagementEventAggregationCondition |
odata.type | 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). | "Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition" (wymagane) |
Microsoft.Insights/alertrules
Nazwa | Opis | Wartość |
---|---|---|
lokalizacja | Lokalizacja zasobu | ciąg (wymagany) |
nazwa | Nazwa zasobu | ciąg (wymagany) |
Właściwości | Właściwości reguły alertu zasobu. | AlertRule (wymagane) |
Tagi | Tagi zasobów | Słownik nazw tagów i wartości. Zobacz tagi w szablonach |
Tagi zasobów
Nazwa | Opis | Wartość |
---|
RegułaAkcja
Nazwa | Opis | Wartość |
---|---|---|
odata.type | Ustaw wartość "Microsoft.Azure.Management.Insights.Models.RuleEmailAction" dla typu RuleEmailAction. Ustaw wartość "Microsoft.Azure.Management.Insights.Models.RuleWebhookAction" dla typu RuleWebhookAction. | "Microsoft.Azure.Management.Insights.Models.RuleEmailAction" "Microsoft.Azure.Management.Insights.Models.RuleWebhookAction" (wymagane) |
RuleCondition
Nazwa | Opis | Wartość |
---|---|---|
dataSource | zasób, z którego reguła zbiera dane. W przypadku tego typu źródło danych zawsze będzie typu RuleMetricDataSource. | RuleDataSource |
odata.type | Ustaw wartość "Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition" dla typu LocationThresholdRuleCondition. Ustaw wartość "Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition" dla typu ManagementEventRuleCondition. Ustaw wartość "Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition" dla typu ThresholdRuleCondition. | "Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition" "Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition" "Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition" (wymagane) |
RuleDataSource
Nazwa | Opis | Wartość |
---|---|---|
legacyResourceId | starszy identyfikator zasobu, który monitoruje reguła. UWAGA: tej właściwości nie można zaktualizować dla istniejącej reguły. | struna |
metricNamespace | przestrzeń nazw metryki. | struna |
odata.type | Ustaw wartość "Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource" dla typu RuleManagementEventDataSource. Ustaw wartość "Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource" dla typu RuleMetricDataSource. | "Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource" "Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource" (wymagane) |
resourceLocation | lokalizacja zasobu. | struna |
resourceUri | identyfikator zasobu, który monitoruje reguła. UWAGA: tej właściwości nie można zaktualizować dla istniejącej reguły. | struna |
RuleEmailAction
Nazwa | Opis | Wartość |
---|---|---|
customEmails | lista niestandardowych adresów e-mail administratora w celu powiadomienia o aktywacji alertu. | string[] |
odata.type | określa typ akcji. Istnieją dwa typy akcji: RuleEmailAction i RuleWebhookAction. | "Microsoft.Azure.Management.Insights.Models.RuleEmailAction" (wymagane) |
sendToServiceOwners | Czy administratorzy (usługa i współadministratorzy) usługi powinny być powiadamiane o aktywowaniu alertu. | Bool |
RuleManagementEventClaimsDataSource
Nazwa | Opis | Wartość |
---|---|---|
emailAddress | adres e-mail. | struna |
RuleManagementEventDataSource
Nazwa | Opis | Wartość |
---|---|---|
Roszczeń | oświadczenia. | RuleManagementEventClaimsDataSource |
eventName | nazwa zdarzenia. | struna |
eventSource | źródło zdarzeń. | struna |
poziom | poziom. | struna |
odata.type | określa typ źródła danych. Istnieją dwa typy źródeł danych reguł: RuleMetricDataSource i RuleManagementEventDataSource | "Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource" (wymagane) |
operationName | Nazwa operacji, która ma zostać sprawdzona. Jeśli żadna nazwa nie zostanie podana, dowolna operacja będzie zgodna. | struna |
resourceGroupName | nazwa grupy zasobów. | struna |
resourceProviderName | nazwa dostawcy zasobów. | struna |
stan | Stan operacji, którą należy sprawdzić. Jeśli stan nie zostanie podany, stan będzie zgodny. | struna |
subStatus | podstatu. | struna |
RuleMetricDataSource
Nazwa | Opis | Wartość |
---|---|---|
metricName | nazwa metryki definiującej, co monitoruje reguła. | struna |
odata.type | określa typ źródła danych. Istnieją dwa typy źródeł danych reguł: RuleMetricDataSource i RuleManagementEventDataSource | "Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource" (wymagane) |
RuleWebhookAction
Nazwa | Opis | Wartość |
---|---|---|
odata.type | określa typ akcji. Istnieją dwa typy akcji: RuleEmailAction i RuleWebhookAction. | "Microsoft.Azure.Management.Insights.Models.RuleWebhookAction" (wymagane) |
Właściwości | słownik właściwości niestandardowych do uwzględnienia w operacji po operacji. Te dane są dołączane do ładunku elementu webhook. | ruleWebhookActionProperties |
serviceUri | identyfikator URI usługi , aby opublikować powiadomienie po aktywowaniu lub rozwiązaniu alertu. | struna |
RuleWebhookActionProperties
Nazwa | Opis | Wartość |
---|
ThresholdRuleCondition
Nazwa | Opis | Wartość |
---|---|---|
odata.type | 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). | "Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition" (wymagane) |
operator | operator używany do porównywania danych i progu. | "GreaterThan" "GreaterThanOrEqual" "LessThan" "LessThanOrEqual" (wymagane) |
próg | wartość progowa, która aktywuje alert. | int (wymagane) |
timeAggregation | operator agregacji czasu. Sposób łączenia zbieranych danych z upływem czasu. Wartość domyślna to PrimaryAggregationType Metryki. | "Średnia" "Ostatni" "Maksimum" "Minimum" "Suma" |
windowSize | 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. | struna |
Definicja zasobu szablonu usługi ARM
Typ zasobu alertrules można wdrożyć przy użyciu operacji docelowych:
- grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.
Format zasobu
Aby utworzyć zasób Microsoft.Insights/alertrules, dodaj następujący kod JSON do szablonu.
{
"type": "Microsoft.Insights/alertrules",
"apiVersion": "2016-03-01",
"name": "string",
"location": "string",
"properties": {
"action": {
"odata.type": "string"
// For remaining properties, see RuleAction objects
},
"actions": [ {
"odata.type": "string"
// For remaining properties, see RuleAction objects
} ],
"condition": {
"dataSource": {
"legacyResourceId": "string",
"metricNamespace": "string",
"resourceLocation": "string",
"resourceUri": "string",
"odata.type": "string"
// For remaining properties, see RuleDataSource objects
},
"odata.type": "string"
// For remaining properties, see RuleCondition objects
},
"description": "string",
"isEnabled": "bool",
"name": "string",
"provisioningState": "string"
},
"tags": {
"{customized property}": "string"
}
}
Obiekty RuleAction
Ustaw właściwość odata.type, aby określić typ obiektu.
W przypadku Microsoft.Azure.Management.Insights.Models.RuleEmailActionużyj:
{
"customEmails": [ "string" ],
"odata.type": "Microsoft.Azure.Management.Insights.Models.RuleEmailAction",
"sendToServiceOwners": "bool"
}
W przypadku Microsoft.Azure.Management.Insights.Models.RuleWebhookActionużyj:
{
"odata.type": "Microsoft.Azure.Management.Insights.Models.RuleWebhookAction",
"properties": {
"{customized property}": "string"
},
"serviceUri": "string"
}
Obiekty RuleDataSource
Ustaw właściwość odata.type, aby określić typ obiektu.
W przypadku Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSourceużyj:
{
"claims": {
"emailAddress": "string"
},
"eventName": "string",
"eventSource": "string",
"level": "string",
"odata.type": "Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource",
"operationName": "string",
"resourceGroupName": "string",
"resourceProviderName": "string",
"status": "string",
"subStatus": "string"
}
W przypadku Microsoft.Azure.Management.Insights.Models.RuleMetricDataSourceużyj:
{
"metricName": "string",
"odata.type": "Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource"
}
Obiekty RuleCondition
Ustaw właściwość odata.type, aby określić typ obiektu.
W przypadku Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleConditionużyj:
{
"failedLocationCount": "int",
"odata.type": "Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition",
"windowSize": "string"
}
W przypadku Microsoft.Azure.Management.Insights.Models.ManagementEventRuleConditionużyj:
{
"aggregation": {
"operator": "string",
"threshold": "int",
"windowSize": "string"
},
"odata.type": "Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition"
}
W przypadku Microsoft.Azure.Management.Insights.Models.ThresholdRuleConditionużyj:
{
"odata.type": "Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition",
"operator": "string",
"threshold": "int",
"timeAggregation": "string",
"windowSize": "string"
}
Wartości właściwości
AlertRule
Nazwa | Opis | Wartość |
---|---|---|
akcja | akcja wykonywana, gdy reguła alertu stanie się aktywna, a po rozwiązaniu warunku alertu. | RuleAction |
akcje | tablica akcji, które są wykonywane, gdy reguła alertu stanie się aktywna, i gdy warunek alertu zostanie rozwiązany. | RuleAction[] |
warunek | warunek, który powoduje aktywowanie reguły alertu. | RuleCondition (wymagane) |
opis | opis reguły alertu, która zostanie uwzględniona w wiadomości e-mail z alertem. | struna |
isEnabled | flaga wskazująca, czy reguła alertu jest włączona. | bool (wymagane) |
nazwa | nazwa reguły alertu. | ciąg (wymagany) |
provisioningState | stan aprowizacji. | struna |
LocationThresholdRuleCondition
Nazwa | Opis | Wartość |
---|---|---|
failedLocationCount | liczba lokalizacji, które nie mogą aktywować alertu. | Int Ograniczenia: Minimalna wartość = 0 (wymagane) |
odata.type | 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). | "Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition" (wymagane) |
windowSize | 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. | struna |
ManagementEventAggregationCondition
Nazwa | Opis | Wartość |
---|---|---|
operator | operator warunku. | "GreaterThan" "GreaterThanOrEqual" "LessThan" "LessThanOrEqual" |
próg | Wartość progowa, która aktywuje alert. | Int |
windowSize | 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. | struna |
ZarządzanieEventRuleCondition
Nazwa | Opis | Wartość |
---|---|---|
agregacja | 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 aktywację alertu. | ManagementEventAggregationCondition |
odata.type | 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). | "Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition" (wymagane) |
Microsoft.Insights/alertrules
Nazwa | Opis | Wartość |
---|---|---|
apiVersion | Wersja interfejsu API | '2016-03-01' |
lokalizacja | Lokalizacja zasobu | ciąg (wymagany) |
nazwa | Nazwa zasobu | ciąg (wymagany) |
Właściwości | Właściwości reguły alertu zasobu. | AlertRule (wymagane) |
Tagi | Tagi zasobów | Słownik nazw tagów i wartości. Zobacz tagi w szablonach |
typ | Typ zasobu | "Microsoft.Insights/alertrules" |
Tagi zasobów
Nazwa | Opis | Wartość |
---|
RegułaAkcja
Nazwa | Opis | Wartość |
---|---|---|
odata.type | Ustaw wartość "Microsoft.Azure.Management.Insights.Models.RuleEmailAction" dla typu RuleEmailAction. Ustaw wartość "Microsoft.Azure.Management.Insights.Models.RuleWebhookAction" dla typu RuleWebhookAction. | "Microsoft.Azure.Management.Insights.Models.RuleEmailAction" "Microsoft.Azure.Management.Insights.Models.RuleWebhookAction" (wymagane) |
RuleCondition
Nazwa | Opis | Wartość |
---|---|---|
dataSource | zasób, z którego reguła zbiera dane. W przypadku tego typu źródło danych zawsze będzie typu RuleMetricDataSource. | RuleDataSource |
odata.type | Ustaw wartość "Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition" dla typu LocationThresholdRuleCondition. Ustaw wartość "Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition" dla typu ManagementEventRuleCondition. Ustaw wartość "Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition" dla typu ThresholdRuleCondition. | "Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition" "Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition" "Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition" (wymagane) |
RuleDataSource
Nazwa | Opis | Wartość |
---|---|---|
legacyResourceId | starszy identyfikator zasobu, który monitoruje reguła. UWAGA: tej właściwości nie można zaktualizować dla istniejącej reguły. | struna |
metricNamespace | przestrzeń nazw metryki. | struna |
odata.type | Ustaw wartość "Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource" dla typu RuleManagementEventDataSource. Ustaw wartość "Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource" dla typu RuleMetricDataSource. | "Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource" "Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource" (wymagane) |
resourceLocation | lokalizacja zasobu. | struna |
resourceUri | identyfikator zasobu, który monitoruje reguła. UWAGA: tej właściwości nie można zaktualizować dla istniejącej reguły. | struna |
RuleEmailAction
Nazwa | Opis | Wartość |
---|---|---|
customEmails | lista niestandardowych adresów e-mail administratora w celu powiadomienia o aktywacji alertu. | string[] |
odata.type | określa typ akcji. Istnieją dwa typy akcji: RuleEmailAction i RuleWebhookAction. | "Microsoft.Azure.Management.Insights.Models.RuleEmailAction" (wymagane) |
sendToServiceOwners | Czy administratorzy (usługa i współadministratorzy) usługi powinny być powiadamiane o aktywowaniu alertu. | Bool |
RuleManagementEventClaimsDataSource
Nazwa | Opis | Wartość |
---|---|---|
emailAddress | adres e-mail. | struna |
RuleManagementEventDataSource
Nazwa | Opis | Wartość |
---|---|---|
Roszczeń | oświadczenia. | RuleManagementEventClaimsDataSource |
eventName | nazwa zdarzenia. | struna |
eventSource | źródło zdarzeń. | struna |
poziom | poziom. | struna |
odata.type | określa typ źródła danych. Istnieją dwa typy źródeł danych reguł: RuleMetricDataSource i RuleManagementEventDataSource | "Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource" (wymagane) |
operationName | Nazwa operacji, która ma zostać sprawdzona. Jeśli żadna nazwa nie zostanie podana, dowolna operacja będzie zgodna. | struna |
resourceGroupName | nazwa grupy zasobów. | struna |
resourceProviderName | nazwa dostawcy zasobów. | struna |
stan | Stan operacji, którą należy sprawdzić. Jeśli stan nie zostanie podany, stan będzie zgodny. | struna |
subStatus | podstatu. | struna |
RuleMetricDataSource
Nazwa | Opis | Wartość |
---|---|---|
metricName | nazwa metryki definiującej, co monitoruje reguła. | struna |
odata.type | określa typ źródła danych. Istnieją dwa typy źródeł danych reguł: RuleMetricDataSource i RuleManagementEventDataSource | "Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource" (wymagane) |
RuleWebhookAction
Nazwa | Opis | Wartość |
---|---|---|
odata.type | określa typ akcji. Istnieją dwa typy akcji: RuleEmailAction i RuleWebhookAction. | "Microsoft.Azure.Management.Insights.Models.RuleWebhookAction" (wymagane) |
Właściwości | słownik właściwości niestandardowych do uwzględnienia w operacji po operacji. Te dane są dołączane do ładunku elementu webhook. | ruleWebhookActionProperties |
serviceUri | identyfikator URI usługi , aby opublikować powiadomienie po aktywowaniu lub rozwiązaniu alertu. | struna |
RuleWebhookActionProperties
Nazwa | Opis | Wartość |
---|
ThresholdRuleCondition
Nazwa | Opis | Wartość |
---|---|---|
odata.type | 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). | "Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition" (wymagane) |
operator | operator używany do porównywania danych i progu. | "GreaterThan" "GreaterThanOrEqual" "LessThan" "LessThanOrEqual" (wymagane) |
próg | wartość progowa, która aktywuje alert. | int (wymagane) |
timeAggregation | operator agregacji czasu. Sposób łączenia zbieranych danych z upływem czasu. Wartość domyślna to PrimaryAggregationType Metryki. | "Średnia" "Ostatni" "Maksimum" "Minimum" "Suma" |
windowSize | 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. | struna |
Szablony szybkiego startu
Następujące szablony szybkiego startu wdrażają ten typ zasobu.
Szablon | Opis |
---|---|
atak DDoS na maszynę wirtualną Wdrażanie do Azure |
Spowoduje to wdrożenie maszyny wirtualnej, pakietu OMS i innych zasobów sieciowych. Wykonaj atak DDoS, postępując zgodnie z identyfikatorami guidleines i wykonując scenariusz wykrywania ataku DDoS. |
Definicja zasobu narzędzia Terraform (dostawcy AzAPI)
Typ zasobu alertrules można wdrożyć przy użyciu operacji docelowych:
- grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.
Format zasobu
Aby utworzyć zasób Microsoft.Insights/alertrules, dodaj następujący program Terraform do szablonu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Insights/alertrules@2016-03-01"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
action = {
odata.type = "string"
// For remaining properties, see RuleAction objects
}
actions = [
{
odata.type = "string"
// For remaining properties, see RuleAction objects
}
]
condition = {
dataSource = {
legacyResourceId = "string"
metricNamespace = "string"
resourceLocation = "string"
resourceUri = "string"
odata.type = "string"
// For remaining properties, see RuleDataSource objects
}
odata.type = "string"
// For remaining properties, see RuleCondition objects
}
description = "string"
isEnabled = bool
name = "string"
provisioningState = "string"
}
})
}
Obiekty RuleAction
Ustaw właściwość odata.type, aby określić typ obiektu.
W przypadku Microsoft.Azure.Management.Insights.Models.RuleEmailActionużyj:
{
customEmails = [
"string"
]
odata.type = "Microsoft.Azure.Management.Insights.Models.RuleEmailAction"
sendToServiceOwners = bool
}
W przypadku Microsoft.Azure.Management.Insights.Models.RuleWebhookActionużyj:
{
odata.type = "Microsoft.Azure.Management.Insights.Models.RuleWebhookAction"
properties = {
{customized property} = "string"
}
serviceUri = "string"
}
Obiekty RuleDataSource
Ustaw właściwość odata.type, aby określić typ obiektu.
W przypadku Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSourceużyj:
{
claims = {
emailAddress = "string"
}
eventName = "string"
eventSource = "string"
level = "string"
odata.type = "Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource"
operationName = "string"
resourceGroupName = "string"
resourceProviderName = "string"
status = "string"
subStatus = "string"
}
W przypadku Microsoft.Azure.Management.Insights.Models.RuleMetricDataSourceużyj:
{
metricName = "string"
odata.type = "Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource"
}
Obiekty RuleCondition
Ustaw właściwość odata.type, aby określić typ obiektu.
W przypadku Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleConditionużyj:
{
failedLocationCount = int
odata.type = "Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition"
windowSize = "string"
}
W przypadku Microsoft.Azure.Management.Insights.Models.ManagementEventRuleConditionużyj:
{
aggregation = {
operator = "string"
threshold = int
windowSize = "string"
}
odata.type = "Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition"
}
W przypadku Microsoft.Azure.Management.Insights.Models.ThresholdRuleConditionużyj:
{
odata.type = "Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition"
operator = "string"
threshold = int
timeAggregation = "string"
windowSize = "string"
}
Wartości właściwości
AlertRule
Nazwa | Opis | Wartość |
---|---|---|
akcja | akcja wykonywana, gdy reguła alertu stanie się aktywna, a po rozwiązaniu warunku alertu. | RuleAction |
akcje | tablica akcji, które są wykonywane, gdy reguła alertu stanie się aktywna, i gdy warunek alertu zostanie rozwiązany. | RuleAction[] |
warunek | warunek, który powoduje aktywowanie reguły alertu. | RuleCondition (wymagane) |
opis | opis reguły alertu, która zostanie uwzględniona w wiadomości e-mail z alertem. | struna |
isEnabled | flaga wskazująca, czy reguła alertu jest włączona. | bool (wymagane) |
nazwa | nazwa reguły alertu. | ciąg (wymagany) |
provisioningState | stan aprowizacji. | struna |
LocationThresholdRuleCondition
Nazwa | Opis | Wartość |
---|---|---|
failedLocationCount | liczba lokalizacji, które nie mogą aktywować alertu. | Int Ograniczenia: Minimalna wartość = 0 (wymagane) |
odata.type | 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). | "Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition" (wymagane) |
windowSize | 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. | struna |
ManagementEventAggregationCondition
Nazwa | Opis | Wartość |
---|---|---|
operator | operator warunku. | "GreaterThan" "GreaterThanOrEqual" "LessThan" "LessThanOrEqual" |
próg | Wartość progowa, która aktywuje alert. | Int |
windowSize | 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. | struna |
ZarządzanieEventRuleCondition
Nazwa | Opis | Wartość |
---|---|---|
agregacja | 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 aktywację alertu. | ManagementEventAggregationCondition |
odata.type | 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). | "Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition" (wymagane) |
Microsoft.Insights/alertrules
Tagi zasobów
Nazwa | Opis | Wartość |
---|
RegułaAkcja
Nazwa | Opis | Wartość |
---|---|---|
odata.type | Ustaw wartość "Microsoft.Azure.Management.Insights.Models.RuleEmailAction" dla typu RuleEmailAction. Ustaw wartość "Microsoft.Azure.Management.Insights.Models.RuleWebhookAction" dla typu RuleWebhookAction. | "Microsoft.Azure.Management.Insights.Models.RuleEmailAction" "Microsoft.Azure.Management.Insights.Models.RuleWebhookAction" (wymagane) |
RuleCondition
Nazwa | Opis | Wartość |
---|---|---|
dataSource | zasób, z którego reguła zbiera dane. W przypadku tego typu źródło danych zawsze będzie typu RuleMetricDataSource. | RuleDataSource |
odata.type | Ustaw wartość "Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition" dla typu LocationThresholdRuleCondition. Ustaw wartość "Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition" dla typu ManagementEventRuleCondition. Ustaw wartość "Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition" dla typu ThresholdRuleCondition. | "Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition" "Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition" "Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition" (wymagane) |
RuleDataSource
Nazwa | Opis | Wartość |
---|---|---|
legacyResourceId | starszy identyfikator zasobu, który monitoruje reguła. UWAGA: tej właściwości nie można zaktualizować dla istniejącej reguły. | struna |
metricNamespace | przestrzeń nazw metryki. | struna |
odata.type | Ustaw wartość "Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource" dla typu RuleManagementEventDataSource. Ustaw wartość "Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource" dla typu RuleMetricDataSource. | "Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource" "Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource" (wymagane) |
resourceLocation | lokalizacja zasobu. | struna |
resourceUri | identyfikator zasobu, który monitoruje reguła. UWAGA: tej właściwości nie można zaktualizować dla istniejącej reguły. | struna |
RuleEmailAction
Nazwa | Opis | Wartość |
---|---|---|
customEmails | lista niestandardowych adresów e-mail administratora w celu powiadomienia o aktywacji alertu. | string[] |
odata.type | określa typ akcji. Istnieją dwa typy akcji: RuleEmailAction i RuleWebhookAction. | "Microsoft.Azure.Management.Insights.Models.RuleEmailAction" (wymagane) |
sendToServiceOwners | Czy administratorzy (usługa i współadministratorzy) usługi powinny być powiadamiane o aktywowaniu alertu. | Bool |
RuleManagementEventClaimsDataSource
Nazwa | Opis | Wartość |
---|---|---|
emailAddress | adres e-mail. | struna |
RuleManagementEventDataSource
Nazwa | Opis | Wartość |
---|---|---|
Roszczeń | oświadczenia. | RuleManagementEventClaimsDataSource |
eventName | nazwa zdarzenia. | struna |
eventSource | źródło zdarzeń. | struna |
poziom | poziom. | struna |
odata.type | określa typ źródła danych. Istnieją dwa typy źródeł danych reguł: RuleMetricDataSource i RuleManagementEventDataSource | "Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource" (wymagane) |
operationName | Nazwa operacji, która ma zostać sprawdzona. Jeśli żadna nazwa nie zostanie podana, dowolna operacja będzie zgodna. | struna |
resourceGroupName | nazwa grupy zasobów. | struna |
resourceProviderName | nazwa dostawcy zasobów. | struna |
stan | Stan operacji, którą należy sprawdzić. Jeśli stan nie zostanie podany, stan będzie zgodny. | struna |
subStatus | podstatu. | struna |
RuleMetricDataSource
Nazwa | Opis | Wartość |
---|---|---|
metricName | nazwa metryki definiującej, co monitoruje reguła. | struna |
odata.type | określa typ źródła danych. Istnieją dwa typy źródeł danych reguł: RuleMetricDataSource i RuleManagementEventDataSource | "Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource" (wymagane) |
RuleWebhookAction
Nazwa | Opis | Wartość |
---|---|---|
odata.type | określa typ akcji. Istnieją dwa typy akcji: RuleEmailAction i RuleWebhookAction. | "Microsoft.Azure.Management.Insights.Models.RuleWebhookAction" (wymagane) |
Właściwości | słownik właściwości niestandardowych do uwzględnienia w operacji po operacji. Te dane są dołączane do ładunku elementu webhook. | ruleWebhookActionProperties |
serviceUri | identyfikator URI usługi , aby opublikować powiadomienie po aktywowaniu lub rozwiązaniu alertu. | struna |
RuleWebhookActionProperties
Nazwa | Opis | Wartość |
---|
ThresholdRuleCondition
Nazwa | Opis | Wartość |
---|---|---|
odata.type | 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). | "Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition" (wymagane) |
operator | operator używany do porównywania danych i progu. | "GreaterThan" "GreaterThanOrEqual" "LessThan" "LessThanOrEqual" (wymagane) |
próg | wartość progowa, która aktywuje alert. | int (wymagane) |
timeAggregation | operator agregacji czasu. Sposób łączenia zbieranych danych z upływem czasu. Wartość domyślna to PrimaryAggregationType Metryki. | "Średnia" "Ostatni" "Maksimum" "Minimum" "Suma" |
windowSize | 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. | struna |