Metric Alerts Status - List

服務:

Monitor

API 版本:

2024-03-01-preview

請取得警報規則狀態。

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

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。 名稱不區分大小寫。
ruleName	path	True	string	規則的名稱。
subscriptionId	path	True	string minLength: 1	目標訂用帳戶的標識碼。
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

回應

名稱	類型	Description
200 OK	MetricAlertStatusCollection	成功申請一份指標警示清單
Other Status Codes	ErrorResponse	錯誤的請求

安全性

azure_auth

Azure Active Directory OAuth2 流

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Get an alert rule status

範例要求

HTTP

GET https://management.azure.com/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Insights/metricAlerts/chiricutin/status?api-version=2024-03-01-preview

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.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/preview/2024-03-01-preview/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

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/preview/2024-03-01-preview/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

範例回覆

狀態碼:

200

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

定義

名稱	Description
AdditionalInfo	一組具有「類型」和「資訊」屬性的物件陣列。 「info」的結構是服務特定的，並依賴於「類型」字串。
Error
ErrorDetail	描述錯誤回應的細節。
ErrorResponse	描述錯誤回應的格式。
MetricAlertStatus	警報狀態。
MetricAlertStatusCollection	代表警示規則資源的集合。
MetricAlertStatusProperties	警報狀態屬性。

AdditionalInfo

Object

一組具有「類型」和「資訊」屬性的物件陣列。 「info」的結構是服務特定的，並依賴於「類型」字串。

名稱	類型	Description
info		針對特定類型的額外資訊。
type	string	附加資訊的類型。

Error

Object

名稱	類型	Description
additionalInfo	AdditionalInfo[]	一組具有「類型」和「資訊」屬性的物件陣列。 「info」的結構是服務特定的，並依賴於「類型」字串。
code	string	未局域字串，可用於程式化識別錯誤。
details	ErrorDetail[]	其他巢狀錯誤回應資訊對象的陣列，如此合約所述。
message	string	詳細描述錯誤並提供除錯資訊。 如果請求中設定了 Accept-Language，必須在地化到該語言。
target	string	特定錯誤的目標 （例如，發生錯誤的屬性名稱）。

ErrorDetail

Object

描述錯誤回應的細節。

名稱	類型	Description
additionalInfo	AdditionalInfo[]	一組具有「類型」和「資訊」屬性的物件陣列。 「info」的結構是服務特定的，並依賴於「類型」字串。
code	string	未局域字串，可用於程式化識別錯誤。
message	string	詳細描述錯誤並提供除錯資訊。
target	string	特定錯誤的目標 （例如，發生錯誤的屬性名稱）。

ErrorResponse

Object

描述錯誤回應的格式。

名稱	類型	Description
error	Error

MetricAlertStatus

Object

警報狀態。

名稱	類型	Description
id	string	警報規則的手臂識別碼。
name	string	身份名稱。
properties	MetricAlertStatusProperties	警示狀態屬性的指標警示狀態。
type	string	擴充資源類型名稱。

MetricAlertStatusCollection

Object

代表警示規則資源的集合。

名稱	類型	Description
value	MetricAlertStatus[]	警報規則資源的值。

MetricAlertStatusProperties

Object

警報狀態屬性。

名稱	類型	Description
dimensions	object	一個描述尺寸類型的物件。
status	string	狀態值
timestamp	string (date-time)	檢查狀態時的UTC時間。