Iot Alerts - List

  • 參考
Service:
Defender for Cloud
API Version:
2019-08-01

列出IoT警示

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/iotSecuritySolutions/{solutionName}/iotAlerts?api-version=2019-08-01
With optional parameters: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/iotSecuritySolutions/{solutionName}/iotAlerts?api-version=2019-08-01&startTimeUtc>={startTimeUtc>}&startTimeUtc<={startTimeUtc<}&alertType={alertType}&compromisedEntity={compromisedEntity}&$limit={$limit}&$skipToken={$skipToken}

URI 參數

名稱 位於 必要 類型 Description
resourceGroupName
 path True

string

用戶訂用帳戶內的資源組名。 名稱不區分大小寫。

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

string

IoT 安全性解決方案的名稱。
subscriptionId
 path True

string

Azure 訂用帳戶識別碼

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

string

作業的 API 版本
$limit
 query

integer

int32

限制單頁中傳回的項目數目
$skipToken
 query

string

略過用於分頁的令牌
alertType
 query

string

依警示類型篩選
compromisedEntity
 query

string

依遭入侵的裝置進行篩選
startTimeUtc<
 query

string

依最大 startTimeUtc (ISO 8601 格式篩選)

startTimeUtc>
 query

string

依最小 startTimeUtc (ISO 8601 格式篩選)

回應

名稱 類型 Description
200 OK

IotAlertList

確定
Other Status Codes

CloudError

描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

名稱 Description
user_impersonation 模擬您的用戶帳戶

範例

Get IoT Alerts

Sample Request

GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myGroup/providers/Microsoft.Security/iotSecuritySolutions/mySolution/iotAlerts?api-version=2019-08-01&startTimeUtc>=2020-05-12T06:32:25Z&startTimeUtc<=2020-05-14T06:32:25Z&alertType=IoT_PrivilegedContainer&compromisedEntity=device-1&$limit=1

Sample Response

Status code:
200 
{
  "value": [
    {
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/MyGroup/providers/Microsoft.Devices/iotHubs/myIotHub/providers/Microsoft.Security/iotAlerts/903e76ff-17eb-4bac-ac8a-2bc31ab68fd8",
      "name": "903e76ff-17eb-4bac-ac8a-2bc31ab68fd8",
      "type": "Microsoft.Security/iotAlerts",
      "properties": {
        "systemAlertId": "903e76ff-17eb-4bac-ac8a-2bc31ab68fd8",
        "compromisedEntity": "device-1",
        "alertType": "IoT_PrivilegedContainer",
        "startTimeUtc": "2020-05-13T06:32:25Z",
        "endTimeUtc": "2020-05-13T06:32:25Z",
        "entities": [
          {
            "$id": "1",
            "CommandLine": "docker run --privileged",
            "Type": "process"
          }
        ],
        "extendedProperties": {
          "CommandLine": "docker run --privileged",
          "User Name": "aUser",
          "UserId": "",
          "ParentProcessId": 1593,
          "DeviceId": "device-1"
        }
      }
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myGroup/providers/Microsoft.Security/iotSecuritySolutions/mySolution/iotAlerts?api-version=2019-08-01&alertType=IoT_PrivilegedContainer&startTimeUtc>=2020-05-12T06:32:25Z&startTimeUtc<=2020-05-14T06:32:25Z&compromisedEntity=device-1&$limit=1&$skipToken=903e76ff-17eb-4bac-ac8a-2bc31ab68fd8",
  "totalCount": 23
}

定義

名稱 Description
CloudError

所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。 (這也會遵循 OData 錯誤回應格式.) 。
CloudErrorBody

錯誤詳細數據。
ErrorAdditionalInfo

資源管理錯誤其他資訊。
IotAlert

IoT 警示
IotAlertList

IoT 警示清單

CloudError

所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。 (這也會遵循 OData 錯誤回應格式.) 。

名稱 類型 Description
error.additionalInfo

ErrorAdditionalInfo[]

錯誤其他資訊。
error.code

string

錯誤碼。
error.details

CloudErrorBody[]

錯誤詳細資料。
error.message

string

錯誤訊息。
error.target

string

錯誤目標。

CloudErrorBody

錯誤詳細數據。

名稱 類型 Description
additionalInfo

ErrorAdditionalInfo[]

錯誤其他資訊。
code

string

錯誤碼。
details

CloudErrorBody[]

錯誤詳細資料。
message

string

錯誤訊息。
target

string

錯誤目標。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱 類型 Description
info

object

其他資訊。
type

string

其他信息類型。

IotAlert

IoT 警示

名稱 類型 Description
id

string

資源標識碼
name

string

資源名稱
properties.alertType

string

警示的類型名稱
properties.compromisedEntity

string

所報告之主要實體的顯示名稱
properties.endTimeUtc

string

警示的影響結束時間 (警示中包含的上次事件或啟用時間)

properties.entities

object[]

與警示相關的實體清單
properties.extendedProperties

object

延伸警示資訊的欄位包
properties.startTimeUtc

string

警示的影響開始時間 (警示中包含的第一個事件或活動的時間)

properties.systemAlertId

string

保存產品範圍內警示的產品標準標識碼
type

string

資源類型

IotAlertList

IoT 警示清單

名稱 類型 Description
nextLink

string

可用時，請遵循 URI 以取得下一頁的數據
totalCount

integer

符合指定篩選選項的警示總數， (不受頁面大小影響)

value

IotAlert[]

列出數據