Activity Log Alerts - Update

Referencia

Szolgáltatás:: Monitor

API-verzió:: 2020-10-01

Frissítések "tags" és "enabled" mezőket egy meglévő riasztási szabályban. Ez a módszer a riasztási szabály címkéinek frissítésére, valamint a riasztási szabály engedélyezésére vagy letiltására szolgál. Más mezők frissítéséhez használja a CreateOrUpdate műveletet.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/activityLogAlerts/{activityLogAlertName}?api-version=2020-10-01

URI-paraméterek

Name	In	Kötelező	Típus	Description
activityLogAlertName	path	True	string	A tevékenységnapló-riasztási szabály neve.
resourceGroupName	path	True	string	Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket.
subscriptionId	path	True	string	A cél-előfizetés azonosítója.
api-version	query	True	string	A művelethez használandó API-verzió.

Kérelem törzse

Name	Típus	Description
properties.enabled	boolean	Azt jelzi, hogy engedélyezve van-e ez a tevékenységnapló-riasztási szabály. Ha egy tevékenységnapló-riasztási szabály nincs engedélyezve, akkor egyik művelete sem lesz aktiválva.
tags	object	Az erőforráscímkék

Válaszok

Name	Típus	Description
200 OK	ActivityLogAlertResource	Sikeresen frissítettek egy meglévő tevékenységnapló-riasztási szabályt.
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

Patch an Activity Log Alert rule

Mintakérelem

PATCH https://management.azure.com/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/activityLogAlerts/SampleActivityLogAlertRule?api-version=2020-10-01

{
  "tags": {
    "key1": "value1",
    "key2": "value2"
  },
  "properties": {
    "enabled": false
  }
}


import com.azure.resourcemanager.monitor.models.AlertRulePatchObject;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for ActivityLogAlerts Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/monitor/resource-manager/Microsoft.Insights/stable/2020-10-01/examples/ActivityLogAlertRule_Update.
     * json
     */
    /**
     * Sample code: Patch an Activity Log Alert rule.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void patchAnActivityLogAlertRule(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.diagnosticSettings().manager().serviceClient().getActivityLogAlerts().updateWithResponse(
            "MyResourceGroup", "SampleActivityLogAlertRule", new AlertRulePatchObject()
                .withTags(mapOf("key1", "fakeTokenPlaceholder", "key2", "fakeTokenPlaceholder")).withEnabled(false),
            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/2020-10-01/examples/ActivityLogAlertRule_Update.json
func ExampleActivityLogAlertsClient_Update() {
	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.NewActivityLogAlertsClient().Update(ctx, "MyResourceGroup", "SampleActivityLogAlertRule", armmonitor.AlertRulePatchObject{
		Properties: &armmonitor.AlertRulePatchProperties{
			Enabled: to.Ptr(false),
		},
		Tags: map[string]*string{
			"key1": to.Ptr("value1"),
			"key2": to.Ptr("value2"),
		},
	}, 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.ActivityLogAlertResource = armmonitor.ActivityLogAlertResource{
	// 	Name: to.Ptr("SampleActivityLogAlertRule"),
	// 	Type: to.Ptr("Microsoft.Insights/ActivityLogAlerts"),
	// 	ID: to.Ptr("/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRule"),
	// 	Location: to.Ptr("Global"),
	// 	Tags: map[string]*string{
	// 		"key1": to.Ptr("value1"),
	// 		"key2": to.Ptr("value2"),
	// 	},
	// 	Properties: &armmonitor.AlertRuleProperties{
	// 		Description: to.Ptr("Description of sample Activity Log Alert rule."),
	// 		Actions: &armmonitor.ActionList{
	// 			ActionGroups: []*armmonitor.ActionGroupAutoGenerated{
	// 				{
	// 					ActionGroupID: to.Ptr("/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/actionGroups/SampleActionGroup"),
	// 					WebhookProperties: map[string]*string{
	// 						"sampleWebhookProperty": to.Ptr("SamplePropertyValue"),
	// 					},
	// 			}},
	// 		},
	// 		Condition: &armmonitor.AlertRuleAllOfCondition{
	// 			AllOf: []*armmonitor.AlertRuleAnyOfOrLeafCondition{
	// 				{
	// 					Equals: to.Ptr("Administrative"),
	// 					Field: to.Ptr("category"),
	// 				},
	// 				{
	// 					Equals: to.Ptr("Error"),
	// 					Field: to.Ptr("level"),
	// 			}},
	// 		},
	// 		Enabled: to.Ptr(false),
	// 		Scopes: []*string{
	// 			to.Ptr("/subscriptions/187f412d-1758-44d9-b052-169e2564721d")},
	// 		},
	// 	}
}

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 Updates 'tags' and 'enabled' fields in an existing Alert rule. This method is used to update the Alert rule tags, and to enable or disable the Alert rule. To update other fields use CreateOrUpdate operation.
 *
 * @summary Updates 'tags' and 'enabled' fields in an existing Alert rule. This method is used to update the Alert rule tags, and to enable or disable the Alert rule. To update other fields use CreateOrUpdate operation.
 * x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/stable/2020-10-01/examples/ActivityLogAlertRule_Update.json
 */
async function patchAnActivityLogAlertRule() {
  const subscriptionId =
    process.env["MONITOR_SUBSCRIPTION_ID"] || "187f412d-1758-44d9-b052-169e2564721d";
  const resourceGroupName = process.env["MONITOR_RESOURCE_GROUP"] || "MyResourceGroup";
  const activityLogAlertName = "SampleActivityLogAlertRule";
  const activityLogAlertRulePatch = {
    enabled: false,
    tags: { key1: "value1", key2: "value2" },
  };
  const credential = new DefaultAzureCredential();
  const client = new MonitorClient(credential, subscriptionId);
  const result = await client.activityLogAlerts.update(
    resourceGroupName,
    activityLogAlertName,
    activityLogAlertRulePatch,
  );
  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 Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Monitor.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Monitor;

// Generated from example definition: specification/monitor/resource-manager/Microsoft.Insights/stable/2020-10-01/examples/ActivityLogAlertRule_Update.json
// this example is just showing the usage of "ActivityLogAlerts_Update" 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 ActivityLogAlertResource created on azure
// for more information of creating ActivityLogAlertResource, please refer to the document of ActivityLogAlertResource
string subscriptionId = "187f412d-1758-44d9-b052-169e2564721d";
string resourceGroupName = "MyResourceGroup";
string activityLogAlertName = "SampleActivityLogAlertRule";
ResourceIdentifier activityLogAlertResourceId = ActivityLogAlertResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, activityLogAlertName);
ActivityLogAlertResource activityLogAlert = client.GetActivityLogAlertResource(activityLogAlertResourceId);

// invoke the operation
ActivityLogAlertPatch patch = new ActivityLogAlertPatch()
{
    Tags =
    {
    ["key1"] = "value1",
    ["key2"] = "value2",
    },
    IsEnabled = false,
};
ActivityLogAlertResource result = await activityLogAlert.UpdateAsync(patch);

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

Mintaválasz

Állapotkód:: 200

{
  "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRule",
  "type": "Microsoft.Insights/ActivityLogAlerts",
  "name": "SampleActivityLogAlertRule",
  "location": "Global",
  "tags": {
    "key1": "value1",
    "key2": "value2"
  },
  "properties": {
    "scopes": [
      "/subscriptions/187f412d-1758-44d9-b052-169e2564721d"
    ],
    "condition": {
      "allOf": [
        {
          "field": "category",
          "equals": "Administrative"
        },
        {
          "field": "level",
          "equals": "Error"
        }
      ]
    },
    "actions": {
      "actionGroups": [
        {
          "actionGroupId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/actionGroups/SampleActionGroup",
          "webhookProperties": {
            "sampleWebhookProperty": "SamplePropertyValue"
          }
        }
      ]
    },
    "enabled": false,
    "description": "Description of sample Activity Log Alert rule."
  }
}

Definíciók

Name	Description
ActionGroup	Egy Azure-műveletcsoportra mutató mutató.
ActionList	A tevékenységnapló-riasztási szabályműveletek listája.
ActivityLogAlertResource	Tevékenységnapló-riasztási szabály erőforrása.
AlertRuleAllOfCondition	Tevékenységnapló-riasztási szabályfeltétel, amely akkor teljesül, ha az összes tagfeltétel teljesül.
AlertRuleAnyOfOrLeafCondition	Tevékenységnapló-riasztási szabályfeltétel, amely akkor teljesül, ha az összes tagfeltétel teljesül. Minden feltétel a következő típusok valamelyike lehet: Fontos: Minden típus egyedi tulajdonsághalmazsal rendelkezik. A különböző típusú tulajdonságok nem létezhetnek egy feltételben. Levélfeltétel – a "mező" és az "equals" vagy a "containsAny" értéket kell tartalmaznia. Kérjük, vegye figyelembe, hogy az "anyOf" nem* állítható be levélfeltételben.* AnyOf feltétel –csak "anyOf" (levélfeltételek tömbje) tartalmazhat. Vegye figyelembe, hogy a "mező", az "equals" és a "containsAny" nem* állítható be AnyOf feltételben.*
AlertRuleLeafCondition	Tevékenységnapló-riasztási szabályfeltétel, amely egy tevékenységnapló-esemény mezőjének és értékének összehasonlításával teljesül. Ennek a feltételnek tartalmaznia kell a "mező" és az "equals" vagy a "containsAny" értéket.
AlertRulePatchObject	A javítási műveletek törzsének tevékenységnapló-riasztási szabályobjektuma.
ErrorResponse	A hibaválasz.

ActionGroup

Egy Azure-műveletcsoportra mutató mutató.

Name	Típus	Description
actionGroupId	string	A műveletcsoport erőforrás-azonosítója. Ez nem lehet null értékű vagy üres.
webhookProperties	object	a post művelethez felvenni kívánt egyéni tulajdonságok szótárát. Ezek az adatok hozzá vannak fűzve a webhook hasznos adataihoz.

ActionList

A tevékenységnapló-riasztási szabályműveletek listája.

Name	Típus	Description
actionGroups	ActionGroup[]	A műveletcsoportok listája.

ActivityLogAlertResource

Tevékenységnapló-riasztási szabály erőforrása.

Name	Típus	Alapértelmezett érték	Description
id	string		Az erőforrás azonosítója.
location	string	global	Az erőforrás helye. Az Azure-tevékenységnapló-riasztási szabályok a globális, a nyugat-európai és az észak-európai régiókban támogatottak.
name	string		Az erőforrás neve.
properties.actions	ActionList		A feltétel teljesülésekor aktiválni kívánt műveletek.
properties.condition	AlertRuleAllOfCondition		A riasztás aktiválását okozó feltétel.
properties.description	string		Ennek a tevékenységnapló-riasztási szabálynak a leírása.
properties.enabled	boolean	True	Azt jelzi, hogy engedélyezve van-e ez a tevékenységnapló-riasztási szabály. Ha egy tevékenységnapló-riasztási szabály nincs engedélyezve, akkor egyik művelete sem lesz aktiválva.
properties.scopes	string[]		Az előtagként használni kívánt erőforrás-azonosítók listája. A riasztás csak olyan tevékenységnapló-eseményekre vonatkozik, amelyek erőforrás-azonosítói ezen előtagok valamelyike alá tartoznak. Ennek a listának legalább egy elemet tartalmaznia kell.
tags	object		Az erőforrás címkéi.
type	string		Az erőforrás típusa.

AlertRuleAllOfCondition

Tevékenységnapló-riasztási szabályfeltétel, amely akkor teljesül, ha az összes tagfeltétel teljesül.

Name	Típus	Description
allOf	AlertRuleAnyOfOrLeafCondition[]	A tevékenységnapló-riasztási szabályfeltételek listája.

AlertRuleAnyOfOrLeafCondition

Tevékenységnapló-riasztási szabályfeltétel, amely akkor teljesül, ha az összes tagfeltétel teljesül. Minden feltétel a következő típusok valamelyike lehet: Fontos: Minden típus egyedi tulajdonsághalmazsal rendelkezik. A különböző típusú tulajdonságok nem létezhetnek egy feltételben.

Levélfeltétel – a "mező" és az "equals" vagy a "containsAny" értéket kell tartalmaznia. Kérjük, vegye figyelembe, hogy az "anyOf" nem állítható be levélfeltételben.
AnyOf feltétel –csak "anyOf" (levélfeltételek tömbje) tartalmazhat. Vegye figyelembe, hogy a "mező", az "equals" és a "containsAny" nem állítható be AnyOf feltételben.

Name	Típus	Description
anyOf	AlertRuleLeafCondition[]	Tevékenységnapló-riasztási szabály "anyOf" feltétel. Egy tevékenységnapló-riasztási szabályfeltétel, amely akkor teljesül, ha legalább az egyik taglevélfeltétel teljesül.
containsAny	string[]	Az esemény mezőjének értékét a rendszer összehasonlítja a tömb értékeivel (kis- és nagybetűk megkülönböztetése), hogy megállapítsa, teljesül-e a feltétel.
equals	string	Az esemény mezőjének értéke ehhez az értékhez lesz összehasonlítani (kis- és nagybetűk megkülönböztetése), hogy megállapítsa, teljesül-e a feltétel.
field	string	Annak a tevékenységnapló-eseménynek a neve, amelyet ez a feltétel megvizsgál. Ennek a mezőnek a lehetséges értékei (kis- és nagybetűk megkülönböztetése): "resourceId", "category", "caller", "level", "operationName", "resourceGroup", "resourceProvider", "status", "subStatus", "resourceType", vagy bármi, amely "tulajdonságok" kezdetű.

AlertRuleLeafCondition

Tevékenységnapló-riasztási szabályfeltétel, amely egy tevékenységnapló-esemény mezőjének és értékének összehasonlításával teljesül. Ennek a feltételnek tartalmaznia kell a "mező" és az "equals" vagy a "containsAny" értéket.

Name	Típus	Description
containsAny	string[]	Az esemény mezőjének értékét a rendszer összehasonlítja a tömb értékeivel (kis- és nagybetűk megkülönböztetése), hogy megállapítsa, teljesül-e a feltétel.
equals	string	Az esemény mezőjének értéke ehhez az értékhez lesz összehasonlítani (kis- és nagybetűk megkülönböztetése), hogy megállapítsa, teljesül-e a feltétel.
field	string	Annak a tevékenységnapló-eseménynek a neve, amelyet ez a feltétel megvizsgál. Ennek a mezőnek a lehetséges értékei (kis- és nagybetűk megkülönböztetése): "resourceId", "category", "caller", "level", "operationName", "resourceGroup", "resourceProvider", "status", "subStatus", "resourceType", vagy bármi, amely "tulajdonságok" kezdetű.

AlertRulePatchObject

A javítási műveletek törzsének tevékenységnapló-riasztási szabályobjektuma.

Name	Típus	Alapértelmezett érték	Description
properties.enabled	boolean	True	Azt jelzi, hogy engedélyezve van-e ez a tevékenységnapló-riasztási szabály. Ha egy tevékenységnapló-riasztási szabály nincs engedélyezve, akkor egyik művelete sem lesz aktiválva.
tags	object		Az erőforráscímkék

ErrorResponse

A hibaválasz.

Name	Típus	Description
code	string	A hibakód.
message	string	A művelet meghiúsulását jelző hibaüzenet.

Megosztás a következőn keresztül:

Activity Log Alerts - Update

URI-paraméterek

Kérelem törzse

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

Patch an Activity Log Alert rule

Mintakérelem

Mintaválasz

Definíciók

ActionGroup

ActionList

ActivityLogAlertResource

AlertRuleAllOfCondition

AlertRuleAnyOfOrLeafCondition

AlertRuleLeafCondition

AlertRulePatchObject

ErrorResponse

További források