Iot Recommendation Types - Get

Service:

Defender for Cloud

API Version:

2019-08-01

Get IoT recommendation type

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

URI Parameters

Name	In	Required	Type	Description
iotRecommendationTypeName	path	True	string	Name of the recommendation type
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	IotRecommendationType	IoT recommendation type
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 Type

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myGroup/providers/Microsoft.Security/iotSecuritySolutions/mySolution/iotRecommendationTypes/IoT_VulnerableTLSCipherSuite",
  "name": "IoT_VulnerableTLSCipherSuite",
  "type": "Microsoft.Security/iotSecuritySolutions/iotRecommendationTypes",
  "properties": {
    "recommendationDisplayName": "TLS cipher suite upgrade needed",
    "severity": "Medium",
    "description": "Insecure TLS configurations detected. Immediate TLS cipher suite upgrade recommended.",
    "remediationSteps": [
      "Upgrade your TLS cipher suite to a secure configuration. See the Guide to TLS Standards Compliance for more information."
    ],
    "vendorName": "Microsoft",
    "control": "Communication between device and IoT Hub is not optimized",
    "productName": "Azure Security Center for IoT",
    "productComponentName": "IoT Hub"
  }
}

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.
IotRecommendationType	IoT recommendation type.
recommendationSeverity	The severity of the 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.

IotRecommendationType

IoT recommendation type.

Name	Type	Description
id	string	Resource Id
name	string	Resource name
properties.control	string	The name of the recommendation's control category
properties.dataSource	string	The alert's data source
properties.description	string	Description of the suspected vulnerability and meaning.
properties.productComponentName	string	The name of a component inside the product which generated the recommendation
properties.productName	string	The name of the product which published this recommendation
properties.recommendationDisplayName	string	The display name of the recommendation
properties.remediationSteps	string[]	Manual action items to take to resolve the recommendation
properties.severity	recommendationSeverity	The severity of the recommendation
properties.vendorName	string	The name of the vendor that raised the recommendation
type	string	Resource type

recommendationSeverity

The severity of the recommendation

Name	Type	Description
Healthy	string
High	string
Low	string
Medium	string
NotApplicable	string
OffByPolicy	string
Unknown	string