Prometheus Rule Groups - Get

Referenz

Dienst:: Monitor

API-Version:: 2023-03-01

Ruft eine Prometheus-Regelgruppendefinition ab.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AlertsManagement/prometheusRuleGroups/{ruleGroupName}?api-version=2023-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.
ruleGroupName	path	True	string	Der Name der Regelgruppe. RegEx-Muster: `^[^:@/#{}%&+*<>?]+$`
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	Typ	Beschreibung
200 OK	PrometheusRuleGroupResource	Erfolgreiche Anforderung für eine Liste von Prometheus-Regelgruppen
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Beispiele

Get a PrometheusRuleGroup

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/promResourceGroup/providers/Microsoft.AlertsManagement/prometheusRuleGroups/myPrometheusRuleGroup?api-version=2023-03-01

Beispiel für eine Antwort

Statuscode:: 200

{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/promResourceGroup/providers/Microsoft.AlertsManagement/prometheusRuleGroups/myPrometheusRuleGroup",
  "type": "Microsoft.AlertsManagement/prometheusRuleGroups",
  "location": "East US",
  "properties": {
    "description": "This is the description of the following rule group",
    "enabled": true,
    "interval": "PT10M",
    "clusterName": "myClusterName",
    "scopes": [
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/myResourceGroup/providers/microsoft.monitor/accounts/myAzureMonitorWorkspace"
    ],
    "rules": [
      {
        "record": "job_type:billing_jobs_duration_seconds:99p5m",
        "expression": "histogram_quantile(0.99, sum(rate(jobs_duration_seconds_bucket{service=\"billing-processing\"}[5m])) by (job_type))",
        "labels": {
          "team": "prod"
        }
      },
      {
        "alert": "Billing_Processing_Very_Slow",
        "expression": "job_type:billing_jobs_duration_seconds:99p5m > 30",
        "enabled": true,
        "severity": 2,
        "for": "PT5M",
        "labels": {
          "team": "prod"
        },
        "annotations": {
          "annotationName1": "annotationValue1"
        },
        "resolveConfiguration": {
          "autoResolved": true,
          "timeToResolve": "PT10M"
        },
        "actions": [
          {
            "actionGroupId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourcegroups/myrg/providers/microsoft.insights/actiongroups/myactiongroup",
            "actionProperties": {
              "key11": "value11",
              "key12": "value12"
            }
          },
          {
            "actionGroupId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourcegroups/myrg/providers/microsoft.insights/actiongroups/myotheractiongroup",
            "actionProperties": {
              "key21": "value21",
              "key22": "value22"
            }
          }
        ]
      }
    ]
  }
}

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
PrometheusRule	Eine Azure Prometheus-Warnungs- oder Aufzeichnungsregel.
PrometheusRuleGroupAction	Eine Warnungsaktion. Nur relevant für Warnungen.
PrometheusRuleGroupResource	Die Prometheus-Regelgruppenressource.
PrometheusRuleResolveConfiguration	Gibt die Konfiguration der Prometheus-Warnungsregel an.
systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

PrometheusRule

Eine Azure Prometheus-Warnungs- oder Aufzeichnungsregel.

Name	Typ	Beschreibung
actions	PrometheusRuleGroupAction[]	Aktionen, die ausgeführt werden, wenn die Warnungsregel aktiv wird und eine Warnungsbedingung aufgelöst wird.
alert	string	Name der Warnungsregel.
annotations	object	Die Anmerkungsklausel gibt eine Reihe von Informationsbezeichnungen an, die verwendet werden können, um längere zusätzliche Informationen wie Warnungsbeschreibungen oder Runbooklinks zu speichern. Die Anmerkungswerte können in Vorlagen erstellt werden.
enabled	boolean	Aktivieren/Deaktivieren der Regel.
expression	string	Der auszuwertende PromQL-Ausdruck. https://prometheus.io/docs/prometheus/latest/querying/basics/. Wird regelmäßig ausgewertet, wie durch "interval" angegeben, und das Ergebnis wird als neuer Satz von Zeitreihen mit dem Metriknamen aufgezeichnet, wie er von "record" angegeben wird.
for	string	Die Zeitspanne der Warnung muss vor dem Auslösen aktiv sein.
labels	object	Bezeichnungen, die vor dem Speichern des Ergebnisses hinzugefügt oder überschrieben werden sollen.
record	string	Name der aufgezeichneten Metriken.
resolveConfiguration	PrometheusRuleResolveConfiguration	Definiert die Konfiguration zum Auflösen ausgelöster Warnungen. Nur relevant für Warnungen.
severity	integer	Der Schweregrad der von der Regel ausgelösten Warnungen. Muss zwischen 0 und 4 sein.

PrometheusRuleGroupAction

Eine Warnungsaktion. Nur relevant für Warnungen.

Name	Typ	Beschreibung
actionGroupId	string	Die Ressourcen-ID der zu verwendenden Aktionsgruppe.
actionProperties	object	Die Eigenschaften eines Aktionsgruppenobjekts.

PrometheusRuleGroupResource

Die Prometheus-Regelgruppenressource.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Der geografische Standort, an dem sich die Ressource befindet
name	string	Der Name der Ressource
properties.clusterName	string	Regel auf Daten aus einem bestimmten Cluster anwenden.
properties.description	string	Beschreibung der Regelgruppe.
properties.enabled	boolean	Aktivieren/Deaktivieren der Regelgruppe.
properties.interval	string	Das Intervall, in dem die im ISO 8601-Dauerformat dargestellte Prometheus-Regelgruppe ausgeführt werden soll. Sollte zwischen 1 und 15 Minuten dauern
properties.rules	PrometheusRule[]	Definiert die Regeln in der Prometheus-Regelgruppe.
properties.scopes	string[]	Ressourcen-IDs für Azure Monitor-Arbeitsbereiche als Ziel. Diese API-Version ist derzeit auf das Erstellen mit einem Bereich beschränkt. Dies kann sich in Zukunft ändern.
systemData	systemData	Azure Resource Manager-Metadaten mit createdBy- und modifiedBy-Informationen.
tags	object	Ressourcentags.
type	string	Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

PrometheusRuleResolveConfiguration

Gibt die Konfiguration der Prometheus-Warnungsregel an.

Name	Typ	Beschreibung
autoResolved	boolean	Aktivieren Der automatischen Warnungsauflösung.
timeToResolve	string	Timeout für automatische Auflösung von Warnungen.

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Freigeben über