The IoT Security Solution API from Microsoft Defender — 3 operation(s) for iot security solution.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/microsoft-defender:microsoft-defender-iot-security-solution-api"curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Microsoft Defender for Cloud REST API (Microsoft.Security)…
version: stable-composite
description: Composite of the latest stable Microsoft.Security resource-manager swagger files published by Microsoft in Azure/azure-rest-api-specs. Each path keeps its own api-version via x-source.
x-source-repo: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/security/resource-manager/Microsoft.Security/Security
servers:
- url: https://management.azure.com
security:
- azure_auth:
- user_impersonation
tags:
- name: IoT Security Solution
paths:
/subscriptions/{subscriptionId}/providers/Microsoft.Security/iotSecuritySolutions:
get:
operationId: IotSecuritySolution_ListBySubscription
tags:
- IoT Security Solution
description: Use this method to get the list of IoT Security solutions by subscription.
parameters:
- $ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- name: $filter
in: query
description: Filter the IoT Security solution with OData syntax. Supports filtering by iotHubs.
required: false
schema:
type: string
responses:
'200':
description: Azure operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/IoTSecuritySolutionsList'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/Common.CloudError'
x-ms-examples:
List IoT Security solutions by IoT Hub:
$ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/security/resource-manager/Microsoft.Security/Security/stable/2019-08-01/examples/IoTSecuritySolutions/GetIoTSecuritySolutionsListByIotHub.json
List IoT Security solutions by subscription:
$ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/security/resource-manager/Microsoft.Security/Security/stable/2019-08-01/examples/IoTSecuritySolutions/GetIoTSecuritySolutionsList.json
x-ms-pageable:
nextLinkName: nextLink
x-source: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/security/resource-manager/Microsoft.Security/Security/stable/2019-08-01/security-IoTSecurity.json
summary: Iot security solution list by subscription
x-summary-source: derived
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/iotSecuritySolutions:
get:
operationId: IotSecuritySolution_ListByResourceGroup
tags:
- IoT Security Solution
description: Use this method to get the list IoT Security solutions organized by resource group.
parameters:
- $ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: $filter
in: query
description: Filter the IoT Security solution with OData syntax. Supports filtering by iotHubs.
required: false
schema:
type: string
responses:
'200':
description: Azure operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/IoTSecuritySolutionsList'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/Common.CloudError'
x-ms-examples:
List IoT Security solutions by resource group:
$ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/security/resource-manager/Microsoft.Security/Security/stable/2019-08-01/examples/IoTSecuritySolutions/GetIoTSecuritySolutionsListByRg.json
List IoT Security solutions by resource group and IoT Hub:
$ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/security/resource-manager/Microsoft.Security/Security/stable/2019-08-01/examples/IoTSecuritySolutions/GetIoTSecuritySolutionsListByIotHubAndRg.json
x-ms-pageable:
nextLinkName: nextLink
x-source: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/security/resource-manager/Microsoft.Security/Security/stable/2019-08-01/security-IoTSecurity.json
summary: Iot security solution list by resource group
x-summary-source: derived
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/iotSecuritySolutions/{solutionName}
: get:
operationId: IotSecuritySolution_Get
tags:
- IoT Security Solution
description: User this method to get details of a specific IoT Security solution based on solution name
parameters:
- $ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: solutionName
in: path
description: The name of the IoT Security solution.
required: true
schema:
type: string
responses:
'200':
description: Azure operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/IoTSecuritySolutionModel'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/Common.CloudError'
x-ms-examples:
Get a IoT security solution:
$ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/security/resource-manager/Microsoft.Security/Security/stable/2019-08-01/examples/IoTSecuritySolutions/GetIoTSecuritySolution.json
x-source: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/security/resource-manager/Microsoft.Security/Security/stable/2019-08-01/security-IoTSecurity.json
summary: Iot security solution get
x-summary-source: derived
put:
operationId: IotSecuritySolution_CreateOrUpdate
tags:
- IoT Security Solution
description: Use this method to create or update yours IoT Security solution
parameters:
- $ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: solutionName
in: path
description: The name of the IoT Security solution.
required: true
schema:
type: string
responses:
'200':
description: Resource 'IoTSecuritySolutionModel' update operation succeeded
content:
application/json:
schema:
$ref: '#/components/schemas/IoTSecuritySolutionModel'
'201':
description: Resource 'IoTSecuritySolutionModel' create operation succeeded
content:
application/json:
schema:
$ref: '#/components/schemas/IoTSecuritySolutionModel'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/Common.CloudError'
x-ms-examples:
Create or update a IoT security solution:
$ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/security/resource-manager/Microsoft.Security/Security/stable/2019-08-01/examples/IoTSecuritySolutions/CreateIoTSecuritySolution.json
x-source: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/security/resource-manager/Microsoft.Security/Security/stable/2019-08-01/security-IoTSecurity.json
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/IoTSecuritySolutionModel'
description: The security solution data
required: true
summary: Iot security solution create or update
x-summary-source: derived
patch:
operationId: IotSecuritySolution_Update
tags:
- IoT Security Solution
description: Use this method to update existing IoT Security solution tags or user defined resources. To update other fields use the CreateOrUpdate method.
parameters:
- $ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: solutionName
in: path
description: The name of the IoT Security solution.
required: true
schema:
type: string
responses:
'200':
description: Azure operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/IoTSecuritySolutionModel'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/Common.CloudError'
x-ms-examples:
Use this method to update existing IoT Security solution:
$ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/security/resource-manager/Microsoft.Security/Security/stable/2019-08-01/examples/IoTSecuritySolutions/UpdateIoTSecuritySolution.json
x-source: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/security/resource-manager/Microsoft.Security/Security/stable/2019-08-01/security-IoTSecurity.json
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateIotSecuritySolutionData'
description: The security solution data
required: true
summary: Iot security solution update
x-summary-source: derived
delete:
operationId: IotSecuritySolution_Delete
tags:
- IoT Security Solution
description: Use this method to delete yours IoT Security solution
parameters:
- $ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: solutionName
in: path
description: The name of the IoT Security solution.
required: true
schema:
type: string
responses:
'200':
description: Resource deleted successfully.
'204':
description: Resource does not exist.
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/Common.CloudError'
x-ms-examples:
Delete an IoT security solution:
$ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/security/resource-manager/Microsoft.Security/Security/stable/2019-08-01/examples/IoTSecuritySolutions/DeleteIoTSecuritySolution.json
x-source: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/security/resource-manager/Microsoft.Security/Security/stable/2019-08-01/security-IoTSecurity.json
summary: Iot security solution delete
x-summary-source: derived
components:
schemas:
RecommendationConfigurationList:
type: array
description: List of the configuration status for each recommendation type.
items:
$ref: '#/components/schemas/RecommendationConfigurationProperties'
TagsResource:
properties:
tags:
type: object
additionalProperties:
type: string
description: Resource tags
description: A container holding only the Tags for a resource, allowing the user to update the tags.
Common.CloudErrorBody:
type: object
description: The error detail.
properties:
code:
type: string
description: The error code.
readOnly: true
message:
type: string
description: The error message.
readOnly: true
target:
type: string
description: The error target.
readOnly: true
details:
type: array
description: The error details.
items:
$ref: '#/components/schemas/Common.CloudErrorBody'
readOnly: true
x-ms-identifiers: []
additionalInfo:
type: array
description: The error additional info.
items:
$ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/types.json#/definitions/ErrorAdditionalInfo
readOnly: true
x-ms-identifiers: []
x-ms-external: true
IoTSecuritySolutionModel:
type: object
description: IoT Security solution configuration and resource information.
properties:
location:
type: string
description: The resource location.
properties:
x-ms-client-flatten: true
description: Security Solution data
$ref: '#/components/schemas/IoTSecuritySolutionProperties'
systemData:
readOnly: true
type: object
description: Azure Resource Manager metadata containing createdBy and modifiedBy information.
$ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v2/types.json#/definitions/systemData
allOf:
- $ref: ./common/v1/types.json#/definitions/Resource
- $ref: '#/components/schemas/TagsResource'
UpdateIotSecuritySolutionData:
type: object
properties:
properties:
x-ms-client-flatten: true
description: Security Solution data
$ref: '#/components/schemas/UpdateIoTSecuritySolutionProperties'
allOf:
- $ref: '#/components/schemas/TagsResource'
UpdateIoTSecuritySolutionProperties:
type: object
description: Update Security Solution setting data
properties:
userDefinedResources:
$ref: '#/components/schemas/UserDefinedResourcesProperties'
recommendationsConfiguration:
$ref: '#/components/schemas/RecommendationConfigurationList'
RecommendationConfigurationProperties:
type: object
description: The type of IoT Security recommendation.
properties:
recommendationType:
type: string
description: The type of IoT Security recommendation.
enum:
- IoT_ACRAuthentication
- IoT_AgentSendsUnutilizedMessages
- IoT_Baseline
- IoT_EdgeHubMemOptimize
- IoT_EdgeLoggingOptions
- IoT_InconsistentModuleSettings
- IoT_InstallAgent
- IoT_IPFilter_DenyAll
- IoT_IPFilter_PermissiveRule
- IoT_OpenPorts
- IoT_PermissiveFirewallPolicy
- IoT_PermissiveInputFirewallRules
- IoT_PermissiveOutputFirewallRules
- IoT_PrivilegedDockerOptions
- IoT_SharedCredentials
- IoT_VulnerableTLSCipherSuite
x-ms-enum:
name: RecommendationType
modelAsString: true
values:
- value: IoT_ACRAuthentication
description: Authentication schema used for pull an edge module from an ACR repository does not use Service Principal Authentication.
- value: IoT_AgentSendsUnutilizedMessages
description: IoT agent message size capacity is currently underutilized, causing an increase in the number of sent messages. Adjust message intervals for better utilization.
- value: IoT_Baseline
description: Identified security related system configuration issues.
- value: IoT_EdgeHubMemOptimize
description: You can optimize Edge Hub memory usage by turning off protocol heads for any protocols not used by Edge modules in your solution.
- value: IoT_EdgeLoggingOptions
description: Logging is disabled for this edge module.
- value: IoT_InconsistentModuleSettings
description: A minority within a device security group has inconsistent Edge Module settings with the rest of their group.
- value: IoT_InstallAgent
description: Install the Azure Security of Things Agent.
- value: IoT_IPFilter_DenyAll
description: IP Filter Configuration should have rules defined for allowed traffic and should deny all other traffic by default.
- value: IoT_IPFilter_PermissiveRule
description: An Allow IP Filter rules source IP range is too large. Overly permissive rules might expose your IoT hub to malicious intenders.
- value: IoT_OpenPorts
description: A listening endpoint was found on the device.
- value: IoT_PermissiveFirewallPolicy
description: An Allowed firewall policy was found (INPUT/OUTPUT). The policy should Deny all traffic by default and define rules to allow necessary communication to/from the device.
- value: IoT_PermissiveInputFirewallRules
description: A rule in the firewall has been found that contains a permissive pattern for a wide range of IP addresses or Ports.
- value: IoT_PermissiveOutputFirewallRules
description: A rule in the firewall has been found that contains a permissive pattern for a wide range of IP addresses or Ports.
- value: IoT_PrivilegedDockerOptions
description: Edge module is configured to run in privileged mode, with extensive Linux capabilities or with host-level network access (send/receive data to host machine).
- value: IoT_SharedCredentials
description: Same authentication credentials to the IoT Hub used by multiple devices. This could indicate an illegitimate device impersonating a legitimate device. It also exposes the risk of device impersonation by an attacker.
- value: IoT_VulnerableTLSCipherSuite
description: Insecure TLS configurations detected. Immediate upgrade recommended.
name:
type: string
readOnly: true
status:
type: string
enum:
- Disabled
- Enabled
default: Enabled
description: Recommendation status. When the recommendation status is disabled recommendations are not generated.
x-ms-enum:
name: RecommendationConfigStatus
modelAsString: true
required:
- recommendationType
- status
AdditionalWorkspacesProperties:
type: object
description: Properties of the additional workspaces.
properties:
workspace:
type: string
description: Workspace resource id
type:
type: string
enum:
- Sentinel
default: Sentinel
description: Workspace type.
x-ms-enum:
name: AdditionalWorkspaceType
modelAsString: true
dataTypes:
type: array
description: List of data types sent to workspace
items:
type: string
enum:
- Alerts
- RawEvents
description: Data types sent to workspace.
x-ms-enum:
name: AdditionalWorkspaceDataType
modelAsString: true
IoTSecuritySolutionProperties:
type: object
description: Security Solution setting data
properties:
workspace:
type: string
description: Workspace resource ID
displayName:
type: string
description: Resource display name.
status:
type: string
enum:
- Enabled
- Disabled
default: Enabled
description: Status of the IoT Security solution.
x-ms-enum:
name: SecuritySolutionStatus
modelAsString: true
export:
type: array
items:
enum:
- RawEvents
type: string
x-ms-enum:
name: ExportData
modelAsString: true
values:
- value: RawEvents
description: Agent raw events
description: List of additional options for exporting to workspace data.
disabledDataSources:
type: array
items:
enum:
- TwinData
type: string
x-ms-enum:
name: DataSource
modelAsString: true
values:
- value: TwinData
description: Devices twin data
description: Disabled data sources. Disabling these data sources compromises the system.
iotHubs:
type: array
description: IoT Hub resource IDs
items:
type: string
userDefinedResources:
$ref: '#/components/schemas/UserDefinedResourcesProperties'
autoDiscoveredResources:
type: array
description: List of resources that were automatically discovered as relevant to the security solution.
items:
type: string
readOnly: true
recommendationsConfiguration:
$ref: '#/components/schemas/RecommendationConfigurationList'
unmaskedIpLoggingStatus:
description: Unmasked IP address logging status
type: string
enum:
- Disabled
- Enabled
default: Disabled
x-ms-enum:
name: UnmaskedIpLoggingStatus
modelAsString: true
values:
- value: Disabled
description: Unmasked IP logging is disabled
- value: Enabled
description: Unmasked IP logging is enabled
additionalWorkspaces:
type: array
description: List of additional workspaces
items:
$ref: '#/components/schemas/AdditionalWorkspacesProperties'
required:
- iotHubs
- displayName
UserDefinedResourcesProperties:
type: object
description: Properties of the IoT Security solution's user defined resources.
properties:
query:
type:
- string
- 'null'
description: Azure Resource Graph query which represents the security solution's user defined resources. Required to start with "where type != "Microsoft.Devices/IotHubs""
querySubscriptions:
type:
- array
- 'null'
description: List of Azure subscription ids on which the user defined resources query should be executed.
items:
type: string
pattern: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$
required:
- query
- querySubscriptions
Common.CloudError:
type: object
description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
properties:
error:
$ref: '#/components/schemas/Common.CloudErrorBody'
description: The error object.
x-ms-client-flatten: true
x-ms-external: true
IoTSecuritySolutionsList:
description: List of IoT Security solutions.
required:
- value
properties:
value:
type: array
description: List of IoT Security solutions
items:
$ref: '#/components/schemas/IoTSecuritySolutionModel'
nextLink:
readOnly: true
type: string
description: The URI to fetch the next page.
securitySchemes:
azure_auth:
type: oauth2
flows:
implicit:
scopes:
user_impersonation: impersonate your user account
authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
description: Azure Active Directory OAuth2 Flow.