Log Analytics - Get Waf Log Analytics Rankings

服务:

Front Door Service

API 版本:

2025-04-15

获取 AFD 配置文件的 WAF 日志分析图表

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getWafLogAnalyticsRankings?api-version=2025-04-15&metrics=clientRequestCount&dateTimeBegin={dateTimeBegin}&dateTimeEnd={dateTimeEnd}&maxRanking={maxRanking}&rankings={rankings}

具有可选参数:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getWafLogAnalyticsRankings?api-version=2025-04-15&metrics=clientRequestCount&dateTimeBegin={dateTimeBegin}&dateTimeEnd={dateTimeEnd}&maxRanking={maxRanking}&rankings={rankings}&actions={actions}&ruleTypes={ruleTypes}

URI 参数

名称	在	必需	类型	说明
profileName	path	True	string	Azure Front Door Standard 或 Azure Front Door Premium 配置文件的名称，该配置文件在资源组中是唯一的。 在资源组中是唯一的。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。 此名称不区分大小写。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。 该值必须是 UUID。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。
dateTimeBegin	query	True	string (date-time)
dateTimeEnd	query	True	string (date-time)
maxRanking	query	True	integer (int32)
metrics	query	True	WafMetric[]
rankings	query	True	WafRankingType[]
actions	query		WafAction[]
ruleTypes	query		WafRuleType[]

响应

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

LogAnalytics_GetWafLogAnalyticsRankings

示例请求

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/getWafLogAnalyticsRankings?api-version=2025-04-15&metrics=clientRequestCount&dateTimeBegin=2020-11-04T06:49:27.554Z&dateTimeEnd=2020-11-04T09:49:27.554Z&maxRanking=5&rankings=ruleId

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Cdn.Models;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Cdn;

// Generated from example definition: specification/cdn/resource-manager/Microsoft.Cdn/stable/2025-04-15/examples/LogAnalytics_GetWafLogAnalyticsRankings.json
// this example is just showing the usage of "LogAnalytics_GetWafLogAnalyticsRankings" 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 ProfileResource created on azure
// for more information of creating ProfileResource, please refer to the document of ProfileResource
string subscriptionId = "subid";
string resourceGroupName = "RG";
string profileName = "profile1";
ResourceIdentifier profileResourceId = ProfileResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, profileName);
ProfileResource profile = client.GetProfileResource(profileResourceId);

// invoke the operation
IEnumerable<WafMetric> metrics = new WafMetric[] { WafMetric.ClientRequestCount };
DateTimeOffset dateTimeBegin = DateTimeOffset.Parse("2020-11-04T06:49:27.554Z");
DateTimeOffset dateTimeEnd = DateTimeOffset.Parse("2020-11-04T09:49:27.554Z");
int maxRanking = 5;
IEnumerable<WafRankingType> rankings = new WafRankingType[] { WafRankingType.RuleId };
ProfileResourceGetWafLogAnalyticsRankingsOptions options = new ProfileResourceGetWafLogAnalyticsRankingsOptions(metrics, dateTimeBegin, dateTimeEnd, maxRanking, rankings);
WafRankingsResponse result = await profile.GetWafLogAnalyticsRankingsAsync(options);

Console.WriteLine($"Succeeded: {result}");

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

示例响应

状态代码:

200

{
  "dateTimeBegin": "2020-11-04T14:49:27.554+08:00",
  "dateTimeEnd": "2020-11-04T17:49:27.554+08:00",
  "groups": [
    "ruleId"
  ],
  "data": [
    {
      "groupValues": [
        "BlockRateLimit"
      ],
      "metrics": [
        {
          "metric": "clientRequestCount",
          "value": 1268,
          "percentage": 0
        }
      ]
    }
  ]
}

定义

名称	说明
Data
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
WafAction
WafMetric
WafRankingsResponse	Waf 排名响应
WafRankingType
WafRuleType

Data

Object

名称	类型	说明
dateTime	string (date-time)
value	number

ErrorAdditionalInfo

Object

资源管理错误附加信息。

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

ErrorDetail

Object

错误详细信息。

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

ErrorResponse

Object

错误响应

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

WafAction

枚举

值	说明
allow
block
log
redirect

WafMetric

枚举

值	说明
clientRequestCount

WafRankingsResponse

Object

Waf 排名响应

名称	类型	说明
data	Data[]
dateTimeBegin	string (date-time)
dateTimeEnd	string (date-time)
groups	string[]

WafRankingType

枚举

值	说明
action
clientIp
countryOrRegion
ruleGroup
ruleId
ruleType
url
userAgent

WafRuleType

枚举

值	说明
bot
custom
managed