Freigeben über


Alert Rules - Update

Updates eine vorhandene klassische Metrik AlertRuleResource. Um andere Felder zu aktualisieren, verwenden Sie die CreateOrUpdate-Methode.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
resourceGroupName
path True

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

ruleName
path True

string

Der Name der Regel.

subscriptionId
path True

string

Hierbei handelt es sich um die ID des Zielabonnements.

api-version
query True

string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name Erforderlich Typ Beschreibung
properties.condition True RuleCondition:

die Bedingung, die dazu führt, dass die Warnungsregel aktiviert wird.

properties.isEnabled True

boolean

das Flag, das angibt, ob die Warnungsregel aktiviert ist.

properties.name True

string

der Name der Warnungsregel.

properties.action RuleAction:

Aktion, die ausgeführt wird, wenn die Warnungsregel aktiv wird und wenn eine Warnungsbedingung aufgelöst wird.

properties.actions RuleAction[]:

das Array von Aktionen, die ausgeführt werden, wenn die Warnungsregel aktiv wird und wenn eine Warnungsbedingung aufgelöst wird.

properties.description

string

die Beschreibung der Warnungsregel, die in der Warnungs-E-Mail enthalten sein wird.

properties.provisioningState

string

den Bereitstellungsstatus.

tags

object

Ressourcentags

Antworten

Name Typ Beschreibung
200 OK

AlertRuleResource

Erfolgreiche Anforderung zum Aktualisieren einer Warnungsregel

201 Created

AlertRuleResource

Erfolgreiche Anforderung zum Aktualisieren einer Warnungsregel, die zur Erstellung der Warnungsregel führte

Other Status Codes

ErrorResponse

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

Patch an alert rule

Beispielanforderung

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

{
  "tags": {
    "$type": "Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary"
  },
  "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": []
  }
}

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
AlertRuleResource

Die Warnungsregelressource.

AlertRuleResourcePatch

Das Warnungsregelobjekt für Patchvorgänge.

ConditionOperator

In der Regelbedingung zulässige Operatoren.

ErrorResponse

Beschreibt das Format der Fehlerantwort.

LocationThresholdRuleCondition

Eine Regelbedingung, die auf einer bestimmten Anzahl von Speicherorten basiert, die fehlschlagen.

ManagementEventAggregationCondition

Legt fest, wie die erfassten Daten im Zeitverlauf kombiniert werden sollen.

ManagementEventRuleCondition

Eine Verwaltungsereignisregelbedingung.

RuleEmailAction

Gibt die Aktion zum Senden einer E-Mail an, wenn die Regelbedingung ausgewertet wird. Der Diskriminator ist in diesem Fall immer RuleEmailAction.

RuleManagementEventClaimsDataSource

Die Ansprüche für eine Regelverwaltungsereignis-Datenquelle.

RuleManagementEventDataSource

Eine Regelverwaltungsereignis-Datenquelle. Die Diskriminatorfelder sind in diesem Fall immer RuleManagementEventDataSource.

RuleMetricDataSource

Eine Regelmetrik-Datenquelle. Der Diskriminatorwert ist in diesem Fall immer RuleMetricDataSource.

RuleWebhookAction

Gibt die Aktion an, die beim Auswerten der Regelbedingung nach dem Dienst ausgeführt werden soll. Der Diskriminator ist in diesem Fall immer RuleWebhookAction.

ThresholdRuleCondition

Eine Regelbedingung, die auf einer Metrik basiert, die einen Schwellenwert überschreitet.

TimeAggregationOperator

Aggregationsoperatoren sind in einer Regel zulässig.

AlertRuleResource

Die Warnungsregelressource.

Name Typ Beschreibung
id

string

Azure-Ressourcen-ID

location

string

Ressourcenspeicherort

name

string

Name der Azure-Ressource

properties.action RuleAction:

Aktion, die ausgeführt wird, wenn die Warnungsregel aktiv wird und wenn eine Warnungsbedingung aufgelöst wird.

properties.actions RuleAction[]:

das Array von Aktionen, die ausgeführt werden, wenn die Warnungsregel aktiv wird und wenn eine Warnungsbedingung aufgelöst wird.

properties.condition RuleCondition:

die Bedingung, die dazu führt, dass die Warnungsregel aktiviert wird.

properties.description

string

die Beschreibung der Warnungsregel, die in der Warnungs-E-Mail enthalten sein wird.

properties.isEnabled

boolean

das Flag, das angibt, ob die Warnungsregel aktiviert ist.

properties.lastUpdatedTime

string

Das letzte Mal wurde die Regel im ISO8601 Format aktualisiert.

properties.name

string

der Name der Warnungsregel.

properties.provisioningState

string

den Bereitstellungsstatus.

tags

object

Ressourcentags

type

string

Azure-Ressourcentyp

AlertRuleResourcePatch

Das Warnungsregelobjekt für Patchvorgänge.

Name Typ Beschreibung
properties.action RuleAction:

Aktion, die ausgeführt wird, wenn die Warnungsregel aktiv wird und wenn eine Warnungsbedingung aufgelöst wird.

properties.actions RuleAction[]:

das Array von Aktionen, die ausgeführt werden, wenn die Warnungsregel aktiv wird und wenn eine Warnungsbedingung aufgelöst wird.

properties.condition RuleCondition:

die Bedingung, die dazu führt, dass die Warnungsregel aktiviert wird.

properties.description

string

die Beschreibung der Warnungsregel, die in der Warnungs-E-Mail enthalten sein wird.

properties.isEnabled

boolean

das Flag, das angibt, ob die Warnungsregel aktiviert ist.

properties.lastUpdatedTime

string

Das letzte Mal wurde die Regel im ISO8601 Format aktualisiert.

properties.name

string

der Name der Warnungsregel.

properties.provisioningState

string

den Bereitstellungsstatus.

tags

object

Ressourcentags

ConditionOperator

In der Regelbedingung zulässige Operatoren.

Name Typ Beschreibung
GreaterThan

string

GreaterThanOrEqual

string

LessThan

string

LessThanOrEqual

string

ErrorResponse

Beschreibt das Format der Fehlerantwort.

Name Typ Beschreibung
code

string

Fehlercode

message

string

Eine Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

LocationThresholdRuleCondition

Eine Regelbedingung, die auf einer bestimmten Anzahl von Speicherorten basiert, die fehlschlagen.

Name Typ Beschreibung
dataSource RuleDataSource:

die Ressource, aus der die Regel ihre Daten sammelt. Für diesen Typ hat dataSource immer den Typ RuleMetricDataSource.

failedLocationCount

integer

die Anzahl der Speicherorte, an denen die Warnung nicht aktiviert werden muss.

odata.type string:

Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition

gibt den Zustandstyp an. Dies kann einer von drei Typen sein: ManagementEventRuleCondition (Vorkommen von Verwaltungsereignissen), LocationThresholdRuleCondition (basierend auf der Anzahl der Fehler eines Webtests) und ThresholdRuleCondition (basierend auf dem Schwellenwert einer Metrik).

windowSize

string

der Zeitraum (im ISO 8601-Dauerformat), der zum Überwachen der Warnungsaktivität basierend auf dem Schwellenwert verwendet wird. Wenn angegeben, muss es zwischen 5 Minuten und 1 Tag dauern.

ManagementEventAggregationCondition

Legt fest, wie die erfassten Daten im Zeitverlauf kombiniert werden sollen.

Name Typ Beschreibung
operator

ConditionOperator

der Bedingungsoperator.

threshold

number

Der Schwellenwert, der die Warnung aktiviert.

windowSize

string

der Zeitraum (im ISO 8601-Dauerformat), der zum Überwachen der Warnungsaktivität basierend auf dem Schwellenwert verwendet wird. Wenn angegeben, muss es zwischen 5 Minuten und 1 Tag dauern.

ManagementEventRuleCondition

Eine Verwaltungsereignisregelbedingung.

Name Typ Beschreibung
aggregation

ManagementEventAggregationCondition

Wie die gesammelten Daten im Laufe der Zeit kombiniert werden sollen und wann die Warnung aktiviert wird. Beachten Sie, dass die Aggregation von Warnungen für Verwaltungsereignisse optional ist. Wenn sie nicht bereitgestellt wird, führt jedes Ereignis zu einer Aktivierung der Warnung.

dataSource RuleDataSource:

die Ressource, aus der die Regel ihre Daten sammelt. Für diesen Typ hat dataSource immer den Typ RuleMetricDataSource.

odata.type string:

Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition

gibt den Zustandstyp an. Dies kann einer von drei Typen sein: ManagementEventRuleCondition (Vorkommen von Verwaltungsereignissen), LocationThresholdRuleCondition (basierend auf der Anzahl der Fehler eines Webtests) und ThresholdRuleCondition (basierend auf dem Schwellenwert einer Metrik).

RuleEmailAction

Gibt die Aktion zum Senden einer E-Mail an, wenn die Regelbedingung ausgewertet wird. Der Diskriminator ist in diesem Fall immer RuleEmailAction.

Name Typ Beschreibung
customEmails

string[]

die Liste der benutzerdefinierten E-Mail-Adressen des Administrators, um die Aktivierung der Warnung zu benachrichtigen.

odata.type string:

Microsoft.Azure.Management.Insights.Models.RuleEmailAction

gibt den Typ der Aktion an. Es gibt zwei Arten von Aktionen: RuleEmailAction und RuleWebhookAction.

sendToServiceOwners

boolean

Gibt an, ob die Administratoren (Dienst- und Co-Administratoren) des Diensts benachrichtigt werden sollen, wenn die Warnung aktiviert wurde.

RuleManagementEventClaimsDataSource

Die Ansprüche für eine Regelverwaltungsereignis-Datenquelle.

Name Typ Beschreibung
emailAddress

string

die E-Mail-Adresse.

RuleManagementEventDataSource

Eine Regelverwaltungsereignis-Datenquelle. Die Diskriminatorfelder sind in diesem Fall immer RuleManagementEventDataSource.

Name Typ Beschreibung
claims

RuleManagementEventClaimsDataSource

die Ansprüche.

eventName

string

der Ereignisname.

eventSource

string

die Ereignisquelle.

legacyResourceId

string

der Legacyressourcenbezeichner der Ressource, die von der Regel überwacht wird. HINWEIS: Diese Eigenschaft kann nicht für eine vorhandene Regel aktualisiert werden.

level

string

die Ebene.

metricNamespace

string

der Namespace der Metrik.

odata.type string:

Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource

gibt den Typ der Datenquelle an. Es gibt zwei Arten von Regeldatenquellen: RuleMetricDataSource und RuleManagementEventDataSource

operationName

string

Der Name des zu prüfenden Vorgangs. Wenn kein Name angegeben ist, wird jeder Vorgang verglichen.

resourceGroupName

string

den Namen der Ressourcengruppe.

resourceLocation

string

der Speicherort der Ressource.

resourceProviderName

string

den Namen des Ressourcenanbieters.

resourceUri

string

der Ressourcenbezeichner der Ressource, die von der Regel überwacht wird. HINWEIS: Diese Eigenschaft kann nicht für eine vorhandene Regel aktualisiert werden.

status

string

Der Status des zu prüfenden Vorgangs. Wenn kein Status angegeben ist, wird jeder Status verglichen.

subStatus

string

den Unterstatus.

RuleMetricDataSource

Eine Regelmetrik-Datenquelle. Der Diskriminatorwert ist in diesem Fall immer RuleMetricDataSource.

Name Typ Beschreibung
legacyResourceId

string

der Legacyressourcenbezeichner der Ressource, die von der Regel überwacht wird. HINWEIS: Diese Eigenschaft kann nicht für eine vorhandene Regel aktualisiert werden.

metricName

string

der Name der Metrik, die definiert, was die Regel überwacht.

metricNamespace

string

der Namespace der Metrik.

odata.type string:

Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource

gibt den Typ der Datenquelle an. Es gibt zwei Arten von Regeldatenquellen: RuleMetricDataSource und RuleManagementEventDataSource

resourceLocation

string

der Speicherort der Ressource.

resourceUri

string

der Ressourcenbezeichner der Ressource, die von der Regel überwacht wird. HINWEIS: Diese Eigenschaft kann nicht für eine vorhandene Regel aktualisiert werden.

RuleWebhookAction

Gibt die Aktion an, die beim Auswerten der Regelbedingung nach dem Dienst ausgeführt werden soll. Der Diskriminator ist in diesem Fall immer RuleWebhookAction.

Name Typ Beschreibung
odata.type string:

Microsoft.Azure.Management.Insights.Models.RuleWebhookAction

gibt den Typ der Aktion an. Es gibt zwei Arten von Aktionen: RuleEmailAction und RuleWebhookAction.

properties

object

das Wörterbuch der benutzerdefinierten Eigenschaften, die in den post-Vorgang eingeschlossen werden sollen. Diese Daten werden an die Webhooknutzlast angefügt.

serviceUri

string

der Dienst-URI, um die Benachrichtigung zu posten, wenn die Warnung aktiviert oder aufgelöst wird.

ThresholdRuleCondition

Eine Regelbedingung, die auf einer Metrik basiert, die einen Schwellenwert überschreitet.

Name Typ Beschreibung
dataSource RuleDataSource:

die Ressource, aus der die Regel ihre Daten sammelt. Für diesen Typ hat dataSource immer den Typ RuleMetricDataSource.

odata.type string:

Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition

gibt den Zustandstyp an. Dies kann einer von drei Typen sein: ManagementEventRuleCondition (Vorkommen von Verwaltungsereignissen), LocationThresholdRuleCondition (basierend auf der Anzahl der Fehler eines Webtests) und ThresholdRuleCondition (basierend auf dem Schwellenwert einer Metrik).

operator

ConditionOperator

der Operator, der zum Vergleichen der Daten und des Schwellenwerts verwendet wird.

threshold

number

der Schwellenwert, der die Warnung aktiviert.

timeAggregation

TimeAggregationOperator

der Zeitaggregationsoperator. Wie die gesammelten Daten im Laufe der Zeit kombiniert werden sollen. Der Standardwert ist der PrimaryAggregationType der Metrik.

windowSize

string

der Zeitraum (im ISO 8601-Dauerformat), der zum Überwachen der Warnungsaktivität basierend auf dem Schwellenwert verwendet wird. Wenn angegeben, muss es zwischen 5 Minuten und 1 Tag dauern.

TimeAggregationOperator

Aggregationsoperatoren sind in einer Regel zulässig.

Name Typ Beschreibung
Average

string

Last

string

Maximum

string

Minimum

string

Total

string