Alerts - List Enrichments

Service:

Monitor

API Version:

2023-07-12-preview

Visa en lista över berikanden för en avisering. Den returnerar en samling med ett objekt med namnet default.

GET https://management.azure.com/{scope}/providers/Microsoft.AlertsManagement/alerts/{alertId}/enrichments?api-version=2023-07-12-preview

URI-parametrar

Name	I	Obligatorisk	Typ	Description
alertId	path	True	string	Unikt ID för en aviseringsinstans.
scope	path	True	string	scope här är resourceId som aviseringen skapas för.
api-version	query	True	string	Den API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	alertEnrichmentsList	OK. Returnerar berikandena för den angivna aviseringen.
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Exempel

Resolve

Sample Request

HTTP

GET https://management.azure.com/subscriptions/72fa99ef-9c84-4a7c-b343-ec62da107d81/providers/Microsoft.AlertsManagement/alerts/66114d64-d9d9-478b-95c9-b789d6502101/enrichments?api-version=2023-07-12-preview

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/9e261de7-c804-4b9d-9ebf-6f50fe350a9a/providers/Microsoft.AlertsManagement/alerts/66114d64-d9d9-478b-95c9-b789d6502101/enrichments/default",
      "type": "Microsoft.AlertsManagement/alerts/enrichments",
      "name": "default",
      "properties": {
        "alertId": "66114d64-d9d9-478b-95c9-b789d6502101",
        "enrichments": [
          {
            "title": "Number of OOM killed events by container",
            "description": "Enrichment description",
            "status": "Succeeded",
            "type": "PrometheusInstantQuery",
            "grafanaExplorePath": "/explore?left=%7B%22datasource%22...",
            "linkToApi": "https://test-3sxl.eastus.prometheus.monitor.azure.com/api/v1/query_range?...",
            "datasources": [
              "/subscriptions/72fa99ef-9c84-4a7c-b343-ec62da107d81/resourceGroups/SyntheticRules/providers/microsoft.monitor/accounts/canaryamw"
            ],
            "query": "sum by (cluster,container,replicaset,namespace)(label_replace( kube_pod_container_status_last_terminated_reason{reason='OOMKilled', cluster='cluster1', namespace='namespace1'}'}, 'replicaset', '$1', 'pod', '(.*)(-[a-z0-9]{5})$')) > 0",
            "time": "2015-07-01T20:10:51.781Z"
          },
          {
            "title": "Number of OOM killed events by container",
            "description": "Enrichment description",
            "status": "Succeeded",
            "type": "PrometheusRangeQuery",
            "linkToApi": "https://test-3sxl.eastus.prometheus.monitor.azure.com/api/v1/query_range?...",
            "grafanaExplorePath": "/explore?left=%7B%22datasource%22...",
            "datasources": [
              "/subscriptions/72fa99ef-9c84-4a7c-b343-ec62da107d81/resourceGroups/SyntheticRules/providers/microsoft.monitor/accounts/canaryamw"
            ],
            "query": "sum by (cluster,container,replicaset,namespace)(label_replace( kube_pod_container_status_last_terminated_reason{reason='OOMKilled', cluster='cluster1', namespace='namespace'}'}, 'replicaset', '$1', 'pod', '(.*)(-[a-z0-9]{5})$')) > 0",
            "start": "2015-07-01T20:10:51.781Z",
            "end": "2015-07-01T20:20:51.781Z",
            "step": "PT15S"
          },
          {
            "title": "Number of OOM killed events by container",
            "description": "Enrichment description",
            "status": "Failed",
            "type": "PrometheusRangeQuery",
            "linkToApi": "https://test-3sxl.eastus.prometheus.monitor.azure.com/api/v1/query_range?...",
            "grafanaExplorePath": "/explore?left=%7B%22datasource%22...",
            "errorMessage": "Calling Prometheus query API failed",
            "datasources": [
              "/subscriptions/72fa99ef-9c84-4a7c-b343-ec62da107d81/resourceGroups/SyntheticRules/providers/microsoft.monitor/accounts/canaryamw"
            ],
            "query": "sum by (cluster,container,replicaset,namespace)(label_replace( kube_pod_container_status_last_terminated_reason{reason='OOMKilled', cluster='cluster1', namespace='namespace'}'}, 'replicaset', '$1', 'pod', '(.*)(-[a-z0-9]{5})$')) > 0",
            "start": "2015-07-01T20:10:51.781Z",
            "end": "2015-07-01T20:20:51.781Z",
            "step": "PT15S"
          }
        ]
      }
    }
  ]
}

Definitioner

Name	Description
alertEnrichmentProperties	Egenskaper för aviseringsberikningsobjektet.
alertEnrichmentResponse	Aviseringens berikning.
alertEnrichmentsList	Ange aviseringens berikning.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar

alertEnrichmentProperties

Egenskaper för aviseringsberikningsobjektet.

Name	Typ	Description
alertId	string	Unikt ID (GUID) för aviseringen som berikanden hämtas för.
enrichments	alertEnrichmentItem[]	Berikningsinformation

alertEnrichmentResponse

Aviseringens berikning.

Name	Typ	Description
id	string	Resurs-ID för Azure
name	string	Azure-resursnamn
properties	alertEnrichmentProperties	Egenskaper för aviseringsberikningsobjektet.
type	string	Azure-resurstyp

alertEnrichmentsList

Ange aviseringens berikning.

Name	Typ	Description
nextLink	string	Begärande-URL som kan användas för att fråga nästa sida.
value	alertEnrichmentResponse[]	Visa en lista över aviseringens berikanden

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Den ytterligare informationen.
type	string	Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.