Prometheus Rule Groups - Get

Riferimento

Service:: Monitor

API Version:: 2023-03-01

Recuperare una definizione del gruppo di regole Prometheus.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string	Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
ruleGroupName	path	True	string	Nome del gruppo di regole. Regex pattern: `^[^:@/#{}%&+*<>?]+$`
subscriptionId	path	True	string	ID della sottoscrizione di destinazione.
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	PrometheusRuleGroupResource	Richiesta riuscita per un elenco di gruppi di regole Prometheus
Other Status Codes	ErrorResponse	Risposta di errore che descrive perché l'operazione non è riuscita.

Esempio

Get a PrometheusRuleGroup

Sample Request

HTTP

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

Sample Response

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

Definizioni

Nome	Descrizione
createdByType	Tipo di identità che ha creato la risorsa.
ErrorAdditionalInfo	Informazioni aggiuntive sulla gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
PrometheusRule	Regola di avviso o registrazione di Azure Prometheus.
PrometheusRuleGroupAction	Azione di avviso. Solo pertinente per gli avvisi.
PrometheusRuleGroupResource	Risorsa del gruppo di regole Prometheus.
PrometheusRuleResolveConfiguration	Specifica la configurazione della regola di avviso Prometheus.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

createdByType

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Informazioni aggiuntive sulla gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

PrometheusRule

Regola di avviso o registrazione di Azure Prometheus.

Nome	Tipo	Descrizione
actions	PrometheusRuleGroupAction[]	Azioni eseguite quando la regola di avviso diventa attiva e quando viene risolta una condizione di avviso.
alert	string	Nome della regola di avviso.
annotations	object	La clausola annotazioni specifica un set di etichette informativi che possono essere usate per archiviare informazioni aggiuntive più lunghe, ad esempio descrizioni degli avvisi o collegamenti al runbook. I valori di annotazione possono essere modellizzati.
enabled	boolean	Abilitare/disabilitare la regola.
expression	string	Espressione PromQL da valutare. https://prometheus.io/docs/prometheus/latest/querying/basics/. Valutata periodicamente come specificata da 'intervallo', e il risultato registrato come nuovo set di serie temporali con il nome della metrica come indicato da 'record'.
for	string	La quantità di tempo di avviso deve essere attiva prima dell'attivazione.
labels	object	Etichette da aggiungere o sovrascrivere prima di archiviare il risultato.
record	string	Nome delle metriche registrate.
resolveConfiguration	PrometheusRuleResolveConfiguration	Definisce la configurazione per la risoluzione degli avvisi attivati. Solo pertinente per gli avvisi.
severity	integer	Gravità degli avvisi generati dalla regola. Deve essere compreso tra 0 e 4.

PrometheusRuleGroupAction

Azione di avviso. Solo pertinente per gli avvisi.

Nome	Tipo	Descrizione
actionGroupId	string	ID risorsa del gruppo di azioni da usare.
actionProperties	object	Proprietà di un oggetto gruppo di azioni.

PrometheusRuleGroupResource

Risorsa del gruppo di regole Prometheus.

Nome	Tipo	Descrizione
id	string	ID di risorsa completo per la risorsa. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Posizione geografica in cui vive la risorsa
name	string	nome della risorsa.
properties.clusterName	string	Applicare la regola ai dati da un cluster specifico.
properties.description	string	Descrizione del gruppo di regole.
properties.enabled	boolean	Abilitare/disabilitare il gruppo di regole.
properties.interval	string	Intervallo in cui eseguire il gruppo di regole Prometheus rappresentato in formato di durata ISO 8601. Deve essere compreso tra 1 e 15 minuti
properties.rules	PrometheusRule[]	Definisce le regole nel gruppo di regole Prometheus.
properties.scopes	string[]	Destinazione aree di lavoro di Monitoraggio di Azure id risorsa. Questa versione api è attualmente limitata alla creazione con un ambito. Questo può cambiare in futuro.
systemData	systemData	Metadati di Azure Resource Manager contenenti le informazioni createBy e modificateBy.
tags	object	Tag di risorse.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

PrometheusRuleResolveConfiguration

Specifica la configurazione della regola di avviso Prometheus.

Nome	Tipo	Descrizione
autoResolved	boolean	Abilitare la risoluzione automatica degli avvisi.
timeToResolve	string	Timeout di risoluzione automatica degli avvisi.

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione di risorse (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima risorsa.

Condividi tramite