Iot Recommendations - Get

Reference

Service:: Defender for Cloud

API Version:: 2019-08-01

Get IoT recommendation

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

URI Parameters

Name	In	Required	Type	Description
iotRecommendationId	path	True	string	Id of the recommendation
resourceGroupName	path	True	string	The name of the resource group within the user's subscription. The name is case insensitive. Regex pattern: `^[-\w\._]+$`
solutionName	path	True	string	The name of the IoT Security solution.
subscriptionId	path	True	string	Azure subscription 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 version for the operation

Responses

Name	Type	Description
200 OK	IotRecommendation	IoT recommendation
Other Status Codes	CloudError	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 Recommendation

Sample Request

HTTP

GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myGroup/providers/Microsoft.Security/iotSecuritySolutions/mySolution/iotRecommendations/903e76ff-17eb-4bac-ac8a-2bc31ab68fd8?api-version=2019-08-01

Sample Response

Status code:: 200

{
  "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"
    }
  }
}

Definitions

Name	Description
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.).
CloudErrorBody	The error detail.
ErrorAdditionalInfo	The resource management error additional info.
IotRecommendation	IoT recommendation

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	ErrorAdditionalInfo[]	The error additional info.
error.code	string	The error code.
error.details	CloudErrorBody[]	The error details.
error.message	string	The error message.
error.target	string	The error target.

CloudErrorBody

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	CloudErrorBody[]	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

Share via