Alert Rules - Get

Ruft eine klassische metrische Warnungsregel ab

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

URI-Parameter

Name In Required Type Description
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.

Antworten

Name Type Description
200 OK

Erfolgreiche Anforderung zum Abrufen einer Warnungsregel

Other Status Codes

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

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

Scopes

Name Description
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

Get an alert rule

Sample Request

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

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

Definitionen

AlertRuleResource

Die Warnungsregelressource.

ConditionOperator

Operatoren, die in der Regelbedingung zulässig sind.

ErrorResponse

Beschreibt das Format der Fehlerantwort.

LocationThresholdRuleCondition

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

ManagementEventAggregationCondition

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

ManagementEventRuleCondition

Eine Verwaltungsereignisregelbedingung.

RuleEmailAction

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

RuleManagementEventClaimsDataSource

Die Ansprüche für eine Regelverwaltungsereignisdatenquelle.

RuleManagementEventDataSource

Eine Regelverwaltungsereignisdatenquelle. 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 nach dem Dienst bereitgestellt werden soll, wenn die Regelbedingung ausgewertet wird. Der Diskriminator ist in diesem Fall immer RuleWebhookAction.

ThresholdRuleCondition

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

TimeAggregationOperator

Aggregationsoperatoren, die in einer Regel zulässig sind.

AlertRuleResource

Die Warnungsregelressource.

Name Type Description
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 die Warnungs-E-Mail aufgenommen wird.

properties.isEnabled
  • boolean

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

properties.lastUpdatedTime
  • string

Zuletzt wurde die Regel im ISO8601-Format aktualisiert.

properties.name
  • string

der Name der Warnungsregel.

properties.provisioningState
  • string

der Bereitstellungsstatus.

tags
  • object

Ressourcentags

type
  • string

Azure-Ressourcentyp

ConditionOperator

Operatoren, die in der Regelbedingung zulässig sind.

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

ErrorResponse

Beschreibt das Format der Fehlerantwort.

Name Type Description
code
  • string

Fehlercode

message
  • string

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

LocationThresholdRuleCondition

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

Name Type Description
dataSource RuleDataSource:

die Ressource, aus der die Regel seine Daten sammelt. Für diesen Typ dataSource ist immer der Typ RuleMetricDataSource.

failedLocationCount
  • integer

die Anzahl der Speicherorte, die die Warnung nicht aktivieren müssen.

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

Gibt den Zustandstyp an. Dies kann eine 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 verwendet wird, um die Warnungsaktivität basierend auf dem Schwellenwert zu überwachen. Wenn angegeben, muss es zwischen 5 Minuten und 1 Tag sein.

ManagementEventAggregationCondition

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

Name Type Description
operator

der Bedingungsoperator.

threshold
  • number

Der Schwellenwert, der die Warnung aktiviert.

windowSize
  • string

der Zeitraum (im ISO 8601-Dauerformat), der verwendet wird, um die Warnungsaktivität basierend auf dem Schwellenwert zu überwachen. Wenn angegeben, muss es zwischen 5 Minuten und 1 Tag sein.

ManagementEventRuleCondition

Eine Verwaltungsereignisregelbedingung.

Name Type Description
aggregation

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 seine Daten sammelt. Für diesen Typ dataSource ist immer der Typ RuleMetricDataSource.

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

Gibt den Zustandstyp an. Dies kann eine 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 von E-Mails an, wenn die Regelbedingung ausgewertet wird. Der Diskriminator ist in diesem Fall immer RuleEmailAction.

Name Type Description
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 Regelverwaltungsereignisdatenquelle.

Name Type Description
emailAddress
  • string

die E-Mail-Adresse.

RuleManagementEventDataSource

Eine Regelverwaltungsereignisdatenquelle. Die Diskriminatorfelder sind in diesem Fall immer RuleManagementEventDataSource.

Name Type Description
claims

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 für eine vorhandene Regel nicht aktualisiert werden.

level
  • string

die Ebene.

metricNamespace
  • string

der Namespace der Metrik.

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

Gibt den Datentyp 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

der Ressourcengruppenname.

resourceLocation
  • string

die Position der Ressource.

resourceProviderName
  • string

der Name des Ressourcenanbieters.

resourceUri
  • string

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

status
  • string

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

subStatus
  • string

der Unterstatus.

RuleMetricDataSource

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

Name Type Description
legacyResourceId
  • string

der Legacyressourcenbezeichner der Ressource, die von der Regel überwacht wird. HINWEIS: Diese Eigenschaft kann für eine vorhandene Regel nicht 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 Datentyp der Datenquelle an. Es gibt zwei Arten von Regeldatenquellen: RuleMetricDataSource und RuleManagementEventDataSource

resourceLocation
  • string

die Position der Ressource.

resourceUri
  • string

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

RuleWebhookAction

Gibt die Aktion an, die nach dem Dienst bereitgestellt werden soll, wenn die Regelbedingung ausgewertet wird. Der Diskriminator ist in diesem Fall immer RuleWebhookAction.

Name Type Description
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, das in den Postvorgang aufgenommen werden soll. Diese Daten werden an die Webhook-Nutzlast angefügt.

serviceUri
  • string

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

ThresholdRuleCondition

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

Name Type Description
dataSource RuleDataSource:

die Ressource, aus der die Regel seine Daten sammelt. Für diesen Typ dataSource ist immer der Typ RuleMetricDataSource.

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

Gibt den Zustandstyp an. Dies kann eine 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

der Operator, der verwendet wird, um die Daten und den Schwellenwert zu vergleichen.

threshold
  • number

der Schwellenwert, der die Warnung aktiviert.

timeAggregation

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 verwendet wird, um die Warnungsaktivität basierend auf dem Schwellenwert zu überwachen. Wenn angegeben, muss es zwischen 5 Minuten und 1 Tag sein.

TimeAggregationOperator

Aggregationsoperatoren, die in einer Regel zulässig sind.

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