Alerts - Change State Tenant

Szolgáltatás:

Monitor

API-verzió:

2025-05-25-preview

Riasztás állapotának módosítása.

POST https://management.azure.com/providers/Microsoft.AlertsManagement/alerts/{alertId}/changestate?api-version=2025-05-25-preview&newState={newState}

URI-paraméterek

Name	In	Kötelező	Típus	Description
alertId	path	True	string	Riasztási példány egyedi azonosítója.
api-version	query	True	string minLength: 1	A művelethez használandó API-verzió.
newState	query	True	AlertState	A riasztás új állapota.

Kérelem törzse

Name	Típus	Description
comments	string

Válaszok

Name	Típus	Description
200 OK	Alert	Az Azure-művelet sikeresen befejeződött.
Other Status Codes	AlertsManagementErrorResponse	Váratlan hibaválasz.

Biztonság

azure_auth

Azure Active Directory OAuth2-folyamat.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

Resolve

Mintakérelem

HTTP

POST https://management.azure.com/providers/Microsoft.AlertsManagement/alerts/66114d64-d9d9-478b-95c9-b789d6502100/changestate?api-version=2025-05-25-preview&newState=Acknowledged

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.alertsmanagement import AlertsManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-alertsmanagement
# USAGE
    python alerts_change_state_tenant.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = AlertsManagementClient(
        credential=DefaultAzureCredential(),
    )

    response = client.alerts.change_state_tenant(
        alert_id="66114d64-d9d9-478b-95c9-b789d6502100",
        new_state="Acknowledged",
    )
    print(response)


# x-ms-original-file: 2025-05-25-preview/Alerts_ChangeStateTenant.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armalertsmanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/alertsmanagement/armalertsmanagement"
)

// Generated from example definition: 2025-05-25-preview/Alerts_ChangeStateTenant.json
func ExampleAlertsClient_ChangeStateTenant() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armalertsmanagement.NewClientFactory("<scope>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAlertsClient().ChangeStateTenant(ctx, "66114d64-d9d9-478b-95c9-b789d6502100", armalertsmanagement.AlertStateAcknowledged, &armalertsmanagement.AlertsClientChangeStateTenantOptions{
		Comment: &armalertsmanagement.Comments{}})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armalertsmanagement.AlertsClientChangeStateTenantResponse{
	// 	Alert: &armalertsmanagement.Alert{
	// 		Name: to.Ptr("cpu alert"),
	// 		Type: to.Ptr("Microsoft.AlertsManagement/alerts"),
	// 		ID: to.Ptr("/subscriptions/3b540246-808d-4331-99aa-917b808a9166/resourcegroups/servicedeskresourcegroup/providers/microsoft.insights/components/servicedeskappinsight/providers/Microsoft.AlertsManagement/alerts/66114d64-d9d9-478b-95c9-b789d6502100"),
	// 		Properties: &armalertsmanagement.AlertProperties{
	// 			Context: map[string]any{
	// 			},
	// 			EgressConfig: map[string]any{
	// 			},
	// 			Essentials: &armalertsmanagement.Essentials{
	// 				Description: to.Ptr("description of the alert"),
	// 				ActionStatus: &armalertsmanagement.ActionStatus{
	// 					IsSuppressed: to.Ptr(false),
	// 				},
	// 				AlertRule: to.Ptr("https://servisdfsdfappinsight.portal.mms.microsoft.com/#Workspace/overview/settings/details/Edit Alert Rule/details/index?savedSearchId=&scheduleId="),
	// 				AlertState: to.Ptr(armalertsmanagement.AlertStateAcknowledged),
	// 				LastModifiedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-09-13T15:51:02Z"); return t}()),
	// 				LastModifiedUserName: to.Ptr("System"),
	// 				MonitorCondition: to.Ptr(armalertsmanagement.MonitorConditionFired),
	// 				MonitorConditionResolvedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-09-13T15:51:02Z"); return t}()),
	// 				MonitorService: to.Ptr(armalertsmanagement.MonitorServiceApplicationInsights),
	// 				Severity: to.Ptr(armalertsmanagement.SeveritySev3),
	// 				SignalType: to.Ptr(armalertsmanagement.SignalTypeLog),
	// 				SmartGroupID: to.Ptr("23d6b2ce-8c54-468f-aff0-sd32aebb7e56"),
	// 				SmartGroupingReason: to.Ptr("Occurred frequently with other alerts"),
	// 				SourceCreatedID: to.Ptr("6cd6b2ce-8c54-468f-aff0-9d12aebb7e49"),
	// 				StartDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-09-13T15:51:02Z"); return t}()),
	// 				TargetResource: to.Ptr("/subscriptions/3b540246-808d-4331-99aa-917b808a9166/resourcegroups/servicedeskresourcegroup/providers/microsoft.insights/components/servicedeskappinsight"),
	// 				TargetResourceGroup: to.Ptr("servicedeskresourcegroup"),
	// 				TargetResourceName: to.Ptr("servicedeskappinsight"),
	// 				TargetResourceType: to.Ptr("components"),
	// 			},
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { AlertsManagementClient } = require("@azure/arm-alertsmanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to change the state of an alert.
 *
 * @summary change the state of an alert.
 * x-ms-original-file: 2025-05-25-preview/Alerts_ChangeStateTenant.json
 */
async function resolve() {
  const credential = new DefaultAzureCredential();
  const client = new AlertsManagementClient(credential);
  const result = await client.alerts.changeStateTenant(
    "66114d64-d9d9-478b-95c9-b789d6502100",
    "Acknowledged",
    { comment: {} },
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Mintaválasz

Állapotkód:

200

{
  "name": "cpu alert",
  "type": "Microsoft.AlertsManagement/alerts",
  "id": "/subscriptions/3b540246-808d-4331-99aa-917b808a9166/resourcegroups/servicedeskresourcegroup/providers/microsoft.insights/components/servicedeskappinsight/providers/Microsoft.AlertsManagement/alerts/66114d64-d9d9-478b-95c9-b789d6502100",
  "properties": {
    "context": {},
    "egressConfig": {},
    "essentials": {
      "description": "description of the alert",
      "actionStatus": {
        "isSuppressed": false
      },
      "alertRule": "https://servisdfsdfappinsight.portal.mms.microsoft.com/#Workspace/overview/settings/details/Edit Alert Rule/details/index?savedSearchId=&scheduleId=",
      "alertState": "Acknowledged",
      "lastModifiedDateTime": "2018-09-13T15:51:02Z",
      "lastModifiedUserName": "System",
      "monitorCondition": "Fired",
      "monitorConditionResolvedDateTime": "2018-09-13T15:51:02Z",
      "monitorService": "Application Insights",
      "severity": "Sev3",
      "signalType": "Log",
      "smartGroupId": "23d6b2ce-8c54-468f-aff0-sd32aebb7e56",
      "smartGroupingReason": "Occurred frequently with other alerts",
      "sourceCreatedId": "6cd6b2ce-8c54-468f-aff0-9d12aebb7e49",
      "startDateTime": "2018-09-13T15:51:02Z",
      "targetResource": "/subscriptions/3b540246-808d-4331-99aa-917b808a9166/resourcegroups/servicedeskresourcegroup/providers/microsoft.insights/components/servicedeskappinsight",
      "targetResourceGroup": "servicedeskresourcegroup",
      "targetResourceName": "servicedeskappinsight",
      "targetResourceType": "components"
    }
  }
}

Definíciók

Name	Description
ActionStatus	Művelet állapota
Alert	A riasztáskezelési szolgáltatásban létrehozott riasztás.
AlertProperties	Riasztási tulajdonság táska
AlertsManagementErrorResponse	Hibaválasz a szolgáltatástól.
AlertState
Comments	A riasztás állapotának okának módosítása
ErrorResponseBody	A hibaválasz részletei.
Essentials	Ez az objektum konzisztens mezőket tartalmaz a különböző figyelési szolgáltatásokban.
MonitorCondition
MonitorService
Severity
SignalType	A riasztás alapjául szolgáló jel típusa, amely lehet metrika, napló vagy tevékenységnapló.

ActionStatus

Tárgy

Művelet állapota

Name	Típus	Description
isSuppressed	boolean	Az az érték, amely azt jelzi, hogy a riasztás le van-e tiltva.

Alert

Tárgy

A riasztáskezelési szolgáltatásban létrehozott riasztás.

Name	Típus	Description
id	string	Azure-erőforrás azonosítója
name	string	Azure-erőforrás neve
properties	AlertProperties	Riasztási tulajdonság táska
type	string	Azure-erőforrástípus

AlertProperties

Tárgy

Riasztási tulajdonság táska

Name	Típus	Description
context		A figyelési szolgáltatásra vonatkozó információk, amelyek további környezetfüggő részleteket tartalmaznak a riasztásról.
customProperties	object	Egyéni tulajdonságok, amelyek bármilyen felhasználó által definiált kulcs-érték párt tartalmazhatnak
egressConfig		Konfiguráció, amely az adatok portálon való megjelenítésére szolgál.
essentials	Essentials	Ez az objektum konzisztens mezőket tartalmaz a különböző figyelési szolgáltatásokban.

AlertsManagementErrorResponse

Tárgy

Hibaválasz a szolgáltatástól.

Name	Típus	Description
error	ErrorResponseBody	A hibaválasz részletei.

AlertState

Felsorolás

Érték	Description
New	Új
Acknowledged	Elfogadva
Closed	Closed

Comments

Tárgy

A riasztás állapotának okának módosítása

Name	Típus	Description
comments	string

ErrorResponseBody

Tárgy

A hibaválasz részletei.

Name	Típus	Description
code	string	Hibakód, programozott felhasználásra szánt.
details	ErrorResponseBody[]	A hiba további részleteinek listája.
message	string	A hiba leírása, a felhasználói felületen való megjelenítésre.
target	string	Az adott hiba célja, például a tulajdonság neve.

Essentials

Tárgy

Ez az objektum konzisztens mezőket tartalmaz a különböző figyelési szolgáltatásokban.

Name	Típus	Description
actionStatus	ActionStatus	Művelet állapota
alertRule	string	Rule (monitor), amely riasztási példányt aktivált. A figyelési szolgáltatástól függően ez az ARM-azonosító vagy a szabály neve lehet.
alertState	AlertState	Riasztási objektum állapota, amelyet a felhasználó módosíthat.
description	string	Riasztás leírása.
lastModifiedDateTime	string (date-time)	A riasztási példány utolsó módosításának időpontja (ISO-8601 formátum).
lastModifiedUserName	string	A riasztást utoljára módosító felhasználó a figyelési szolgáltatásfrissítések esetén a felhasználó "rendszer", ellenkező esetben a felhasználó neve lesz.
monitorCondition	MonitorCondition	Lehet "Aktiválva" vagy "Megoldva", amely azt jelzi, hogy a mögöttes feltételek átlépték-e a riasztási szabály meghatározott küszöbértékeit.
monitorConditionResolvedDateTime	string (date-time)	A riasztási példány feloldott ideje (ISO-8601 formátum). Ez akkor frissül, amikor a figyelési szolgáltatás feloldja a riasztási példányt, mert a szabály feltétele már nem teljesül.
monitorService	MonitorService	Figyelési szolgáltatás, amelyen a szabály (monitor) be van állítva.
severity	Severity	A riasztás súlyossága: Sev0 a legmagasabb, Sev4 pedig a legalacsonyabb.
signalType	SignalType	A riasztás alapjául szolgáló jel típusa, amely lehet metrika, napló vagy tevékenységnapló.
smartGroupId	string	Az intelligens csoport egyedi azonosítója
smartGroupingReason	string	Részletes indoklás, amely leírja a riasztási példány intelligens csoporthoz való hozzáadásának okát
sourceCreatedId	string	A figyelési szolgáltatás által létrehozott egyedi azonosító az egyes riasztási példányokhoz. Ezzel nyomon követhető a probléma a monitor szolgáltatásnál, Nagios, Zabbix, SCOM stb. esetén.
startDateTime	string (date-time)	A riasztási példány létrehozásának ideje (ISO-8601 formátum).
targetResource	string	Cél ARM-erőforrás, amelyen a riasztás létrejött.
targetResourceGroup	string	A cél ARM-erőforrás erőforráscsoportja, amelyen a riasztás létrejött.
targetResourceName	string	Annak a cél ARM-erőforrásnak a neve, amelyen a riasztás létrejött.
targetResourceType	string	A cél ARM-erőforrás erőforrástípusa, amelyen a riasztás létrejött.

MonitorCondition

Felsorolás

Érték	Description
Fired	Kirúgott
Resolved	Resolved

MonitorService

Felsorolás

Érték	Description
Application Insights	Application Insights
ActivityLog Administrative	ActivityLog Adminisztratív
ActivityLog Security	ActivityLog biztonság
ActivityLog Recommendation	ActivityLog Ajánlás
ActivityLog Policy	ActivityLog szabályzat
ActivityLog Autoscale	ActivityLog Autoscale
Log Analytics	Log Analytics
Nagios	Nagios
Platform	Plattform
SCOM	SCOM
ServiceHealth	ServiceHealth
SmartDetector	SmartDetector
VM Insights	VM betekintések
Zabbix	Zabbix
Resource Health	Resource Health

Severity

Felsorolás

Érték	Description
Sev0	Sev0
Sev1	Sev1
Sev2	Sev2
Sev3	Sev3
Sev4	Sev4

SignalType

Felsorolás

A riasztás alapjául szolgáló jel típusa, amely lehet metrika, napló vagy tevékenységnapló.

Érték	Description
Metric	Mértékegység
Log	Log
Unknown	Ismeretlen