Metric Alerts Status - List By Name

Dienst:

Monitor

API-Version:

2018-03-01

Dient zum Abrufen eines Warnungsregelstatus.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/metricAlerts/{ruleName}/status/{statusName}?api-version=2018-03-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
ruleName	path	True	string	Der Name der Regel.
statusName	path	True	string	Der Name des Status.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	MetricAlertStatusCollection	Erfolgreiche Anforderung für eine Liste von Metrikwarnungen
Other Status Codes	ErrorResponse	Fehlerhafte Anfrage

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Get an alert rule status

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/009f6022-67ec-423e-9aa7-691182870588/resourceGroups/EastUs/providers/Microsoft.Insights/metricAlerts/custom1/status/cmVzb3VyY2VJZD0vc3Vic2NyaXB0aW9ucy8xNGRkZjBjNS03N2M1LTRiNTMtODRmNi1lMWZhNDNhZDY4ZjcvcmVzb3VyY2VHcm91cHMvZ2lndGVzdC9wcm92aWRlcnMvTWljcm9zb2Z0LkNvbXB1dGUvdmlydHVhbE1hY2hpbmVzL2dpZ3dhZG1l?api-version=2018-03-01

Java

/**
 * Samples for MetricAlertsStatus ListByName.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/getMetricAlertStatusByName.
     * json
     */
    /**
     * Sample code: Get an alert rule status.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAnAlertRuleStatus(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.diagnosticSettings().manager().serviceClient().getMetricAlertsStatus().listByNameWithResponse("EastUs",
            "custom1",
            "cmVzb3VyY2VJZD0vc3Vic2NyaXB0aW9ucy8xNGRkZjBjNS03N2M1LTRiNTMtODRmNi1lMWZhNDNhZDY4ZjcvcmVzb3VyY2VHcm91cHMvZ2lndGVzdC9wcm92aWRlcnMvTWljcm9zb2Z0LkNvbXB1dGUvdmlydHVhbE1hY2hpbmVzL2dpZ3dhZG1l",
            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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.monitor import MonitorManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-monitor
# USAGE
    python get_metric_alert_status_by_name.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 = MonitorManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="009f6022-67ec-423e-9aa7-691182870588",
    )

    response = client.metric_alerts_status.list_by_name(
        resource_group_name="EastUs",
        rule_name="custom1",
        status_name="cmVzb3VyY2VJZD0vc3Vic2NyaXB0aW9ucy8xNGRkZjBjNS03N2M1LTRiNTMtODRmNi1lMWZhNDNhZDY4ZjcvcmVzb3VyY2VHcm91cHMvZ2lndGVzdC9wcm92aWRlcnMvTWljcm9zb2Z0LkNvbXB1dGUvdmlydHVhbE1hY2hpbmVzL2dpZ3dhZG1l",
    )
    print(response)


# x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/getMetricAlertStatusByName.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 armmonitor_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/monitor/armmonitor"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/969fd0c2634fbcc1975d7abe3749330a5145a97c/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/getMetricAlertStatusByName.json
func ExampleMetricAlertsStatusClient_ListByName() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armmonitor.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewMetricAlertsStatusClient().ListByName(ctx, "EastUs", "custom1", "cmVzb3VyY2VJZD0vc3Vic2NyaXB0aW9ucy8xNGRkZjBjNS03N2M1LTRiNTMtODRmNi1lMWZhNDNhZDY4ZjcvcmVzb3VyY2VHcm91cHMvZ2lndGVzdC9wcm92aWRlcnMvTWljcm9zb2Z0LkNvbXB1dGUvdmlydHVhbE1hY2hpbmVzL2dpZ3dhZG1l", 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.MetricAlertStatusCollection = armmonitor.MetricAlertStatusCollection{
	// 	Value: []*armmonitor.MetricAlertStatus{
	// 		{
	// 			Name: to.Ptr("cmVzb3VyY2VJZD0vc3Vic2NyaXB0aW9ucy8xNGRkZjBjNS03N2M1LTRiNTMtODRmNi1lMWZhNDNhZDY4ZjcvcmVzb3VyY2VHcm91cHMvZ2lndGVzdC9wcm92aWRlcnMvTWljcm9zb2Z0LkNvbXB1dGUvdmlydHVhbE1hY2hpbmVzL2dpZ3dhZG1l"),
	// 			Type: to.Ptr("Microsoft.Insights/metricAlerts/status"),
	// 			ID: to.Ptr("/subscriptions/009f6022-67ec-423e-9aa7-691182870588/resourceGroups/EastUs/providers/microsoft.insights/metricAlerts/custom1"),
	// 			Properties: &armmonitor.MetricAlertStatusProperties{
	// 				Dimensions: map[string]*string{
	// 					"resourceId": to.Ptr("/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme"),
	// 				},
	// 				Status: to.Ptr("Healthy"),
	// 				Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-17T20:17:25.629Z"); 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

JavaScript

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

/**
 * This sample demonstrates how to Retrieve an alert rule status.
 *
 * @summary Retrieve an alert rule status.
 * x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/getMetricAlertStatusByName.json
 */
async function getAnAlertRuleStatus() {
  const subscriptionId =
    process.env["MONITOR_SUBSCRIPTION_ID"] || "009f6022-67ec-423e-9aa7-691182870588";
  const resourceGroupName = process.env["MONITOR_RESOURCE_GROUP"] || "EastUs";
  const ruleName = "custom1";
  const statusName =
    "cmVzb3VyY2VJZD0vc3Vic2NyaXB0aW9ucy8xNGRkZjBjNS03N2M1LTRiNTMtODRmNi1lMWZhNDNhZDY4ZjcvcmVzb3VyY2VHcm91cHMvZ2lndGVzdC9wcm92aWRlcnMvTWljcm9zb2Z0LkNvbXB1dGUvdmlydHVhbE1hY2hpbmVzL2dpZ3dhZG1l";
  const credential = new DefaultAzureCredential();
  const client = new MonitorClient(credential, subscriptionId);
  const result = await client.metricAlertsStatus.listByName(
    resourceGroupName,
    ruleName,
    statusName,
  );
  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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Monitor.Models;
using Azure.ResourceManager.Monitor;

// Generated from example definition: specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/getMetricAlertStatusByName.json
// this example is just showing the usage of "MetricAlertsStatus_ListByName" 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 MetricAlertResource created on azure
// for more information of creating MetricAlertResource, please refer to the document of MetricAlertResource
string subscriptionId = "009f6022-67ec-423e-9aa7-691182870588";
string resourceGroupName = "EastUs";
string ruleName = "custom1";
ResourceIdentifier metricAlertResourceId = MetricAlertResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, ruleName);
MetricAlertResource metricAlert = client.GetMetricAlertResource(metricAlertResourceId);

// invoke the operation and iterate over the result
string statusName = "cmVzb3VyY2VJZD0vc3Vic2NyaXB0aW9ucy8xNGRkZjBjNS03N2M1LTRiNTMtODRmNi1lMWZhNDNhZDY4ZjcvcmVzb3VyY2VHcm91cHMvZ2lndGVzdC9wcm92aWRlcnMvTWljcm9zb2Z0LkNvbXB1dGUvdmlydHVhbE1hY2hpbmVzL2dpZ3dhZG1l";
await foreach (MetricAlertStatus item in metricAlert.GetAllMetricAlertsStatusByNameAsync(statusName))
{
    Console.WriteLine($"Succeeded: {item}");
}

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

Beispiel für eine Antwort

Statuscode:

200

{
  "value": [
    {
      "id": "/subscriptions/009f6022-67ec-423e-9aa7-691182870588/resourceGroups/EastUs/providers/microsoft.insights/metricAlerts/custom1",
      "name": "cmVzb3VyY2VJZD0vc3Vic2NyaXB0aW9ucy8xNGRkZjBjNS03N2M1LTRiNTMtODRmNi1lMWZhNDNhZDY4ZjcvcmVzb3VyY2VHcm91cHMvZ2lndGVzdC9wcm92aWRlcnMvTWljcm9zb2Z0LkNvbXB1dGUvdmlydHVhbE1hY2hpbmVzL2dpZ3dhZG1l",
      "type": "Microsoft.Insights/metricAlerts/status",
      "properties": {
        "dimensions": {
          "resourceId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme"
        },
        "status": "Healthy",
        "timestamp": "2018-01-17T20:17:25.6293237Z"
      }
    }
  ]
}

Definitionen

Name	Beschreibung
AdditionalInfo	Ein Array von Objekten mit eigenschaften "type" und "info". Das Schema von "info" ist dienstspezifisch und abhängig von der Zeichenfolge "type".
Error
ErrorDetail	Beschreibt Details einer Fehlerantwort.
ErrorResponse	Beschreibt das Format der Fehlerantwort.
MetricAlertStatus	Ein Warnungsstatus.
MetricAlertStatusCollection	Stellt eine Auflistung von Ressourcen für Warnungsregel dar.
MetricAlertStatusProperties	Eigenschaften des Warnungsstatus.

AdditionalInfo

Objekt

Ein Array von Objekten mit eigenschaften "type" und "info". Das Schema von "info" ist dienstspezifisch und abhängig von der Zeichenfolge "type".

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen, die für den Typ spezifisch sind.
type	string	Der Typ der zusätzlichen Informationen.

Error

Objekt

Name	Typ	Beschreibung
additionalInfo	AdditionalInfo[]	Ein Array von Objekten mit eigenschaften "type" und "info". Das Schema von "info" ist dienstspezifisch und abhängig von der Zeichenfolge "type".
code	string	Nicht lokalisierte Zeichenfolge, die zum programmgesteuerten Identifizieren des Fehlers verwendet werden kann.
details	ErrorDetail[]	Ein Array zusätzlicher geschachtelter Fehlerantwort-Infoobjekte, wie in diesem Vertrag beschrieben.
message	string	Beschreibt den Fehler im Detail und stellt Debuginformationen bereit. Wenn Accept-Language in der Anforderung festgelegt ist, muss sie in diese Sprache lokalisiert werden.
target	string	Das Ziel des bestimmten Fehlers (z. B. der Name der Eigenschaft im Fehler).

ErrorDetail

Objekt

Beschreibt Details einer Fehlerantwort.

Name	Typ	Beschreibung
additionalInfo	AdditionalInfo[]	Ein Array von Objekten mit eigenschaften "type" und "info". Das Schema von "info" ist dienstspezifisch und abhängig von der Zeichenfolge "type".
code	string	Nicht lokalisierte Zeichenfolge, die zum programmgesteuerten Identifizieren des Fehlers verwendet werden kann.
message	string	Beschreibt den Fehler im Detail und stellt Debuginformationen bereit.
target	string	Das Ziel des bestimmten Fehlers (z. B. der Name der Eigenschaft im Fehler).

ErrorResponse

Objekt

Beschreibt das Format der Fehlerantwort.

Name	Typ	Beschreibung
error	Error

MetricAlertStatus

Objekt

Ein Warnungsstatus.

Name	Typ	Beschreibung
id	string	Die Arm-ID der Warnungsregel.
name	string	Der Statusname.
properties	MetricAlertStatusProperties	Die Warnungsstatuseigenschaften des metrischen Warnungsstatus.
type	string	Der Name des erweiterten Ressourcentyps.

MetricAlertStatusCollection

Objekt

Stellt eine Auflistung von Ressourcen für Warnungsregel dar.

Name	Typ	Beschreibung
value	MetricAlertStatus[]	die Werte für die Ressourcen der Warnungsregel.

MetricAlertStatusProperties

Objekt

Eigenschaften des Warnungsstatus.

Name	Typ	Beschreibung
dimensions	object	Ein Objekt, das den Typ der Dimensionen beschreibt.
status	string	Statuswert
timestamp	string (date-time)	UTC-Zeit, zu der der Status überprüft wurde.