Prometheus Rule Groups - Update

Referencia

Servicio:: Monitor

Versión de la API:: 2023-03-01

Actualice una definición de grupo de reglas de Prometheus.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
ruleGroupName	path	True	string pattern: ^[^:@/#{}%&+*<>?]+$	Nombre del grupo de reglas.
subscriptionId	path	True	string minLength: 1	Identificador de la suscripción de destino.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre	Tipo	Description
properties.enabled	boolean	marca que indica si el grupo de reglas de Prometheus está habilitado.
tags	object	Etiquetas de recursos

Respuestas

Nombre	Tipo	Description
200 OK	PrometheusRuleGroupResource	De acuerdo
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Ejemplos

Patch a PrometheusRuleGroup

Solicitud de ejemplo

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
  }
}

Respuesta de muestra

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": 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"
  }
}

Definiciones

Nombre	Description
createdByType	Tipo de identidad que creó el recurso.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
PrometheusRule	Una regla de grabación o alertas de Azure Prometheus.
PrometheusRuleGroupAction	Una acción de alerta. Solo es relevante para las alertas.
PrometheusRuleGroupResource	Recurso del grupo de reglas de Prometheus.
PrometheusRuleGroupResourcePatchParameters	Recurso de grupo de reglas de Prometheus para las operaciones de revisión.
PrometheusRuleResolveConfiguration	Especifica la configuración de la regla de alertas de Prometheus.
systemData	Metadatos relativos a la creación y última modificación del recurso.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

PrometheusRule

Object

Una regla de grabación o alertas de Azure Prometheus.

Nombre	Tipo	Description
actions	PrometheusRuleGroupAction[]	Acciones que se realizan cuando la regla de alerta se activa y cuando se resuelve una condición de alerta.
alert	string	Nombre de la regla de alerta.
annotations	object	La cláusula annotations especifica un conjunto de etiquetas informativas que se pueden usar para almacenar información adicional más larga, como descripciones de alertas o vínculos de runbook. Los valores de anotación se pueden crear plantillas.
enabled	boolean	Habilitar o deshabilitar regla.
expression	string	Expresión PromQL que se va a evaluar. https://prometheus.io/docs/prometheus/latest/querying/basics/. Se evalúa periódicamente según "interval" y el resultado registrado como un nuevo conjunto de series temporales con el nombre de la métrica tal como se indica en "record".
for	string (duration)	La cantidad de tiempo que la alerta debe estar activa antes de activarse.
labels	object	Etiquetas para agregar o sobrescribir antes de almacenar el resultado.
record	string	Nombre de las métricas grabadas.
resolveConfiguration	PrometheusRuleResolveConfiguration	Define la configuración para resolver alertas desencadenadas. Solo es relevante para las alertas.
severity	integer (int32)	Gravedad de las alertas desencadenadas por la regla. Debe estar entre 0 y 4.

PrometheusRuleGroupAction

Object

Una acción de alerta. Solo es relevante para las alertas.

Nombre	Tipo	Description
actionGroupId	string	Identificador de recurso del grupo de acciones que se va a usar.
actionProperties	object	Propiedades de un objeto de grupo de acciones.

PrometheusRuleGroupResource

Object

Recurso del grupo de reglas de Prometheus.

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Ubicación geográfica donde reside el recurso
name	string	Nombre del recurso
properties.clusterName	string	Aplique una regla a los datos de un clúster específico.
properties.description	string	Descripción del grupo de reglas.
properties.enabled	boolean	Habilite o deshabilite el grupo de reglas.
properties.interval	string (duration)	Intervalo en el que se ejecuta el grupo de reglas de Prometheus representado en formato de duración ISO 8601. Debe estar entre 1 y 15 minutos.
properties.rules	PrometheusRule[]	Define las reglas del grupo de reglas de Prometheus.
properties.scopes	string[]	Identificadores de recursos de las áreas de trabajo de Azure Monitor de destino. Esta versión de API se limita actualmente a la creación con un ámbito. Esto puede cambiar en el futuro.
systemData	systemData	Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
tags	object	Etiquetas de recursos.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

PrometheusRuleGroupResourcePatchParameters

Object

Recurso de grupo de reglas de Prometheus para las operaciones de revisión.

Nombre	Tipo	Description
properties.enabled	boolean	marca que indica si el grupo de reglas de Prometheus está habilitado.
tags	object	Etiquetas de recursos

PrometheusRuleResolveConfiguration

Object

Especifica la configuración de la regla de alertas de Prometheus.

Nombre	Tipo	Description
autoResolved	boolean	Habilite la resolución automática de alertas.
timeToResolve	string (duration)	Tiempo de espera de resolución automática de alertas.

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

Compartir a través de

Prometheus Rule Groups - Update

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Ejemplos

Patch a PrometheusRuleGroup

Solicitud de ejemplo

Respuesta de muestra

Definiciones

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PrometheusRule

PrometheusRuleGroupAction

PrometheusRuleGroupResource

PrometheusRuleGroupResourcePatchParameters

PrometheusRuleResolveConfiguration

systemData