Activity Log Alerts - Update

Referens

Tjänst:: Monitor

API-version:: 2020-10-01

Uppdateringar "taggar" och "aktiverade" fält i en befintlig aviseringsregel. Den här metoden används för att uppdatera aviseringsregeltaggar och för att aktivera eller inaktivera aviseringsregeln. Om du vill uppdatera andra fält använder du åtgärden CreateOrUpdate.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
activityLogAlertName	path	True	string	Namnet på aviseringsregeln för aktivitetsloggen.
resourceGroupName	path	True	string	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string	ID för målprenumerationen.
api-version	query	True	string	Den API-version som ska användas för den här åtgärden.

Begärandetext

Name	Typ	Description
properties.enabled	boolean	Anger om den här aviseringsregeln för aktivitetslogg är aktiverad. Om en aktivitetsloggaviseringsregel inte är aktiverad aktiveras ingen av dess åtgärder.
tags	object	Resurstaggar

Svar

Name	Typ	Description
200 OK	ActivityLogAlertResource	En befintlig aktivitetsloggaviseringsregel har uppdaterats.
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Patch an Activity Log Alert rule

Exempelbegäran

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

Exempelsvar

Statuskod:: 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."
  }
}

Definitioner

Name	Description
ActionGroup	En pekare till en Azure-åtgärdsgrupp.
ActionList	En lista över aktivitetsloggens aviseringsregelåtgärder.
ActivityLogAlertResource	En resurs för aktivitetsloggaviseringsregler.
AlertRuleAllOfCondition	Ett regelvillkor för aktivitetsloggavisering som uppfylls när alla dess medlemsvillkor uppfylls.
AlertRuleAnyOfOrLeafCondition	Ett regelvillkor för aktivitetsloggavisering som uppfylls när alla dess medlemsvillkor uppfylls. Varje villkor kan vara av någon av följande typer: Viktigt: Varje typ har sin unika delmängd av egenskaper. Egenskaper från olika typer KAN INTE finnas i ett villkor. Lövvillkor – måste innehålla "field" och antingen "equals" eller "containsAny". Observera att "anyOf" inte* ska anges i ett lövvillkor.* AnyOf-villkor – får bara innehålla 'anyOf' (som är en matris med lövvillkor). Observera att "field", "equals" och "containsAny" inte* ska anges i ett AnyOf-villkor.*
AlertRuleLeafCondition	Ett regelvillkor för aktivitetsloggavisering som uppfylls genom att jämföra fältet och värdet för en aktivitetslogghändelse. Det här villkoret måste innehålla "field" och antingen "equals" eller "containsAny".
AlertRulePatchObject	Ett aktivitetsloggaviseringsregelobjekt för brödtexten för korrigeringsåtgärder.
ErrorResponse	Felsvaret.

ActionGroup

En pekare till en Azure-åtgärdsgrupp.

Name	Typ	Description
actionGroupId	string	Resurs-ID för åtgärdsgruppen. Detta får inte vara null eller tomt.
webhookProperties	object	ordlistan med anpassade egenskaper som ska inkluderas i poståtgärden. Dessa data läggs till i webhookens nyttolast.

ActionList

En lista över aktivitetsloggens aviseringsregelåtgärder.

Name	Typ	Description
actionGroups	ActionGroup[]	Listan över åtgärdsgrupper.

ActivityLogAlertResource

En resurs för aktivitetsloggaviseringsregler.

Name	Typ	Standardvärde	Description
id	string		Resurs-ID:t.
location	string	global	Platsen för resursen. Azure Activity Log Alert-regler stöds i regionerna Global, Europa, västra och Europa, norra.
name	string		Namnet på resursen.
properties.actions	ActionList		De åtgärder som aktiveras när villkoret uppfylls.
properties.condition	AlertRuleAllOfCondition		Villkoret som gör att aviseringen aktiveras.
properties.description	string		En beskrivning av den här aviseringsregeln för aktivitetsloggen.
properties.enabled	boolean	True	Anger om den här aviseringsregeln för aktivitetslogg är aktiverad. Om en aktivitetsloggaviseringsregel inte är aktiverad aktiveras ingen av dess åtgärder.
properties.scopes	string[]		En lista över resurs-ID:t som ska användas som prefix. Aviseringen gäller endast för aktivitetslogghändelser med resurs-ID:t som omfattas av något av dessa prefix. Listan måste innehålla minst ett objekt.
tags	object		Taggarna för resursen.
type	string		Resurstypen.

AlertRuleAllOfCondition

Ett regelvillkor för aktivitetsloggavisering som uppfylls när alla dess medlemsvillkor uppfylls.

Name	Typ	Description
allOf	AlertRuleAnyOfOrLeafCondition[]	Listan över villkor för aktivitetsloggaviseringsregler.

AlertRuleAnyOfOrLeafCondition

Ett regelvillkor för aktivitetsloggavisering som uppfylls när alla dess medlemsvillkor uppfylls. Varje villkor kan vara av någon av följande typer: Viktigt: Varje typ har sin unika delmängd av egenskaper. Egenskaper från olika typer KAN INTE finnas i ett villkor.

Lövvillkor – måste innehålla "field" och antingen "equals" eller "containsAny". Observera att "anyOf" inte ska anges i ett lövvillkor.
AnyOf-villkor – får bara innehålla 'anyOf' (som är en matris med lövvillkor). Observera att "field", "equals" och "containsAny" inte ska anges i ett AnyOf-villkor.

Name	Typ	Description
anyOf	AlertRuleLeafCondition[]	Ett villkor för aktivitetsloggaviseringsregeln "anyOf". Ett regelvillkor för aktivitetsloggavisering som uppfylls när minst ett av dess lövvillkor för medlemmar uppfylls.
containsAny	string[]	Värdet för händelsens fält jämförs med värdena i den här matrisen (skiftlägesokänsliga) för att avgöra om villkoret uppfylls.
equals	string	Värdet för händelsens fält jämförs med det här värdet (skiftlägesokänsligt) för att avgöra om villkoret uppfylls.
field	string	Namnet på aktivitetslogghändelsens fält som villkoret ska undersöka. Möjliga värden för det här fältet är (skiftlägesokänsliga): "resourceId", "category", "caller", "level", "operationName", "resourceGroup", "resourceProvider", "status", "subStatus", "resourceType" eller något som börjar med "properties".

AlertRuleLeafCondition

Ett regelvillkor för aktivitetsloggavisering som uppfylls genom att jämföra fältet och värdet för en aktivitetslogghändelse. Det här villkoret måste innehålla "field" och antingen "equals" eller "containsAny".

Name	Typ	Description
containsAny	string[]	Värdet för händelsens fält jämförs med värdena i den här matrisen (skiftlägesokänsliga) för att avgöra om villkoret uppfylls.
equals	string	Värdet för händelsens fält jämförs med det här värdet (skiftlägesokänsligt) för att avgöra om villkoret uppfylls.
field	string	Namnet på aktivitetslogghändelsens fält som villkoret ska undersöka. Möjliga värden för det här fältet är (skiftlägesokänsliga): "resourceId", "category", "caller", "level", "operationName", "resourceGroup", "resourceProvider", "status", "subStatus", "resourceType" eller något som börjar med "properties".

AlertRulePatchObject

Ett aktivitetsloggaviseringsregelobjekt för brödtexten för korrigeringsåtgärder.

Name	Typ	Standardvärde	Description
properties.enabled	boolean	True	Anger om den här aviseringsregeln för aktivitetslogg är aktiverad. Om en aktivitetsloggaviseringsregel inte är aktiverad aktiveras ingen av dess åtgärder.
tags	object		Resurstaggar

ErrorResponse

Felsvaret.

Name	Typ	Description
code	string	Felkoden.
message	string	Felmeddelandet som anger varför åtgärden misslyckades.

Dela via

Activity Log Alerts - Update

URI-parametrar

Begärandetext

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

Patch an Activity Log Alert rule

Exempelbegäran

Exempelsvar

Definitioner

ActionGroup

ActionList

ActivityLogAlertResource

AlertRuleAllOfCondition

AlertRuleAnyOfOrLeafCondition

AlertRuleLeafCondition

AlertRulePatchObject

ErrorResponse

Ytterligare resurser