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

Iot Security Solution Analytics - List

参考

服务:: Defender for Cloud

API 版本:: 2019-08-01

使用此方法获取数组中的 IoT 安全分析指标。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/iotSecuritySolutions/{solutionName}/analyticsModels?api-version=2019-08-01

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string	用户订阅中的资源组的名称。名称不区分大小写。正则表达式模式: `^[-\w\._]+$`
solutionName	path	True	string	IoT 安全解决方案的名称。
subscriptionId	path	True	string	Azure 订阅 ID 正则表达式模式: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
api-version	query	True	string	操作的 API 版本

响应

名称	类型	说明
200 OK	IoTSecuritySolutionAnalyticsModelList	还行
Other Status Codes	CloudError	描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Get Security Solution Analytics

示例请求

GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/MyGroup/providers/Microsoft.Security/iotSecuritySolutions/default/analyticsModels?api-version=2019-08-01


/**
 * Samples for IotSecuritySolutionAnalytics List.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/
     * IoTSecuritySolutionsAnalytics/GetIoTSecuritySolutionsSecurityAnalyticsList.json
     */
    /**
     * Sample code: Get Security Solution Analytics.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void getSecuritySolutionAnalytics(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.iotSecuritySolutionAnalytics().listWithResponse("MyGroup", "default", 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 armsecurity_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/security/armsecurity"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ac34f238dd6b9071f486b57e9f9f1a0c43ec6f6/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IoTSecuritySolutionsAnalytics/GetIoTSecuritySolutionsSecurityAnalyticsList.json
func ExampleIotSecuritySolutionAnalyticsClient_List() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsecurity.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewIotSecuritySolutionAnalyticsClient().List(ctx, "MyGroup", "default", 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.IoTSecuritySolutionAnalyticsModelList = armsecurity.IoTSecuritySolutionAnalyticsModelList{
	// 	Value: []*armsecurity.IoTSecuritySolutionAnalyticsModel{
	// 		{
	// 			Name: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/MyGroup/providers/Microsoft.Security/IoTSecuritySolutions/Locations/eastus/default"),
	// 			Type: to.Ptr("Microsoft.Security/iotSecuritySolutions/analyticsModels"),
	// 			ID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/MyGroup/providers/Microsoft.Security/IoTSecuritySolutions/Locations/eastus/default"),
	// 			Properties: &armsecurity.IoTSecuritySolutionAnalyticsModelProperties{
	// 				DevicesMetrics: []*armsecurity.IoTSecuritySolutionAnalyticsModelPropertiesDevicesMetricsItem{
	// 					{
	// 						Date: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-02-01T00:00:00.000Z"); return t}()),
	// 						DevicesMetrics: &armsecurity.IoTSeverityMetrics{
	// 							High: to.Ptr[int64](3),
	// 							Low: to.Ptr[int64](70),
	// 							Medium: to.Ptr[int64](15),
	// 						},
	// 					},
	// 					{
	// 						Date: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-02-02T00:00:00.000Z"); return t}()),
	// 						DevicesMetrics: &armsecurity.IoTSeverityMetrics{
	// 							High: to.Ptr[int64](3),
	// 							Low: to.Ptr[int64](65),
	// 							Medium: to.Ptr[int64](45),
	// 						},
	// 				}},
	// 				Metrics: &armsecurity.IoTSeverityMetrics{
	// 					High: to.Ptr[int64](5),
	// 					Low: to.Ptr[int64](102),
	// 					Medium: to.Ptr[int64](200),
	// 				},
	// 				MostPrevalentDeviceAlerts: []*armsecurity.IoTSecurityDeviceAlert{
	// 					{
	// 						AlertDisplayName: to.Ptr("Custom Alert - number of device to cloud messages in AMQP protocol is not in the allowed range"),
	// 						AlertsCount: to.Ptr[int64](200),
	// 						ReportedSeverity: to.Ptr(armsecurity.ReportedSeverityLow),
	// 					},
	// 					{
	// 						AlertDisplayName: to.Ptr("Custom Alert - execution of a process that is not allowed"),
	// 						AlertsCount: to.Ptr[int64](170),
	// 						ReportedSeverity: to.Ptr(armsecurity.ReportedSeverityMedium),
	// 					},
	// 					{
	// 						AlertDisplayName: to.Ptr("Successful Bruteforce"),
	// 						AlertsCount: to.Ptr[int64](150),
	// 						ReportedSeverity: to.Ptr(armsecurity.ReportedSeverityLow),
	// 				}},
	// 				MostPrevalentDeviceRecommendations: []*armsecurity.IoTSecurityDeviceRecommendation{
	// 					{
	// 						DevicesCount: to.Ptr[int64](200),
	// 						RecommendationDisplayName: to.Ptr("Install the Azure Security of Things Agent"),
	// 						ReportedSeverity: to.Ptr(armsecurity.ReportedSeverityLow),
	// 					},
	// 					{
	// 						DevicesCount: to.Ptr[int64](170),
	// 						RecommendationDisplayName: to.Ptr("High level permissions configured in Edge model twin for Edge module"),
	// 						ReportedSeverity: to.Ptr(armsecurity.ReportedSeverityLow),
	// 					},
	// 					{
	// 						DevicesCount: to.Ptr[int64](150),
	// 						RecommendationDisplayName: to.Ptr("Same Authentication Credentials used by multiple devices"),
	// 						ReportedSeverity: to.Ptr(armsecurity.ReportedSeverityMedium),
	// 				}},
	// 				TopAlertedDevices: []*armsecurity.IoTSecurityAlertedDevice{
	// 					{
	// 						AlertsCount: to.Ptr[int64](200),
	// 						DeviceID: to.Ptr("id1"),
	// 					},
	// 					{
	// 						AlertsCount: to.Ptr[int64](170),
	// 						DeviceID: to.Ptr("id2"),
	// 					},
	// 					{
	// 						AlertsCount: to.Ptr[int64](150),
	// 						DeviceID: to.Ptr("id3"),
	// 				}},
	// 				UnhealthyDeviceCount: to.Ptr[int64](1200),
	// 			},
	// 	}},
	// }
}

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

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

/**
 * This sample demonstrates how to Use this method to get IoT security Analytics metrics in an array.
 *
 * @summary Use this method to get IoT security Analytics metrics in an array.
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IoTSecuritySolutionsAnalytics/GetIoTSecuritySolutionsSecurityAnalyticsList.json
 */
async function getSecuritySolutionAnalytics() {
  const subscriptionId =
    process.env["SECURITY_SUBSCRIPTION_ID"] || "20ff7fc3-e762-44dd-bd96-b71116dcdc23";
  const resourceGroupName = process.env["SECURITY_RESOURCE_GROUP"] || "MyGroup";
  const solutionName = "default";
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential, subscriptionId);
  const result = await client.iotSecuritySolutionAnalytics.list(resourceGroupName, solutionName);
  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

示例响应

状态代码:: 200

{
  "value": [
    {
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/MyGroup/providers/Microsoft.Security/IoTSecuritySolutions/Locations/eastus/default",
      "name": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/MyGroup/providers/Microsoft.Security/IoTSecuritySolutions/Locations/eastus/default",
      "type": "Microsoft.Security/iotSecuritySolutions/analyticsModels",
      "properties": {
        "metrics": {
          "high": 5,
          "medium": 200,
          "low": 102
        },
        "unhealthyDeviceCount": 1200,
        "devicesMetrics": [
          {
            "date": "2019-02-01T00:00:00Z",
            "devicesMetrics": {
              "high": 3,
              "medium": 15,
              "low": 70
            }
          },
          {
            "date": "2019-02-02T00:00:00Z",
            "devicesMetrics": {
              "high": 3,
              "medium": 45,
              "low": 65
            }
          }
        ],
        "topAlertedDevices": [
          {
            "deviceId": "id1",
            "alertsCount": 200
          },
          {
            "deviceId": "id2",
            "alertsCount": 170
          },
          {
            "deviceId": "id3",
            "alertsCount": 150
          }
        ],
        "mostPrevalentDeviceAlerts": [
          {
            "alertDisplayName": "Custom Alert - number of device to cloud messages in AMQP protocol is not in the allowed range",
            "reportedSeverity": "Low",
            "alertsCount": 200
          },
          {
            "alertDisplayName": "Custom Alert - execution of a process that is not allowed",
            "reportedSeverity": "Medium",
            "alertsCount": 170
          },
          {
            "alertDisplayName": "Successful Bruteforce",
            "reportedSeverity": "Low",
            "alertsCount": 150
          }
        ],
        "mostPrevalentDeviceRecommendations": [
          {
            "recommendationDisplayName": "Install the Azure Security of Things Agent",
            "reportedSeverity": "Low",
            "devicesCount": 200
          },
          {
            "recommendationDisplayName": "High level permissions configured in Edge model twin for Edge module",
            "reportedSeverity": "Low",
            "devicesCount": 170
          },
          {
            "recommendationDisplayName": "Same Authentication Credentials used by multiple devices",
            "reportedSeverity": "Medium",
            "devicesCount": 150
          }
        ]
      }
    }
  ]
}

定义

名称	说明
CloudError	所有 Azure 资源管理器 API 的常见错误响应，以返回失败操作的错误详细信息。（这也遵循 OData 错误响应格式）。
CloudErrorBody	错误详细信息。
DevicesMetrics	按聚合日期列出的设备指标列表。
ErrorAdditionalInfo	资源管理错误附加信息。
IoTSecurityAlertedDevice	有关上次设置天数内每个设备的警报数的统计信息。
IoTSecurityDeviceAlert	有关上次设置天数期间每个警报类型的警报数的统计信息
IoTSecurityDeviceRecommendation	有关每个设备的建议数（每个建议类型）的统计信息。
IoTSecuritySolutionAnalyticsModel	IoT 安全解决方案的安全分析
IoTSecuritySolutionAnalyticsModelList	IoT 安全解决方案的安全分析列表
IoTSeverityMetrics	IoT 安全解决方案分析严重性指标。
reportedSeverity	评估的警报严重性。

CloudError

所有 Azure 资源管理器 API 的常见错误响应，以返回失败操作的错误详细信息。（这也遵循 OData 错误响应格式）。

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

CloudErrorBody

错误详细信息。

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

DevicesMetrics

按聚合日期列出的设备指标列表。

名称	类型	说明
date	string	按日期聚合 IoT 安全解决方案设备警报指标。
devicesMetrics	IoTSeverityMetrics	按严重性对设备警报计数。

ErrorAdditionalInfo

资源管理错误附加信息。

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

IoTSecurityAlertedDevice

有关上次设置天数内每个设备的警报数的统计信息。

名称	类型	说明
alertsCount	integer	为此设备引发的警报数。
deviceId	string	设备标识符。

IoTSecurityDeviceAlert

有关上次设置天数期间每个警报类型的警报数的统计信息

名称	类型	说明
alertDisplayName	string	警报的显示名称
alertsCount	integer	为此警报类型引发的警报数。
reportedSeverity	reportedSeverity	评估的警报严重性。

IoTSecurityDeviceRecommendation

有关每个设备的建议数（每个建议类型）的统计信息。

名称	类型	说明
devicesCount	integer	此建议的设备数。
recommendationDisplayName	string	建议的显示名称。
reportedSeverity	reportedSeverity	评估的建议严重性。

IoTSecuritySolutionAnalyticsModel

IoT 安全解决方案的安全分析

名称	类型	说明
id	string	资源 ID
name	string	资源名称
properties.devicesMetrics	DevicesMetrics[]	按聚合日期列出的设备指标列表。
properties.metrics	IoTSeverityMetrics	IoT 安全解决方案的安全分析。
properties.mostPrevalentDeviceAlerts	IoTSecurityDeviceAlert[]	3 个最普遍的设备警报列表。
properties.mostPrevalentDeviceRecommendations	IoTSecurityDeviceRecommendation[]	最普遍的设备建议的 3 个列表。
properties.topAlertedDevices	IoTSecurityAlertedDevice[]	包含最多警报的 3 台设备列表。
properties.unhealthyDeviceCount	integer	IoT 安全解决方案中的不正常设备数。
type	string	资源类型

IoTSecuritySolutionAnalyticsModelList

IoT 安全解决方案的安全分析列表

名称	类型	说明
nextLink	string	如果一页的警报数据过多，请使用此 URI 提取下一页。
value	IoTSecuritySolutionAnalyticsModel[]	IoT 安全解决方案的安全分析列表

IoTSeverityMetrics

IoT 安全解决方案分析严重性指标。

名称	类型	说明
high	integer	高严重性警报/建议的计数。
low	integer	低严重性警报/建议的计数。
medium	integer	中等严重性警报/建议的计数。

reportedSeverity

评估的警报严重性。

名称	类型	说明
High	string
Informational	string
Low	string
Medium	string

通过

Iot Security Solution Analytics - List

URI 参数

响应

安全性

azure_auth

作用域

示例

Get Security Solution Analytics

示例请求

示例响应

定义

CloudError

CloudErrorBody

DevicesMetrics

ErrorAdditionalInfo

IoTSecurityAlertedDevice

IoTSecurityDeviceAlert

IoTSecurityDeviceRecommendation

IoTSecuritySolutionAnalyticsModel

IoTSecuritySolutionAnalyticsModelList

IoTSeverityMetrics

reportedSeverity

其他资源