Smart Groups - Get All

Reference

Service:: Monitor

API Version:: 2019-05-05-preview

Get all Smart Groups within a specified subscription
List all the Smart Groups within a specified subscription.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups?api-version=2019-05-05-preview

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups?targetResource={targetResource}&targetResourceGroup={targetResourceGroup}&targetResourceType={targetResourceType}&monitorService={monitorService}&monitorCondition={monitorCondition}&severity={severity}&smartGroupState={smartGroupState}&timeRange={timeRange}&pageCount={pageCount}&sortBy={sortBy}&sortOrder={sortOrder}&api-version=2019-05-05-preview

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string	The ID of the target subscription.
api-version	query	True	api-version	client API version
monitorCondition	query		MonitorCondition	Filter by monitor condition which is either 'Fired' or 'Resolved'. Default value is to select all.
monitorService	query		MonitorService	Filter by monitor service which generates the alert instance. Default value is select all.
pageCount	query		integer int64	Determines number of alerts returned per page in response. Permissible value is between 1 to 250. When the "includeContent" filter is selected, maximum value allowed is 25. Default value is 25.
severity	query		Severity	Filter by severity. Default value is select all.
smartGroupState	query		AlertState	Filter by state of the smart group. Default value is to select all.
sortBy	query		SmartGroupsSortByFields	Sort the query results by input field. Default value is sort by 'lastModifiedDateTime'.
sortOrder	query		SortOrder	Sort the query results order in either ascending or descending. Default value is 'desc' for time fields and 'asc' for others.
targetResource	query		string	Filter by target resource( which is full ARM ID) Default value is select all.
targetResourceGroup	query		string	Filter by target resource group name. Default value is select all.
targetResourceType	query		string	Filter by target resource type. Default value is select all.
timeRange	query		TimeRange	Filter by time range by below listed values. Default value is 1 day.

Responses

Name	Type	Description
200 OK	smartGroupsList	OK. Returns list of all smartGroups.
Other Status Codes	errorResponse	Error response describing why the operation failed.

Examples

List

Sample Request

GET https://management.azure.com/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/providers/Microsoft.AlertsManagement/smartGroups?api-version=2019-05-05-preview

import com.azure.core.util.Context;

/** Samples for SmartGroups List. */
public final class Main {
    /*
     * x-ms-original-file: specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2019-05-05-preview/examples/SmartGroups_List.json
     */
    /**
     * Sample code: List.
     *
     * @param manager Entry point to AlertsManagementManager.
     */
    public static void list(com.azure.resourcemanager.alertsmanagement.AlertsManagementManager manager) {
        manager.smartGroups().list(null, null, null, null, null, null, null, null, null, null, null, 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_list.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.get_all()
    for item in response:
        print(item)


# x-ms-original-file: specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2019-05-05-preview/examples/SmartGroups_List.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_List.json
func ExampleSmartGroupsClient_NewGetAllPager() {
	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)
	}
	pager := clientFactory.NewSmartGroupsClient().NewGetAllPager(&armalertsmanagement.SmartGroupsClientGetAllOptions{TargetResource: nil,
		TargetResourceGroup: nil,
		TargetResourceType:  nil,
		MonitorService:      nil,
		MonitorCondition:    nil,
		Severity:            nil,
		SmartGroupState:     nil,
		TimeRange:           nil,
		PageCount:           nil,
		SortBy:              nil,
		SortOrder:           nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SmartGroupsList = armalertsmanagement.SmartGroupsList{
		// 	Value: []*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.StateNew),
		// 				StartDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-06T12:35:09.000Z"); return t}()),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("CPU Alert"),
		// 			Type: to.Ptr("Microsoft.AlertsManagement/smartGroups"),
		// 			ID: to.Ptr("/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/providers/Microsoft.AlertsManagement/smartGroups/01114c7c-769f-4fd4-b6fa-ab77693b83cd"),
		// 			Properties: &armalertsmanagement.SmartGroupProperties{
		// 				AlertSeverities: []*armalertsmanagement.SmartGroupAggregatedProperty{
		// 					{
		// 						Name: to.Ptr("Sev0"),
		// 						Count: to.Ptr[int64](6984),
		// 					},
		// 					{
		// 						Name: to.Ptr("Sev1"),
		// 						Count: to.Ptr[int64](6927),
		// 				}},
		// 				AlertStates: []*armalertsmanagement.SmartGroupAggregatedProperty{
		// 					{
		// 						Name: to.Ptr("New"),
		// 						Count: to.Ptr[int64](15358),
		// 					},
		// 					{
		// 						Name: to.Ptr("Acknowledged"),
		// 						Count: to.Ptr[int64](12),
		// 					},
		// 					{
		// 						Name: to.Ptr("Closed"),
		// 						Count: to.Ptr[int64](4),
		// 				}},
		// 				AlertsCount: to.Ptr[int64](15374),
		// 				LastModifiedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-13T06:29:01.000Z"); return t}()),
		// 				LastModifiedUserName: to.Ptr("System"),
		// 				MonitorConditions: []*armalertsmanagement.SmartGroupAggregatedProperty{
		// 					{
		// 						Name: to.Ptr("Fired"),
		// 						Count: to.Ptr[int64](15374),
		// 				}},
		// 				MonitorServices: []*armalertsmanagement.SmartGroupAggregatedProperty{
		// 					{
		// 						Name: to.Ptr("Log Analytics"),
		// 						Count: to.Ptr[int64](13911),
		// 				}},
		// 				ResourceGroups: []*armalertsmanagement.SmartGroupAggregatedProperty{
		// 					{
		// 						Name: to.Ptr("mms-eus"),
		// 						Count: to.Ptr[int64](15374),
		// 				}},
		// 				ResourceTypes: []*armalertsmanagement.SmartGroupAggregatedProperty{
		// 					{
		// 						Name: to.Ptr("microsoft.operationalinsights/workspaces"),
		// 						Count: to.Ptr[int64](6912),
		// 					},
		// 					{
		// 						Name: to.Ptr("workspaces"),
		// 						Count: to.Ptr[int64](8462),
		// 				}},
		// 				Resources: []*armalertsmanagement.SmartGroupAggregatedProperty{
		// 					{
		// 						Name: to.Ptr("/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/resourcegroups/mms-eus/providers/microsoft.operationalinsights/workspaces/alertsint"),
		// 						Count: to.Ptr[int64](15374),
		// 				}},
		// 				Severity: to.Ptr(armalertsmanagement.SeveritySev0),
		// 				SmartGroupState: to.Ptr(armalertsmanagement.StateAcknowledged),
		// 				StartDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-05-17T10:18:44.202Z"); 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;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.AlertsManagement;
using Azure.ResourceManager.AlertsManagement.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2019-05-05-preview/examples/SmartGroups_List.json
// this example is just showing the usage of "SmartGroups_GetAll" 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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "dd91de05-d791-4ceb-b6dc-988682dc7d72";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// get the collection of this SmartGroupResource
SmartGroupCollection collection = subscriptionResource.GetSmartGroups();

// invoke the operation and iterate over the result
SmartGroupCollectionGetAllOptions options = new SmartGroupCollectionGetAllOptions() { };
await foreach (SmartGroupResource item in collection.GetAllAsync(options))
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

{
  "nextLink": null,
  "value": [
    {
      "properties": {
        "alertsCount": 1942,
        "smartGroupState": "New",
        "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"
    },
    {
      "properties": {
        "alertsCount": 15374,
        "smartGroupState": "Acknowledged",
        "severity": "Sev0",
        "startDateTime": "2018-05-17T10:18:44.2020997Z",
        "lastModifiedDateTime": "2018-06-13T06:29:01Z",
        "lastModifiedUserName": "System",
        "resources": [
          {
            "name": "/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/resourcegroups/mms-eus/providers/microsoft.operationalinsights/workspaces/alertsint",
            "count": 15374
          }
        ],
        "resourceTypes": [
          {
            "name": "microsoft.operationalinsights/workspaces",
            "count": 6912
          },
          {
            "name": "workspaces",
            "count": 8462
          }
        ],
        "resourceGroups": [
          {
            "name": "mms-eus",
            "count": 15374
          }
        ],
        "monitorServices": [
          {
            "name": "Log Analytics",
            "count": 13911
          }
        ],
        "monitorConditions": [
          {
            "name": "Fired",
            "count": 15374
          }
        ],
        "alertStates": [
          {
            "name": "New",
            "count": 15358
          },
          {
            "name": "Acknowledged",
            "count": 12
          },
          {
            "name": "Closed",
            "count": 4
          }
        ],
        "alertSeverities": [
          {
            "name": "Sev0",
            "count": 6984
          },
          {
            "name": "Sev1",
            "count": 6927
          }
        ]
      },
      "id": "/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/providers/Microsoft.AlertsManagement/smartGroups/01114c7c-769f-4fd4-b6fa-ab77693b83cd",
      "type": "Microsoft.AlertsManagement/smartGroups",
      "name": "CPU Alert"
    }
  ]
}

Definitions

Name	Description
AlertState	Filter by state of the smart group. Default value is to select all.
api-version	client API version
errorResponse	An error response from the service.
errorResponseBody	Details of error response.
MonitorCondition	Filter by monitor condition which is either 'Fired' or 'Resolved'. Default value is to select all.
MonitorService	Filter by monitor service which generates the alert instance. Default value is select all.
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
smartGroupsList	List the alerts.
SmartGroupsSortByFields	Sort the query results by input field. Default value is sort by 'lastModifiedDateTime'.
SortOrder	Sort the query results order in either ascending or descending. Default value is 'desc' for time fields and 'asc' for others.
State	Smart group state
TimeRange	Filter by time range by below listed values. Default value is 1 day.

AlertState

Filter by state of the smart group. Default value is to select all.

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.

MonitorCondition

Filter by monitor condition which is either 'Fired' or 'Resolved'. Default value is to select all.

Name	Type	Description
Fired	string
Resolved	string

MonitorService

Filter by monitor service which generates the alert instance. Default value is select all.

Name	Type	Description
ActivityLog Administrative	string
ActivityLog Autoscale	string
ActivityLog Policy	string
ActivityLog Recommendation	string
ActivityLog Security	string
Application Insights	string
Log Analytics	string
Nagios	string
Platform	string
SCOM	string
ServiceHealth	string
SmartDetector	string
VM Insights	string
Zabbix	string

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.

smartGroupsList

List the alerts.

Name	Type	Description
nextLink	string	URL to fetch the next set of alerts.
value	smartGroup[]	List of alerts

SmartGroupsSortByFields

Sort the query results by input field. Default value is sort by 'lastModifiedDateTime'.

Name	Type	Description
alertsCount	string
lastModifiedDateTime	string
severity	string
startDateTime	string
state	string

SortOrder

Sort the query results order in either ascending or descending. Default value is 'desc' for time fields and 'asc' for others.

Name	Type	Description
asc	string
desc	string

State

Smart group state

Name	Type	Description
Acknowledged	string
Closed	string
New	string

TimeRange

Filter by time range by below listed values. Default value is 1 day.

Name	Type	Description
1d	string
1h	string
30d	string
7d	string

Share via

Smart Groups - Get All

URI Parameters

Responses

Examples

List

Sample Request

Sample Response

Definitions

AlertState

api-version

errorResponse

errorResponseBody

MonitorCondition

MonitorService

Severity

smartGroup

smartGroupAggregatedProperty

smartGroupsList

SmartGroupsSortByFields

SortOrder

State

TimeRange

Additional resources