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

Iot Security Solution Analytics - Get

使用此方法获取 IoT 安全分析指标。

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

URI 参数

Name In Required Type Description
resourceGroupName
path True
  • string

用户订阅中的资源组的名称。 此名称不区分大小写。

Regex pattern: ^[-\w\._\(\)]+$

solutionName
path True
  • string

IoT 安全解决方案的名称。

subscriptionId
path True
  • string

Azure 订阅 ID

Regex pattern: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$

api-version
query True
  • string

操作的 API 版本

响应

Name Type Description
200 OK

OK

Other Status Codes

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

Get Security Solution Analytics

Sample Request

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

Sample Response

{
  "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 安全解决方案的安全分析

IoTSeverityMetrics

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

reportedSeverity

评估的警报严重性。

CloudError

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

Name Type Description
error.additionalInfo

错误附加信息。

error.code
  • string

错误代码。

error.details

错误详细信息。

error.message
  • string

错误消息。

error.target
  • string

错误目标。

CloudErrorBody

错误详细信息。

Name Type Description
additionalInfo

错误附加信息。

code
  • string

错误代码。

details

错误详细信息。

message
  • string

错误消息。

target
  • string

错误目标。

DevicesMetrics

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

Name Type Description
date
  • string

按日期聚合 IoT 安全解决方案设备警报指标。

devicesMetrics

按严重性划分的设备警报计数。

ErrorAdditionalInfo

资源管理错误附加信息。

Name Type Description
info
  • object

其他信息。

type
  • string

其他信息类型。

IoTSecurityAlertedDevice

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

Name Type Description
alertsCount
  • integer

为此设备引发的警报数。

deviceId
  • string

设备标识符。

IoTSecurityDeviceAlert

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

Name Type Description
alertDisplayName
  • string

警报的显示名称

alertsCount
  • integer

为此警报类型引发的警报数。

reportedSeverity

评估的警报严重性。

IoTSecurityDeviceRecommendation

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

Name Type Description
devicesCount
  • integer

具有此建议的设备数。

recommendationDisplayName
  • string

建议的显示名称。

reportedSeverity

评估的建议严重性。

IoTSecuritySolutionAnalyticsModel

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

Name Type Description
id
  • string

资源 ID

name
  • string

资源名称

properties.devicesMetrics

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

properties.metrics

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

properties.mostPrevalentDeviceAlerts

3 个最常见的设备警报列表。

properties.mostPrevalentDeviceRecommendations

3 种最常见的设备建议列表。

properties.topAlertedDevices

包含最多警报的 3 台设备列表。

properties.unhealthyDeviceCount
  • integer

IoT 安全解决方案中的不正常设备数。

type
  • string

资源类型

IoTSeverityMetrics

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

Name Type Description
high
  • integer

高严重性警报/建议的计数。

low
  • integer

低严重性警报/建议计数。

medium
  • integer

中等严重性警报/建议的计数。

reportedSeverity

评估的警报严重性。

Name Type Description
High
  • string
Informational
  • string
Low
  • string
Medium
  • string