Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The iotSecuritySolutions resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Security/iotSecuritySolutions resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Security/iotSecuritySolutions@2019-08-01' = {
location: 'string'
name: 'string'
properties: {
additionalWorkspaces: [
{
dataTypes: [
'string'
]
type: 'string'
workspace: 'string'
}
]
disabledDataSources: [
'string'
]
displayName: 'string'
export: [
'string'
]
iotHubs: [
'string'
]
recommendationsConfiguration: [
{
recommendationType: 'string'
status: 'string'
}
]
status: 'string'
unmaskedIpLoggingStatus: 'string'
userDefinedResources: {
query: 'string'
querySubscriptions: [
'string'
]
}
workspace: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.Security/iotSecuritySolutions
| Name | Description | Value |
|---|---|---|
| location | The resource location. | string |
| name | The resource name | string (required) |
| properties | Security Solution data | IoTSecuritySolutionProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
AdditionalWorkspacesProperties
| Name | Description | Value |
|---|---|---|
| dataTypes | List of data types sent to workspace | String array containing any of: 'Alerts' 'RawEvents' |
| type | Workspace type. | 'Sentinel' |
| workspace | Workspace resource id | string |
IoTSecuritySolutionProperties
| Name | Description | Value |
|---|---|---|
| additionalWorkspaces | List of additional workspaces | AdditionalWorkspacesProperties[] |
| disabledDataSources | Disabled data sources. Disabling these data sources compromises the system. | String array containing any of: 'TwinData' |
| displayName | Resource display name. | string (required) |
| export | List of additional options for exporting to workspace data. | String array containing any of: 'RawEvents' |
| iotHubs | IoT Hub resource IDs | string[] (required) |
| recommendationsConfiguration | List of the configuration status for each recommendation type. | RecommendationConfigurationProperties[] |
| status | Status of the IoT Security solution. | 'Disabled' 'Enabled' |
| unmaskedIpLoggingStatus | Unmasked IP address logging status | 'Disabled' 'Enabled' |
| userDefinedResources | Properties of the IoT Security solution's user defined resources. | UserDefinedResourcesProperties |
| workspace | Workspace resource ID | string |
RecommendationConfigurationProperties
| Name | Description | Value |
|---|---|---|
| recommendationType | The type of IoT Security recommendation. | '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' (required) |
| status | Recommendation status. When the recommendation status is disabled recommendations are not generated. | 'Disabled' 'Enabled' (required) |
TagsResourceTags
| Name | Description | Value |
|---|
UserDefinedResourcesProperties
| Name | Description | Value |
|---|---|---|
| query | Azure Resource Graph query which represents the security solution's user defined resources. Required to start with "where type != "Microsoft.Devices/IotHubs"" | string (required) |
| querySubscriptions | List of Azure subscription ids on which the user defined resources query should be executed. | string Constraints: Pattern = ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$[] (required) |
ARM template resource definition
The iotSecuritySolutions resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Security/iotSecuritySolutions resource, add the following JSON to your template.
{
"type": "Microsoft.Security/iotSecuritySolutions",
"apiVersion": "2019-08-01",
"name": "string",
"location": "string",
"properties": {
"additionalWorkspaces": [
{
"dataTypes": [ "string" ],
"type": "string",
"workspace": "string"
}
],
"disabledDataSources": [ "string" ],
"displayName": "string",
"export": [ "string" ],
"iotHubs": [ "string" ],
"recommendationsConfiguration": [
{
"recommendationType": "string",
"status": "string"
}
],
"status": "string",
"unmaskedIpLoggingStatus": "string",
"userDefinedResources": {
"query": "string",
"querySubscriptions": [ "string" ]
},
"workspace": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.Security/iotSecuritySolutions
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2019-08-01' |
| location | The resource location. | string |
| name | The resource name | string (required) |
| properties | Security Solution data | IoTSecuritySolutionProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Security/iotSecuritySolutions' |
AdditionalWorkspacesProperties
| Name | Description | Value |
|---|---|---|
| dataTypes | List of data types sent to workspace | String array containing any of: 'Alerts' 'RawEvents' |
| type | Workspace type. | 'Sentinel' |
| workspace | Workspace resource id | string |
IoTSecuritySolutionProperties
| Name | Description | Value |
|---|---|---|
| additionalWorkspaces | List of additional workspaces | AdditionalWorkspacesProperties[] |
| disabledDataSources | Disabled data sources. Disabling these data sources compromises the system. | String array containing any of: 'TwinData' |
| displayName | Resource display name. | string (required) |
| export | List of additional options for exporting to workspace data. | String array containing any of: 'RawEvents' |
| iotHubs | IoT Hub resource IDs | string[] (required) |
| recommendationsConfiguration | List of the configuration status for each recommendation type. | RecommendationConfigurationProperties[] |
| status | Status of the IoT Security solution. | 'Disabled' 'Enabled' |
| unmaskedIpLoggingStatus | Unmasked IP address logging status | 'Disabled' 'Enabled' |
| userDefinedResources | Properties of the IoT Security solution's user defined resources. | UserDefinedResourcesProperties |
| workspace | Workspace resource ID | string |
RecommendationConfigurationProperties
| Name | Description | Value |
|---|---|---|
| recommendationType | The type of IoT Security recommendation. | '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' (required) |
| status | Recommendation status. When the recommendation status is disabled recommendations are not generated. | 'Disabled' 'Enabled' (required) |
TagsResourceTags
| Name | Description | Value |
|---|
UserDefinedResourcesProperties
| Name | Description | Value |
|---|---|---|
| query | Azure Resource Graph query which represents the security solution's user defined resources. Required to start with "where type != "Microsoft.Devices/IotHubs"" | string (required) |
| querySubscriptions | List of Azure subscription ids on which the user defined resources query should be executed. | string Constraints: Pattern = ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$[] (required) |
Usage Examples
Terraform (AzAPI provider) resource definition
The iotSecuritySolutions resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Security/iotSecuritySolutions resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Security/iotSecuritySolutions@2019-08-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
additionalWorkspaces = [
{
dataTypes = [
"string"
]
type = "string"
workspace = "string"
}
]
disabledDataSources = [
"string"
]
displayName = "string"
export = [
"string"
]
iotHubs = [
"string"
]
recommendationsConfiguration = [
{
recommendationType = "string"
status = "string"
}
]
status = "string"
unmaskedIpLoggingStatus = "string"
userDefinedResources = {
query = "string"
querySubscriptions = [
"string"
]
}
workspace = "string"
}
}
}
Property Values
Microsoft.Security/iotSecuritySolutions
| Name | Description | Value |
|---|---|---|
| location | The resource location. | string |
| name | The resource name | string (required) |
| properties | Security Solution data | IoTSecuritySolutionProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Security/iotSecuritySolutions@2019-08-01" |
AdditionalWorkspacesProperties
| Name | Description | Value |
|---|---|---|
| dataTypes | List of data types sent to workspace | String array containing any of: 'Alerts' 'RawEvents' |
| type | Workspace type. | 'Sentinel' |
| workspace | Workspace resource id | string |
IoTSecuritySolutionProperties
| Name | Description | Value |
|---|---|---|
| additionalWorkspaces | List of additional workspaces | AdditionalWorkspacesProperties[] |
| disabledDataSources | Disabled data sources. Disabling these data sources compromises the system. | String array containing any of: 'TwinData' |
| displayName | Resource display name. | string (required) |
| export | List of additional options for exporting to workspace data. | String array containing any of: 'RawEvents' |
| iotHubs | IoT Hub resource IDs | string[] (required) |
| recommendationsConfiguration | List of the configuration status for each recommendation type. | RecommendationConfigurationProperties[] |
| status | Status of the IoT Security solution. | 'Disabled' 'Enabled' |
| unmaskedIpLoggingStatus | Unmasked IP address logging status | 'Disabled' 'Enabled' |
| userDefinedResources | Properties of the IoT Security solution's user defined resources. | UserDefinedResourcesProperties |
| workspace | Workspace resource ID | string |
RecommendationConfigurationProperties
| Name | Description | Value |
|---|---|---|
| recommendationType | The type of IoT Security recommendation. | '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' (required) |
| status | Recommendation status. When the recommendation status is disabled recommendations are not generated. | 'Disabled' 'Enabled' (required) |
TagsResourceTags
| Name | Description | Value |
|---|
UserDefinedResourcesProperties
| Name | Description | Value |
|---|---|---|
| query | Azure Resource Graph query which represents the security solution's user defined resources. Required to start with "where type != "Microsoft.Devices/IotHubs"" | string (required) |
| querySubscriptions | List of Azure subscription ids on which the user defined resources query should be executed. | string Constraints: Pattern = ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$[] (required) |