你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Log Analytics - Get Waf Log Analytics Metrics

Service:

Front Door Service

API Version:

2023-05-01

获取 AFD 配置文件的 Waf 相关日志分析报告。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getWafLogAnalyticsMetrics?api-version=2023-05-01&metrics=clientRequestCount&dateTimeBegin={dateTimeBegin}&dateTimeEnd={dateTimeEnd}&granularity={granularity}

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getWafLogAnalyticsMetrics?api-version=2023-05-01&metrics=clientRequestCount&dateTimeBegin={dateTimeBegin}&dateTimeEnd={dateTimeEnd}&granularity={granularity}&actions={actions}&groupBy={groupBy}&ruleTypes={ruleTypes}

URI 参数

名称	在	必需	类型	说明
profileName	path	True	string	资源组中唯一的 Azure Front Door Standard 或 Azure Front Door Premium 配置文件的名称。 在资源组中是唯一的。
resourceGroupName	path	True	string	Azure 订阅中的资源组的名称。 Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	Azure 订阅 ID。
api-version	query	True	string	要与客户端请求一起使用的 API 的版本。 当前版本为 2023-05-01。
dateTimeBegin	query	True	string date-time
dateTimeEnd	query	True	string date-time
granularity	query	True	WafGranularity
metrics	query	True	WafMetric[]
actions	query		WafAction[]
groupBy	query		WafRankingGroupBy[]
ruleTypes	query		WafRuleType[]

响应

名称	类型	说明
200 OK	WafMetricsResponse	描述成功操作的结果。
Other Status Codes	AfdErrorResponse	描述操作失败原因的 Azure Front Door 错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

LogAnalytics_GetWafLogAnalyticsMetrics

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/getWafLogAnalyticsMetrics?api-version=2023-05-01&metrics=clientRequestCount&dateTimeBegin=2020-11-04T06:49:27.554Z&dateTimeEnd=2020-11-04T09:49:27.554Z&granularity=PT5M&actions=block&actions=log

Java

import com.azure.resourcemanager.cdn.models.WafAction;
import com.azure.resourcemanager.cdn.models.WafGranularity;
import com.azure.resourcemanager.cdn.models.WafMetric;
import java.time.OffsetDateTime;
import java.util.Arrays;

/** Samples for LogAnalytics GetWafLogAnalyticsMetrics. */
public final class Main {
    /*
     * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/
     * LogAnalytics_GetWafLogAnalyticsMetrics.json
     */
    /**
     * Sample code: LogAnalytics_GetWafLogAnalyticsMetrics.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void logAnalyticsGetWafLogAnalyticsMetrics(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cdnProfiles().manager().serviceClient().getLogAnalytics().getWafLogAnalyticsMetricsWithResponse("RG",
            "profile1", Arrays.asList(WafMetric.CLIENT_REQUEST_COUNT), OffsetDateTime.parse("2020-11-04T06:49:27.554Z"),
            OffsetDateTime.parse("2020-11-04T09:49:27.554Z"), WafGranularity.PT5M,
            Arrays.asList(WafAction.BLOCK, WafAction.LOG), null, null, 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

Python

import isodate

from azure.identity import DefaultAzureCredential
from azure.mgmt.cdn import CdnManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cdn
# USAGE
    python log_analytics_get_waf_log_analytics_metrics.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 = CdnManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.log_analytics.get_waf_log_analytics_metrics(
        resource_group_name="RG",
        profile_name="profile1",
        metrics=["clientRequestCount"],
        date_time_begin=isodate.parse_datetime("2020-11-04T06:49:27.554Z"),
        date_time_end=isodate.parse_datetime("2020-11-04T09:49:27.554Z"),
        granularity="PT5M",
    )
    print(response)


# x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/LogAnalytics_GetWafLogAnalyticsMetrics.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

Go

package armcdn_test

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cdn/armcdn/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7b551033155a63739b6d28f79b9c07569f6179b8/specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/LogAnalytics_GetWafLogAnalyticsMetrics.json
func ExampleLogAnalyticsClient_GetWafLogAnalyticsMetrics() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcdn.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewLogAnalyticsClient().GetWafLogAnalyticsMetrics(ctx, "RG", "profile1", []armcdn.WafMetric{
		armcdn.WafMetricClientRequestCount}, func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-04T06:49:27.554Z"); return t }(), func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-04T09:49:27.554Z"); return t }(), armcdn.WafGranularityPT5M, &armcdn.LogAnalyticsClientGetWafLogAnalyticsMetricsOptions{Actions: []armcdn.WafAction{
		armcdn.WafActionBlock,
		armcdn.WafActionLog},
		GroupBy:   []armcdn.WafRankingGroupBy{},
		RuleTypes: []armcdn.WafRuleType{},
	})
	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.WafMetricsResponse = armcdn.WafMetricsResponse{
	// 	DateTimeBegin: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-04T06:30:27.554Z"); return t}()),
	// 	DateTimeEnd: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-04T09:00:27.554Z"); return t}()),
	// 	Granularity: to.Ptr(armcdn.WafMetricsGranularityPT5M),
	// 	Series: []*armcdn.WafMetricsResponseSeriesItem{
	// 		{
	// 			Data: []*armcdn.Components18OrqelSchemasWafmetricsresponsePropertiesSeriesItemsPropertiesDataItems{
	// 				{
	// 					DateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-04T07:05:00.000Z"); return t}()),
	// 					Value: to.Ptr[float32](2),
	// 				},
	// 				{
	// 					DateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-04T07:10:00.000Z"); return t}()),
	// 					Value: to.Ptr[float32](32),
	// 				},
	// 				{
	// 					DateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-04T07:15:00.000Z"); return t}()),
	// 					Value: to.Ptr[float32](31),
	// 				},
	// 				{
	// 					DateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-04T07:20:00.000Z"); return t}()),
	// 					Value: to.Ptr[float32](63),
	// 				},
	// 				{
	// 					DateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-04T07:25:00.000Z"); return t}()),
	// 					Value: to.Ptr[float32](50),
	// 				},
	// 				{
	// 					DateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-04T07:30:00.000Z"); return t}()),
	// 					Value: to.Ptr[float32](12),
	// 				},
	// 				{
	// 					DateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-04T07:35:00.000Z"); return t}()),
	// 					Value: to.Ptr[float32](8),
	// 				},
	// 				{
	// 					DateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-04T07:40:00.000Z"); return t}()),
	// 					Value: to.Ptr[float32](21),
	// 				},
	// 				{
	// 					DateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-04T07:45:00.000Z"); return t}()),
	// 					Value: to.Ptr[float32](30),
	// 				},
	// 				{
	// 					DateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-04T07:50:00.000Z"); return t}()),
	// 					Value: to.Ptr[float32](18),
	// 				},
	// 				{
	// 					DateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-04T07:55:00.000Z"); return t}()),
	// 					Value: to.Ptr[float32](28),
	// 				},
	// 				{
	// 					DateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-04T08:00:00.000Z"); return t}()),
	// 					Value: to.Ptr[float32](3),
	// 				},
	// 				{
	// 					DateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-04T08:05:00.000Z"); return t}()),
	// 					Value: to.Ptr[float32](58),
	// 				},
	// 				{
	// 					DateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-04T08:10:00.000Z"); return t}()),
	// 					Value: to.Ptr[float32](42),
	// 				},
	// 				{
	// 					DateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-04T08:15:00.000Z"); return t}()),
	// 					Value: to.Ptr[float32](17),
	// 				},
	// 				{
	// 					DateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-04T08:20:00.000Z"); return t}()),
	// 					Value: to.Ptr[float32](21),
	// 				},
	// 				{
	// 					DateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-04T08:25:00.000Z"); return t}()),
	// 					Value: to.Ptr[float32](41),
	// 				},
	// 				{
	// 					DateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-04T08:30:00.000Z"); return t}()),
	// 					Value: to.Ptr[float32](8),
	// 				},
	// 				{
	// 					DateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-04T08:35:00.000Z"); return t}()),
	// 					Value: to.Ptr[float32](15),
	// 				},
	// 				{
	// 					DateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-04T08:40:00.000Z"); return t}()),
	// 					Value: to.Ptr[float32](25),
	// 				},
	// 				{
	// 					DateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-04T08:45:00.000Z"); return t}()),
	// 					Value: to.Ptr[float32](13),
	// 				},
	// 				{
	// 					DateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-04T08:50:00.000Z"); return t}()),
	// 					Value: to.Ptr[float32](17),
	// 				},
	// 				{
	// 					DateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-04T08:55:00.000Z"); return t}()),
	// 					Value: to.Ptr[float32](29),
	// 				},
	// 				{
	// 					DateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-04T09:00:00.000Z"); return t}()),
	// 					Value: to.Ptr[float32](17),
	// 			}},
	// 			Groups: []*armcdn.WafMetricsResponseSeriesPropertiesItemsItem{
	// 			},
	// 			Metric: to.Ptr("clientRequestCount"),
	// 			Unit: to.Ptr(armcdn.WafMetricsSeriesUnitCount),
	// 	}},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { CdnManagementClient } = require("@azure/arm-cdn");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get Waf related log analytics report for AFD profile.
 *
 * @summary Get Waf related log analytics report for AFD profile.
 * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/LogAnalytics_GetWafLogAnalyticsMetrics.json
 */
async function logAnalyticsGetWafLogAnalyticsMetrics() {
  const subscriptionId = process.env["CDN_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["CDN_RESOURCE_GROUP"] || "RG";
  const profileName = "profile1";
  const metrics = ["clientRequestCount"];
  const dateTimeBegin = new Date("2020-11-04T06:49:27.554Z");
  const dateTimeEnd = new Date("2020-11-04T09:49:27.554Z");
  const granularity = "PT5M";
  const actions = ["block", "log"];
  const options = {
    actions,
  };
  const credential = new DefaultAzureCredential();
  const client = new CdnManagementClient(credential, subscriptionId);
  const result = await client.logAnalytics.getWafLogAnalyticsMetrics(
    resourceGroupName,
    profileName,
    metrics,
    dateTimeBegin,
    dateTimeEnd,
    granularity,
    options
  );
  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

Sample Response

Status code:

200

{
  "dateTimeBegin": "2020-11-04T14:30:27.554+08:00",
  "dateTimeEnd": "2020-11-04T17:00:27.554+08:00",
  "granularity": "PT5M",
  "series": [
    {
      "metric": "clientRequestCount",
      "unit": "count",
      "groups": [],
      "data": [
        {
          "dateTime": "2020-11-04T07:05:00+00:00",
          "value": 2
        },
        {
          "dateTime": "2020-11-04T07:10:00+00:00",
          "value": 32
        },
        {
          "dateTime": "2020-11-04T07:15:00+00:00",
          "value": 31
        },
        {
          "dateTime": "2020-11-04T07:20:00+00:00",
          "value": 63
        },
        {
          "dateTime": "2020-11-04T07:25:00+00:00",
          "value": 50
        },
        {
          "dateTime": "2020-11-04T07:30:00+00:00",
          "value": 12
        },
        {
          "dateTime": "2020-11-04T07:35:00+00:00",
          "value": 8
        },
        {
          "dateTime": "2020-11-04T07:40:00+00:00",
          "value": 21
        },
        {
          "dateTime": "2020-11-04T07:45:00+00:00",
          "value": 30
        },
        {
          "dateTime": "2020-11-04T07:50:00+00:00",
          "value": 18
        },
        {
          "dateTime": "2020-11-04T07:55:00+00:00",
          "value": 28
        },
        {
          "dateTime": "2020-11-04T08:00:00+00:00",
          "value": 3
        },
        {
          "dateTime": "2020-11-04T08:05:00+00:00",
          "value": 58
        },
        {
          "dateTime": "2020-11-04T08:10:00+00:00",
          "value": 42
        },
        {
          "dateTime": "2020-11-04T08:15:00+00:00",
          "value": 17
        },
        {
          "dateTime": "2020-11-04T08:20:00+00:00",
          "value": 21
        },
        {
          "dateTime": "2020-11-04T08:25:00+00:00",
          "value": 41
        },
        {
          "dateTime": "2020-11-04T08:30:00+00:00",
          "value": 8
        },
        {
          "dateTime": "2020-11-04T08:35:00+00:00",
          "value": 15
        },
        {
          "dateTime": "2020-11-04T08:40:00+00:00",
          "value": 25
        },
        {
          "dateTime": "2020-11-04T08:45:00+00:00",
          "value": 13
        },
        {
          "dateTime": "2020-11-04T08:50:00+00:00",
          "value": 17
        },
        {
          "dateTime": "2020-11-04T08:55:00+00:00",
          "value": 29
        },
        {
          "dateTime": "2020-11-04T09:00:00+00:00",
          "value": 17
        }
      ]
    }
  ]
}

定义

名称	说明
AfdErrorResponse	错误响应
Data
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
Groups
MetricsSeriesUnit
Series
WafAction
WafGranularity
WafMetric
WafMetricsGranularity
WafMetricsResponse	Waf 指标响应
WafRankingGroupBy
WafRuleType

AfdErrorResponse

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

Data

名称	类型	说明
dateTime	string
value	number

ErrorAdditionalInfo

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

Groups

名称	类型	说明
name	string
value	string

MetricsSeriesUnit

名称	类型	说明
bitsPerSecond	string
bytes	string
count	string
milliSeconds	string

Series

名称	类型	说明
data	Data[]
groups	Groups[]
metric	string
unit	MetricsSeriesUnit

WafAction

名称	类型	说明
allow	string
block	string
log	string
redirect	string

WafGranularity

名称	类型	说明
P1D	string
PT1H	string
PT5M	string

WafMetric

名称	类型	说明
clientRequestCount	string

WafMetricsGranularity

名称	类型	说明
P1D	string
PT1H	string
PT5M	string

WafMetricsResponse

Waf 指标响应

名称	类型	说明
dateTimeBegin	string
dateTimeEnd	string
granularity	WafMetricsGranularity
series	Series[]

WafRankingGroupBy

名称	类型	说明
customDomain	string
httpStatusCode	string

WafRuleType

名称	类型	说明
bot	string
custom	string
managed	string