Smart Groups - Change State

Reference

Service:: Monitor

API Version:: 2019-05-05-preview

Change the state of a Smart Group.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups/{smartGroupId}/changeState?api-version=2019-05-05-preview&newState={newState}

URI Parameters

Name	In	Required	Type	Description
smartGroupId	path	True	string	Smart group unique id.
subscriptionId	path	True	string	The ID of the target subscription.
api-version	query	True	api-version	client API version
newState	query	True	AlertState	New state of the alert.

Responses

Name	Type	Description
200 OK	smartGroup	OK. Smart Group state updated. Headers x-ms-request-id: string
Other Status Codes	errorResponse	Error response describing why the operation failed.

Name

Type

Description

200 OK

smartGroup

OK. Smart Group state updated.

Headers

x-ms-request-id: string

Other Status Codes

errorResponse

Error response describing why the operation failed.

Examples

changestate

Sample Request

POST https://management.azure.com/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/providers/Microsoft.AlertsManagement/smartGroups/a808445e-bb38-4751-85c2-1b109ccc1059/changeState?api-version=2019-05-05-preview&newState=Acknowledged

import com.azure.core.util.Context;
import com.azure.resourcemanager.alertsmanagement.models.AlertState;

/** Samples for SmartGroups ChangeState. */
public final class Main {
    /*
     * x-ms-original-file: specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2019-05-05-preview/examples/SmartGroups_ChangeState.json
     */
    /**
     * Sample code: changestate.
     *
     * @param manager Entry point to AlertsManagementManager.
     */
    public static void changestate(com.azure.resourcemanager.alertsmanagement.AlertsManagementManager manager) {
        manager
            .smartGroups()
            .changeStateWithResponse("a808445e-bb38-4751-85c2-1b109ccc1059", AlertState.ACKNOWLEDGED, Context.NONE);
    }
}

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

from azure.identity import DefaultAzureCredential
from azure.mgmt.alertsmanagement import AlertsManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-alertsmanagement
# USAGE
    python smart_groups_change_state.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(),
        subscription_id="dd91de05-d791-4ceb-b6dc-988682dc7d72",
    )

    response = client.smart_groups.change_state(
        smart_group_id="a808445e-bb38-4751-85c2-1b109ccc1059",
        new_state="Acknowledged",
    )
    print(response)


# x-ms-original-file: specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2019-05-05-preview/examples/SmartGroups_ChangeState.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

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: https://github.com/Azure/azure-rest-api-specs/blob/6d2438481021a94793b07b226df06d5f3c61d51d/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2019-05-05-preview/examples/SmartGroups_ChangeState.json
func ExampleSmartGroupsClient_ChangeState() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armalertsmanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSmartGroupsClient().ChangeState(ctx, "a808445e-bb38-4751-85c2-1b109ccc1059", armalertsmanagement.AlertStateAcknowledged, nil)
	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.SmartGroup = armalertsmanagement.SmartGroup{
	// 	Name: to.Ptr("cpu alert"),
	// 	Type: to.Ptr("Microsoft.AlertsManagement/smartGroups"),
	// 	ID: to.Ptr("/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/providers/Microsoft.AlertsManagement/smartGroups/a808445e-bb38-4751-85c2-1b109ccc1059"),
	// 	Properties: &armalertsmanagement.SmartGroupProperties{
	// 		AlertSeverities: []*armalertsmanagement.SmartGroupAggregatedProperty{
	// 			{
	// 				Name: to.Ptr("Sev3"),
	// 				Count: to.Ptr[int64](1942),
	// 		}},
	// 		AlertStates: []*armalertsmanagement.SmartGroupAggregatedProperty{
	// 			{
	// 				Name: to.Ptr("New"),
	// 				Count: to.Ptr[int64](1941),
	// 			},
	// 			{
	// 				Name: to.Ptr("Acknowledged"),
	// 				Count: to.Ptr[int64](1),
	// 		}},
	// 		AlertsCount: to.Ptr[int64](1942),
	// 		LastModifiedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-13T06:30:09.000Z"); return t}()),
	// 		LastModifiedUserName: to.Ptr("System"),
	// 		MonitorConditions: []*armalertsmanagement.SmartGroupAggregatedProperty{
	// 			{
	// 				Name: to.Ptr("Fired"),
	// 				Count: to.Ptr[int64](1942),
	// 		}},
	// 		MonitorServices: []*armalertsmanagement.SmartGroupAggregatedProperty{
	// 			{
	// 				Name: to.Ptr("Application Insights"),
	// 				Count: to.Ptr[int64](1942),
	// 		}},
	// 		ResourceGroups: []*armalertsmanagement.SmartGroupAggregatedProperty{
	// 			{
	// 				Name: to.Ptr("alertscorrelationrg"),
	// 				Count: to.Ptr[int64](1942),
	// 		}},
	// 		ResourceTypes: []*armalertsmanagement.SmartGroupAggregatedProperty{
	// 			{
	// 				Name: to.Ptr("components"),
	// 				Count: to.Ptr[int64](1942),
	// 		}},
	// 		Resources: []*armalertsmanagement.SmartGroupAggregatedProperty{
	// 			{
	// 				Name: to.Ptr("/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/resourcegroups/alertscorrelationrg/providers/microsoft.insights/components/alertscorrelationworkerrole_int"),
	// 				Count: to.Ptr[int64](1942),
	// 		}},
	// 		Severity: to.Ptr(armalertsmanagement.SeveritySev3),
	// 		SmartGroupState: to.Ptr(armalertsmanagement.StateAcknowledged),
	// 		StartDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-06T12:35:09.000Z"); return t}()),
	// 	},
	// }
}

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

using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.AlertsManagement;
using Azure.ResourceManager.AlertsManagement.Models;

// Generated from example definition: specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2019-05-05-preview/examples/SmartGroups_ChangeState.json
// this example is just showing the usage of "SmartGroups_ChangeState" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SmartGroupResource created on azure
// for more information of creating SmartGroupResource, please refer to the document of SmartGroupResource
string subscriptionId = "dd91de05-d791-4ceb-b6dc-988682dc7d72";
Guid smartGroupId = Guid.Parse("a808445e-bb38-4751-85c2-1b109ccc1059");
ResourceIdentifier smartGroupResourceId = SmartGroupResource.CreateResourceIdentifier(subscriptionId, smartGroupId);
SmartGroupResource smartGroup = client.GetSmartGroupResource(smartGroupResourceId);

// invoke the operation
ServiceAlertState newState = ServiceAlertState.Acknowledged;
SmartGroupResource result = await smartGroup.ChangeStateAsync(newState);

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SmartGroupData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Sample Response

Status code:: 200

{
  "properties": {
    "alertsCount": 1942,
    "smartGroupState": "Acknowledged",
    "severity": "Sev3",
    "startDateTime": "2018-06-06T12:35:09Z",
    "lastModifiedDateTime": "2018-06-13T06:30:09Z",
    "lastModifiedUserName": "System",
    "resources": [
      {
        "name": "/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/resourcegroups/alertscorrelationrg/providers/microsoft.insights/components/alertscorrelationworkerrole_int",
        "count": 1942
      }
    ],
    "resourceTypes": [
      {
        "name": "components",
        "count": 1942
      }
    ],
    "resourceGroups": [
      {
        "name": "alertscorrelationrg",
        "count": 1942
      }
    ],
    "monitorServices": [
      {
        "name": "Application Insights",
        "count": 1942
      }
    ],
    "monitorConditions": [
      {
        "name": "Fired",
        "count": 1942
      }
    ],
    "alertStates": [
      {
        "name": "New",
        "count": 1941
      },
      {
        "name": "Acknowledged",
        "count": 1
      }
    ],
    "alertSeverities": [
      {
        "name": "Sev3",
        "count": 1942
      }
    ]
  },
  "id": "/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/providers/Microsoft.AlertsManagement/smartGroups/a808445e-bb38-4751-85c2-1b109ccc1059",
  "type": "Microsoft.AlertsManagement/smartGroups",
  "name": "cpu alert"
}

Definitions

Name	Description
AlertState	New state of the alert.
api-version	client API version
errorResponse	An error response from the service.
errorResponseBody	Details of error response.
Severity	Severity of smart group is the highest(Sev0 >... > Sev4) severity of all the alerts in the group.
smartGroup	Set of related alerts grouped together smartly by AMS.
smartGroupAggregatedProperty	Aggregated property of each type
State	Smart group state

AlertState

New state of the alert.

Name	Type	Description
Acknowledged	string
Closed	string
New	string

api-version

client API version

Name	Type	Description
2019-05-05-preview	string

errorResponse

An error response from the service.

Name	Type	Description
error	errorResponseBody	Details of error response.

errorResponseBody

Details of error response.

Name	Type	Description
code	string	Error code, intended to be consumed programmatically.
details	errorResponseBody[]	A list of additional details about the error.
message	string	Description of the error, intended for display in user interface.
target	string	Target of the particular error, for example name of the property.

Severity

Severity of smart group is the highest(Sev0 >... > Sev4) severity of all the alerts in the group.

Name	Type	Description
Sev0	string
Sev1	string
Sev2	string
Sev3	string
Sev4	string

smartGroup

Set of related alerts grouped together smartly by AMS.

Name	Type	Description
id	string	Azure resource Id
name	string	Azure resource name
properties.alertSeverities	smartGroupAggregatedProperty[]	Summary of alertSeverities in the smart group
properties.alertStates	smartGroupAggregatedProperty[]	Summary of alertStates in the smart group
properties.alertsCount	integer	Total number of alerts in smart group
properties.lastModifiedDateTime	string	Last updated time of smart group. Date-Time in ISO-8601 format.
properties.lastModifiedUserName	string	Last modified by user name.
properties.monitorConditions	smartGroupAggregatedProperty[]	Summary of monitorConditions in the smart group
properties.monitorServices	smartGroupAggregatedProperty[]	Summary of monitorServices in the smart group
properties.nextLink	string	The URI to fetch the next page of alerts. Call ListNext() with this URI to fetch the next page alerts.
properties.resourceGroups	smartGroupAggregatedProperty[]	Summary of target resource groups in the smart group
properties.resourceTypes	smartGroupAggregatedProperty[]	Summary of target resource types in the smart group
properties.resources	smartGroupAggregatedProperty[]	Summary of target resources in the smart group
properties.severity	Severity	Severity of smart group is the highest(Sev0 >... > Sev4) severity of all the alerts in the group.
properties.smartGroupState	State	Smart group state
properties.startDateTime	string	Creation time of smart group. Date-Time in ISO-8601 format.
type	string	Azure resource type

smartGroupAggregatedProperty

Aggregated property of each type

Name	Type	Description
count	integer	Total number of items of type.
name	string	Name of the type.

State

Smart group state

Name	Type	Description
Acknowledged	string
Closed	string
New	string

Share via

Smart Groups - Change State

URI Parameters

Responses

Examples

changestate

Sample Request

Sample Response

Definitions

AlertState

api-version

errorResponse

errorResponseBody

Severity

smartGroup

smartGroupAggregatedProperty

State

Additional resources