Prometheus Rule Groups - Get

Reference

Služba:: Monitor

Verze rozhraní API:: 2023-03-01

Načtěte definici skupiny pravidel Prometheus.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AlertsManagement/prometheusRuleGroups/{ruleGroupName}?api-version=2023-03-01

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
ruleGroupName	path	True	string pattern: ^[^:@/#{}%&+*<>?]+$	Název skupiny pravidel.
subscriptionId	path	True	string minLength: 1	ID cílového předplatného.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	PrometheusRuleGroupResource	Úspěšná žádost o seznam skupin pravidel Prometheus
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Příklady

Get a PrometheusRuleGroup

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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"
            }
          }
        ]
      }
    ]
  }
}

Definice

Name	Description
createdByType	Typ identity, která prostředek vytvořila.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
PrometheusRule	Pravidlo upozorňování nebo záznamu Azure Prometheus
PrometheusRuleGroupAction	Akce upozornění Relevantní pouze pro výstrahy.
PrometheusRuleGroupResource	Prostředek skupiny pravidel Prometheus.
PrometheusRuleResolveConfiguration	Určuje konfiguraci pravidla upozornění Prometheus.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

PrometheusRule

Objekt

Pravidlo upozorňování nebo záznamu Azure Prometheus

Name	Typ	Description
actions	PrometheusRuleGroupAction[]	Akce, které se provádějí při aktivním pravidlu upozornění a při vyřešení podmínky upozornění
alert	string	Název pravidla upozornění
annotations	object	Klauzule poznámek určuje sadu informačních popisků, které lze použít k uložení delších dalších informací, jako jsou popisy výstrah nebo odkazy runbooku. Hodnoty poznámek lze vytvořit pomocí šablony.
enabled	boolean	Povolte nebo zakažte pravidlo.
expression	string	Výraz PromQL, který se má vyhodnotit. https://prometheus.io/docs/prometheus/latest/querying/basics/. Pravidelně se vyhodnocuje podle intervalu a výsledek zaznamenaný jako nová sada časových řad s názvem metriky podle "záznamu".
for	string (duration)	Před aktivací musí být upozornění na dobu aktivní.
labels	object	Popisky, které se mají přidat nebo přepsat před uložením výsledku
record	string	Název zaznamenaných metrik
resolveConfiguration	PrometheusRuleResolveConfiguration	Definuje konfiguraci pro řešení aktivovaných upozornění. Relevantní pouze pro výstrahy.
severity	integer (int32)	Závažnost výstrah aktivovaných pravidlem. Musí být v rozmezí od 0 do 4.

PrometheusRuleGroupAction

Objekt

Akce upozornění Relevantní pouze pro výstrahy.

Name	Typ	Description
actionGroupId	string	ID prostředku skupiny akcí, které se má použít.
actionProperties	object	Vlastnosti objektu skupiny akcí.

PrometheusRuleGroupResource

Objekt

Prostředek skupiny pravidel Prometheus.

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Geografické umístění, ve kterém se nachází zdroj
name	string	Název prostředku
properties.clusterName	string	Použijte pravidlo pro data z konkrétního clusteru.
properties.description	string	Popis skupiny pravidel
properties.enabled	boolean	Povolte nebo zakažte skupinu pravidel.
properties.interval	string (duration)	Interval, ve kterém se má spustit skupina pravidel Prometheus reprezentovaná ve formátu doby trvání ISO 8601. Mělo by to být 1 až 15 minut.
properties.rules	PrometheusRule[]	Definuje pravidla ve skupině pravidel Prometheus.
properties.scopes	string[]	Cílení ID prostředků pracovních prostorů služby Azure Monitor Tato verze api-version je v současné době omezená na vytvoření s jedním oborem. To se může v budoucnu změnit.
systemData	systemData	Metadata Azure Resource Manageru obsahující informace createdBy a modifiedBy
tags	object	Značky prostředků
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

PrometheusRuleResolveConfiguration

Objekt

Určuje konfiguraci pravidla upozornění Prometheus.

Name	Typ	Description
autoResolved	boolean	Povolte automatické řešení upozornění.
timeToResolve	string (duration)	Vypršení časového limitu automatického řešení upozornění

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

Sdílet prostřednictvím

Prometheus Rule Groups - Get

Parametry identifikátoru URI

Odpovědi

Příklady

Get a PrometheusRuleGroup

Ukázkový požadavek

Ukázková odpověď

Definice

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PrometheusRule

PrometheusRuleGroupAction

PrometheusRuleGroupResource

PrometheusRuleResolveConfiguration

systemData

Další materiály