Alert Rules - Create Or Update

Odwołanie

Service:: Monitor

API Version:: 2016-03-01

Tworzy lub aktualizuje regułę alertu dotyczącego metryk klasycznych.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/alertrules/{ruleName}?api-version=2016-03-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string	Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
ruleName	path	True	string	Nazwa reguły.
subscriptionId	path	True	string	Identyfikator subskrypcji docelowej.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Wymagane	Typ	Opis
location	True	string	Lokalizacja zasobu
properties.condition	True	RuleCondition: ThresholdRuleCondition LocationThresholdRuleCondition ManagementEventRuleCondition	warunek, który powoduje aktywowanie reguły alertu.
properties.isEnabled	True	boolean	flaga wskazująca, czy reguła alertu jest włączona.
properties.name	True	string	nazwa reguły alertu.
properties.action		RuleAction: RuleEmailAction RuleWebhookAction	akcja wykonywana, gdy reguła alertu stanie się aktywna i gdy warunek alertu zostanie rozwiązany.
properties.actions		RuleAction[]: RuleEmailAction[] RuleWebhookAction[]	tablica akcji, które są wykonywane, gdy reguła alertu staje się aktywna, a po rozwiązaniu warunku alertu.
properties.description		string	opis reguły alertu, która zostanie uwzględniona w wiadomości e-mail z alertem.
properties.provisioningState		string	stan aprowizacji.
tags		object	Tagi zasobów

Odpowiedzi

Nazwa	Typ	Opis
200 OK	AlertRuleResource	Pomyślne żądanie zaktualizowania reguły alertu
201 Created	AlertRuleResource	Utworzono regułę alertu
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Create or update an alert rule

Sample Request

PUT https://management.azure.com/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourcegroups/Rac46PostSwapRG/providers/Microsoft.Insights/alertrules/chiricutin?api-version=2016-03-01

{
  "location": "West US",
  "tags": {},
  "properties": {
    "name": "chiricutin",
    "description": "Pura Vida",
    "isEnabled": true,
    "condition": {
      "odata.type": "Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition",
      "dataSource": {
        "odata.type": "Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource",
        "resourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest",
        "metricName": "Requests"
      },
      "operator": "GreaterThan",
      "threshold": 3,
      "windowSize": "PT5M",
      "timeAggregation": "Total"
    },
    "actions": []
  }
}


import com.azure.resourcemanager.monitor.fluent.models.AlertRuleResourceInner;
import com.azure.resourcemanager.monitor.models.ConditionOperator;
import com.azure.resourcemanager.monitor.models.RuleMetricDataSource;
import com.azure.resourcemanager.monitor.models.ThresholdRuleCondition;
import com.azure.resourcemanager.monitor.models.TimeAggregationOperator;
import java.time.Duration;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for AlertRules CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/createOrUpdateAlertRule.json
     */
    /**
     * Sample code: Create or update an alert rule.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createOrUpdateAnAlertRule(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.diagnosticSettings().manager().serviceClient().getAlertRules().createOrUpdateWithResponse(
            "Rac46PostSwapRG", "chiricutin",
            new AlertRuleResourceInner().withLocation("West US").withTags(mapOf()).withNamePropertiesName("chiricutin")
                .withDescription("Pura Vida").withIsEnabled(true)
                .withCondition(new ThresholdRuleCondition().withDataSource(new RuleMetricDataSource().withResourceUri(
                    "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest")
                    .withMetricName("Requests")).withOperator(ConditionOperator.GREATER_THAN).withThreshold(3.0)
                    .withWindowSize(Duration.parse("PT5M")).withTimeAggregation(TimeAggregationOperator.TOTAL))
                .withActions(Arrays.asList()),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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/azcore/to"
	"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/2016-03-01/examples/createOrUpdateAlertRule.json
func ExampleAlertRulesClient_CreateOrUpdate() {
	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.NewAlertRulesClient().CreateOrUpdate(ctx, "Rac46PostSwapRG", "chiricutin", armmonitor.AlertRuleResource{
		Location: to.Ptr("West US"),
		Tags:     map[string]*string{},
		Properties: &armmonitor.AlertRule{
			Name:        to.Ptr("chiricutin"),
			Description: to.Ptr("Pura Vida"),
			Actions:     []armmonitor.RuleActionClassification{},
			Condition: &armmonitor.ThresholdRuleCondition{
				DataSource: &armmonitor.RuleMetricDataSource{
					ODataType:   to.Ptr("Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource"),
					ResourceURI: to.Ptr("/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest"),
					MetricName:  to.Ptr("Requests"),
				},
				ODataType:       to.Ptr("Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition"),
				Operator:        to.Ptr(armmonitor.ConditionOperatorGreaterThan),
				Threshold:       to.Ptr[float64](3),
				TimeAggregation: to.Ptr(armmonitor.TimeAggregationOperatorTotal),
				WindowSize:      to.Ptr("PT5M"),
			},
			IsEnabled: to.Ptr(true),
		},
	}, 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.AlertRuleResource = armmonitor.AlertRuleResource{
	// 	Name: to.Ptr("chiricutin"),
	// 	Type: to.Ptr("Microsoft.Insights/alertRules"),
	// 	ID: to.Ptr("/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/alertrules/chiricutin"),
	// 	Location: to.Ptr("West US"),
	// 	Tags: map[string]*string{
	// 		"$type": to.Ptr("Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary, Microsoft.WindowsAzure.Management.Common.Storage"),
	// 		"hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": to.Ptr("Resource"),
	// 	},
	// 	Properties: &armmonitor.AlertRule{
	// 		Name: to.Ptr("chiricutin"),
	// 		Description: to.Ptr("Pura Vida"),
	// 		Actions: []armmonitor.RuleActionClassification{
	// 		},
	// 		Condition: &armmonitor.ThresholdRuleCondition{
	// 			DataSource: &armmonitor.RuleMetricDataSource{
	// 				ODataType: to.Ptr("Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource"),
	// 				ResourceURI: to.Ptr("/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest"),
	// 				MetricName: to.Ptr("Requests"),
	// 			},
	// 			ODataType: to.Ptr("Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition"),
	// 			Operator: to.Ptr(armmonitor.ConditionOperatorGreaterThan),
	// 			Threshold: to.Ptr[float64](3),
	// 			TimeAggregation: to.Ptr(armmonitor.TimeAggregationOperatorTotal),
	// 			WindowSize: to.Ptr("PT5M"),
	// 		},
	// 		IsEnabled: to.Ptr(true),
	// 		LastUpdatedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2016-11-23T21:23:52.022Z"); 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 Creates or updates a classic metric alert rule.
 *
 * @summary Creates or updates a classic metric alert rule.
 * x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/createOrUpdateAlertRule.json
 */
async function createOrUpdateAnAlertRule() {
  const subscriptionId =
    process.env["MONITOR_SUBSCRIPTION_ID"] || "b67f7fec-69fc-4974-9099-a26bd6ffeda3";
  const resourceGroupName = process.env["MONITOR_RESOURCE_GROUP"] || "Rac46PostSwapRG";
  const ruleName = "chiricutin";
  const parameters = {
    namePropertiesName: "chiricutin",
    description: "Pura Vida",
    actions: [],
    condition: {
      dataSource: {
        metricName: "Requests",
        odataType: "Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource",
        resourceUri:
          "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest",
      },
      odataType: "Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition",
      operator: "GreaterThan",
      threshold: 3,
      timeAggregation: "Total",
      windowSize: "PT5M",
    },
    isEnabled: true,
    location: "West US",
    tags: {},
  };
  const credential = new DefaultAzureCredential();
  const client = new MonitorClient(credential, subscriptionId);
  const result = await client.alertRules.createOrUpdate(resourceGroupName, ruleName, parameters);
  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 System;
using System.Threading.Tasks;
using System.Xml;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Monitor;
using Azure.ResourceManager.Monitor.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/createOrUpdateAlertRule.json
// this example is just showing the usage of "AlertRules_CreateOrUpdate" 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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "b67f7fec-69fc-4974-9099-a26bd6ffeda3";
string resourceGroupName = "Rac46PostSwapRG";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this AlertRuleResource
AlertRuleCollection collection = resourceGroupResource.GetAlertRules();

// invoke the operation
string ruleName = "chiricutin";
AlertRuleData data = new AlertRuleData(new AzureLocation("West US"), "chiricutin", true, new ThresholdRuleCondition(MonitorConditionOperator.GreaterThan, 3)
{
    WindowSize = XmlConvert.ToTimeSpan("PT5M"),
    TimeAggregation = ThresholdRuleConditionTimeAggregationType.Total,
    DataSource = new RuleMetricDataSource()
    {
        MetricName = "Requests",
        ResourceId = new ResourceIdentifier("/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest"),
    },
})
{
    Description = "Pura Vida",
    Actions =
    {
    },
    Tags =
    {
    },
};
ArmOperation<AlertRuleResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, ruleName, data);
AlertRuleResource result = lro.Value;

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

Sample Response

Status code:: 200

{
  "id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/alertrules/chiricutin",
  "name": "chiricutin",
  "type": "Microsoft.Insights/alertRules",
  "location": "West US",
  "tags": {
    "$type": "Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary, Microsoft.WindowsAzure.Management.Common.Storage",
    "hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": "Resource"
  },
  "properties": {
    "name": "chiricutin",
    "description": "Pura Vida",
    "isEnabled": true,
    "condition": {
      "odata.type": "Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition",
      "dataSource": {
        "odata.type": "Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource",
        "resourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest",
        "metricName": "Requests"
      },
      "operator": "GreaterThan",
      "threshold": 3,
      "windowSize": "PT5M",
      "timeAggregation": "Total"
    },
    "lastUpdatedTime": "2016-11-23T21:23:52.0221265Z",
    "actions": []
  }
}

Status code:: 201

{
  "id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/alertrules/chiricutin",
  "name": "chiricutin",
  "type": "Microsoft.Insights/alertRules",
  "location": "West US",
  "tags": {
    "$type": "Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary, Microsoft.WindowsAzure.Management.Common.Storage",
    "hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": "Resource"
  },
  "properties": {
    "name": "chiricutin",
    "description": "Pura Vida",
    "isEnabled": true,
    "condition": {
      "odata.type": "Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition",
      "dataSource": {
        "odata.type": "Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource",
        "resourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest",
        "metricName": "Requests"
      },
      "operator": "GreaterThan",
      "threshold": 3,
      "windowSize": "PT5M",
      "timeAggregation": "Total"
    },
    "lastUpdatedTime": "2016-11-23T21:23:52.0221265Z",
    "actions": []
  }
}

Definicje

Nazwa	Opis
AlertRuleResource	Zasób reguły alertu.
ConditionOperator	Operatory dozwolone w warunku reguły.
ErrorResponse	Opisuje format odpowiedzi na błąd.
LocationThresholdRuleCondition	Warunek reguły oparty na określonej liczbie lokalizacji kończy się niepowodzeniem.
ManagementEventAggregationCondition	Sposób łączenia zebranych danych w czasie.
ManagementEventRuleCondition	Warunek reguły zdarzenia zarządzania.
RuleEmailAction	Określa akcję wysyłania wiadomości e-mail po ocenie warunku reguły. Dyskryminujące jest zawsze RuleEmailAction w tym przypadku.
RuleManagementEventClaimsDataSource	Oświadczenia dotyczące źródła danych zdarzenia zarządzania regułami.
RuleManagementEventDataSource	Źródło danych zdarzenia zarządzania regułami. Pola dyskryminujące są zawsze ruleManagementEventDataSource w tym przypadku.
RuleMetricDataSource	Źródło danych metryki reguły. W tym przypadku wartość dyskryminująca jest zawsze RuleMetricDataSource.
RuleWebhookAction	Określa akcję, która ma być publikowana w usłudze po ocenie warunku reguły. Dyskryminujące jest zawsze RuleWebhookAction w tym przypadku.
ThresholdRuleCondition	Warunek reguły oparty na metryce przekraczającej próg.
TimeAggregationOperator	Operatory agregacji dozwolone w regule.

AlertRuleResource

Zasób reguły alertu.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu platformy Azure
location	string	Lokalizacja zasobu
name	string	Nazwa zasobu platformy Azure
properties.action	RuleAction: RuleEmailAction RuleWebhookAction	akcja wykonywana, gdy reguła alertu stanie się aktywna i gdy zostanie rozwiązany warunek alertu.
properties.actions	RuleAction[]: RuleEmailAction[] RuleWebhookAction[]	tablica akcji, które są wykonywane, gdy reguła alertu stanie się aktywna, a gdy warunek alertu zostanie rozwiązany.
properties.condition	RuleCondition: LocationThresholdRuleCondition ManagementEventRuleCondition ThresholdRuleCondition	warunek, który powoduje aktywowanie reguły alertu.
properties.description	string	opis reguły alertu, która zostanie uwzględniona w wiadomości e-mail z alertem.
properties.isEnabled	boolean	flaga wskazująca, czy reguła alertu jest włączona.
properties.lastUpdatedTime	string	Ostatni raz reguła została zaktualizowana w formacie ISO8601.
properties.name	string	nazwa reguły alertu.
properties.provisioningState	string	stan aprowizacji.
tags	object	Tagi zasobów
type	string	Typ zasobu platformy Azure

ConditionOperator

Operatory dozwolone w warunku reguły.

Nazwa	Typ	Opis
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string

ErrorResponse

Opisuje format odpowiedzi na błąd.

Nazwa	Typ	Opis
code	string	Kod błędu
message	string	Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.

LocationThresholdRuleCondition

Warunek reguły oparty na określonej liczbie lokalizacji kończy się niepowodzeniem.

Nazwa	Typ	Opis
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	zasób, z którego reguła zbiera dane. W przypadku tego typu źródło danych zawsze będzie typu RuleMetricDataSource.
failedLocationCount	integer	liczba lokalizacji, które nie mogą aktywować alertu.
odata.type	string: Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition	określa typ warunku. Może to być jeden z trzech typów: ManagementEventRuleCondition (wystąpienia zdarzeń zarządzania), LocationThresholdRuleCondition (na podstawie liczby błędów testu internetowego) i ThresholdRuleCondition (na podstawie progu metryki).
windowSize	string	okres czasu (w formacie czasu trwania ISO 8601), który służy do monitorowania aktywności alertów na podstawie progu. Jeśli zostanie określony, musi to być od 5 minut do 1 dnia.

ManagementEventAggregationCondition

Sposób łączenia zebranych danych w czasie.

Nazwa	Typ	Opis
operator	ConditionOperator	operator warunku.
threshold	number	Wartość progowa, która aktywuje alert.
windowSize	string	okres czasu (w formacie czasu trwania ISO 8601), który służy do monitorowania aktywności alertów na podstawie progu. Jeśli zostanie określony, musi to być od 5 minut do 1 dnia.

ManagementEventRuleCondition

Warunek reguły zdarzenia zarządzania.

Nazwa	Typ	Opis
aggregation	ManagementEventAggregationCondition	Sposób, w jaki dane są zbierane, powinny być łączone wraz z upływem czasu i po aktywowaniu alertu. Należy pamiętać, że agregacja alertów zdarzeń zarządzania jest opcjonalna — jeśli nie zostanie podana, jakiekolwiek zdarzenie spowoduje aktywowanie alertu.
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	zasób, z którego reguła zbiera dane. W przypadku tego typu źródło danych zawsze będzie typu RuleMetricDataSource.
odata.type	string: Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition	określa typ warunku. Może to być jeden z trzech typów: ManagementEventRuleCondition (wystąpienia zdarzeń zarządzania), LocationThresholdRuleCondition (na podstawie liczby błędów testu internetowego) i ThresholdRuleCondition (na podstawie progu metryki).

RuleEmailAction

Określa akcję wysyłania wiadomości e-mail po ocenie warunku reguły. Dyskryminujące jest zawsze RuleEmailAction w tym przypadku.

Nazwa	Typ	Opis
customEmails	string[]	lista niestandardowych adresów e-mail administratora w celu powiadomienia o aktywacji alertu.
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleEmailAction	określa typ akcji. Istnieją dwa typy akcji: RuleEmailAction i RuleWebhookAction.
sendToServiceOwners	boolean	Czy administratorzy (usługa i współadministratorzy) usługi powinni otrzymywać powiadomienia po aktywowaniu alertu.

RuleManagementEventClaimsDataSource

Oświadczenia dotyczące źródła danych zdarzenia zarządzania regułami.

Nazwa	Typ	Opis
emailAddress	string	adres e-mail.

RuleManagementEventDataSource

Źródło danych zdarzenia zarządzania regułami. Pola dyskryminujące są zawsze ruleManagementEventDataSource w tym przypadku.

Nazwa	Typ	Opis
claims	RuleManagementEventClaimsDataSource	oświadczenia.
eventName	string	nazwa zdarzenia.
eventSource	string	źródło zdarzenia.
legacyResourceId	string	starszy identyfikator zasobu zasobu, który monitoruje reguła. UWAGA: nie można zaktualizować tej właściwości dla istniejącej reguły.
level	string	poziom.
metricNamespace	string	przestrzeń nazw metryki.
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource	określa typ źródła danych. Istnieją dwa typy źródeł danych reguł: RuleMetricDataSource i RuleManagementEventDataSource
operationName	string	Nazwa operacji, która powinna zostać sprawdzona. Jeśli żadna nazwa nie zostanie podana, każda operacja będzie zgodna.
resourceGroupName	string	nazwa grupy zasobów.
resourceLocation	string	lokalizacja zasobu.
resourceProviderName	string	nazwa dostawcy zasobów.
resourceUri	string	identyfikator zasobu, który monitoruje reguła. UWAGA: nie można zaktualizować tej właściwości dla istniejącej reguły.
status	string	Stan operacji, którą należy sprawdzić. Jeśli nie zostanie podany żaden stan, stan będzie zgodny.
subStatus	string	podstatu.

RuleMetricDataSource

Źródło danych metryki reguły. W tym przypadku wartość dyskryminująca jest zawsze RuleMetricDataSource.

Nazwa	Typ	Opis
legacyResourceId	string	starszy identyfikator zasobu zasobu, który monitoruje reguła. UWAGA: nie można zaktualizować tej właściwości dla istniejącej reguły.
metricName	string	nazwa metryki, która definiuje, co monitoruje reguła.
metricNamespace	string	przestrzeń nazw metryki.
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource	określa typ źródła danych. Istnieją dwa typy źródeł danych reguł: RuleMetricDataSource i RuleManagementEventDataSource
resourceLocation	string	lokalizacja zasobu.
resourceUri	string	identyfikator zasobu, który monitoruje reguła. UWAGA: nie można zaktualizować tej właściwości dla istniejącej reguły.

RuleWebhookAction

Określa akcję, która ma być publikowana w usłudze po ocenie warunku reguły. Dyskryminujące jest zawsze RuleWebhookAction w tym przypadku.

Nazwa	Typ	Opis
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleWebhookAction	określa typ akcji. Istnieją dwa typy akcji: RuleEmailAction i RuleWebhookAction.
properties	object	słownik właściwości niestandardowych do uwzględnienia w operacji po operacji. Te dane są dołączane do ładunku elementu webhook.
serviceUri	string	identyfikator URI usługi, aby opublikować powiadomienie po aktywowaniu lub rozwiązaniu alertu.

ThresholdRuleCondition

Warunek reguły oparty na metryce przekraczającej próg.

Nazwa	Typ	Opis
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	zasób, z którego reguła zbiera dane. W przypadku tego typu źródło danych zawsze będzie typu RuleMetricDataSource.
odata.type	string: Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition	określa typ warunku. Może to być jeden z trzech typów: ManagementEventRuleCondition (wystąpienia zdarzeń zarządzania), LocationThresholdRuleCondition (na podstawie liczby błędów testu internetowego) i ThresholdRuleCondition (na podstawie progu metryki).
operator	ConditionOperator	operator używany do porównywania danych i progu.
threshold	number	wartość progowa, która aktywuje alert.
timeAggregation	TimeAggregationOperator	operator agregacji czasu. Sposób łączenia zebranych danych w czasie. Wartość domyślna to PrimaryAggregationType Metryki.
windowSize	string	okres czasu (w formacie czasu trwania ISO 8601), który służy do monitorowania aktywności alertów na podstawie progu. Jeśli zostanie określony, musi to być od 5 minut do 1 dnia.

TimeAggregationOperator

Operatory agregacji dozwolone w regule.

Nazwa	Typ	Opis
Average	string
Last	string
Maximum	string
Minimum	string
Total	string

Alert Rules - Create Or Update

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Scopes

Przykłady

Create or update an alert rule

Sample Request

Sample Response

Definicje

AlertRuleResource

ConditionOperator

ErrorResponse

LocationThresholdRuleCondition

ManagementEventAggregationCondition

ManagementEventRuleCondition

RuleEmailAction

RuleManagementEventClaimsDataSource

RuleManagementEventDataSource

RuleMetricDataSource

RuleWebhookAction

ThresholdRuleCondition

TimeAggregationOperator

Dodatkowe zasoby