Prometheus Rule Groups - Update

Referentie

Service:: Monitor

API-versie:: 2023-03-01

Werk de definitie van een Prometheus-regelgroep bij.

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
ruleGroupName	path	True	string	De naam van de regelgroep. Regex-patroon: `^[^:@/#{}%&+*<>?]+$`
subscriptionId	path	True	string	De id van het doelabonnement.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Type	Description
properties.enabled	boolean	de vlag die aangeeft of de Prometheus-regelgroep is ingeschakeld.
tags	object	Resourcetags

Antwoorden

Name	Type	Description
200 OK	PrometheusRuleGroupResource	OK
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Voorbeelden

Patch a PrometheusRuleGroup

Voorbeeldaanvraag

HTTP

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

{
  "tags": {
    "tag1": "tagValueFromPatch"
  },
  "properties": {
    "enabled": false
  }
}

Voorbeeldrespons

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": false,
    "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"
            }
          }
        ]
      }
    ]
  },
  "tags": {
    "tag1": "tagValueFromPatch"
  }
}

Definities

Name	Description
createdByType	Het type identiteit waarmee de resource is gemaakt.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
PrometheusRule	Een Azure Prometheus-waarschuwings- of opnameregel.
PrometheusRuleGroupAction	Een waarschuwingsactie. Alleen relevant voor waarschuwingen.
PrometheusRuleGroupResource	De resource van de Prometheus-regelgroep.
PrometheusRuleGroupResourcePatchParameters	De prometheus-regelgroepresource voor patchbewerkingen.
PrometheusRuleResolveConfiguration	Hiermee geeft u de configuratie van de Prometheus-waarschuwingsregel op.
systemData	Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het type aanvullende informatie.

ErrorDetail

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Aanvullende informatie over de fout.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

PrometheusRule

Een Azure Prometheus-waarschuwings- of opnameregel.

Name	Type	Description
actions	PrometheusRuleGroupAction[]	Acties die worden uitgevoerd wanneer de waarschuwingsregel actief wordt en wanneer een waarschuwingsvoorwaarde is opgelost.
alert	string	Naam van waarschuwingsregel.
annotations	object	De component aantekeningen specificeert een set informatieve labels die kunnen worden gebruikt voor het opslaan van langere aanvullende informatie, zoals waarschuwingsbeschrijvingen of runbookkoppelingen. De aantekeningswaarden kunnen worden gesjabloond.
enabled	boolean	Regel in-/uitschakelen.
expression	string	De PromQL-expressie die moet worden geëvalueerd. https://prometheus.io/docs/prometheus/latest/querying/basics/. Periodiek geëvalueerd volgens 'interval', en het resultaat wordt geregistreerd als een nieuwe set tijdreeksen met de metrische naam zoals opgegeven door 'record'.
for	string	De tijdsduur van de waarschuwing moet actief zijn voordat deze wordt geactiveerd.
labels	object	Labels die moeten worden toegevoegd of overschreven voordat het resultaat wordt opgeslagen.
record	string	Naam van opgenomen metrische gegevens.
resolveConfiguration	PrometheusRuleResolveConfiguration	Definieert de configuratie voor het oplossen van geactiveerde waarschuwingen. Alleen relevant voor waarschuwingen.
severity	integer	De ernst van de waarschuwingen die door de regel worden geactiveerd. Moet tussen 0 en 4 zijn.

PrometheusRuleGroupAction

Een waarschuwingsactie. Alleen relevant voor waarschuwingen.

Name	Type	Description
actionGroupId	string	De resource-id van de actiegroep die moet worden gebruikt.
actionProperties	object	De eigenschappen van een actiegroepobject.

PrometheusRuleGroupResource

De resource van de Prometheus-regelgroep.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	De geografische locatie waar de resource zich bevindt
name	string	De naam van de resource
properties.clusterName	string	Regel toepassen op gegevens van een specifiek cluster.
properties.description	string	Beschrijving van regelgroep.
properties.enabled	boolean	Regelgroep in-/uitschakelen.
properties.interval	string	Het interval waarin de Prometheus-regelgroep moet worden uitgevoerd, weergegeven in iso 8601-duurnotatie. Moet tussen 1 en 15 minuten zijn
properties.rules	PrometheusRule[]	Hiermee definieert u de regels in de regelgroep Prometheus.
properties.scopes	string[]	Resource-id's voor Azure Monitor-werkruimten. Deze API-versie is momenteel beperkt tot het maken met één bereik. Dit kan in de toekomst veranderen.
systemData	systemData	Azure Resource Manager metagegevens met informatie over createdBy en modifiedBy.
tags	object	Resourcetags.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

PrometheusRuleGroupResourcePatchParameters

De prometheus-regelgroepresource voor patchbewerkingen.

Name	Type	Description
properties.enabled	boolean	de vlag die aangeeft of de Prometheus-regelgroep is ingeschakeld.
tags	object	Resourcetags

PrometheusRuleResolveConfiguration

Hiermee geeft u de configuratie van de Prometheus-waarschuwingsregel op.

Name	Type	Description
autoResolved	boolean	Automatische oplossing van waarschuwingen inschakelen.
timeToResolve	string	Time-out voor automatische oplossing van waarschuwingen.

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

Name	Type	Description
createdAt	string	Het tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource het laatst heeft gewijzigd.

Delen via