Smart Groups - Get By Id

Referencia

Servicio:: Monitor

Versión de la API:: 2019-05-05-preview

Obtenga información relacionada con un grupo inteligente específico.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
smartGroupId	path	True	string	Identificador único del grupo inteligente.
subscriptionId	path	True	string minLength: 1	Identificador de la suscripción de destino.
api-version	query	True	api-version	versión de la API de cliente

Respuestas

Nombre	Tipo	Description
200 OK	smartGroup	De acuerdo. Devuelve el grupo con el identificador de grupo inteligente especificado. Encabezados x-ms-request-id: string
Other Status Codes	errorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Nombre

Tipo

Description

200 OK

smartGroup

De acuerdo. Devuelve el grupo con el identificador de grupo inteligente especificado.

Encabezados

x-ms-request-id: string

Other Status Codes

errorResponse

Respuesta de error que describe por qué se produjo un error en la operación.

Ejemplos

Get

Solicitud de ejemplo

GET https://management.azure.com/subscriptions/9e261de7-c804-4b9d-9ebf-6f50fe350a9a/providers/Microsoft.AlertsManagement/smartGroups/603675da-9851-4b26-854a-49fc53d32715?api-version=2019-05-05-preview


/**
 * Samples for SmartGroups GetById.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2019-05-05-preview/examples/
     * SmartGroups_GetById.json
     */
    /**
     * Sample code: Get.
     * 
     * @param manager Entry point to AlertsManagementManager.
     */
    public static void get(com.azure.resourcemanager.alertsmanagement.AlertsManagementManager manager) {
        manager.smartGroups().getByIdWithResponse("603675da-9851-4b26-854a-49fc53d32715",
            com.azure.core.util.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_get_by_id.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="9e261de7-c804-4b9d-9ebf-6f50fe350a9a",
    )

    response = client.smart_groups.get_by_id(
        smart_group_id="603675da-9851-4b26-854a-49fc53d32715",
    )
    print(response)


# x-ms-original-file: specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2019-05-05-preview/examples/SmartGroups_GetById.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_GetById.json
func ExampleSmartGroupsClient_GetByID() {
	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().GetByID(ctx, "603675da-9851-4b26-854a-49fc53d32715", 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.StateNew),
	// 		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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AlertsManagement.Models;
using Azure.ResourceManager.AlertsManagement;

// Generated from example definition: specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2019-05-05-preview/examples/SmartGroups_GetById.json
// this example is just showing the usage of "SmartGroups_GetById" 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 = "9e261de7-c804-4b9d-9ebf-6f50fe350a9a";
Guid smartGroupId = Guid.Parse("603675da-9851-4b26-854a-49fc53d32715");
ResourceIdentifier smartGroupResourceId = SmartGroupResource.CreateResourceIdentifier(subscriptionId, smartGroupId);
SmartGroupResource smartGroup = client.GetSmartGroupResource(smartGroupResourceId);

// invoke the operation
SmartGroupResource result = await smartGroup.GetAsync();

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

Respuesta de muestra

status code:: 200

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

Definiciones

Nombre	Description
api-version	versión de la API de cliente
errorResponse	Respuesta de error del servicio.
errorResponseBody	Detalles de la respuesta de error.
Severity	La gravedad del grupo inteligente es la gravedad más alta (Sev0 >... > Sev4) de todas las alertas del grupo.
smartGroup	Conjunto de alertas relacionadas agrupadas de forma inteligente por AMS.
smartGroupAggregatedProperty	Propiedad agregada de cada tipo
State	Estado del grupo inteligente

api-version

Enumeración

versión de la API de cliente

Valor	Description
2019-05-05-preview

errorResponse

Object

Respuesta de error del servicio.

Nombre	Tipo	Description
error	errorResponseBody	Detalles de la respuesta de error.

errorResponseBody

Object

Detalles de la respuesta de error.

Nombre	Tipo	Description
code	string	Código de error, diseñado para consumirse mediante programación.
details	errorResponseBody[]	Lista de detalles adicionales sobre el error.
message	string	Descripción del error, diseñado para mostrarse en la interfaz de usuario.
target	string	Destino del error concreto, por ejemplo el nombre de la propiedad.

Severity

Enumeración

La gravedad del grupo inteligente es la gravedad más alta (Sev0 >... > Sev4) de todas las alertas del grupo.

Valor	Description
Sev0
Sev1
Sev2
Sev3
Sev4

smartGroup

Object

Conjunto de alertas relacionadas agrupadas de forma inteligente por AMS.

Nombre	Tipo	Description
id	string	Identificador de recurso de Azure
name	string	Nombre del recurso de Azure
properties.alertSeverities	smartGroupAggregatedProperty[]	Resumen de las alertaseveraciones en el grupo inteligente
properties.alertStates	smartGroupAggregatedProperty[]	Resumen de alertStates en el grupo inteligente
properties.alertsCount	integer (int64)	Número total de alertas en el grupo inteligente
properties.lastModifiedDateTime	string (date-time)	Hora de última actualización del grupo inteligente. Date-Time en formato ISO-8601.
properties.lastModifiedUserName	string	Última modificación por nombre de usuario.
properties.monitorConditions	smartGroupAggregatedProperty[]	Resumen de monitorConditions en el grupo inteligente
properties.monitorServices	smartGroupAggregatedProperty[]	Resumen de monitorServices en el grupo inteligente
properties.nextLink	string	Identificador URI para capturar la página siguiente de alertas. Llame a ListNext() con este URI para capturar las alertas de la página siguiente.
properties.resourceGroups	smartGroupAggregatedProperty[]	Resumen de los grupos de recursos de destino en el grupo inteligente
properties.resourceTypes	smartGroupAggregatedProperty[]	Resumen de los tipos de recursos de destino en el grupo inteligente
properties.resources	smartGroupAggregatedProperty[]	Resumen de los recursos de destino en el grupo inteligente
properties.severity	Severity	La gravedad del grupo inteligente es la gravedad más alta (Sev0 >... > Sev4) de todas las alertas del grupo.
properties.smartGroupState	State	Estado del grupo inteligente
properties.startDateTime	string (date-time)	Tiempo de creación del grupo inteligente. Date-Time en formato ISO-8601.
type	string	Tipo de recurso de Azure

smartGroupAggregatedProperty

Object

Propiedad agregada de cada tipo

Nombre	Tipo	Description
count	integer (int64)	Número total de elementos de tipo.
name	string	Nombre del tipo.

State

Enumeración

Estado del grupo inteligente

Valor	Description
Acknowledged
Closed
New

Compartir a través de

Smart Groups - Get By Id

Parámetros de identificador URI

Respuestas

Ejemplos

Get

Solicitud de ejemplo

Respuesta de muestra

Definiciones

api-version

errorResponse

errorResponseBody

Severity

smartGroup

smartGroupAggregatedProperty

State