Iot Recommendations - List
List IoT recommendations
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/iotSecuritySolutions/{solutionName}/iotRecommendations?api-version=2019-08-01
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 Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
The name of the resource group within the user's subscription. The name is case insensitive. Regex pattern: |
solution
|
path | True |
string |
The name of the IoT Security solution. |
subscription
|
path | True |
string |
Azure subscription ID Regex pattern: |
api-version
|
query | True |
string |
API version for the operation |
$limit
|
query |
integer int32 |
Limit the number of items returned in a single page |
|
$skip
|
query |
string |
Skip token used for pagination |
|
device
|
query |
string |
Filter by device id |
|
recommendation
|
query |
string |
Filter by recommendation type |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Error response describing why the operation failed. |
Security
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 | impersonate your user account |
Examples
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
{
"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
}
Definitions
Name | Description |
---|---|
Cloud |
Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). |
Cloud |
The error detail. |
Error |
The resource management error additional info. |
Iot |
IoT recommendation |
Iot |
List of IoT recommendations |
CloudError
Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
Name | Type | Description |
---|---|---|
error.additionalInfo |
The error additional info. |
|
error.code |
string |
The error code. |
error.details |
The error details. |
|
error.message |
string |
The error message. |
error.target |
string |
The error target. |
CloudErrorBody
The error detail.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
IotRecommendation
IoT recommendation
Name | Type | Description |
---|---|---|
id |
string |
Resource Id |
name |
string |
Resource name |
properties.deviceId |
string |
Identifier of the device being reported on |
properties.discoveredTimeUtc |
string |
The discovery time of the recommendation |
properties.recommendationAdditionalData |
object |
A bag of fields which extends the recommendation information |
properties.recommendationType |
string |
The type name of the recommendation |
type |
string |
Resource type |
IotRecommendationList
List of IoT recommendations
Name | Type | Description |
---|---|---|
nextLink |
string |
When available, follow the URI to get the next page of data |
totalCount |
integer |
Total count of recommendations that conforms with the given filter options (not affected by page size) |
value |
List data |