Activity Log Alerts - Get

Referensi

Layanan:: Monitor

Versi API:: 2020-10-01

Mendapatkan aturan Pemberitahuan Log Aktivitas.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
activityLogAlertName	path	True	string	Nama aturan Pemberitahuan Log Aktivitas.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.
subscriptionId	path	True	string minLength: 1	ID langganan target.
api-version	query	True	string minLength: 1	Versi API yang akan digunakan untuk operasi ini.

Respons

Nama	Jenis	Deskripsi
200 OK	ActivityLogAlertResource	Permintaan berhasil.
Other Status Codes	ErrorResponse	Terjadi kesalahan dan aturan Pemberitahuan Log Aktivitas tidak dapat diambil.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

Get an Activity Log Alert rule

Permintaan sampel

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


/**
 * Samples for ActivityLogAlerts GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/monitor/resource-manager/Microsoft.Insights/stable/2020-10-01/examples/ActivityLogAlertRule_Get.
     * json
     */
    /**
     * Sample code: Get an Activity Log Alert rule.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAnActivityLogAlertRule(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.diagnosticSettings().manager().serviceClient().getActivityLogAlerts().getByResourceGroupWithResponse(
            "MyResourceGroup", "SampleActivityLogAlertRule", 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

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/2020-10-01/examples/ActivityLogAlertRule_Get.json
func ExampleActivityLogAlertsClient_Get() {
	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().Get(ctx, "MyResourceGroup", "SampleActivityLogAlertRule", 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{
	// 	},
	// 	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(true),
	// 		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 Get an Activity Log Alert rule.
 *
 * @summary Get an Activity Log Alert rule.
 * x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/stable/2020-10-01/examples/ActivityLogAlertRule_Get.json
 */
async function getAnActivityLogAlertRule() {
  const subscriptionId =
    process.env["MONITOR_SUBSCRIPTION_ID"] || "187f412d-1758-44d9-b052-169e2564721d";
  const resourceGroupName = process.env["MONITOR_RESOURCE_GROUP"] || "MyResourceGroup";
  const activityLogAlertName = "SampleActivityLogAlertRule";
  const credential = new DefaultAzureCredential();
  const client = new MonitorClient(credential, subscriptionId);
  const result = await client.activityLogAlerts.get(resourceGroupName, activityLogAlertName);
  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_Get.json
// this example is just showing the usage of "ActivityLogAlerts_Get" 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 = "187f412d-1758-44d9-b052-169e2564721d";
string resourceGroupName = "MyResourceGroup";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this ActivityLogAlertResource
ActivityLogAlertCollection collection = resourceGroupResource.GetActivityLogAlerts();

// invoke the operation
string activityLogAlertName = "SampleActivityLogAlertRule";
NullableResponse<ActivityLogAlertResource> response = await collection.GetIfExistsAsync(activityLogAlertName);
ActivityLogAlertResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // 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

Respon sampel

Kode status:: 200

{
  "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRule",
  "type": "Microsoft.Insights/ActivityLogAlerts",
  "name": "SampleActivityLogAlertRule",
  "location": "Global",
  "tags": {},
  "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": true,
    "description": "Description of sample Activity Log Alert rule."
  }
}

Definisi

Nama	Deskripsi
ActionGroup	Penunjuk ke Grup Tindakan Azure.
ActionList	Daftar tindakan aturan Pemberitahuan Log Aktivitas.
ActivityLogAlertResource	Sumber daya aturan Pemberitahuan Log Aktivitas.
AlertRuleAllOfCondition	Kondisi aturan Pemberitahuan Log Aktivitas yang terpenuhi saat semua kondisi anggotanya terpenuhi.
AlertRuleAnyOfOrLeafCondition	Kondisi aturan Pemberitahuan Log Aktivitas yang terpenuhi saat semua kondisi anggotanya terpenuhi. Setiap kondisi dapat berupa salah satu jenis berikut: Penting : Setiap jenis memiliki subset properti yang unik. Properti dari berbagai jenis TIDAK DAPAT ada dalam satu kondisi. Kondisi Daun - harus berisi 'bidang' dan 'sama dengan' atau 'containsAny'. Harap dicatat, 'anyOf' harus tidak* diatur dalam Kondisi Daun.* Kondisi AnyOf - harus berisi hanya 'anyOf' (yang merupakan larik Kondisi Daun). Harap dicatat, 'field', 'equals' dan 'containsAny' harus tidak* diatur dalam Kondisi AnyOf.*
AlertRuleLeafCondition	Kondisi aturan Pemberitahuan Log Aktivitas yang terpenuhi dengan membandingkan bidang dan nilai peristiwa Log Aktivitas. Kondisi ini harus berisi 'bidang' dan 'sama dengan' atau 'containsAny'.
ErrorResponse	Respons kesalahan.

ActionGroup

Objek

Penunjuk ke Grup Tindakan Azure.

Nama	Jenis	Deskripsi
actionGroupId	string	ID sumber daya Grup Tindakan. Ini tidak boleh null atau kosong.
webhookProperties	object	kamus properti kustom untuk disertakan dengan operasi pasca. Data ini ditambahkan ke payload webhook.

ActionList

Objek

Daftar tindakan aturan Pemberitahuan Log Aktivitas.

Nama	Jenis	Deskripsi
actionGroups	ActionGroup[]	Daftar Grup Tindakan.

ActivityLogAlertResource

Objek

Sumber daya aturan Pemberitahuan Log Aktivitas.

Nama	Jenis	Nilai default	Deskripsi
id	string		Id sumber daya.
location	string	global	Lokasi sumber daya. Aturan Pemberitahuan Log Aktivitas Azure didukung di wilayah Global, Eropa Barat, dan Eropa Utara.
name	string		Nama sumber daya.
properties.actions	ActionList		Tindakan yang akan diaktifkan saat kondisi terpenuhi.
properties.condition	AlertRuleAllOfCondition		Kondisi yang akan menyebabkan pemberitahuan ini diaktifkan.
properties.description	string		Deskripsi aturan Pemberitahuan Log Aktivitas ini.
properties.enabled	boolean	True	Menunjukkan apakah aturan Pemberitahuan Log Aktivitas ini diaktifkan. Jika aturan Pemberitahuan Log Aktivitas tidak diaktifkan, maka tidak ada tindakannya yang akan diaktifkan.
properties.scopes	string[]		Daftar ID sumber daya yang akan digunakan sebagai awalan. Pemberitahuan hanya akan berlaku untuk peristiwa Log Aktivitas dengan ID sumber daya yang termasuk dalam salah satu awalan ini. Daftar ini harus menyertakan setidaknya satu item.
tags	object		Tag sumber daya.
type	string		Jenis sumber daya.

AlertRuleAllOfCondition

Objek

Kondisi aturan Pemberitahuan Log Aktivitas yang terpenuhi saat semua kondisi anggotanya terpenuhi.

Nama	Jenis	Deskripsi
allOf	AlertRuleAnyOfOrLeafCondition[]	Daftar kondisi aturan Pemberitahuan Log Aktivitas.

AlertRuleAnyOfOrLeafCondition

Objek

Kondisi aturan Pemberitahuan Log Aktivitas yang terpenuhi saat semua kondisi anggotanya terpenuhi. Setiap kondisi dapat berupa salah satu jenis berikut: Penting : Setiap jenis memiliki subset properti yang unik. Properti dari berbagai jenis TIDAK DAPAT ada dalam satu kondisi.

Kondisi Daun - harus berisi 'bidang' dan 'sama dengan' atau 'containsAny'. Harap dicatat, 'anyOf' harus tidak diatur dalam Kondisi Daun.
Kondisi AnyOf - harus berisi hanya 'anyOf' (yang merupakan larik Kondisi Daun). Harap dicatat, 'field', 'equals' dan 'containsAny' harus tidak diatur dalam Kondisi AnyOf.

Nama	Jenis	Deskripsi
anyOf	AlertRuleLeafCondition[]	Aturan Pemberitahuan Log Aktivitas kondisi 'anyOf'. Kondisi aturan Pemberitahuan Log Aktivitas yang terpenuhi ketika setidaknya salah satu kondisi daun anggotanya terpenuhi.
containsAny	string[]	Nilai bidang peristiwa akan dibandingkan dengan nilai dalam array ini (tidak peka huruf besar/kecil) untuk menentukan apakah kondisi terpenuhi.
equals	string	Nilai bidang peristiwa akan dibandingkan dengan nilai ini (tidak peka huruf besar/kecil) untuk menentukan apakah kondisi terpenuhi.
field	string	Nama bidang peristiwa Log Aktivitas yang akan diperiksa kondisi ini. Nilai yang mungkin untuk bidang ini adalah (tidak peka huruf besar/kecil): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', atau apa pun yang dimulai dengan 'properti'.

AlertRuleLeafCondition

Objek

Kondisi aturan Pemberitahuan Log Aktivitas yang terpenuhi dengan membandingkan bidang dan nilai peristiwa Log Aktivitas. Kondisi ini harus berisi 'bidang' dan 'sama dengan' atau 'containsAny'.

Nama	Jenis	Deskripsi
containsAny	string[]	Nilai bidang peristiwa akan dibandingkan dengan nilai dalam array ini (tidak peka huruf besar/kecil) untuk menentukan apakah kondisi terpenuhi.
equals	string	Nilai bidang peristiwa akan dibandingkan dengan nilai ini (tidak peka huruf besar/kecil) untuk menentukan apakah kondisi terpenuhi.
field	string	Nama bidang peristiwa Log Aktivitas yang akan diperiksa kondisi ini. Nilai yang mungkin untuk bidang ini adalah (tidak peka huruf besar/kecil): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', atau apa pun yang dimulai dengan 'properti'.

ErrorResponse

Objek

Respons kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan.
message	string	Pesan kesalahan yang menunjukkan mengapa operasi gagal.

Bagikan melalui

Activity Log Alerts - Get

Parameter URI

Respons

Keamanan

azure_auth

Cakupan

Contoh

Get an Activity Log Alert rule

Permintaan sampel

Respon sampel

Definisi

ActionGroup

ActionList

ActivityLogAlertResource

AlertRuleAllOfCondition

AlertRuleAnyOfOrLeafCondition

AlertRuleLeafCondition

ErrorResponse

Sumber Daya Tambahan: