Haal de status van een waarschuwingsregel op.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/metricAlerts/{ruleName}/status?api-version=2018-03-01
URI-parameters
| Name |
In |
Vereist |
Type |
Description |
|
resourceGroupName
|
path |
True
|
string
minLength: 1
maxLength: 90
|
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
|
|
ruleName
|
path |
True
|
string
|
De naam van de regel.
|
|
subscriptionId
|
path |
True
|
string
minLength: 1
|
De id van het doelabonnement.
|
|
api-version
|
query |
True
|
string
minLength: 1
|
De API-versie die voor deze bewerking moet worden gebruikt.
|
Antwoorden
Beveiliging
azure_auth
Azure Active Directory OAuth2-stroom
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiken
| Name |
Description |
|
user_impersonation
|
Uw gebruikersaccount imiteren
|
Voorbeelden
Get an alert rule status
Voorbeeldaanvraag
GET https://management.azure.com/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Insights/metricAlerts/chiricutin/status?api-version=2018-03-01
/**
* Samples for MetricAlertsStatus List.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/getMetricAlertStatus.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().listWithResponse("gigtest",
"chiricutin", 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.monitor import MonitorManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-monitor
# USAGE
python get_metric_alert_status.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="14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7",
)
response = client.metric_alerts_status.list(
resource_group_name="gigtest",
rule_name="chiricutin",
)
print(response)
# x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/getMetricAlertStatus.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 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/getMetricAlertStatus.json
func ExampleMetricAlertsStatusClient_List() {
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().List(ctx, "gigtest", "chiricutin", 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/LeoAlert_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
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/getMetricAlertStatus.json
*/
async function getAnAlertRuleStatus() {
const subscriptionId =
process.env["MONITOR_SUBSCRIPTION_ID"] || "14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7";
const resourceGroupName = process.env["MONITOR_RESOURCE_GROUP"] || "gigtest";
const ruleName = "chiricutin";
const credential = new DefaultAzureCredential();
const client = new MonitorClient(credential, subscriptionId);
const result = await client.metricAlertsStatus.list(resourceGroupName, ruleName);
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
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/getMetricAlertStatus.json
// this example is just showing the usage of "MetricAlertsStatus_List" 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 = "14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7";
string resourceGroupName = "gigtest";
string ruleName = "chiricutin";
ResourceIdentifier metricAlertResourceId = MetricAlertResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, ruleName);
MetricAlertResource metricAlert = client.GetMetricAlertResource(metricAlertResourceId);
// invoke the operation and iterate over the result
await foreach (MetricAlertStatus item in metricAlert.GetAllMetricAlertsStatusAsync())
{
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
Voorbeeldrespons
{
"value": [
{
"id": "/subscriptions/009f6022-67ec-423e-9aa7-691182870588/resourceGroups/EastUs/providers/microsoft.insights/metricAlerts/LeoAlert_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"
}
}
]
}
Definities
AdditionalInfo
Object
Een matrix met objecten met de eigenschappen 'type' en 'info'. Het schema van 'info' is servicespecifiek en is afhankelijk van de tekenreeks 'type'.
| Name |
Type |
Description |
|
info
|
object
|
De aanvullende informatie die specifiek is voor het type.
|
|
type
|
string
|
Het type aanvullende informatie.
|
Error
Object
| Name |
Type |
Description |
|
additionalInfo
|
AdditionalInfo[]
|
Een matrix met objecten met de eigenschappen 'type' en 'info'. Het schema van 'info' is servicespecifiek en is afhankelijk van de tekenreeks 'type'.
|
|
code
|
string
|
Niet-gelokaliseerde tekenreeks die kan worden gebruikt om de fout programmatisch te identificeren.
|
|
details
|
ErrorDetail[]
|
Een matrix met aanvullende geneste informatieobjecten voor foutreacties, zoals beschreven in dit contract.
|
|
message
|
string
|
Hierin wordt de fout gedetailleerd beschreven en vindt u informatie over foutopsporing. Als Accept-Language is ingesteld in de aanvraag, moet deze worden gelokaliseerd naar die taal.
|
|
target
|
string
|
Het doel van de specifieke fout (bijvoorbeeld de naam van de eigenschap in fout).
|
ErrorDetail
Object
Beschrijft details van een foutreactie.
| Name |
Type |
Description |
|
additionalInfo
|
AdditionalInfo[]
|
Een matrix met objecten met de eigenschappen 'type' en 'info'. Het schema van 'info' is servicespecifiek en is afhankelijk van de tekenreeks 'type'.
|
|
code
|
string
|
Niet-gelokaliseerde tekenreeks die kan worden gebruikt om de fout programmatisch te identificeren.
|
|
message
|
string
|
Hierin wordt de fout gedetailleerd beschreven en vindt u informatie over foutopsporing.
|
|
target
|
string
|
Het doel van de specifieke fout (bijvoorbeeld de naam van de eigenschap in fout).
|
ErrorResponse
Object
Beschrijft de indeling van foutreactie.
| Name |
Type |
Description |
|
error
|
Error
|
|
MetricAlertStatus
Object
Een waarschuwingsstatus.
| Name |
Type |
Description |
|
id
|
string
|
De arm-id van de waarschuwingsregel.
|
|
name
|
string
|
De statusnaam.
|
|
properties
|
MetricAlertStatusProperties
|
De eigenschappen van de waarschuwingsstatus van de metrische waarschuwing.
|
|
type
|
string
|
De naam van het uitgebreide resourcetype.
|
MetricAlertStatusCollection
Object
Vertegenwoordigt een verzameling waarschuwingsregelbronnen.
| Name |
Type |
Description |
|
value
|
MetricAlertStatus[]
|
de waarden voor de resources van de waarschuwingsregel.
|
MetricAlertStatusProperties
Object
Een eigenschappen van de waarschuwingsstatus.
| Name |
Type |
Description |
|
dimensions
|
object
|
Een object met een beschrijving van het type dimensies.
|
|
status
|
string
|
statuswaarde
|
|
timestamp
|
string
(date-time)
|
UTC-tijd waarop de status is gecontroleerd.
|