Iot Recommendations - 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}/iotRecommendations?api-version=2019-08-01
With optional parameters: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/iotSecuritySolutions/{solutionName}/iotRecommendations?api-version=2019-08-01&recommendationType={recommendationType}&deviceId={deviceId}&$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

略過用於分頁的令牌
deviceId
 query

string

依裝置標識碼篩選
recommendationType
 query

string

依建議類型篩選

回應

名稱 類型 Description
200 OK

IotRecommendationList

確定
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 Recommendations

Sample Request

GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myGroup/providers/Microsoft.Security/iotSecuritySolutions/mySolution/iotRecommendations?api-version=2019-08-01&recommendationType=IoT_Baseline&deviceId=device-1&$limit=1

Sample Response

Status code:
200 
{
  "value": [
    {
      "name": "IoT_Baseline|device-1",
      "properties": {
        "recommendationType": "IoT_Baseline",
        "deviceId": "device-1",
        "discoveredTimeUtc": "2020-05-13T06:32:25Z",
        "recommendationAdditionalData": {
          "SnapshotId": "48519d58-4e35-46cd-aed5-6251af95ed50",
          "TotalFailedRules": "7",
          "TotalRulesFailedDuoToError": "1",
          "TotalInformationalFailedRules": "2",
          "TotalCriticalFailedRules": "3",
          "TotalWarningFailedRules": "1"
        }
      }
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myGroup/providers/Microsoft.Security/iotSecuritySolutions/mySolution/iotRecommendations?api-version=2019-08-01&recommendationType=IoT_Baseline&deviceId=device-1&$limit=1&$skipToken=903e76ff-17eb-4bac-ac8a-2bc31ab68fd8",
  "totalCount": 23
}

定義

名稱 Description
CloudError

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

錯誤詳細數據。
ErrorAdditionalInfo

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

IoT 建議
IotRecommendationList

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

其他信息類型。

IotRecommendation

IoT 建議

名稱 類型 Description
id

string

資源標識碼
name

string

資源名稱
properties.deviceId

string

所報告裝置的標識碼
properties.discoveredTimeUtc

string

建議的探索時間
properties.recommendationAdditionalData

object

延伸建議資訊的欄位包
properties.recommendationType

string

建議的類型名稱
type

string

資源類型

IotRecommendationList

IoT 建議清單

名稱 類型 Description
nextLink

string

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

integer

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

value

IotRecommendation[]

列出數據