Prometheus Rule Groups - Get

Odwołanie

Usługa:: Monitor

Wersja interfejsu API:: 2023-03-01

Pobierz definicję grupy reguł Prometheus.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string	Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
ruleGroupName	path	True	string	Nazwa grupy reguł. Wzorzec wyrażenia regularnego: `^[^:@/#{}%&+*<>?]+$`
subscriptionId	path	True	string	Identyfikator subskrypcji docelowej.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	PrometheusRuleGroupResource	Pomyślne żądanie listy grup reguł Rozwiązania Prometheus
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Przykłady

Get a PrometheusRuleGroup

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

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

Definicje

Nazwa	Opis
createdByType	Typ tożsamości, która utworzyła zasób.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
PrometheusRule	Reguła alertów lub rejestrowania usługi Azure Prometheus.
PrometheusRuleGroupAction	Akcja alertu. Dotyczy tylko alertów.
PrometheusRuleGroupResource	Zasób grupy reguł Prometheus.
PrometheusRuleResolveConfiguration	Określa konfigurację reguły alertu Prometheus.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt error.

PrometheusRule

Reguła alertów lub rejestrowania usługi Azure Prometheus.

Nazwa	Typ	Opis
actions	PrometheusRuleGroupAction[]	Akcje wykonywane, gdy reguła alertu stanie się aktywna, oraz gdy warunek alertu zostanie rozwiązany.
alert	string	Nazwa reguły alertu.
annotations	object	Klauzula adnotacji określa zestaw etykiet informacyjnych, których można użyć do przechowywania dłuższych dodatkowych informacji, takich jak opisy alertów lub linki elementu Runbook. Wartości adnotacji można szablonować.
enabled	boolean	Reguła włączania/wyłączania.
expression	string	Wyrażenie PromQL do obliczenia. https://prometheus.io/docs/prometheus/latest/querying/basics/. Oceniane okresowo jako podane przez wartość "interval" i wynik zarejestrowany jako nowy zestaw szeregów czasowych z nazwą metryki podaną przez "record".
for	string	Przed uruchomieniem alertu musi być aktywny czas.
labels	object	Etykiety do dodania lub zastąpienia przed zapisaniem wyniku.
record	string	Nazwa zarejestrowanych metryk.
resolveConfiguration	PrometheusRuleResolveConfiguration	Definiuje konfigurację rozpoznawania wyzwolonych alertów. Dotyczy tylko alertów.
severity	integer	Ważność alertów wyzwolonych przez regułę. Musi należeć do przedziału od 0 do 4.

PrometheusRuleGroupAction

Akcja alertu. Dotyczy tylko alertów.

Nazwa	Typ	Opis
actionGroupId	string	Identyfikator zasobu grupy akcji do użycia.
actionProperties	object	Właściwości obiektu grupy akcji.

PrometheusRuleGroupResource

Zasób grupy reguł Prometheus.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Lokalizacja geograficzna, w której znajduje się zasób
name	string	Nazwa zasobu
properties.clusterName	string	Zastosuj regułę do danych z określonego klastra.
properties.description	string	Opis grupy reguł.
properties.enabled	boolean	Włącz/wyłącz grupę reguł.
properties.interval	string	Interwał uruchamiania grupy reguł Prometheus reprezentowany w formacie czasu trwania ISO 8601. Powinna należeć do przedziału od 1 do 15 minut
properties.rules	PrometheusRule[]	Definiuje reguły w grupie reguł Prometheus.
properties.scopes	string[]	Określanie identyfikatorów zasobów obszarów roboczych usługi Azure Monitor. Ta wersja interfejsu API jest obecnie ograniczona do tworzenia z jednym zakresem. Może to ulec zmianie w przyszłości.
systemData	systemData	Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.
tags	object	Tagi zasobów.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

PrometheusRuleResolveConfiguration

Określa konfigurację reguły alertu Prometheus.

Nazwa	Typ	Opis
autoResolved	boolean	Włącz automatyczne rozwiązywanie alertów.
timeToResolve	string	Limit czasu automatycznego rozwiązywania alertów.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobów (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string	Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

Udostępnij za pośrednictwem